---
title: Analytics Glossary
description: "Reference the events and properties Amplitude tracks automatically for Guides and Surveys, Resource Center, and Assistant."
product: guides-surveys
lang: en
last_updated: 2026-10-22
token_estimate: 3745
---
# Analytics Glossary

> For AI agents: a documentation index is available at [/docs/llms.txt](/docs/llms.txt). Append `.md` to any page URL for markdown, or send `Accept: text/markdown`.

This glossary lists the events and event properties Amplitude tracks automatically for Guides and Surveys, Resource Center, and Assistant.

> **Note:** Event count
>
> Guides and Surveys events don't count toward your total event count.

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

## Common Guides and Surveys event properties

All Guides and Surveys events include the following event properties.

| Property | Type | 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 occurred 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:<br>- "domain" (string): Page domain, for example: "example.com"<br>- "path" (string): URL path, for example: "/example-path/123"<br>- "title" (string): Page title, for example: "Dashboard" |
| Lifecycle UUID | string | Enables grouping of Guides and Surveys events by lifecycle.<br>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.<br><br>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 occurred. |
| Variant ID | string | A unique identifier for the guide or survey variant. Useful for analyzing guide or survey experiments. |
| Version | number | The version identifier. |

## Lifecycle events

Events for the Guides and Surveys SDK lifecycle.

| Event | Description | Event-specific properties |
| --- | --- | --- |
| Engagement Booted | The SDK successfully booted after the end user store initialized. Guides and Surveys are ready to display based on triggers. | `initArguments` (object): SDK configuration from `init()`.<br><br>`bootArguments` (object): Arguments from `boot()`. |

## Guides events

Events for guides.

