Register the Analytics module
IMPORTANT: Sitefinity CMS Analytics module is unavailable after July 1, 2024, because it depends on the discontinued Google Universal Analytics. We recommend using Sitefinity Insight and the Script manager (available in Sitefinity CMS 14.3 and later) to integrate another analytics solution.
Register the Analytics module
Before you setup the Analytics module, you must register it in Google Analytics. You must register when you are setting up Analytics for the first time.
Perform the following:
- In Sitefinity CMS backend, navigate to Administration » Settings » Advanced » WebSecurity » RefererValidation.
- In Trusted locations input field, enter accounts.google.com and click Save changes.
- Log in to your Google Analytics account.
- Go to https://code.google.com/apis/console/.
- In the toolbar, click CREATE PROJECT.
- Choose a name for the project and click Create.
- In the toolbar, click on the Notification icon and then click on your newly created project.
- In the Google APIs screen, in the APIs section, click Go to APIs overview.
- Open the Library tab page.
- Under Other, select Google Analytics API.
- In the toolbar, click ENABLE.
- In the upper-right corner, click Create credentials.
- Under Add credentials to your project, click Cancel.
- On the top of the screen, expand Create credentials and click OAuth Client ID.
- In the upper-right corner, click Configure consent screen.
- Select the user type.
You can select External for testing purposes.
- Click Create.
- Fill out the required information, such as App name, User support email, and Developer contact information.
For more information, see Google's documentation about creating the consent screen.
- Go back to the Credentials page, expand Create credentials again, and click OAuth client ID.
- Select Web application.
- Under Authorized JavaScript origins, enter
http://<your website>
- Under Authorized redirect URIs, enter http://<your website>/Sitefinity/marketing/Analytics
- Click Create.
- Copy the generated Client ID and the Client secret.
RESULT: You have registered the Analytics module, you can continue to setup the Analytics module in Sitefinity CMS backend.
Set up the Analytics module
PREREQUISITES: Before you setup the Analytics module, you must have added and configured the Google Analytics widget on at least one page, and the module must have already collected some data.
NOTE: When using the Google Analytics widget, the tracking code is always placed inside the <body> section of the page HTML. If you need to have the tracking code placed inside the <head> tag of the page HTML you must use a JavaScript widget and add the code manually. For more information see JavaScript widget.
When you open the Analytics module for the first time, you need to configure it to show data for the site you want.
To setup Analytics, perform the following:
- Login to Sitefinity CMS and click Marketing » Analytics.
If you have not used the Analytics module before, the Configure Analytics link appears.
- Click Configure Analytics.
- Paste the Client ID and Client Secret that you have copied in Register the Analytics module » Step 18.
NOTE: For specific Client ID and Client Secret, Sitefinity CMS stores only the latest generated refresh token. The reason is Google OAuth 2.0 limitation of 50 refresh tokens per user account. For more information, see Google official documentation about OAuth 2.0 expiration.
- Click Login to Google.
- Allow the created project to view and manage your Google Analytics data.
- In Available accounts, select the view that you have created to track this website.
NOTE: If you have not set the tracking code, provided by Google Analytics on any page of your website or the page where you have set it has not been requested, Sitefinity CMS cannot find account and your domain in the list of Tracked domains.
- In Tracked domains, select the domain of your website.
If you do not see the domain in the list, you can enter it manually.
- Click Save Settings.
The Google Analytics tracking code appears.
- Click Save Settings.
RESULT: You can see website analytics data in the Analytics module.
Before you setup the Analytics module, you must register it in Google Analytics. You must register when you are setting up Analytics for the first time.
Before registering, you need to log in your account:
- Log in to your Google Analytics account.
- Go to https://code.google.com/apis/console/.
- Create a new project by clicking Create Project.
NOTE: You can also open the All projects tab page to select an existing project.
- Type in a project name that you will use in the console.
The project ID is automatically created, based on the project name. Optionally, click Edit to enter another project ID.
NOTE: You cannot change the project ID once you create the project.
- Click the Create button.
Wait for the project to be created. You are automatically redirected to the Google API Manager.
- In API Manager, open the Library tab page.
Under Other popular APIs, click Analytics API.
- By default, the API is disabled.
Enable the API by clicking the Enable button.
- To start using the API, click Go to Credentials button.
- In the Add credentials to your project page, click Cancel to skip this step and continue to the New credentials step.
NOTE: You can optionally complete the form and get recommendations what credentials you need.
- Open the OAuth consent screen tab page.
- In the PRODUCT NAME textbox, enter a name for the Sitefinity CMS Analytics project.
Optionally, fill in all other fields. Click Save.
- In the Credentials tab page, from the Create credentials dropdown menu, select OAuth client ID.
- Under Application Type, select Web application.
You must now register the origins from which your app is allowed to access the APIs. An origin is a unique combination of protocol, hostname, and port.
- Under AUTHORIZED JAVASCRIPT ORIGINS, enter http://<your website>
- Under AUTHORIZED REDIRECT URIS, enter
http://<your website>/Sitefinity/marketing/Analytics
- Click Create.
- From the resulting OAuth client dialog box, Copy the generated Client ID and the Client secret. Click OK.
You have now registered the Analytics module. You can continue to Set up Analytics in Sitefinity CMS backend.