google-analytics-api

Topics related to google-analytics-api:

Getting started with google-analytics-api

The Google Analytics APIs allow you to access data within Google Analytics. It should not be confused with the measurement protocol which is used for inserting data into Google Analytics.

The Google Analytics API is split into serval parts.

Google Analytics Reporting APIs

  1. The Google Analytics Core Reporting API v3 gives you access to most of the report data in Google Analytics. With the Core Reporting API you can:

    • Build custom dashboards to display Google Analytics data.
    • Save time by automating complex reporting tasks.
    • Integrate your Google Analytics data with other business applications.
  2. The Google Analytics Reporting API V4 is the most advanced programmatic method to access report data in Google Analytics. With the Google Analytics Reporting API, you can:

    • Build custom dashboards to display Google Analytics data.
    • Automate complex reporting tasks to save time.
    • Integrate your Google Analytics data with other business applications.
  1. The Real Time Reporting API enables you to request real time data—for example, real time activity on a view—for an authenticated user. You can use the Real Time Reporting API to:

    • Display active viewers of a page and create a sense of urgency for users looking at an item with finite inventory.
    • Display the most popular content such as the top 10 active pages.
    • Create and display a real time dashboard.

The Real Time Reporting API, in limited beta, is available for developer preview only. Sign up to access the API.

  1. The Multi-Channel Funnels Reporting API enables you to request Multi-Channel Funnels data for an authenticated user. Data is derived from conversion path data, which shows user interactions with various traffic sources over multiple sessions prior to converting. This allows you to analyze how multiple marketing channels influence conversions over time. For more details on what data is available, read the About Multi-Channel Funnels, as well as About Multi-Channel Funnels Data. With the Multi-Channel Funnels Reporting API you can:

    • Create custom reports using Multi-Channel Funnels data. For example, you could use the Top Conversion Paths data to report on attributes such as relative position of interactions in a conversion path.
    • Integrate Multi-Channel Funnels data with your business data. For example, you could correlate online conversion data with offline sales data and media cost data to arrive at a more complete picture of marketing ROI.
    • Display Multi-Channel Funnels in new environments. For instance, you could create visualizations and other presentations of the data that communicate the value of different marketing channels in driving conversions.

Helpers

  1. The Metadata API returns the list and attributes of columns (i.e. dimensions and metrics) exposed in the Google Analytics reporting APIs. Attributes returned include UI name, description, segments support, and more. You can use the Metadata API to:

    • Automatically discover new columns.
    • Access all dimensions and metrics attributes for Google Analytics reporting APIs.

Note: This only returns metadata for the Core Reporting API and the Reporting API. Not real-time metadata.

  1. The Google Analytics Embed API is a JavaScript library that allows you to easily create and embed a dashboard on a 3rd party website in a matter of minutes. It gives you a set of pluggable components that can work together to build complex tools, making it both simple and powerful at the same time.

Configuration APIs

  1. The Analytics Management API allows for programmatic access to the Google Analytics configuration data. You can build applications to more efficiently manage large or complex Analytics accounts. Large companies with many properties can automate account setup. Even if you are building a reporting application the Management API provides you tools to navigate your account. You can use the Google Analytics Management API to:

    • List all the Account, Property and View information for a user.
    • Manage Properties, Views, and Goals.
    • Manage user permissions for an account hierarchy.
    • Retrieve a View ID to use with the Core Reporting API.
    • Determine which goals are active and access their configured names.
    • Manage Links between Analytics properties and AdWords accounts.
    • Manage Remarketing Audiences.

Write operations in the Management API (e.g. create, update, delete, patch) for Web Property, View (Profile), and Goal resources is currently available as a developer preview in limited beta. If you're interested in using these features, request access to the beta.

  1. The Provisioning API can be used to create new Google Analytics accounts and enable Google Analytics for your customers at scale. It is intended for qualified service providers and large partners. For example, you could use the Provisioning API as part of a new user onboarding process to create a new Google Analytics account for a client and then use additional Management API resources to programmatically configure the account and link it to AdWords. This can all be automated and initiated from within your own admin or reporting interface.

The Provisioning API is available by invitation only. We are not currently accepting new projects.

Reporting API (Analytics v4)