| Event | Description | Event-specific properties |
| --- | --- | --- |
| Guide Tooltip Icon Viewed | The tooltip icon was seen by a user. |  |
| Guide Viewed | A guide is viewed by a user. For pin guides, this event fires when the guide content displays. Pin guides that aren't set to **Open by default** don't fire this event until a user clicks the pin beacon to open the guide content. | `Source` (json): Explains why the guide was viewed.<br><br>`Source.type` (string): Values:<br>- nudge<br>- trigger<br>- sdk<br>- share_link<br>- active<br>- debug<br><br>`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:<br><br>1. The user clicks the **Done** button in a checklist.<br>2. The user clicks the button on the last step with a button.<br>3. On the last step of a pin, the user clicks a button, the target element, or the advance target element.<br>4. On a survey, the user clicks **Complete** or finishes the last step.<br>5. On a list or rating survey with no question on the last step, the user selects any option.<br>6. The user dismisses a step that (a) isn't a pin and (b) doesn't have a CTA.<br><br>**Note:** For pin guides that aren't set to **Open by default**, clicking the target element marks the guide as complete without generating a Guide Viewed event. This can result in more Guide Completed events than Guide Viewed events for the same guide when users interact with the target element without first opening the pin beacon. |  |
| 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.<br><br>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:<br>- **Target element**: The element the pin is attached to. Clicking this element always advances the tour and fires this event.<br>- **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. | `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. | `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.<br><br>Clicks on a pin's *target element* or *advance trigger element* do not generate a "Guide Engaged" event. | `Engagement` (object): Object with details about the type of engagement.<br><br>Current keys:<br>- `type` (string): The type of engagement. Possible values: "cta", "link", "survey_focused".<br>- `level` (string): For CTA engagement events, the type of CTA engaged. Possible values: "primary", "secondary", "tertiary".<br>- `url` (string): For link engagement events, the URL of the link that the user clicked. |
| Error | Fires when an error occurs during guide display or interaction. Amplitude deduplicates this event, recording it once for each guide, error type, and session.<br><br>The legacy `Error: Pin Target Not Found` event also fires for `pin_target_not_found` errors for backward compatibility. | `Error Type` (string): The category of error. Possible values:<br>- `pin_target_not_found` — The SDK can't find the pin target element within the search timeout.<br>- `click_action_failed` — A click element action fails because the SDK can't find the element after the retry timeout.<br>- `callback_action_failed` — A callback action fails because the SDK hasn't registered the callback.<br>- `link_action_failed` — A link/URL action fails.<br>- `open_chat_failed` — An open chat action fails.<br>- `show_guide_failed` — A show guide action fails.<br>- `show_survey_failed` — A show survey action fails.<br>- `action_failed` — A catch-all for any other action type that fails.<br>- `scroll_to_target_failed` — The SDK can't scroll to bring the pin target into view (web only).<br><br>`Action Index` (number): The zero-based index of the failing action in the step's action sequence. Present only for action-related errors (`click_action_failed`, `callback_action_failed`, `link_action_failed`, `open_chat_failed`, `show_guide_failed`, `show_survey_failed`, and `action_failed`). |
| Error: Pin Target Not Found | **Deprecated.** Use the `Error` event and set `Error Type` to `pin_target_not_found` instead.<br><br>The SDK doesn't find the pin target selector. This legacy event still fires for backward compatibility alongside the unified `Error` event. |  |

## Resource Center events

Events for the Resource Center widget.

| Event | Description | Event-specific properties |
| --- | --- | --- |
| Resource Center Opened | The Resource Center widget was opened by a user. |  |
| Resource Center Closed | The Resource Center widget was closed by a user. |  |
| Resource Center Item Clicked | A user clicked an item in the Resource Center. |  |
| Resource Center Searched | A user submitted a search query in the Resource Center. |  |
| Resource Center Tab Switched | A user switched to a different tab in the Resource Center. |  |
| Resource Center Fallback | The Resource Center displayed its fallback content. Skipped when the project has no configured fallback row. |  |

## Assistant events

Events for the Assistant chat experience.

| Event | Description | Event-specific properties |
| --- | --- | --- |
| [Assistant] Chat Session Started | A new chat session was started in the Assistant. |  |
| [Assistant] Message Sent | A user sent a message to the Assistant. |  |
| [Assistant] Tool Call | The Assistant invoked a tool while processing a user request. |  |
| [Assistant] Citation Clicked | A user clicked a citation link in an Assistant response. |  |
| [Assistant] Escalated | The Assistant escalated the conversation to a fallback handler. |  |
| [Assistant] Fallback | The Assistant responded with fallback content. Skipped when the project has no configured fallback row. |  |

## Survey events

Events for surveys.

| Event | Description | Event-specific properties |
| --- | --- | --- |
| 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. | `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.<br><br>`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"]<br><br>`Survey Response Number` (number): The user's response as a number. Useful if the question type is rating.<br><br>`Survey Response String` (string): The user's response as a string. Useful if the question type is: long text, short text, or list.<br><br>`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. | `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.<br><br>`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"]<br><br>`Survey Response Number` (number): The user's response as a number. Useful if the question type is rating.<br><br>`Survey Response String` (string): The user's response as a string. Useful if the question type is: long text, short text, or list.<br><br>`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. | `Source` (json): Explains why the survey was viewed.<br><br>`Source.type` (string): Values:<br>- nudge<br>- trigger<br>- sdk<br>- share_link<br>- active<br>- debug<br><br>`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:<br><br>1. The user clicks the **Done** button in a checklist.<br>2. The user clicks the button on the last step with a button.<br>3. On the last step of a pin, the user clicks a button, the target element, or the advance trigger element.<br>4. On a survey, the user clicks *Complete* or finishes the last step.<br>5. On a list or rating survey with no question on the last step, the user selects any option.<br>6. The user dismisses a step that (a) isn't a pin and (b) doesn't have a CTA. |  |
| 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. | `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. | `Snooze Duration` (number): Duration of the snooze in ms |
| Survey Engaged | The user clicked or interacted with a survey. | `Engagement` (object): Object with details about the type of engagement.<br><br>Current keys:<br>- `type` (string): The type of engagement. Possible values: "cta", "link", "survey_focused".<br>- `level` (string): For CTA engagement events, the type of CTA engaged. Possible values: "primary", "secondary", "tertiary".<br>- `url` (string): For link engagement events, the URL of the link that the user clicked. |
| Error | Fires when an error occurs during survey display or interaction. Amplitude deduplicates this event, recording it once for each survey, error type, and session.<br><br>The legacy `Error: Pin Target Not Found` event also fires for `pin_target_not_found` errors for backward compatibility. | `Error Type` (string): The category of error. Possible values:<br>- `pin_target_not_found` — The SDK can't find the pin target element within the search timeout.<br>- `click_action_failed` — A click element action fails because the SDK can't find the element after the retry timeout.<br>- `callback_action_failed` — A callback action fails because the SDK hasn't registered the callback.<br>- `link_action_failed` — A link/URL action fails.<br>- `open_chat_failed` — An open chat action fails.<br>- `show_guide_failed` — A show guide action fails.<br>- `show_survey_failed` — A show survey action fails.<br>- `action_failed` — A catch-all for any other action type that fails.<br>- `scroll_to_target_failed` — The SDK can't scroll to bring the pin target into view (web only).<br><br>`Action Index` (number): The zero-based index of the failing action in the step's action sequence. Present only for action-related errors (`click_action_failed`, `callback_action_failed`, `link_action_failed`, `open_chat_failed`, `show_guide_failed`, `show_survey_failed`, and `action_failed`). |
| Error: Pin Target Not Found | **Deprecated.** Use the `Error` event and set `Error Type` to `pin_target_not_found` instead.<br><br>The SDK doesn't find the pin target selector. This legacy event still fires for backward compatibility alongside the unified `Error` event. |  |