Overview

This article explains how UserGuiding integrates with Google Analytics, a web analytics service offered by Google that tracks & reports website traffic and events.

When it is activated, UserGuiding can be used as a Source that sends UserGuiding content-related event data to your Google Analytics account.

Important Note: To successfully initiate this integration, you must have installed Google Analytics within your web application. If not, this integration will not take place.

How To Enable Google Analytics Integration

You can enable this integration using the toggle within the Integrations Tab under the Settings Section.

This integration will be activated for the pages where UserGuiding Container Code and the Google Analytics Tracking Code are present at the same time.

Installation Method Specific Requirements

To learn more about Google Analytics installation methods, visit Google's documentation.

gtag.js

If you have installed Google Analytics within your web application using the gtag.js method, no additional steps are required.

Google Tag Manager

​If you have installed Google Analytics using Google Tag Manager, you must complete the following steps before enabling the Integration.

1- Create Data Layer Variables

You need to create 11 new Data Layer Variables with the following names;

userguiding_material_id
userguiding_material_name
userguiding_material_type
userguiding_interacted_item_id
userguiding_interacted_item_name
userguiding_survey_id
userguiding_survey_name
userguiding_question_id
userguiding_question_type
userguiding_survey_score
userguiding_survey_answer

Each variable should look something like the below:
​

2- Create a Tag for Material Events

3- Add Trigger to Material Events Tag

• Trigger Type: Custom Event
• Event name: userguiding_(?!survey)\w+\b
• Use regex matching

4- Create a Tag for Survey Events

Add a new GA4 Event tag with the below configurations

5- Add Trigger to Survey Events Tag

• Trigger Type: Custom Event
• Event name: userguiding_survey.+
• Use regex matching

Publish changes to your GTM workspace

As long as your UserGuiding > Google Analytics integration is enabled, all UserGuiding events that get sent to GTM should now also be forwarded to your Google Analytics account.

Event Tracking

When enabled, UserGuiding will send content-related event data to your Google Analytics account.
​
​To view the events:
Go to your Google Analytics Dashboard > Realtime > Events.

Or go to Behavior > Events > Top events

You should see the latest UserGuiding events in this section.

Event Format

<EVENT_NAME>
<EVENT_PROPERTIES>

Event Example

userguiding_banner_button_click

userguiding_material_id: 36
userguiding_material_name: Banner Name
userguiding_material_type: banner
userguiding_interacted_item_id: 0910f959-f611-4f42-9337-3964d7f9e005
userguiding_interacted_item_name: Explore Now

Below, you can find the list of events sent to Google Analytics from UserGuiding.

userguiding_guide_started

userguiding_guide_completed

userguiding_guide_button_clicked

userguiding_hotspot_interacted

userguiding_hotspot_button_clicked

userguiding_banner_button_clicked

userguiding_checklist_completed

userguiding_checklist_item_trigger

userguiding_checklist_item_url_click

userguiding_rc_guide_trigger

userguiding_rc_survey_trigger

userguiding_rc_checklist_guide_trigger

userguiding_rc_checklist_item_url_click

userguiding_rc_external_url_click

userguiding_rc_article_link_click

userguiding_survey_shown

userguiding_survey_answer

userguiding_booster_slide_out_view

userguiding_booster_tooltip_view

userguiding_product_updates_post_view

userguiding_product_updates_page_view

userguiding_product_updates_feedback

userguiding_ai_assistant_booster_tooltip_view

userguiding_ai_assistant_widget_view

userguiding_ai_assistant_conversation_started

userguiding_ai_assistant_message_sent

userguiding_ai_assistant_message_received

userguiding_ai_assistant_fallback_message_received

userguiding_ai_assistant_fallback_action_clicked

userguiding_ai_assistant_article_clicked

userguiding_ai_assistant_guide_trigger