Docs

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 as part of a customized Universal Login page.

Additionally, you will find instructions on how to configure funnels and reports inside of Google Analytics to get the most out of this integration.

Setup and install

To add the Google Analytics integration to your app:

  1. Set your Analytics configuration options
  2. Include a reference to the auth0-analytics.js script on your Login pages/pages with Auth0 Lock

Step 1: Set your Analytics configuration options

First, set your Analytics configuration options. You must set this before you include the references to the Lock and Auth0 Analytics libraries (which we cover in the section immediately following).

Step 2: Include the script reference to auth0-analytics.js

Next, include the script reference to the auth0-analytics.js. This needs to be included after the call to Lock.

The script version above uses a placeholder version X.Y.Z. For example, to reference release 1.3.1 use https://cdn.auth0.com/js/analytics/1.3.1/analytics.min.js. You can find the latest release's version number on GitHub.

Usage

After installation on your site there is nothing else you need to do to start collecting data. Auth0 Analytics will immediately 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 available 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, see the Google Analytics documentation.