Survey Events

Survey Viewed

Event Name: survey-viewed
Track when a user views a survey for the first time.
This event is raised when the survey interface is loaded and displayed to the user.

Name	Type	Description	Required
timestamp	`String (TimeStamp)`	The timestamp of the event	Required
pageTitle	`String`	The title of the page where the event occurred	Required
hostName	`String`	The hostname of the page where the event occurred	Required
pathName	`String`	The path of the page where the event occurred	Required
queryString	`String`	The query string of the page where the event occurred	Required
url	`String`	The URL of the page where the event occurred	Required
referrer	`String`	The URL that linked to the page where the event occurred	Required
languages	`Array`	The languages of the browser that made the request	Required
userAgent	`String`	The user agent of the browser that made the request	Required
siteId	`String (GUID)`	The ID of the hub where the event occurred	Required
siteName	`String`	The name of the hub where the event occurred	Required
userId	`String (GUID)`	The ID of the user that performed the action	Required
contactId	`String (GUID)`	The ID of the contact that performed the action	Required
surveyId	`String (GUID)`	The ID of the survey that was viewed	Required
surveyName	`String`	The name of the survey that was viewed	Required
recipientId	`String (GUID)`	The ID of the recipient that viewed the survey	Required

Survey Submitted

Event Name: survey-submitted
Track when a user completes and submits a survey.
This event is raised after all validation passes and the survey data is successfully submitted.

Name	Type	Description	Required
timestamp	`String (TimeStamp)`	The timestamp of the event	Required
pageTitle	`String`	The title of the page where the event occurred	Required
hostName	`String`	The hostname of the page where the event occurred	Required
pathName	`String`	The path of the page where the event occurred	Required
queryString	`String`	The query string of the page where the event occurred	Required
url	`String`	The URL of the page where the event occurred	Required
referrer	`String`	The URL that linked to the page where the event occurred	Required
languages	`Array`	The languages of the browser that made the request	Required
userAgent	`String`	The user agent of the browser that made the request	Required
siteId	`String (GUID)`	The ID of the hub where the event occurred	Required
siteName	`String`	The name of the hub where the event occurred	Required
userId	`String (GUID)`	The ID of the user that performed the action	Required
contactId	`String (GUID)`	The ID of the contact that performed the action	Required
surveyId	`String (GUID)`	The ID of the survey that was submitted	Required
surveyName	`String`	The name of the survey that was submitted	Required
recipientId	`String (GUID)`	The ID of the recipient that submitted the survey	Required

Survey Screen Viewed

Event Name: survey-screen-viewed
Track when a user views a specific screen within a multi-screen survey.
This event is raised each time a new screen becomes visible to the user.

Name	Type	Description	Required
timestamp	`String (TimeStamp)`	The timestamp of the event	Required
pageTitle	`String`	The title of the page where the event occurred	Required
hostName	`String`	The hostname of the page where the event occurred	Required
pathName	`String`	The path of the page where the event occurred	Required
queryString	`String`	The query string of the page where the event occurred	Required
url	`String`	The URL of the page where the event occurred	Required
referrer	`String`	The URL that linked to the page where the event occurred	Required
languages	`Array`	The languages of the browser that made the request	Required
userAgent	`String`	The user agent of the browser that made the request	Required
siteId	`String (GUID)`	The ID of the hub where the event occurred	Required
siteName	`String`	The name of the hub where the event occurred	Required
userId	`String (GUID)`	The ID of the user that performed the action	Required
contactId	`String (GUID)`	The ID of the contact that performed the action	Required
surveyId	`String (GUID)`	The ID of the survey that was viewed	Required
surveyName	`String`	The name of the survey that was viewed	Required
recipientId	`String (GUID)`	The ID of the recipient that viewed the survey screen	Required
screenId	`String (GUID)`	The ID of the screen that was viewed	Required
screenName	`String`	The name of the screen that was viewed	Required
screenNumber	`Number`	The number of the screen that was viewed	Required

Survey Screen Started

Event Name: survey-screen-started
Track when users start entering data on individual survey screens.
This event is raised when the user first interacts with form elements on a screen.

