Analytics Glossary

The app type for the guide or survey. Possible values: "ios", "android", "react native", "web".

True when the event was sent from preview mode. Use this property to filter administrative activity.

True when the event occured on the last step of a guide or survey. False otherwise.

A unique identifier for the guide or survey.

Details about the page the user was on for the guide or survey event. Current object keys:

• "domain" (string): Page domain, for example: "example.com"
• "path" (string): URL path, for example: "/example-path/123"
• "title" (string): Page title, for example: "Dashboard"

Enables grouping of Guides and Surveys events by lifecycle.
A guide's or survey’s lifecycle starts when it is triggered and ends when it is completed or dismissed. Lifecycle is independent of the application sessions.

Lifecycle UUID is useful for analyzing events for a given guide/survey across multiple app sessions.

The language code for localization.

The unique identifier of a guide or survey step.

The relative zero-based index of the step.

The title of the step.

The list of tags on the guide or survey.

The title of the guide or survey.

None if guide, Survey if survey.

Details about the page of the guide or survey on which the event occured.

A unique identifier for the guide or survey variant. Useful for analyzing guide or survey experiments.

The version identifier.

The tooltip icon was seen by a user.

A guide is viewed by a user.

Source (json): Explains why the guide was viewed.

Source.type (string): Values:

• nudge
• trigger
• sdk
• share_link
• active
• debug

Source.properties.triggerType (string): Details the trigger's type.

A user dismissed a guide.

Indicates a guide is complete, through one of the following:

1. The user clicks the Done button in a checklist.
2. The user clicks the button on the last step with a button.
3. On the last step of a pin, the user clicks a button, the target element, or the advance target element.
4. On a survey, the user clicks Complete or finishes the last step.
5. On a list or rating survey with no question on the last step, the user selects any option.

This event doesn't fire on Tooltips.

The guide was dismissed within two seconds of appearing.

The user completed a step or portion of the guide.

Was Completed Via CTA (boolean): True if the step was completed through one of the step's CTA's.

The user snoozed a step of the guide.

Snooze Duration (number): Duration of the snooze in ms

The user clicked or interacted with a guide.

Engagement (object): Object with details about the type of engagement.

Current keys:

• type (string): The type of engagement. Possible values: "cta", "link", "survey_focused".
• level (string): For CTA engagement events, the type of CTA engaged. Possible values: "primary", "secondary", "tertiary".
• url (string): For link engagement events, the URL of the link that the user clicked.

The target selector for the pin was not found.

A user provided input and completed a step in a survey. This event fires when a user submits their response for any step of the survey.

Survey Response (number | string | array): The user's response. The value type depends on the question type. For list surveys, this property indicates the survey indices as shown in the survey's Build tab. E.g., [0,3] corresponds to the user selecting the first and fourth options as shown in the survey's Build tab. These indices are particularly useful when randomizing the list order.

Survey Response Array (array): The user's response as an array. Useful if the question is a list with multi-select. Example: ["Option 1", "Option 3"]

Survey Response Number (number): The user's response as a number. Useful if the question type is rating.

Survey Response String (string): The user's response as a string. Useful if the question type is: long text, short text, or list.

Survey Response Other (string): The user's input for the "other" field. Useful if the question is a list with the setting "Other option" enabled.

A user dismissed a survey when a response input was not empty.

Survey Response (number | string | array): The user's response. The value type depends on the question type. For list surveys, this property indicates the survey indices as shown in the survey's Build tab. E.g., [0,3] corresponds to the user selecting the first and fourth options as shown in the survey's Build tab. These indices are particularly useful when randomizing the list order.

Survey Response Array (array): The user's response as an array. Useful if the question is a list with multi-select. Example: ["Option 1", "Option 3"]

Survey Response Number (number): The user's response as a number. Useful if the question type is rating.

Survey Response String (string): The user's response as a string. Useful if the question type is: long text, short text, or list.

Survey Response Other (string): The user's input for the "other" field. Useful if the question is a list with the setting "Other option" enabled.

A survey is viewed by a user.

Source (json): Explains why the survey was viewed.

Source.type (string): Values:

• nudge
• trigger
• sdk
• share_link
• active
• debug

Source.properties.triggerType (string): Details the trigger's type.

A user dismissed a survey.

Indicates a survey is complete through one of the following:

