Overview

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

When Mixpanel 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 Mixpanel, you can also test and adjust your Guides for these metrics.

How To Activate Mixpanel Integration

You can start by going to your Mixpanel account and navigating to the project you want your UserGuiding events to stream.

Then go to your 'Project Settings' through the menu shown below.

Under 'Access Keys' there, you can find your 'Project Token' and copy it.

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

On the opening popup, paste your Mixpanel 'Project Key' you copied. If your Mixpanel project data is on EU servers, you should select '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 Mixpanel account.

Event Tracking

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

To check how a particular user performs with your UserGuiding Onboarding material, go to Users > Explore > X User > and examine the event data in the Activity Feed.

UserGuiding sends the following events to Mixpanel:

Guide Preview Start:

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.

Guide Preview Complete:

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.

Survey Shown

{
  "event": "survey shown (userguiding)",
  "properties": {
    "$source": "userguiding",
    "distinct_id": "USER-ID",
    "surveyId": "1",
    "surveyName": "Survey Name",
    "pageUrl": "https://panel.userguiding.com/dashboard"
}

Survey Question Answer (score)

{
  "event": "survey question answer (userguiding)",
  "properties": {
    "$source": "userguiding",
    "distinct_id": "USER-ID",
    "surveyId": "1",
    "surveyName": "Survey Name",
    "questionId": "f4411b5d-7544-477a-b605-5c8622cb5c8b",
    "questionType": "Star Rating" | "Number Rating (5)" | "Number Rating (10)" | "NPS Rating",
    "surveyQuestion": "How likely are you to recommend this product to a friend or colleague?",
    "score": 5,
    "pageUrl": "https://panel.userguiding.com/dashboard",
}

Survey Question Answer (emojiScore)

{
"event": "survey question answer (userguiding)",
"properties": {
"$source": "userguiding",
"distinct_id": "USER-ID",
"surveyId": "1",
"surveyName": "Survey Name",
"questionId": "d82cf468-6dae-4813-a3e2-1ba740254aa1",
"questionType": "Emoji Rating" | "Thumbs Up/Down",
"surveyQuestion": "How would you describe your experience with our product using emojis?",
"emojiScore": "Positive" | "Neutral" | "Negative",
"pageUrl": "https://panel.userguiding.com/dashboard",
}

Survey Question Answer (choices)

{
  "event": "survey question answer (userguiding)",
  "properties": {
    "$source": "userguiding",
    "distinct_id": "USER-ID",
    "surveyId": "1",
    "surveyName": "Survey Name",
    "questionId": "23300f80-4002-461e-b179-559094c82496",
    "questionType": "Multiple Choice",
    "surveyQuestion": "Which of the following options best describes your role?",
    "choices": "Choice 1,Choice 2",
    "pageUrl": "https://panel.userguiding.com/dashboard",
}

Survey Question Answer (feedback)

{
  "event": "survey question answer (userguiding)",
  "properties": {
    "$source": "userguiding",
    "distinct_id": "USER-ID",
    "surveyId": "1",
    "surveyName": "Survey Name",
    "questionId": "81d6c621-d74c-4590-b35e-9d5abc3c49d5",
    "questionType": "Written Feedback",
    "surveyQuestion": "Please provide any comments or feedback regarding your experience with our service.",
    "feedback": "User's feedback",
    "pageUrl": "https://panel.userguiding.com/dashboard",
}

Hotspot Interaction

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

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.

hotspotTitle is the extracted Hotspot title from Hotspot content.

Checklist Item Trigger

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

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

Resource Center Guide Trigger

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, the Guide's name / ID, and the URL of the page on which the user has triggered the guide from the Resource Center.

Resource Center Checklist Guide Trigger

It means that a Guide in a Checklist that is 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, the Checklist's name / ID, the Guide's name / ID, and the URL of the page on which the user has triggered the guide from the checklist within the Resource Center.

Resource Center External URL Click

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.

Resource Center Article Link Click

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.

Resource Center Survey Trigger

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

{
  "event": "resource center survey trigger (userguiding)",
  "properties": {
    "$source": "userguiding",
    "distinct_id": "USER-ID",
    "surveyId": "1",
    "surveyName": "Survey Name",
    "resourceCenterId": "1",
    "resourceCenterName": "Resource Center Name",
    "pageUrl": "https://panel.userguiding.com/dashboard",
  }

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

Amplitude Integration