Name	Type	Description	Required
timestamp	`String (TimeStamp)`	The timestamp of the event	Required
pageTitle	`String`	The title of the page where the event occurred	Required
hostName	`String`	The hostname of the page where the event occurred	Required
pathName	`String`	The path of the page where the event occurred	Required
queryString	`String`	The query string of the page where the event occurred	Required
url	`String`	The URL of the page where the event occurred	Required
referrer	`String`	The URL that linked to the page where the event occurred	Required
languages	`Array`	The languages of the browser that made the request	Required
userAgent	`String`	The user agent of the browser that made the request	Required
siteId	`String (GUID)`	The ID of the hub where the event occurred	Required
siteName	`String`	The name of the hub where the event occurred	Required
userId	`String (GUID)`	The ID of the user that performed the action	Required
contactId	`String (GUID)`	The ID of the contact that performed the action	Required
surveyId	`String (GUID)`	The ID of the survey that was started	Required
surveyName	`String`	The name of the survey that was started	Required
recipientId	`String (GUID)`	The ID of the recipient that started the survey screen	Required
screenId	`String (GUID)`	The ID of the screen that was started	Required
screenName	`String`	The name of the screen that was started	Required
screenNumber	`Number`	The number of the screen that was started	Required

Survey Screen Finished

Event Name: survey-screen-finished
Track when a user completes all required fields on a survey screen.
This event is raised when all mandatory fields on a screen are filled and validated and the user proceeds to the next screen (or submission).

Name	Type	Description	Required
timestamp	`String (TimeStamp)`	The timestamp of the event	Required
pageTitle	`String`	The title of the page where the event occurred	Required
hostName	`String`	The hostname of the page where the event occurred	Required
pathName	`String`	The path of the page where the event occurred	Required
queryString	`String`	The query string of the page where the event occurred	Required
url	`String`	The URL of the page where the event occurred	Required
referrer	`String`	The URL that linked to the page where the event occurred	Required
languages	`Array`	The languages of the browser that made the request	Required
userAgent	`String`	The user agent of the browser that made the request	Required
siteId	`String (GUID)`	The ID of the hub where the event occurred	Required
siteName	`String`	The name of the hub where the event occurred	Required
userId	`String (GUID)`	The ID of the user that performed the action	Required
contactId	`String (GUID)`	The ID of the contact that performed the action	Required
surveyId	`String (GUID)`	The ID of the survey that was finished	Required
surveyName	`String`	The name of the survey that was finished	Required
recipientId	`String (GUID)`	The ID of the recipient that finished the survey screen	Required
screenId	`String (GUID)`	The ID of the screen that was finished	Required
screenName	`String`	The name of the screen that was finished	Required
screenNumber	`Number`	The number of the screen that was finished	Required

Survey Form Field Touched

Event Name: survey-form-field-touched
Track when a user first interacts with a form field within a survey.
This event is raised on the first focus, click, or input action on a form field.

Name	Type	Description	Required
timestamp	`String (TimeStamp)`	The timestamp of the event	Required
pageTitle	`String`	The title of the page where the event occurred	Required
hostName	`String`	The hostname of the page where the event occurred	Required
pathName	`String`	The path of the page where the event occurred	Required
queryString	`String`	The query string of the page where the event occurred	Required
url	`String`	The URL of the page where the event occurred	Required
referrer	`String`	The URL that linked to the page where the event occurred	Required
languages	`Array`	The languages of the browser that made the request	Required
userAgent	`String`	The user agent of the browser that made the request	Required
siteId	`String (GUID)`	The ID of the hub where the event occurred	Required
siteName	`String`	The name of the hub where the event occurred	Required
userId	`String (GUID)`	The ID of the user that performed the action	Required
contactId	`String (GUID)`	The ID of the contact that performed the action	Required
surveyId	`String (GUID)`	The ID of the survey that the form field is on	Required
surveyName	`String`	The name of the survey that the form field is on	Required
recipientId	`String (GUID)`	The ID of the survey recipient that touched the form field	Required
screenId	`String (GUID)`	The ID of the screen that the form field is on	Required
screenName	`String`	The name of the screen that the form field is on	Required
screenNumber	`Number`	The number of the screen that the form field is on	Required
formFieldId	`String (GUID)`	The ID of the form field that was touched	Required
formFieldName	`String`	The name of the form field that was touched	Required