Surveys

// access
nexus.surveys

ActiveOptionsCopy Anchor Link

propertiesCopy Anchor Link

properties?: Record<string, unknown>

deviceTypeCopy Anchor Link

deviceType?: string

NexusSurveyCopy Anchor Link

idCopy Anchor Link

id: string

nameCopy Anchor Link

name: string

typeCopy Anchor Link

type: string

questionsCopy Anchor Link

questions: unknown[]

NexusSurveysCopy Anchor Link

In-product surveys — fetch eligible surveys and submit answers. Headless (bring your own UI); works in any framework and server-side.

NexusSurveysCopy Anchor Link

new NexusSurveys(http: NexusHttp, id: NexusIdentity)

Parameters

Returns NexusSurveys

activeCopy Anchor Link

readonly active: NexusSurvey[]

fetch()Copy Anchor Link

async fetch(options: ActiveOptions = {}): Promise<NexusSurvey[]>

Surveys the current user is eligible for (targeting/sampling/capping applied).

Parameters

Returns Promise<NexusSurvey[]>

byId()Copy Anchor Link

byId(id: string): NexusSurvey | undefined

Parameters

Returns NexusSurvey | undefined

respond()Copy Anchor Link

async respond(surveyId: string, answers: Record<string, unknown>, options: { responseId?: string; completed?: boolean; dismissed?: boolean; iterationKey?: string } = {}): Promise<void>

Submit a response (partial, complete, or dismissed). Answers keyed by question id.

Parameters

complete()Copy Anchor Link

complete(surveyId: string, answers: Record<string, unknown>, options: {} = {}): Promise<void>

Parameters

dismiss()Copy Anchor Link

dismiss(surveyId: string, options: {} = {}): Promise<void>

Parameters