Access Keys:
Skip to content (Access Key - 0)


The Google Analytics step allows you to access your Google analytics data to generate reports or to populate your data warehouse. It uses the Google Analytics 2.4 API.


  1. You must have a Google Analytics account.
  2. The Google Analytics API requires an API key. Here is how to get it:
    1. Navigate to and click on API Console under Developer Tools.
    2. Sign in with your credentials.
    3. From the Projects page, create a new project.  Once created, click 'Enable an API'.  Locate the 'Analytics API', and click the 'OFF' button to change the value to 'ON'. turn on Analytics API.
    4. Click on the 'Credentials' link in the left-hand menu, and create a new Server Key for 'Public API access'.  Enter in your IP address or network, or enter '' to allow global access (not recommended for production systems).  Once created, an API Key will be displayed.  This is the key that is to be entered in the field within the Google Analytics step.

Google Analytics Connection Settings

Option Description
Application Name
Chose an application name like "kettle" or leave the proposed
Email Your Google Analytics account user name
Password Your Google Analytics account password
Simple API Key
See the prerequisites section above to acquire the API key
Specify tableId directly
Check this option, when you want to specify the tableId directly without getting the tableId from the profile
Get tableId from profile
Select the tableId from your profile

Query Definition

Option Description
Start Date Specifies the start date associated with the query - date must be entered in the following format: YYYY-MM-DD
End Date Specifies the end date associated with the query - date must be entered in the following format: YYYY-MM-DD
Dimensions Specifies the dimension fields for which you want to query - the Google Analytics API documentation provides you with a list of valid inputs and metrics that can be combined
Metrics Specifies the metrics fields you want returned
Filters Specifies the filter (described in the Google Analytics API documentation) for example, 'ga:country==Algeria'
Sort Specifies a field on which to sort, for example, 'ga:city'
Use custom segment
Check this option, when you want to specify a custom segment
Use predefined segment
Select from the predefined segments


Click Get Fields to retrieve a list of possible fields based on the query you defined.
Click Preview to preview data based on the defined query.


This documentation is maintained by the Pentaho community, and members are encouraged to create new pages in the appropriate spaces, or edit existing pages that need to be corrected or updated.

Please do not leave comments on Wiki pages asking for help. They will be deleted. Use the forums instead.

Adaptavist Theme Builder (4.2.0) Powered by Atlassian Confluence 3.3.3, the Enterprise Wiki