Surveys

// access
$nexus->surveys()

SurveysCopy Anchor Link

class Inverge\Nexus\Resource\Surveys

In-product surveys — fetch the surveys a user is eligible to see and submit their answers. Useful server-side for headless/API surveys and for rendering surveys in server-driven UIs.

__constructCopy Anchor Link

function __construct(Inverge\Nexus\NexusClient $client)

Parameters

active()Copy Anchor Link

function active(array $options = []): array

The surveys a user is currently eligible to see (targeting + sampling + frequency capping applied server-side).

Parameters

Returns array<mixed> — list of render-ready surveys

respond()Copy Anchor Link

function respond(string $surveyId, array $answers, array $options = []): array

Submit a survey response (partial or complete). Answers are keyed by question id.

Parameters

Returns array<mixed> — { id, completed }

complete()Copy Anchor Link

function complete(string $surveyId, array $answers, array $options = []): array

Submit a completed response in one call.

Parameters

Returns array<mixed>

dismiss()Copy Anchor Link

function dismiss(string $surveyId, array $options = []): array

Record that a user dismissed a survey without completing it.

Parameters

Returns array<mixed>