Google Analytics for Auth0

This article explains how to install and configure the Google Analytics for Auth0 integration. You can use this integration on your own page that is using Lock or you can use this on the hosted Lock pages. Additionally, you will find instructions on how to configure funnels and reports inside of Google Analytics to get the most out of this integration.

Install

To add the Google Analytics integration to your app, include a reference to the Auth0 Analytics.js script on any pages with Auth0 Lock. Include the script reference after Lock and set the configuration options before the script reference.

<script>
window.auth0AnalyticsOptions = {
  // Options
}
</script>
<script src="https://cdn.auth0.com/js/lock/10.20/lock.min.js"></script>
<script src="https://cdn.auth0.com/js/analytics/X.Y.Z/analytics.min.js"></script>

The script version above uses a placeholder version X.Y.Z. For example, to reference release 1.2.0 use https://cdn.auth0.com/js/analytics/1.2.0/analytics.min.js. To find the latest release, see the releases on github.

Setup

There are several ways you can use the Google Analytics integration. If you already have the Google Analytics Script on your site, configure Auth0 Analytics with the preload option as shown below. If you don't have Google Analytics loaded you need to set your Google Analytics ID using the Google Analytics configuration below.

If you have already loaded the Google Analytics script loaded on your site, configure Auth0 Analytics to not load it again as shown below.

<script>
window.auth0AnalyticsOptions = {
  'google-analytics': {
    preloaded: true
  }
}
</script>

No Google Analytics Script

If you are not using Google Analytics already you can have the Auth0 Analytics script load Google Analytics for you. To do this you need to set your Google Analytics ID in the options as shown below.

<script>
window.auth0AnalyticsOptions = {
  'google-analytics': {
    id: 'YOUR_GA_ID'
  }
}
</script>

Usage

After installation on your site there is nothing else you need to do to start collecting data. Auth0 Analytics will immedately begin sending events to Google Analytics.

You will see the following events being logged:

  • Auth0 Lock show
  • Auth0 Lock hide
  • Auth0 Lock unrecoverable_error
  • Auth0 Lock authenticated
  • Auth0 Lock authorization_error
  • Auth0 Lock forgot_password ready
  • Auth0 Lock forgot_password submit
  • Auth0 Lock signin submit
  • Auth0 Lock signup submit
  • Auth0 Lock federated login

Note that some events that Lock emits like hash_parsed are not used for analytics purposes. Also, be aware that some events are only availible in newer versions of Lock. If you are using an older version of Lock you will only see some of these events. We suggest upgrading to the latest version of Lock to get the most of the Auth0 Analytics integration.

For more information on the events that are sent see the Lock API documentation.

Reporting

For the most up to date information on using Google Analytics, check out the Google Analytics documentation.