Get Started
Data
Analytics
Amplitude AI
Session Replay
Guides and Surveys
Experiment
Admin
SDKs APIs
Partners
FAQ
Get Started
Guides and Surveys Web SDK Guides and Surveys iOS SDK Guides and Surveys Android SDK Guides and Surveys React Native SDK Proxy requests to Guides and Surveys Guides and Surveys Mobile SDK Changelog
Themes Custom CSS Personalize with Variables Conditional Logic Content editor
Templates
Experiments
Setup and Targeting
Throttling
Testing
Tags
Overview Guide form factors and properties
Overview Build a Survey Analyze a Survey
Overview Best Practices Source Content Recommendation Sets Recommendation Set Targeting Settings Autopilot Scraper
Localization
Roles and Permissions
Analytics Glossary
Guides and Surveys
/
Analytics Glossary

Analytics Glossary

Amplitude prefixes Guides and Surveys both events and event properties with [Guides-Surveys].

Common Guides and Surveys event properties

All Guides and Surveys events include the following event properties.

Property Description
App Type
string

The app type for the guide or survey. Possible values: "ios", "android", "react native", "web".
Is From Debug Mode
boolean

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

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

A unique identifier for the guide or survey.
Page
object

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"
Lifecycle UUID
string

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.
Localization Language
string

The language code for localization.
Step ID
number

The unique identifier of a guide or survey step.
Step Index
number

The relative zero-based index of the step.
Step Title
string

The title of the step.
Tags
array

The list of tags on the guide or survey.
Title
string

The title of the guide or survey.
Type
string

None if guide, Survey if survey.
Page
json

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

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

The version identifier.

Guides events

Events for guides.

Event Description
Guide Tooltip Icon Viewed

The tooltip icon was seen by a user.
Guide Viewed

A guide is viewed by a user.

Event-Specific Properties:

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.
Guide Dismissed

A user dismissed a guide.
Guide Completed

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.
Guide Rage Closed

The guide was dismissed within two seconds of appearing.
Guide Step Completed

The user completed a step or portion of the guide.

For pins, this event fires when you select the pin target. Pins are unique because clicks outside the pin generate a "Guide Step Completed" event:

  • Target element: The element the pin is attached to. Clicking this element always advances the tour and fires this event.
  • Advance trigger element: An optional additional element you can configure in the "Advanced trigger" setting that can also advance the tour when clicked and fires this event.

Event-Specific Properties:

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

The user snoozed a step of the guide.

Event-Specific Properties:

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

The user clicked or interacted with a guide. This event only fires when guide CTAs (call-to-action buttons) or links are clicked.

Clicks on a pin's target element or advance trigger element do not generate a "Guide Engaged" event.

Event-Specific Properties:

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.
Error: Pin Target Not Found

The target selector for the pin was not found.

Survey events

Events for surveys.

Event Description
Survey Submitted

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.

Event-Specific Properties:

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.
Survey Abandoned

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

Event-Specific Properties:

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.
Survey Viewed

A survey is viewed by a user.

Event-Specific Properties:

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.
Survey Dismissed

A user dismissed a survey.
Survey Completed

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 trigger 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.
Survey Rage Closed

The survey was dismissed within two seconds of appearing.
Survey Step Completed

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.

Event-Specific Properties:

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

The user snoozed a step of the survey.

Event-Specific Properties:

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

The user clicked or interacted with a survey.

Event-Specific Properties:

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.
Error: Pin Target Not Found

The target selector for the pin was not found.

Resource Center events

Events for Resource Center interactions.

Event Description
Resource Center Opened

A user opens the Resource Center
Resource Center Closed

A user closes or the Resource Center
Resource Center Article Viewed

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

Event-Specific Properties:

  • 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).
Resource Center Article Link Copied

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

Event-Specific Properties:

  • 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).
Resource Center Article Link Clicked

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

Event-Specific Properties:

  • 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.
Resource Center Article Scrolled

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

Event-Specific Properties:

  • 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).
Resource Center Video Viewed

A user views a video within the Resource Center.

Event-Specific Properties:

  • 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).
Resource Center Video Played

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

Event-Specific Properties:

  • 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).
Resource Center Video Paused

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

Event-Specific Properties:

  • 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).
Resource Center Video Closed

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

Event-Specific Properties:

  • 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.
Resource Center Article Closed

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

Event-Specific Properties:

  • 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.
Resource Center Search

A user executes a search in the Resource Center.

Event-Specific Properties:

  • Input Text string. The search query text.
  • Results Count number. The number of search results.
Resource Center Result Clicked

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

Event-Specific Properties:

  • 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.
Resource Center Recommendation Set Shown

A recommendation set is displayed in the Resource Center.

Event-Specific Properties:

  • 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.
Resource Center Recommendation Clicked

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

Event-Specific Properties:

  • 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.
Resource Center Quick Link Clicked

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

Event-Specific Properties:

  • 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.

Was this page helpful?

August 25th, 2025

Need help? Contact Support

Visit Amplitude.com

Have a look at the Amplitude Blog

Learn more at Amplitude Academy

Terms of Service Privacy Notice Acceptable Use Policy Legal

© 2025 Amplitude, Inc. All rights reserved. Amplitude is a registered trademark of Amplitude, Inc.