If you would like to evaluate Guides and Surveys, please reach out to a member of your account team.
Who can use this feature?
- Part of Guides and Surveys, an add-on for Business, Advanced, and Enterprise plans.
- Requires an Admin, Architect, or Standard role to configure.
Guides and Surveys is in active development. Product functionality and documentation may change without notice.
In addition to the built-in reporting for Guides and Surveys, Fullstory provides a comprehensive suite of custom events that capture user interactions with your guides and survey content. These custom events allow you to analyze content performance using Fullstory's analytics capabilities, helping you understand how users engage with tours, smart tips, banners, checklists, and surveys.
Events Structure
Guides and Surveys custom events are implemented as Fullstory custom events, each with a set of accompanying properties that provide detailed context about user interactions. These events capture key moments in the user journey, such as when a tour is started or completed, when a survey question is answered, or when a banner is clicked.
Guide (Tour)
Tours guide users through your application with step-by-step walkthroughs. The following custom events capture user interactions with tours, including when tours are started, completed, or closed, and when individual steps are viewed.
Note: Custom events that begin with Guide... correspond to Guides and Surveys tours.
| Event Name | Event Trigger | Event Properties |
|---|---|---|
Guide State Changed |
When a guide is started, completed or closed. We send closed event only when the guide is incomplete. |
guideName (string)guideId (string)state (string)stepName (string)stepType (string)stepId (string)stepIndex (integer) |
Guide Step Seen |
When a guide step is shown. |
guideName (string)guideId (string)stepName (string)stepType (string)stepId (string)stepIndex (integer) |
Guide (Tour) example:
This example uses the Guide State Changed custom event to filter for users who started a tour but didn't complete it.
Smart Tip
Smart Tips provide contextual help and guidance to users as they navigate your application (link to additional documentation to be updated when available). These events track when smart tips are displayed or closed by users.
| Event Name | Event Trigger | Event Properties |
|---|---|---|
Smart Tip State Changed |
When a Smart tip is displayed, or closed. |
smartTipName (string)smartTipId (string)smartTipGroupName (string)smartTipGroupId (string)state (string) |
Smart Tip Example
This example uses the Smart Tip State Changed custom event to filter for users who saw a particular smart tip.
Banner
Banners display important messages and announcements to users (link to additional documentation to be updated when available). These events capture when banners are shown, closed, or clicked.
| Event Name | Event Trigger | Event Properties |
|---|---|---|
Banner State Changed |
When a banner is displayed or closed. |
bannerName (string)bannerId (string)state (string) |
Banner Clicked |
When the banner is clicked. |
bannerName (string)bannerId (string)target (string) |
Banner example
This example uses both the Banner State Changed and Banner Clicked custom events to filter for users who saw a particular banner and then clicked it.
Checklist
Checklists help users complete multi-step workflows and onboarding tasks (link to additional documentation to be updated when available). These events track checklist progress, including when checklists are displayed, when individual items are viewed or clicked, and when items are completed.
| Event Name | Event Trigger | Event Properties |
|---|---|---|
Checklist State Changed |
When a checklist is shown, started, completed, closed, or dismissed. |
checklistName (string)checklistId (string)state (string) |
Checklist Item Seen |
When an item is displayed to user. |
checklistName (string)checklistId (string)itemName (string)itemId (string)itemIndex (integer) |
Checklist Item Clicked |
When an item is clicked. |
checklistName (string)checklistId (string)itemName (string)itemId (string)itemIndex (integer) |
Checklist Item State Changed |
When the checklist item is completed. |
checklistName (string)checklistId (string)itemName (string)itemId (string)itemState (string)itemIndex (integer) |
Checklist example
This example uses the Checklist Item Clicked and Checklist Item State Changed custom events in a funnel to show the drop off between users who began a checklist and those that never made it to the next step.
Survey
Surveys collect feedback and insights from your users through customizable questions (link to additional documentation to be updated when available). These events capture survey interactions, including when surveys are started or completed, when pages are viewed, and when individual questions are answered.
| Event Name | Event Trigger | Event Properties |
|---|---|---|
Survey State Changed |
When a survey is started, completed or closed. We send a closed event only when the survey is incomplete. |
surveyName (string)surveyId (string)state (string)pageName (string)pageType (string)pageId (string)pageIndex (integer) |
Survey Page Seen |
When a survey page is displayed. |
surveyName (string)surveyId (string)pageName (string)pageType (string)pageId (string)pageIndex (integer) |
Question Answered |
When a user submits an answer to a question. |
surveyName (string)surveyId (string)pageName (string)pageType (string)pageId (string)pageIndex (integer)questionName (string)questionId (string)questionType (string)questionIndex (string)isRequired (boolean)answer (string) - for single-selectanswer (integer) - for NPS, rangeanswer (string[]) - for multi-selectsnpsCategory (string) - for NPS questions, represents if the customer is a promoter, passive, or detractor. |
Survey example
This example uses the Survey State Changed and Question Answered custom events to filter for users who started a particular survey and rated a quantitative NPS question 7 or greater.