The Google Analytics Reporting API V4 is the most advanced programmatic method to access report data in Google Analytics. With the Google Analytics Reporting API, you can:

  • Build custom dashboards to display Google Analytics data.
  • Automate complex reporting tasks to save time.
  • Integrate your Google Analytics data with other business applications.

Features

Google Analytics is built upon a powerful data reporting infrastructure. The Google Analytics Reporting API V4 gives you access to the power of the Google Analytics platform. The API provides these key features:

  • Metric expressions: The API allows you to request not only built-in metrics but also combination of metrics expressed in mathematical operations. For example, you can use the expression ga:goal1completions/ga:sessions to request the goal completions per number of sessions.
  • Multiple date ranges: The API allows you in a single request to get data in two date ranges.
  • Cohorts and Lifetime value: The API has a rich vocabulary to request Cohort and Lifetime value reports.
  • Multiple segments: The API enables you to get multiple segments in a single request.

Authentication

In order to access any Google API you need to identify yourself as a developer and identify your project. We do that by creating a new project on Google Developers console.

When you create your project you if you want to access the Google Analytics APIs you must enable the APIs you intend to access.

  • Reporting API: Access to the Google Analytics Reporting API v4.
  • Analytics API: Access to everything else.

Now you must decide how you would like to access the data.

With Google Data there are two types of Data Public and Private.

  • public data is not owned by a user. The metadata API is a public API you don't need to be logged in to access that data.
  • The Reporting API contains a users Google Analytics data it is private you cant look at it unless the user has given you permission to access it.

If you are only accessing public data then all you need do is create a public API key and you will be able to access the API in question. If you are going to be accessing private user data then you will need to create either Oauth2 credentials or service account credentials.

Authorization Oauth2

To access private user data we must have permission of the owner of the data to access it. Oauth2 allows us to request that access from a user.

You have probably seen before Oauth2 before.

enter image description here

The Application "Google Analytics Windows" is requesting access to view the users "Google Analytics Data"

  1. Google Analytics windows is the name of the project that was created on Google Developer console.
  2. Google Analytics Data is the scope of permissions that we asked for.

Scope We need to tell the user what we intend to do the Google analytics API has two scopes that you can use.

  1. https://www.googleapis.com/auth/analytics.readonly
  2. https://www.googleapis.com/auth/analytics

It is best to only request the scopes that you need. If you will only be reading a users data then you only need to request the readonly scope.

Authorization service accounts

Service accounts are different in that they are pre-approved. If you create service account credentials you as the developer can take the service account email and add it as a user on your Google Analytics account At the account level this will grant the service account access to the data. You wont need to pop up the authentication window and request access. The service account will have access to the data for as long as it is a user on the Google Analytics account.

Conclusion

Authentication is needed to access most of the data exposed by the Google Analytics API.

You can not use client login / login and password to access any Google API as of May 2015. You must use Open authentication.

**

Metadata api

The Metadata API returns the list and attributes of columns (i.e. dimensions and metrics) exposed in the Google Analytics reporting APIs (v2,v3 and v4). Attributes returned include UI name, description, segments support, and more.

You can use the Metadata API to:

  • Automatically discover new columns
  • Access all dimensions and metrics attributes for Google Analytics reporting APIs

This is the same list as is in the Dimensions & Metrics Explorer.

Note: Real-time and Multi-Channel Funnels dimensions and metrics are not currently available.

Real-time API

The Real Time Reporting API, in limited beta, is available for developer preview only. Sign up to access the API.

The Real Time Reporting API enables you to request real time data—for example, real time activity on your property—for an authenticated user.

You can use the Real Time Reporting API to:

  • Display active viewers of a page and create a sense of urgency for users looking at an item with finite inventory.
  • Display the most popular content such as the top 10 active pages.
  • Create and display a real time dashboard.

Authorization

Calls to the Google Analytics Real-time API requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scopeaccess granted
https://www.googleapis.com/auth/analyticsFull access to Google Analytics accounts up to the level of the authenticated users access.
https://www.googleapis.com/auth/analytics.readonlyRead only access to the Authenticated users Google Analytics accounts

Error Responses

If an request is successful, the API returns a 200 HTTP status code along with the requested data in the body of the response.

If an error occurs with a request, the API returns an HTTP status code and reason in the response based on the type of error. Additionally, the body of the response contains a detailed description of what caused the error.