Overview

This article explains how UserGuiding integrates with Amplitude, a platform that helps you analyze user data in real-time to identify trends and understand user behavior.

When Amplitude Integration is activated, you can more deeply analyze and target the user onboarding experience you created with UserGuiding.

By setting up onboarding, activation, and retention funnels in Amplitude, you can also test and adjust your Guides for these metrics.

You can start by going to your Amplitude account. Navigate to 'Data' first from the top menu, then go to 'Sources' under 'Connections' from the menu on the left, then click 'Add Source' from the top right.

Search for 'UserGuiding' and click on the UserGuiding card.

On this page, you will find your 'API Key'. Copy this API Key.

Then sign in to your UserGuiding account, go to your Integrations Tab under Settings, and turn on the toggle for Amplitude.

On the opening popup, paste the Amplitude 'API Key' you copied. If your Amplitude project data is on EU servers, you should select the 'EU Data Residency' option. If not, use 'Standard Server', then click 'Complete Integration'.

You are all set! UserGuiding will immediately start sending onboarding material engagement data, for each user, to your Amplitude account.

Once activated, you can find UserGuiding data as custom events in Amplitude, ready to be used as part of any Amplitude chart, report, or funnel.

To check how a particular user performs with your UserGuiding Onboarding material, go to User Look-Up and click on a user.

When you scroll down on the left-hand side, you will see the events performed by the user. If you click on an event on the right-hand side, you will see the details of the event. You can find UserGuiding event metadata under 'Event Properties' there.

UserGuiding sends the following events and metadata to Amplitude:

It means that a user previews the first step of a Guide. To see which Guide it is, click on the guide started (userguiding).

You'll see the Guide's ID, name, and URL of the page on which the user has seen its first step.

It means that a user has gone through all steps of a Guide and seen its last step. To see which Guide it is, click on the guide completed (userguiding).

You'll see the Guide's ID, name, and URL of the page on which the user has seen its first step.

It means that a user sees your Survey. To see the URL of the page where the user has seen the survey, click on the survey shown (userguiding).

It means that a user has given you a certain score or selected an emoji, option, or written feedback. To see the value, check under survey question answer (userguiding).

You'll see the survey question, the URL of the page on which the user has seen the survey, and the user ID.

It means that a user interacted with a Hotspot group and saw Hotspot content. Remember, Hotspot groups can have multiple Hotspots as contents.

This event is sent once in one UserGuiding script load (page refresh).

To see which Hotspot it is, click on the hotspot interacted (userguiding).

You'll see the Hotspot group ID, interacted Hotspot's ID/title, the name of the Hotspot group, and the URL of the page on which the user interacted with the Hotspot.

It means that a user triggers a Checklist item. To see which item is triggered from which Checklist, click on the checklist item triggered (userguiding).

You'll see the Checklist's name / ID, Guide name / ID, and the URL of the page on which the user has triggered the Guide from the Checklist.

It means that the user clicks a URL item on a Checklist. To see which item is clicked from which Checklist, click on the checklist item url click (userguiding).

You'll see the Checklist's name / ID, the URL of the item, and the URL of the page on which the user has clicked on the item in the Checklist.

It means that the user completed a Checklist. To see which Checklist, click on the checklist completed (userguiding).

You'll see the Checklist's name / ID and the URL of the page on which the user has completed the Checklist.

It means that the user triggers a Resource Center Guide. To see which Guide it is, click on the resource center guide triggered (userguiding).

You'll see the Resource Center's name / ID, Guide name / ID, and the URL of the page on which the user has triggered the Guide from the Resource Center.

It means that a Guide in a checklist put in a Resource Center as a module is triggered by a user. To see which Guide it is, click on the resource center checklist guide triggered (userguiding).

You'll see the Resource Center's name / ID, Checklist's name / ID, Guide name / ID, and the URL of the page on which the user has triggered the Guide from the Checklist within the Resource Center.

It means that a URL item in a Checklist put in a Resource Center as a module is clicked by a user. To see the item information, click on the resource center checklist item url click (userguiding) inside recent events.

You'll see the Resource Center's name / ID, Checklist's name / ID, Item URL, and the URL of the page on which the user has clicked the item from the Checklist within the Resource Center.

It means that a user clicks an external URL in a Resource Center. To see which external URL is clicked from which Resource Center, click on the resource center external url clicked (userguiding).

You'll see the Resource Center's name / ID, external URL, and the URL of the page on which the user has clicked on the external URL within the Resource Center.

It means that a user clicks a search article in a Resource Center. To see which search article is clicked from which Research Center, click on the resource center article link clicked (userguiding).

You'll see the Resource Center's name / ID, article link, and the URL of the page on which the user has clicked on the article link within the Resource Center.

It means that a Survey in a Resource Center as a module is triggered by a user. To see which Survey is triggered from which Resource Center, check under resource center survey trigger (userguiding).

Example:

💡Please note that the existing events associated with the now-deprecated Promoter Surveys will remain unchanged; however, they will be emitted in their new format.