1. The user clicks the Done button in a checklist.
2. The user clicks the button on the last step with a button.
3. On the last step of a pin, the user clicks a button, the target element, or the advance target element.
4. On a survey, the user clicks Complete or finishes the last step.
5. On a list or rating survey with no question on the last step, the user selects any option.

This event doesn't fire on Tooltips.

The survey was dismissed within two seconds of appearing.

A user completed a step in a survey and advanced to the next step. This event fires when a user progresses from one step to another within the survey.

Was Completed Via CTA (boolean): True if the step was completed via one of the step's CTA's.

The user snoozed a step of the survey.

Snooze Duration (number): Duration of the snooze in ms

The user clicked or interacted with a survey.

Engagement (object): Object with details about the type of engagement.

Current keys:

• type (string): The type of engagement. Possible values: "cta", "link", "survey_focused".
• level (string): For CTA engagement events, the type of CTA engaged. Possible values: "primary", "secondary", "tertiary".
• url (string): For link engagement events, the URL of the link that the user clicked.

The target selector for the pin was not found.

A user opens the Resource Center

A user closes or the Resource Center

A user views a piece of content in the Resource Center.

• Title string. The title of the article.
• URL string. The URL of the article.
• Source Key string. The source key of the article (if available).

A user copies the link to a document in the Resource Center.

• Title string. The title of the article.
• URL string. The URL of the article.
• Source Key string. The source key of the article (if available).

A user clicks a link within a piece of content in the Resource Center.

• Title string. The title of the article.
• URL string. The URL of the article.
• Source Key string. The source key of the article (if available).
• Destination string. The destination URL of the link.

A user scrolls through a piece of content in the Resource Center.

• Title string. The title of the article.
• URL string. The URL of the article.
• Source Key string. The source key of the article (if available).

A user views a video within the Resource Center.

• Title string. The title of the article.
• URL string. The URL of the article.
• Source Key string. The source key of the article (if available).

A user clicks the play button of a video in the Resource Center.

• Title string. The title of the article.
• URL string. The URL of the article.
• Source Key string. The source key of the article (if available).

A user clicks the pause button of a video in the Resource Center.

• Title string. The title of the article.
• URL string. The URL of the article.
• Source Key string. The source key of the article (if available).

A user closes or stops a video within the Resource Center.

• Title string. The title of the article.
• URL string. The URL of the article.
• Source Key string. The source key of the article (if available).
• Duration number. The duration in milliseconds that the video was viewed.

A user closes or navigates away from a piece of content in the Resource Center.

• Title string. The title of the article.
• URL string. The URL of the article.
• Source Key string. The source key of the article (if available).
• Duration number. The duration in milliseconds that the video was viewed.

A user executes a search in the Resource Center.

• Input Text string. The search query text.
• Results Count number. The number of search results.

A user clicks on a search result in the Resource Center.

• Title string. The title of the clicked result.
• Excerpt string. The excerpt of the clicked result.
• Type string. The type of the clicked result (for example: 'document', 'video', 'resource', 'nudge').
• Source Key string. The source key of the clicked result (if available).
• Position number. The position of the clicked result in the list.

A recommendation set is displayed in the Resource Center.

• Title string. The title of the recommendation set.
• Key string. The key of the recommendation set.
• Is Default boolean. Whether the recommendation set is the default set.

A user clicks on an item in a recommendation set in the Resource Center.

• Title string. The title of the clicked recommendation.
• Type string. The type of the clicked recommendation (fir example: 'document', 'video', 'link', 'nudge').
• URL string. The URL of the clicked recommendation (if available).
• Key string. The key of the clicked recommendation (if available).
• Source Key string. The source key of the clicked recommendation (if available).
• Position number. The position of the clicked recommendation in the list.
• Recommendation Set Key string. The key of the recommendation set that contains the clicked recommendation.
• Is Default boolean. Whether the recommendation set is the default set.
• Is Autopilot boolean. Whether the recommendation is an autopilot recommendation.

A user clicks on an item in the additional resources section (quick links) in the Resource Center.

• Title string. The title of the clicked quick link.
• Type string. The type of the clicked quick link (for example: 'document', 'video', 'link', 'nudge').
• URL string. The URL of the clicked quick link (if available).
• Key string. The key of the clicked quick link (if available).
• Source Key string. The source key of the clicked quick link (if available).
• Position number. The position of the clicked quick link in the list.
• Is Default boolean. Whether the quick link is in the default set.