How to use Google Analytics Real-Time Reporting API

Table of content for how to use Google Analytics Real Time Reporting API

  1. Introduction to Google Analytics Real Time Reporting API
  2. Prerequisites to use GA Real Time Reporting API
  3. Steps to create a project in Google API console
  4. Steps to provide access to service account in Google Analytics
  5. Steps to run the a query in the Real Time Reporting API
  6. Examples and results of querying Real Time Reporting API
  7. Error responses and their explanation in the API

In this article, I will discuss how to use the Google Analytics reporting API and its  limitations.

Introduction to Google Analytics Real Time Reporting API

The Google Analytics Real Time Reporting API enables you to view the active users on your website. It also lets you display the top 10 active pages, and the events performed by the active users on your website.

To access data using the real time data, you should create a query that will contain a view ID and at least one metric. You can also use additional data like dimensions and filters to refine your query. The results are returned in the form of a table.

 
Get the E-Book (50 Pages)
 
Get the FREE E-Book (50+ Pages)

Prerequisites to use GA Real Time Reporting API

First things first, to use GA Real Time Reporting API you need to make sure that the following prerequisites are met:

  • Enable the Google Analytics API
  • Ensure you have the credentials to access the API
  • Update the credentials in your application

Steps to create project in Google API console

Step-1: To get started, first you need to register your application in the Google API console.

Step-2: You need to log in with your Gmail credentials, or create a new Google account.

Step-3: Next step is to create a project in your developer’s console. Click on the ‘My first project’ drop-down, as shown below:

Step-4: Click on ‘New project’.

Step-5:  Give your project a name, select the organization, and then click on ‘Create’.

Step-6: Click on ‘Service accounts’ from the left-hand menu.

Step-7: Now you have to create a service account. Click on ‘Create service account’ in the console.

Step-8: Enter the service account name of your choice and click on ‘Create’. The next two steps are optional so we can skip them and click on ‘Done’.

Step-9: The service account is now generated. To create a key, click on ‘Actions’ and select ‘Manage keys’, as shown below:

Step-10: Click on ‘Add key’ and select ‘Create new key’ from the drop-down.

Step-11: Select the ‘Key type’ as ‘JSON’ and click on ‘Create’.

Step-12: A private key is now created and saved to your local machine/computer. This JSON file has an API key and can be used if you are using any third-party tool for querying real time data.

Steps to provide access to service account in Google Analytics

Step-1: Log in to your Google Analytics account.

Step-2: Click on ‘Admin’ in the left-hand menu.

Step-3: Under ‘View’, click on ‘View user management’.

Step-4: Add the service account created in the developers console with read and analyse access.

Steps to run a query in Google Analytics Real Time Reporting API

Step-1: Log in to developers console Real Time Reporting API using your Google credentials.

Step-2: In the API console, enter the view ID and metrics to query the real time users on the view.

Note: The view should be entered in ga:view ID format. Ex: ga:123456 and to query real time users rt:activeUsers.

Step-3: Now, click on ‘Execute’ to run the query.

Step-4: Once the query is executed, you will see the response code 200 if there are no errors and at the end of the code you would see the real time active users as shown below:

Examples and results of querying Real Time Reporting API

Example 1: Pageviews

To query pageviews in the Real Time Reporting API, use rt:Pageviews.

Response:

Example 2: Medium

To view the medium in the Real Time Reporting API

Response:

Note that out of four pageviews, one is from medium ‘none’ and the remaining three results are from ‘Organic’.

Example 3: Validate active goals

To validate the active goals using the Real Time Reporting API.

Results:

You can refer to this Google Real Time Reporting API documentation for the dimensions and metrics reference.

Error responses and their explanations in the API

200 status code: This means the Real Time Reporting API request was successful and returns the results for the query executed.

400 status code invalid parameter: Indicates an invalid parameter and the request queries has invalid value like location type and location field. Fix the values and query the API again.

400 status code bad request: Indicates that the query was invalid and it could be due to the combination of metrics and dimensions not being valid.

401 invalid credentials: Indicates that the auth token values are incorrect.

 403 insufficient permissions: Indicates that the user does not have sufficient permissions for the view ID used in the API.

For more error codes, refer to this error responses guide which explains the reasons and recommended actions to be taken to run the query successfully.

Register for the FREE TRAINING...

"How to use Digital Analytics to generate floods of new Sales and Customers without spending years figuring everything out on your own."



Here’s what we’re going to cover in this training…

#1 Why digital analytics is the key to online business success.

​#2 The number 1 reason why most marketers are not able to scale their advertising and maximize sales.

#3 Why Google and Facebook ads don’t work for most businesses & how to make them work.

#4 ​Why you won’t get any competitive advantage in the marketplace just by knowing Google Analytics.

#5 The number 1 reason why conversion optimization is not working for your business.

#6 How to advertise on any marketing platform for FREE with an unlimited budget.

​#7 How to learn and master digital analytics and conversion optimization in record time.



   

My best selling books on Digital Analytics and Conversion Optimization

Maths and Stats for Web Analytics and Conversion Optimization
This expert guide will teach you how to leverage the knowledge of maths and statistics in order to accurately interpret data and take actions, which can quickly improve the bottom-line of your online business.

Master the Essentials of Email Marketing Analytics
This book focuses solely on the ‘analytics’ that power your email marketing optimization program and will help you dramatically reduce your cost per acquisition and increase marketing ROI by tracking the performance of the various KPIs and metrics used for email marketing.

Attribution Modelling in Google Analytics and Beyond
Attribution modelling is the process of determining the most effective marketing channels for investment. This book has been written to help you implement attribution modelling. It will teach you how to leverage the knowledge of attribution modelling in order to allocate marketing budget and understand buying behaviour.

Attribution Modelling in Google Ads and Facebook
This book has been written to help you implement attribution modelling in Google Ads (Google AdWords) and Facebook. It will teach you, how to leverage the knowledge of attribution modelling in order to understand the customer purchasing journey and determine the most effective marketing channels for investment.

About the Author

Himanshu Sharma

  • Founder, OptimizeSmart.com
  • Over 15 years of experience in digital analytics and marketing
  • Author of four best-selling books on digital analytics and conversion optimization
  • Nominated for Digital Analytics Association Awards for Excellence
  • Runs one of the most popular blogs in the world on digital analytics
  • Consultant to countless small and big businesses over the decade
error: Alert: Content is protected !!