Surveys

All events below include the Base Context Fields in addition to the event-specific fields listed for each event.

Base Context Fields

Field	Type	Description
siteId	string	The unique site ID
userId	string	The unique user ID
pageId	string	The unique page ID
pageSlug	string	The page slug

Event Reference Table

Event Name	Event Key	Additional Fields (beyond base)
Survey Submitted	`survey-submitted`	`surveyId` (string), `responses` (object)
Survey Viewed	`survey-viewed`	`surveyId` (string)
Survey Screen Viewed	`survey-screen-viewed`	`surveyId` (string), `screenId` (string)
Survey Screen Started	`survey-screen-started`	`surveyId` (string), `screenId` (string)
Survey Screen Finished	`survey-screen-finished`	`surveyId` (string), `screenId` (string)
Survey Form Field Touched	`survey-form-field-touched`	`surveyId` (string), `fieldId` (string)

Example Event Payloads

Survey Submitted

Description: Triggered when a user completes and submits a survey. Captures all responses for the survey fields.


{
  "siteId": "string",
  "userId": "string",
  "pageId": "string",
  "pageSlug": "string",
  "surveyId": "string"
}

Survey Viewed

Description: Triggered when a user first views a survey. Used to track survey impressions and engagement.


{
  "siteId": "string",
  "userId": "string",
  "pageId": "string",
  "pageSlug": "string",
  "surveyId": "string"
}

Survey Screen Viewed

Description: Triggered when a user views a specific screen (page) of a multi-page survey. Used to track navigation and engagement within the survey.


{
  "siteId": "string",
  "userId": "string",
  "pageId": "string",
  "pageSlug": "string",
  "surveyId": "string",
  "screenId": "string"
}

Survey Screen Started

Description: Triggered when a user begins interacting with a specific screen (page) of a survey, either by touching a field or clicking to continue. Used to track the start of engagement on each survey screen.


{
  "siteId": "string",
  "userId": "string",
  "pageId": "string",
  "pageSlug": "string",
  "surveyId": "string",
  "screenId": "string"
}

Survey Screen Finished

Description: Triggered when a user completes a specific screen (page) of a survey, typically by clicking next or submitting that page. Used to track completion and progress through the survey.


{
  "siteId": "string",
  "userId": "string",
  "pageId": "string",
  "pageSlug": "string",
  "surveyId": "string",
  "screenId": "string"
}

Survey Form Field Touched

Description: Triggered when a user interacts with (focuses or changes) a specific field on a survey screen. Used to track field-level engagement and activity.


{
  "siteId": "string",
  "userId": "string",
  "pageId": "string",
  "pageSlug": "string",
  "surveyId": "string",
  "fieldId": "string"
}