The Google Analytics Importer plugin imports Google Analytics reports into a Matomo instance.

When you run an import, your Google Analytics (GA) Property will be automatically created as a Website into Matomo (as well as your Goals and Custom dimensions) and all historical reports in GA will be imported so you can view all your web analytics data in Matomo.

If you find a bug or have any feedback, please report it on Github here.

Requirements

  • At least Matomo 3.12.0 is required to use the Google Analytics importer.
  • PHP configuration needs to allow the use of the functions shell_exec() or exec()
  • Your server must allow the execution of the CLI PHP from within a web request and must have nohup available.
  • Your Matomo instance should have cron archiving setup.

Setup

Before we can start exporting Google Analytics data from their API and importing it into your Matomo, there are two setup steps to go through: 1) Creating Google OAuth Client Config and 2) Authorizing Matomo to export your Google Analytics data. These two steps need to be done only once.

1) Creating Google OAuth Client Config

Follow these steps to get your OAuth Client Config:

  1. Sign in to the Google API Console

  2. Click Select a project in the menu.

  3. To create a new project click the “Plus” button in the overaly:

  4. Give your new Project a useful name (for example Matomo Import).
    New Google Project For Import

  5. After your project has been created, select it manually in the project list and click “open”.
    Select Google Project

  6. Click on Library in the menu on the left, then search for Google Analytics.
    Google Analytics Libraries

  7. Click on the Google Analytics Reporting API row and enable the API.
    Google Analytics Reporting API

  8. Then go back and do the same for the Google Analytics API.

  9. Now you will create the OAuth Client Credentials. Click on the Google logo at the top, to get back to the dashboard, afterwards click on Credentials in the left menu. Then click Create credentials and choose the OAuth client ID option:
    Google API Create Client

  10. You will now be advised to create a product name for the OAuth consent screen. Click on the link Create consent screen and enter a product name (for example Matomo Import). Under “Authorized domains” you need to add the top level domain of your Matomo instance (for example matomo.cloud for a cloud hosted Matomo). You can leave the other fields blank. Click Save.
    Importer OAuth Consent Config

  11. Now you will create the credentials. You should be able to click under Application type a radio button called
    Web application. (If you cannot see this, click again on Create Credentials and choose the OAuth client ID option). Now you need to fill in the following fields:

    • Name: we recommend to set it to your Matomo URL for example: https://matomo.my-website.example
    • Authorized JavaScript origins: set it to your Matomo URL domain for example: https://matomo.my-website.example
      Note: This needs to be a domain. If you have installed Matomo into a subdirectory, you need to enter the domain without the path. (so
      https://my-website.example in case of https://my-website.example/matomo/)
    • Authorized redirect URIs: needs to be set to your Matomo URL with this special URL/query
      /index.php?module=GoogleAnalyticsImporter&action=processAuthCode added at the end. For example:
      https://matomo.my-website.com/index.php?module=GoogleAnalyticsImporter&action=processAuthCode
      Note: the URLs above are HTTPS: we highly recommend you run your Matomo instance over SSL.
      If your Matomo doesn’t support https yet, you can replace the URL and use http.
      If you are using Matomo for WordPress: the URL must begin with the entire path to Matomo’s admin page, eg, http://mysite.com/wp-content/plugins/matomo/app/index.php.
      Create OAuth Client ID
  12. You can now download your OAuth client credentials by clicking the download icon on the credentials overview page.
    Google API Download Client Config

2) Authorizing Matomo

Once you have downloaded your OAuth client credentials, you can authorize your Matomo to have access to your Google Analytics data:

  1. Login as a Super User in Matomo and go to Administration.

  2. Click on Google Analytics Import on the left menu.

  3. Upload the OAuth client credentials you downloaded in How to set up Google OAuth Client config by clicking Configuration File, selecting the file, and clicking Save.
    Upload Client Config for Importer

  4. Now, click Authorize and follow the prompts to give Matomo access to your Google Analytics data.
    Authorize the Importer

Running the Google Analytics import

Once you’ve authorized Matomo, you can begin importing data. This is primarily done through the admin page, though you can use the command line as well. Depending on how much data you are importing it can take a long time to finish (more than one day in most cases).

Note: Google imposes a daily limit on the number of API requests you can make each day (at most 50,000). The import will hit this limit after importing about 4 months of data where every day has data. This takes just a couple of hours. This means the import has to be run over several days until the entire data set is imported.

Using the admin page

To use the admin UI:

  1. Go to the Google Analytics Import admin page.
  2. Fill out the Schedule an Import form and click Start:

    Schedule An Import Form

  3. As the import continues, you will be able to monitor progress through the Import Jobs table below:

    Import Jobs List

    Refresh the page to get an updated status at any time.

  4. Once the import is marked as finished, feel free to delete the status. If an import fails, you can view the logs located in /path/to/your/matomo/tmp/logs/. There should be one for each job.

Using the Command Line

You can also run the import on the command line if you’d like to see more information about it’s progress as it’s going:

  1. First you’ll need some information. In your Google Analytics dashboard, open the property selector.
  2. Take note of the Property ID and the View ID for the property/view you want to import.
  3. ssh into your Matomo instance
  4. Run the following commands to import your site:
    $ cd /path/to/my/matomo
    $ php ./console googleanalyticsimporter:import-reports --property=<property-id> --view=<view-id> --dates=<dates>

    For property-id and view-id substitute the GA property ID and view ID you noted above. For dates specify the date range of date you’d like to import, for example, 2015-01-01,2019-04-31.

Then just wait until the import finishes, which could take some time.

