This page received its last significant update on 4/14/2020
# Google Analytics
The Google Analytics extractor pulls raw data from the Google Analytics Reporting API.
# Google Analytics Setup
In order to access your Google Analytics data, you will need:
- View ID
- Client Secrets or OAuth Credentials
- Start Date
# View ID
To get your View ID:
- Visit Google Analytics: https://analytics.google.com/
- Log in if you haven't already.
- Open the account/property/view selector in the top left corner
- Select the account, property, and view that you would like to connect with Meltano
- You will see the View ID displayed inside the selector below the name of the view (e.g. "All Web Site Data"): 188274549
- Follow the steps below if you don't already have a valid
- The process below can take over 10 minutes, but it's a one-time setup that's well worth it
This extractor supports service account based authorization, where an administrator manually creates a service account with the appropriate permissions to view the account, property, and view you wish to fetch data from.
To access your Google Analytics data, the "Analytics Reporting API" and "Analytics API" both need to be enabled. These need to be enabled for a project inside the same organization as your Google Analytics account.
# Step 1: Creating Service Account Credentials
As a first step, you need to create a new project in Google Cloud Platform or use an existing one:
Sign in to the Google Account you are using for managing Google Analytics (you must have Manage Users permission at the account, property, or view level).
Open the Service accounts page. If prompted, select a project or create a new one to use for accessing Google Analytics.
Click "Create service account"
In the Create service account window, type a name for the service account, and click
We do not need to provide any additional permissions for this account, so click
Service account permissionsconfiguration page.
We also do not need to grant access to any users for this service account, as we only need the key.
Create Key, select
JSONas the key type and create a new private key. Then click
Saveand store it locally as
Meltano will use the private key in this
client_secrets.json file to connect with the Google Analytics API. You will upload it in the Meltano interface after completing the next two steps.
# Step 2: Linking Credentials to Google Analytics
The newly created service account will have an email address that looks similar to:
To grant this service account access to your Google Analytics data, add the email address as a new user to your Google Analytics account, property or view through the "Admin > User Management" page.
Only the Read & Analyze permissions are needed as Meltano only extracts data to generate reports.
# Step 3: Enabling the APIs
Visit the Google Analytics Reporting API dashboard and make sure that the project you used in the previous step is selected.
Now enable the API using the button at the top, so that the button will say "Disable API" instead:
Next, visit the Google Analytics API dashboard, make sure that the project you used in the previous step is selected, and enable this API as well.
# Next Steps
Now it's time to tell Meltano about the newly created service account so that it can use it to connect to the Google Analytics API:
- Click the "Upload" button to the right of "Client Secret" in the Meltano interface
- Select and upload the
client_secrets.jsonfile you generated and downloaded in step 1
# Start Date
This property determines how much historical data will be extracted.
Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
# Meltano Setup
Open your Meltano instance and click "Pipelines" in the top navigation bar. You should now see the Extractors page, which contains various options for connecting your data source.
tap-google-analytics by clicking on the
Connect button inside its card.
For the Client Secrets, you will need to upload your
client_secrets.json using the file uploader.
For the View ID, enter the ID you retrieved using Google Analytics Account Explorer
For the Start Date, choose the date when you want to start extracting data for.
Save to finish configuring the extractor and progress to the next step: "Configure the Loader".
# Advanced: Command Line Installation
- Navigate to your Meltano project in the terminal
- Run the following command:
meltano add extractor tap-google-analytics
If you are successful, you should see
Added and installed extractors 'tap-google-analytics' in your terminal.
- Open your project's
.envfile in a text editor
- Add the following variables to your file:
export GOOGLE_ANALYTICS_API_VIEW_ID="YOUR VIEW ID" export GOOGLE_ANALYTICS_API_START_DATE="2019-02-01T00:00:00Z"
export GOOGLE_ANALYTICS_API_REPORTS="cli_reports.json" export GOOGLE_ANALYTICS_API_END_DATE="2019-06-01T00:00:00Z"
If you are authenticating using
If you are authenticating using OAuth credentials:
export GOOGLE_ANALYTICS_API_OAUTH_ACCESS_TOKEN="YOUR ACCESS TOKEN" export GOOGLE_ANALYTICS_API_OAUTH_REFRESH_TOKEN="YOUR REFRESH TOKEN" export GOOGLE_ANALYTICS_API_OAUTH_CLIENT_ID="YOUR CLIENT ID" export GOOGLE_ANALYTICS_API_OAUTH_CLIENT_SECRET="YOUR CLIENT SECRET"
Check the README for details.