If you would like to resume an existing import, supply the --idsite=<idSite> parameter with the site that was created for this import (this will be in the import status table in the admin page).

Once the import finishes, you can remove the authorization you granted earlier. Matomo only needs access to Google Analytics while importing data, afterwards there’s no point in keeping it there.

Importer Options

Importing a Mobile App Property

If your GA property is for a mobile app, then you will need to check the Mobile App checkbox before starting your import:

Import Mobile App

This will ensure that Matomo imports the correct data. The Screen Views metric in Google Analytics will be imported and used as the Pageviews metric in matomo. The Screens reports will be imported into the Page Titles reports in Matomo.

If you don’t check this box and your property is for a mobile app, the importer will ignore this data.

Importing Unsupported GA Dimensions

Some GA dimensions do not exist in Matomo, such as the demographics dimensions. You may want to hold onto this information when importing, and it is possible to do so by importing the data into a custom dimension.

In the import form, fill out the “Extra Custom Dimension Mappings” field with the GA dimensions you’d like to import:

Extra Custom Dimension Mappings

Use this list to find the proper IDs for GA dimensions.

When importing, one custom dimension slot will be used up in the imported site for each extra mapping. (Note: there will be an error if there are not enough custom dimension slots in your Matomo.)

Troubleshooting

My import never continues

When you start an import the plugin will start importing in the background. Eventually, if you’re importing a large enough amount of data, it will be rate limited and will be forced to continue the next day. The continuation is done through a scheduled task.

In order for the scheduled task to run you first need to have cron archiving setup. This is where scheduled tasks are initiated.

Once you have cron archiving setup, use the TasksTimetable plugin to determine when the scheduled tasks will next run (the relevant tasks will have Piwik\Plugins\GoogleAnalyticsImporter\Tasks in the name).

If these tasks never run, even if they are listed, then something is failing in the cron archiving command. The next step to debug is to check the output of the command.

My import runs for X minutes and then just stops

If you are using shared hosting it is possible that your hoster is simply terminating the process after a set amount of time. This isn’t something either Matomo or you can fix. You will either have to talk to your hoster or find another way to host Matomo.

If neither of those options work for you, you can try the following workarounds:

  • Try importing data through the CLI command instead of through the UI. When you do this, make sure the PHP executable you are using is the CLI php version instead of another (for example, php7-cli vs php7-fcgi). You can see which version it’s using by running php --version. Look for output like PHP 7.2.1 (cli). It’s possible your hoster will allow CLI PHP executions to run for longer.

  • If the process is reliably terminated after a certain amount of time, you can setup a cron job to restart the import. For example, if your import is terminated after 15 minutes, you can setup a cron to run every 20 minutes that will resume the import. To do this, start the import in the UI and make note of the ID of the newly created site. Then add a cron using the googleanalyticsimporter:import-reports command with the --idsite= option (eg: php /path/to/matomo/console googleanalyticsimporter:import-reports --idsite=<your Site ID>).

My import fails every time on the same day

If your import fails regularly for a specific day, you may have found a bug in the import process. In this case you should file a bug report at the github repository. To help us find the cause more quickly, please do the following things when filing your report:

  • Start a new import for the specific day that fails and check the “Enable Verbose Logging” checkbox at the bottom of the form:
    Enable Verbose Logging
  • When the import experiences the error again, find the log file on your server for the import (it will be named something like /path/to/your/matomo/tmp/logs/gaimportlog.$idSite.$matomoHost.log). Email it to us at support@matomo.org (it’s probably a good idea not to post the contents with your bug report as it may contain information about your server).
  • Cancel the import.

This will help us debug the issue you are experiencing, though we may still not be able to find a cause. In this case, if you are able to provide read only access to your Google Analytics account, we will be able to further debug the problem.

Limitations

Not all data in Google Analytics is accessible through the API, please find below the list of data reports that will not show up in Matomo:

  • The importer only imports aggregated report data, not the raw visit and action data. This means the Visitor Log,
    Ecommerce Log and Segmentation features will not work for imported reports.
  • Some reports in Matomo are not supported in Google Analytics, such as the “Search Keywords with No Results” and Contents reports. These reports will not show data after import.
  • Some reports from Google Analytics are not yet imported into Matomo (such as Funnels reports). If you find any missing report in Matomo you expected to see imported, please let us know the details in this issue tracker.
  • Google strips the search parameter from internal site search URLs, but shows those URLs in the page URLs reports. This means when we import that report, we can’t tell if one of those pages was actually an internal site search, so in imported reports site search page URLs will be included in the Page URLs and Page Titles reports.
  • Google’s ecommerce conversion rate is different from Matomo’s. Google defines this as the number of transactions per session, where Matomo defines it as the percent of visits that have at least one order. So this metric cannot be imported.
  • Exit and entrance rates in Google are different than in Matomo. Matomo defines the entrance/exit rate as the percent of times a page URL/page title was the first/last pageview in a visit. In Google Analytics, the rates are defined as the percent of all hits for which a page URL/title is the first/last pageview in a session. So the rates will look different in Matomo.
  • Additionally, Google Analytics doesn’t always set the session count when logging pageviews (see their docs for more info). This means some sessions won’t be counted by Google Analytics, and the session count could be lower than it should be for some actions. In this case, the exit/entrance rate will be calculated as > 100%. This doesn’t affect Google Analytics, because the entrance/exit rate there is calculated using the total number of hits and not the number of sessions.
  • Product reports are missing the product conversion rate and visits metric, since sessions cannot be queried with product dimensions through the Google Analytics API.
  • The importer assumes you have setup GeoIp2. If you don’t, the data will be imported properly, but the reports will display many Unknown regions, until you install GeoIp2.