Take our developer survey. We want your feedback so we can learn how to improve Google Analytics, and make it an even better tool for you.

Google Analytics - All Reporting API Changelogs

This page documents any changes made to Google Analytics Reporting APIs. It includes changelogs for the Core Reporting API and Multi-Channel Funnels Reporting API. We recommend that API developers periodically check this list for any new announcements. You can also subscribe to changes via the feeds listed under the Subscribe section below.

Subscribe To Related Changelogs

Includes all Collection, Configuration, and Reporting APIs.

Includes Core Reporting API, Multi-Channel Funnels Reporting API, and Real Time Reporting API.

This is the initial release of the User Activity API

  • The User Activity API allows you to retrieve all of the data associated with a single Client ID or User ID over a given date range. It is primarily intended to support property owners who want to provide automated access of a user’s data directly to that user. Visit the User Activity API Guide for more details.

With this release, the Resource Based Quota system for the Google Analytics Reporting API v4 is available to all Analytics 360 (Premium) customers.

This release introduces changes to the Analytics Real Time API quotas and limits.

Analytics Real Time Reporting API calls used to contribute to the 10,000 calls per view (profile) per day limit on par with other Analytics API calls. Now, Analytics Real Time Reporting API calls are accounted separately, which means it is possible to make 10,000 calls per day per view (profile) using the Analytics Real Time Reporting API AND make another 10,000 calls per day per view (profile) using any other Analytics APIs. See the Limits and Quotas page for more info.

This change provides more granular and fail-safe approach to managing quotas, so that frequent calls using the Analytics Real Time Reporting API would not accidentally block all other Analytics API calls for the rest of the day for an individual profile.

This release increases the maximum number rows returned in the Analytics Reporting API v4 resultset.

The maximum number of rows returned in the Analytics Reporting API v4 ReportData object is increased from 10,000 to 100,000.

This release adds a preview of the Resource Based Quota system for the Google Analytics Reporting API v4, which allows using higher sampling thresholds for Analytics 360 (Premium) customers.

This release deprecates the Related Products feature and the associated dimensions and metrics; review the Dimensions and Metrics Reference for the complete list of definitions. Review the Data Deprecation Policy for details on data removal:

This release deprecates the following dimensions and metrics:

  • ga:correlationModelId
  • ga:queryProductId
  • ga:queryProductName
  • ga:queryProductVariation
  • ga:relatedProductId
  • ga:relatedProductName
  • ga:relatedProductVariation
  • ga:correlationScore
  • ga:queryProductQuantity
  • ga:relatedProductQuantity

This release adds a new dimension to the API; review the Dimensions and Metrics Reference for the complete list of definitions. This release also removes several deprecated dimensions and metrics; review the Data Deprecation Policy for Google Analytics APIs to understand the full process of data removal.

Time

  • New dimension ga:dateHourMinute, which combines ga:date, ga:hour, and ga:minute.

Data removal

This release removes the following deprecated dimensions and metrics:

  • ga:socialactivities
  • ga:socialactivityaction
  • ga:socialactivitydisplayname
  • ga:socialactivityendorsingurl
  • ga:socialactivitynetworkaction
  • ga:socialactivitypost
  • ga:socialactivitytagssummary
  • ga:socialactivitytimestamp
  • ga:socialactivityuserhandle
  • ga:socialactivityuserphotourl
  • ga:socialactivityuserprofileurl
  • ga:socialinteractionspervisit

This release updates existing metrics and dimensions in the API. Review the Dimensions and Metrics Reference for the complete list of definitions.

User metrics

The calculation for Users and Active Users metrics has been updated to more efficiently count users. You may see a small change in your metrics. For more information please see How users are identified for users metrics.

User metrics affected by calculation update:

  • ga:users - The total number of users for the requested time period.
  • ga:1dayusers - Total number of 1-day active users for each day in the requested time period.
  • ga:7dayusers - Total number of 7-day active users for each day in the requested time period.
  • ga:14dayusers - Total number of 14-day active users for each day in the requested time period.
  • ga:30dayusers - Total number of 30-day active users for each day in the requested time period.

Unique Events

We are nearing the end of the deprecation time period for ga:uniqueEvents. After March 26, 2017 the definition for ga:uniqueEvents will be updated and the private ga:uniqueEventsTemporary metric will be removed from the API. For more information, see Unique Events help documents.

This release adds a new dimension to the API, improves error messages, and starts enforcing the previously announced changes for AdSense dimensions and metrics.

User Dimensions

  • Dimension - ga:userBucket - For any given user, the User Bucket dimension (values 1 to 100) indicates the bucket to which the user has been assigned. See the Test remarketing campaigns article for details.

Error messages

Where previously the API would return an erroneous error message, Unknown dimension(s): or Unknown metric(s): when requesting data with conditions that have not been met, the API now returns the message: Restricted metric(s): ... can only be queried under certain conditions.

AdSense dimensions and metrics

Non-AdSense linked views will be restricted from querying for AdSense dimensions and metrics. Querying for these dimensions and metrics with a non-AdSense linked views will result in an error.

This is a bug fix release, which fixes an issue with AdSense dimensions and metrics, and announces a forthcoming change to these dimensions and metrics.

AdSense dimensions and metrics

This release fixes an issue which started on 1/7/2017 in which querying for AdSense dimensions and metrics would return an “Unknown Metric” error for non-AdSense linked views.

Coming changes

On or after 1/31/2017 non-AdSense linked views will be restricted from querying for AdSense dimensions and metrics. Querying for these dimensions and metrics with a non-AdSense linked views will result in an error.

This release adds the following new metric to the API. Review the Dimensions and Metrics Reference for the complete list of definitions.

Calculated Metrics

This release adds support for calculated metrics.

  • Metric - ga:calcMetric_ - The value of the requested calculated metric, where refers to the user-defined name of the calculated metric. Note that the data type of ga:calcMetric_ can be FLOAT, INTEGER, CURRENCY, TIME, or PERCENT. For details, see About calculated metrics.

This release adds a new metric to the API. It also deprecates an existing metric. Review the Dimensions and Metrics Reference for the complete list of definitions.

Event Tracking

The definition of ga:uniqueEvents will change to more accurately reflect the number of unique events. To affect this change, we will technically deprecate the current ga:uniqueEvents metric in accordance with our data deprecation policy. If you would like to try out the new definition you can reference the private metric ga:uniqueEventsTemporary, which more accurately calculates the number of unique events. We will also be introducing a new metric ga:uniqueDimensionCombinations which keeps the current definition of ga:uniqueEvents. After the proper deprecation time period (approximately 6 months), the private metric ga:uniqueEventsTemporary will be removed and the original metric ga:uniqueEvents will correctly represent the number of unique events. For more information, see the Unique Events help documents.

Unique Events

  • Metric - ga:uniqueEvents - The definition of ga:uniqueEvents will change soon to more accurately reflect the number of unique events. Please use ga:uniqueDimensionCombinations instead if you want to retain the existing definition. For more information, see Unique Events help documents.
  • Metric - ga:uniqueDimensionCombinations - Unique Dimension Combinations counts the number of unique dimension-value combinations for each dimension in a report. This lets you build combined (concatenated) dimensions post-processing, which allows for more flexible reporting without having to update your tracking implementation or use additional custom-dimension slots. For more information, see Unique Events help documents.

Transition Testing – Private

  • Metric - ga:uniqueEventsTemporary - The number of unique events; this will be the new definition for ga:uniqueEvents. You can use this metric to understand the new definition prior to the change. Note this metric is private and will not show up in the Dimensions and Metrics Reference.

This release adds new dimensions and metrics to the API. Review the Dimensions and Metrics Reference for the complete list of definitions.

DoubleClick Bid Manager

  • Dimension - ga:dbmClickAdvertiser - DBM advertiser name of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmClickAdvertiserId - DBM advertiser ID of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmClickCreativeId - DBM creative ID of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmClickExchange - DBM exchange name of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmClickExchangeId - DBM exchange ID of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmClickInsertionOrder - DBM insertion order name of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmClickInsertionOrderId - DBM insertion order ID of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmClickLineItem - DBM line item name of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmClickLineItemId - DBM line item ID of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmClickSite - DBM site name where the DBM creative was shown and clicked on for the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmClickSiteId - DBM site ID where the DBM creative was shown and clicked on for the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmLastEventAdvertiser - DBM advertiser name of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmLastEventAdvertiserId - DBM advertiser ID of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmLastEventCreativeId - DBM creative ID of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmLastEventExchange - DBM exchange name of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmLastEventExchangeId - DBM exchange ID of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmLastEventInsertionOrder - DBM insertion order name of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmLastEventInsertionOrderId - DBM insertion order ID of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmLastEventLineItem - DBM line item name of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmLastEventLineItemId - DBM line item ID of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmLastEventSite - DBM site name where the DBM creative was shown and clicked on for the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dbmLastEventSiteId - DBM site ID where the DBM creative was shown and clicked on for the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
  • Metric - ga:dbmCPA - DBM Revenue eCPA (Analytics 360 only, requires integration with DBM).
  • Metric - ga:dbmCPC - DBM Revenue eCPC (Analytics 360 only, requires integration with DBM).
  • Metric - ga:dbmCPM - DBM Revenue eCPM (Analytics 360 only, requires integration with DBM).
  • Metric - ga:dbmCTR - DBM CTR (Analytics 360 only, requires integration with DBM).
  • Metric - ga:dbmClicks - DBM Total Clicks (Analytics 360 only, requires integration with DBM).
  • Metric - ga:dbmConversions - DBM Total Conversions (Analytics 360 only, requires integration with DBM).
  • Metric - ga:dbmCost - DBM Cost (Analytics 360 only, requires integration with DBM).
  • Metric - ga:dbmImpressions - DBM Total Impressions (Analytics 360 only, requires integration with DBM).
  • Metric - ga:dbmROAS - DBM ROAS (Analytics 360 only, requires integration with DBM).
  • Dimension - ga:dsAdGroup - DS Ad Group (Analytics 360 only, requires integration with DS).
  • Dimension - ga:dsAdGroupId - DS Ad Group ID (Analytics 360 only, requires integration with DS).
  • Dimension - ga:dsAdvertiser - DS Advertiser (Analytics 360 only, requires integration with DS).
  • Dimension - ga:dsAdvertiserId - DS Advertiser ID (Analytics 360 only, requires integration with DS).
  • Dimension - ga:dsAgency - DS Agency (Analytics 360 only, requires integration with DS).
  • Dimension - ga:dsAgencyId - DS Agency ID (Analytics 360 only, requires integration with DS).
  • Dimension - ga:dsCampaign - DS Campaign (Analytics 360 only, requires integration with DS).
  • Dimension - ga:dsCampaignId - DS Campaign ID (Analytics 360 only, requires integration with DS).
  • Dimension - ga:dsEngineAccount - DS Engine Account (Analytics 360 only, requires integration with DS).
  • Dimension - ga:dsEngineAccountId - DS Engine Account ID (Analytics 360 only, requires integration with DS).
  • Dimension - ga:dsKeyword - DS Keyword (Analytics 360 only, requires integration with DS).
  • Dimension - ga:dsKeywordId - DS Keyword ID (Analytics 360 only, requires integration with DS).
  • ga:dsCPC - DS Cost to advertiser per click (Analytics 360 only, requires integration with DS).
  • ga:dsCTR - DS Click Through Rate (Analytics 360 only, requires integration with DS).
  • ga:dsClicks - DS Clicks (Analytics 360 only, requires integration with DS).
  • ga:dsCost - DS Cost (Analytics 360 only, requires integration with DS).
  • ga:dsImpressions - DS Impressions (Analytics 360 only, requires integration with DS).
  • ga:dsProfit - DS Profie (Analytics 360 only, requires integration with DS).
  • ga:dsReturnOnAdSpend - DS Return On Ad Spend (Analytics 360 only, requires integration with DS).
  • ga:dsRevenuePerClick - DS Revenue Per Click (Analytics 360 only, requires integration with DS).

This release adds a new dimension to the API. Check the Dimensions and metrics Reference for the complete list of definitions.

Transaction ID

  • dimension - mcf:transactionId - The transaction ID, supplied by the ecommerce tracking method, for the purchase in the shopping cart.

This release adds a new dimension to the API. This release also adds certain restrictions on the combination of dimensions that can be querried together. Review the Dimensions and Metrics Reference for the complete list of definitions.

Geo Network

  • Dimension - ga:continentId - Users’ continent ID, derived from users’ IP addresses or Geographical IDs.

Restrictions

The following dimensions in the following groups cannot be querried with dimensions in the other groups:

  • Visit Shopping Info Group
    • ga:checkoutOptions
    • ga:shoppingStage
  • GWO Experiment Group
    • ga:experimentVariant
    • ga:experimentId
  • Interest Group
    • ga:interestOtherCategory
  • In Market Interest Group
    • ga:interestInMarketCategory
  • Internal Promotion Group:
    • ga:internalPromotionCreative
    • ga:internalPromotionId
    • ga:internalPromotionName
    • ga:internalPromotionPosition
  • Branding Interest Group:
    • ga:interestAffinityCategory

This release introduces new limits and quotas. See the Limits and Quotas documentation for details.

Reporting Errors

This release begins enforcing limits on failed (5XX) reporting requests.

  • 10 failed requests per project per profile per hour.
  • 50 failed requests per project per profile per day.

Pivot limits

This release begins enforcing limits on pivot requests:

  • A report request can now have a maximum of 2 pivots.
  • A pivot can have a maximum of 4 dimensions.
  • Pivot dimensions are part of the restriction on the total number of dimensions allowed in the request.
  • Pivot metrics are part of the restriction on the total number of metrics allowed in the request.

This release adds new dimensions and metrics to the API. Review the Dimensions and Metrics Reference for the complete list of definitions.

Geo Network

  • Dimension - ga:metroId - The three digit Designated Market Area (DMA) code from where traffic arrived, derived from users’ IP addresses or Geographical IDs.

DoubleClick for Publishers

  • Metric - ga:dfpImpressions - A DFP ad impression is reported whenever an individual ad is displayed on the website. For example, if a page with two ad units is viewed once, we’ll display two impressions (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:dfpCoverage - Coverage is the percentage of ad requests that returned at least one ad. Generally, coverage can help identify sites where the DFP account isn’t able to provide targeted ads. (Ad Impressions / Total Ad Requests) * 100 (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:dfpMonetizedPageviews - This measures the total number of pageviews on the property that were shown with an ad from the linked DFP account. Note that a single page can have multiple ad units (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:dfpImpressionsPerSession - The ratio of DFP ad impressions to Analytics sessions (Ad Impressions / Analytics Sessions) (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:dfpViewableImpressionsPercent - The percentage of viewable ad impressions. An impression is considered a viewable impression when it has appeared within users’ browsers and has the opportunity to be seen (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:dfpClicks - The number of times DFP ads were clicked on the site (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:dfpCTR - The percentage of pageviews that resulted in a click on an DFP ad (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:dfpRevenue - DFP revenue is an estimate of the total ad revenue based on served impressions (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:dfpRevenuePer1000Sessions - The total estimated revenue from DFP ads per 1,000 Analytics sessions. Note that this metric is based on sessions to the site, not on ad impressions (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:dfpECPM - The effective cost per thousand pageviews. It is the DFP revenue per 1,000 pageviews (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:backfillImpressions - Backfill Impressions is the sum of all AdSense or Ad Exchance ad impressions served as backfill through DFP. An ad impression is reported whenever an individual ad is displayed on the website. For example, if a page with two ad units is viewed once, we’ll display two impressions (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:backfillCoverage - Backfill Coverage is the percentage of backfill ad requests that returned at least one ad. Generally, coverage can help identify sites where the publisher account isn’t able to provide targeted ads. (Ad Impressions / Total Ad Requests) * 100. If both AdSense and Ad Exchange are providing backfill ads, this metric is the weighted average of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:backfillMonetizedPageviews - This measures the total number of pageviews on the property that were shown with at least one ad from the linked backfill account(s). Note that a single monetized pageview can include multiple ad impressions (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:backfillImpressionsPerSession - The ratio of backfill ad impressions to Analytics sessions (Ad Impressions / Analytics Sessions). If both AdSense and Ad Exchange are providing backfill ads, this metric is the sum of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:backfillViewableImpressionsPercent - The percentage of backfill ad impressions that were viewable. An impression is considered a viewable impression when it has appeared within the users’ browsers and had the opportunity to be seen. If AdSense and Ad Exchange are both providing backfill ads, this metric is the weighted average of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:backfillClicks - The number of times backfill ads were clicked on the site. If AdSense and Ad Exchange are both providing backfill ads, this metric is the sum of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:backfillCTR - The percentage of backfill impressions that resulted in a click on an ad. If AdSense and Ad Exchange are both providing backfill ads, this metric is the weighted average of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:backfillRevenue - The total estimated revenue from backfill ads. If AdSense and Ad Exchange are both providing backfill ads, this metric is the sum of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:backfillRevenuePer1000Sessions - The total estimated revenue from backfill ads per 1,000 Analytics sessions. Note that this metric is based on sessions to the site and not ad impressions. If both AdSense and Ad Exchange are providing backfill ads, this metric is the sum of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).“
  • Metric - ga:backfillECPM - The effective cost per thousand pageviews. It is the DFP Backfill Revenue per 1,000 pageviews. If both AdSense and Ad Exchange are providing backfill ads, this metric is the sum of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).“

This is a bug fix release, which fixes an issue with segments and sampling.

Segments

This release fixes an issue which would cause a subset of requests with the All Users segment (gaid::-1) to be undercounted in the Core Reporting API V3 and to be split into two segments in the Analytics Reporting API V4.

Sampling

This release fixes an issue where a subset of requests from custom tables would return sampled data.

This release adds a new attribute addedInApiVersion.

Added in API Version

  • The addedInApiVersion is a numeric attribute which can be used to check whether a column can be used in a reporting API of a specified version; see the Metadata API - Developer Guide for details.

This release announces a new version of the API, the Analytics Reporting API V4. This new API is the most advanced programmatic method to access report data in Google Analytics.

Key Features

Google Analytics is built upon a powerful data reporting infrastructure. The API gives developers access to the power of the Google Analytics platform. Some key features in the Analytics Reporting API V4 include the following:

  • Metric Expressions - The API allows you to request not only the built-in metrics but also mathematical metric expressions. For example goal completions per number of sessions can be expressed in the request as ga:goal1completions/ga:sessions.
  • Multiple date ranges - Support for requesting two date ranges, allowing you to compare data for two periods in a single request.
  • Cohorts and Lifetime value - The API has a rich vocabulary to request Cohort and Lifetime value reports.
  • Multiple segments - You can now request multiple segments in a single request.

Getting Started

See the developer documention for all the details on getting started with the API.

Quota Policy

The Analytics Reporting API V4 comes with its own quotas and limits; as this is a new API, these limits and quotas are subject to be changed.

Migration

Along with a migration guide, we also make a Python compatibility library available on Github.

Dimensions and Metrics

This release also adds a set of dimensions and metrics specifically for Analytics Reporting API V4. See the dimensions and metrics explorer for the full list definitions.

  • Dimension - ga:cohort - Name of the cohort a user belongs to based on the cohorts definition. Depending on how cohorts are defined, a user can belong to multiple cohorts, similar to how a user can belong to multiple segments.

  • Dimension - ga:cohortNthDay - 0-based day offset relative to the cohort definition date. For example, if a cohort is defined with the first visit date as 2015-09-01, then for the date 2015-09-04, ga:cohortNthDay will be 3.

  • ga:cohortNthMonth - 0-based month offset relative to the cohort definition date.

  • Dimension - ga:cohortNthWeek - 0-based week offset relative to the cohort definition date.

  • Dimension - ga:acquisitionTrafficChannel - Traffic channel through which the user was acquired. It is extracted from the first session of the user. Traffic channel is computed based on the default channel grouping rules (at view level if available) at the time of user acquisition.

  • Dimension - ga:acquisitionSource - The source through which the user was acquired. Derived from the first session of the user.

  • Dimension - ga:acquisitionMedium - The medium through which the user was acquired. Derived from the first session of the user.

  • Dimension - ga:acquisitionSourceMedium - The combined value of ga:userAcquisitionSource and ga:acquisitionMedium.

  • Dimension - ga:acquisitionCampaign The campaign through which the user was acquired. Derived from the first session of the user.

  • Metric - ga:cohortActiveUsers - This metric is relevant in the context of the 0-based offset dimensions (ga:cohortNthDay, ga:cohortNthWeek, or ga:cohortNthMonth). It indicates number of users in the cohort who are active in the time window corresponding to the cohort nth day/week/month. For example, for ga:cohortNthWeek = 1, number of users (in the cohort) who are active in the second week. If a request does not have any of ga:cohortNthDay, ga:cohortNthWeek, or ga:cohortNthMonth, this metric will have the same value as ga:cohortTotalUsers.

  • Metric - ga:cohortTotalUsers - Number of users belonging to the cohort, also known as cohort size.

  • Metric - ga:cohortAppviewsPerUser - App views per user for a cohort.

  • Metric - ga:cohortGoalCompletionsPerUser - Goal completions per user for a cohort.

  • Metric - ga:cohortPageviewsPerUser - Pageviews per user for a cohort.

  • Metric - ga:cohortRetentionRate - Cohort retention rate.

  • Metric - ga:cohortRevenuePerUser - Revenue per user for a cohort.

  • Metric - ga:cohortVisitDurationPerUser - Session duration per user for a cohort.

  • Metric - ga:cohortSessionsPerUser - Sessions per user for a cohort.

  • Metric - ga:cohortTotalUsersWithLifetimeCriteria - This is relevant in the context of a request which has the dimensions ga:acquisitionTrafficChannel, ga:acquisitionSource, ga:acquisitionMedium, or ga:acquisitionCampaign. It represents the number of users in the cohorts who are acquired through the current channel, source, medium, or campaign. For example, for ga:acquisitionTrafficChannel=Direct, it represents the number users in the cohort, who were acquired directly. If none of the mentioned dimensions are present, then its value is equal to ga:cohortTotalUsers.

  • Metric - ga:cohortAppviewsPerUserWithLifetimeCriteria - App views per user for the acquisition dimension for a cohort.

  • Metric - ga:cohortGoalCompletionsPerUserWithLifetimeCriteria - Goal completions per user for the acquisition dimension for a cohort.

  • Metric - ga:cohortPageviewsPerUserWithLifetimeCriteria - Pageviews per user for the acquisition dimension for a cohort.

  • Metric - ga:cohortRevenuePerUserWithLifetimeCriteria - Revenue per user for the acquisition dimension for a cohort.

  • Metric - ga:cohortSessionsPerUserWithLifetimeCriteria - Session duration per user for the acquisition dimension for a cohort.

The Social Data Hub dimensions and metrics have been deprecated and will only report on historical data starting after April 30th, 2016; after this date no new data will appear. As per the Data Deprecation Policy, these dimensions and metrics will be removed after September 30th, 2016.

Review the Dimensions and Metrics Reference for the complete list of definitions.

Social Activities

These dimensions and metrics have been deprecated and will be removed after September 30th, 2016. Review the Data Deprecation Policy for details on data removal:

  • Dimension - ga:socialActivityEndorsingUrl - For a social data hub activity, this is the URL of the social activity (e.g., the Google+ post URL, the blog comment URL, etc.).
  • Dimension - ga:socialActivityDisplayName - For a social data hub activity, this is the title of the social activity posted by the social network users.
  • Dimension - ga:socialActivityPost - For a social data hub activity, this is the content of the social activity (e.g., the content of a message posted in Google+) posted by social network users.
  • Dimension - ga:socialActivityTimestamp - For a social data hub activity, this is the time when the social activity occurred on the social network.
  • Dimension - ga:socialActivityUserHandle - For a social data hub activity, this is the social network handle (e.g., name or ID) of users who initiated the social activity.“
  • Dimension - ga:socialActivityUserPhotoUrl - For a social data hub activity, this is the URL of the photo associated with users’ social network profiles.“
  • Dimension - ga:socialActivityUserProfileUrl - For a social data hub activity, this is the URL of the associated users’ social network profiles.
  • Dimension - ga:socialActivityTagsSummary - For a social data hub activity, this is a comma-separated set of tags associated with the social activity.“
  • Dimension - ga:socialActivityAction - For a social data hub activity, this represents the type of social action (e.g., vote, comment, +1, etc.) associated with the activity.
  • Dimension - ga:socialActivityNetworkAction - For a social data hub activity, this is the type of social action and the social network where the activity originated.
  • Dimension - ga:socialActivityContentUrl - For a social data hub activity, this is the URL shared by the associated social network users.
  • Metric - ga:socialActivities - Total number of activities where a content URL was shared or mentioned on a social data hub partner network.

This release adds a new dimension to the API. Review the Dimensions and Metrics Reference for the complete list of definitions.

Platform or Device

  • Dimension - ga:browserSize - The viewport size of the users’ browsers. Browser size is a session scoped dimension which captures the initial dimensions of the viewport in pixels and is formatted as width X height. For example, 1920x960.

This release adds a new parameter to the API.

Include Empty Rows

  • This release adds the new optional parameter include-empty-rows, which when set to false rows without data will be omitted from the response. The default value is true, which is a non breaking change, and as such should not require a code update. See the Core Reporting API reference documentation for details.

This release adds new metrics to the API. Review the Dimensions and Metrics Reference for the complete list of definitions.

User

  • Metric - ga:1dayUsers - Total number of 1-day active users for each day in the requested time period. At least one of ga:nthDay, ga:date, or ga:day must be specified as a dimension in order to query this metric. For the given date the returned value will be the total unique users for the 1 day period ending on the given date.
  • Metric - ga:7dayUsers - Total number of 7-day active users for each day in the requested time period. At least one of ga:nthDay, ga:date, or ga:day must be specified as a dimension in order to query this metric. For the given date the returned value will be the total unique users for the 7 day period ending on the given date.
  • Metric - ga:14dayUsers - Total number of 14-day active users for each day in the requested time period. At least one of ga:nthDay, ga:date, or ga:day must be specified as a dimension in order to query this metric. For the given date the returned value will be the total unique users for the 14 day period ending on the given date.
  • Metric - ga:30dayUsers - Total number of 30-day active users for each day in the requested time period. At least one of ga:nthDay, ga:date, or ga:day must be specified as a dimension in order to query this metric. For the given date the returned value will be the total unique users for the 30 day period ending on the given date.

This release adds new metrics to the API. Review the Dimensions and Metrics Reference for the complete list of definitions.

DoubleClick Ad Exchange (AdX)

  • Metric - ga:adxCTR - The percentage of pageviews that resulted in a click on an AdX ad.
  • Metric - ga:adxClicks - The number of times AdX ads were clicked on your site.
  • Metric - ga:adxCoverage - Coverage is the percentage of ad requests that returned at least one ad. Generally, coverage can help you identify sites where your AdX account isn’t able to provide targeted ads. (Ad Impressions / Total Ad Requests) * 100
  • Metric - ga:adxECPM - The effective cost per thousand pageviews. It is your AdX Revenue per 1000 pageviews.
  • Metric - ga:adxImpressions - An AdX ad impression is reported whenever an individual ad is displayed on your website. For example, if a page with two ad units is viewed once, we’ll display two impressions.
  • Metric - ga:adxImpressionsPerSession - The ratio of AdX ad impressions to Analytics sessions (Ad Impressions / Analytics Sessions).
  • Metric - ga:adxMonetizedPageviews - Monetized Pageviews measures the total number of pageviews on your property that were shown with an ad from your linked AdX account. Note: A single page can have multiple ad units.
  • Metric - ga:adxRevenue - The total estimated revenue from AdX ads.
  • Metric - ga:adxRevenuePer1000Sessions - The total estimated revenue from AdX ads per 1000 Analytics sessions. Note that this metric is based on sessions to your site and not ad impressions.
  • Metric - ga:adxViewableImpressionsPercent - The percentage of ad impressions that were viewable. An impression is considered a viewable impression when it has appeared within a user’s browser and had the opportunity to be seen.

This release deprecates existing dimensions or metrics. Review the Dimensions and Metrics Reference for the complete list of definitions.

Deprecated Dimensions

These dimensions have been deprecated. Review the Data Deprecation Policy for details on data removal:

  • Dimension - ga:adSlotPosition - Use ga:adSlot instead.
  • Dimension - ga:nextPagePath - Use ga:pagePath instead.
  • Dimension - ga:nextContentGroupXX - Use ga:contentGroupXX instead.

This release adds a new dimension to the API. Review Dimensions and Metrics Reference for the complete list of dimensions and metrics.

Adwords

  • Dimension - ga:adQueryWordCount - The number of words in the search query.

This release adds new dimensions to the API. Review Dimensions and Metrics Reference for the complete list of dimensions and metrics.

Platform or Device

  • Dimension - ga:dataSource - The data source of a hit. Hits sent from ga.js and analytics.js are reported as “web”; hits sent from the mobile SDKs are reported as “app”. These values can be overridden.
  • Dimension - ga:searchAfterDestinationPage - The page that the user visited after performing an internal search on your site.

This is a bug fix release:

  • This release fixes an issue in enforcing the filtering constraints in the Real Time Reporting API query. Requests with rt:activeUsers and a filter on an event level dimension would result in a error with a badRequest reason and a message stating OR operator not supported for a hit level filter. Visit the Real Time Reporting API Developer Guide for more details on query constraints.

This release adds new dimensions and metrics to the API and deprecates two existing metrics. Review the Dimensions and Metrics Reference for the complete list of definitions.

ECommerce

  • Metric - ga:transactionsPerUser - The total number of transactions divided by total number of users.
  • Metric - ga:revenuePerUser - The total sale revenue provided in the transaction excluding shipping and tax divided by total number of users.

User

  • Metric - ga:sessionsPerUser - The total number of sessions divided by the total number of users.

Geo Network

  • Dimension - ga:cityId - The city IDs of users, derived from IP addresses or Geographical IDs.
  • Dimension - ga:countryIsoCode - The country ISO code of users, derived from IP addresses or Geographical IDs. Values are given as an ISO-3166-1 alpha-2 code.
  • Dimension - ga:regionId - The region ID of users, derived from IP addresses or Geographical IDs. In the U.S., a region is a state, such as New York.
  • Dimension - ga:regionIsoCode - The region ISO code of users, derived from IP addresses or Geographical IDs. Values are given as an ISO-3166-2 code.
  • Dimension - ga:subContinentCode - The sub-continent code of users, derived from IP addresses or Geographical IDs. For example, Polynesia or Northern Europe. Values are given as a UN M.49 code.

DoubleClick Campaign Manager

  • Metric - ga:dcmROAS - DCM Return On Ad Spend (ROAS) (premium only).

Deprecated Metrics

These metrics have been deprecated. Review the Data Deprecation Policy for details on data removal: + Metric - ga:dcmROI - Use ga:dcmROAS instead. + Metric - ga:dcmMargen - Use ga:dcmROAS instead.

This release adds a new metric to the API and deprecates two existing metrics. Check the Dimensions and Metrics Reference for the complete list of definitions.

AdWords

  • Metric - ga:ROAS - Return On Ad Spend (ROAS) is the total transaction revenue and goal value divided by derived advertising cost.

Deprecated Dimensions and Metrics

These dimensions and metrics have been deprecated. Review the Data Deprecation Policy for details on data removal: + Metric - ga:ROI - Use ga:ROAS instead. + Metric - ga:margin - Use ga:ROAS instead.

This release includes a new dimension. Review the Dimensions and Metrics Reference for the complete list of definitions.

Time

  • Dimension - rt:minutesAgo - The number of minutes ago a hit occurred.

This release adds new metrics to the API. Check the Dimensions and Metrics Reference for the complete list of definitions.

AdSense

  • Metric - ga:adsenseCoverage - The percentage of ad requests that returned at least one ad.
  • Metric - ga:adsenseViewableImpressionPercent - The percentage of impressions that were viewable.

This release adds new dimensions and metrics to the API. Check the Dimensions and Metrics Reference for the complete list of definitions.

Conversion Paths

  • dimension - mcf:dcmAd - DCM ad name of the DCM event (impression or click) matching the Google Analytics conversion.
  • dimension - mcf:dcmAdPath - The path to conversion where interactions on the path are represented by DCM ads.
  • dimension - mcf:dcmAdType - DCM ad type name of the DCM event (impression or click) matching the Google Analytics conversion.
  • dimension - mcf:dcmAdvertiser - DCM advertiser name of the DCM event (impression or click) matching the Google Analytics conversion.
  • dimension - mcf:dcmAdvertiserPath - The path to conversion where interactions on the path are represented by DCM advertisers.
  • dimension - mcf:dcmCampaign - DCM campaign name of the DCM event (impression or click) matching the Google Analytics conversion.
  • dimension - mcf:dcmCampaignPath - The path to conversion where interactions on the path are represented by DCM campaigns.
  • dimension - mcf:dcmCreative - DCM creative name of the DCM event (impression or click) matching the Google Analytics conversion.
  • dimension - mcf:dcmCreativePath - The path to conversion where interactions on the path are represented by DCM creatives.
  • dimension - mcf:dcmCreativeVersion - DCM creative version of the DCM event (impression or click) matching the Google Analytics conversion.
  • dimension - mcf:dcmCreativeVersionPath - The path to conversion where interactions on the path are represented by DCM creative versions.
  • dimension - mcf:dcmNetwork - The network used.
  • dimension - mcf:dcmPlacement - DCM site placement name of the DCM event (impression or click) matching the Google Analytics conversion.
  • dimension - mcf:dcmPlacementPath - The path to conversion where interactions on the path are represented by DCM placements.
  • dimension - mcf:dcmSite - DCM site name where the DCM creative was shown for the DCM event (impression or click) matching the Google Analytics conversion.
  • dimension - mcf:dcmSitePath - The path to conversion where interactions on the path are represented by DCM sites.
  • metric - mcf:firstImpressionConversions - The number of conversions for which a DCM campaign impression was the first conversion interaction in a 30-day lookback window. This dimension includes both goal completions and transactions.
  • metric - mcf:firstImpressionValue - The value of conversions for which a DCM campaign campaign impression was the first conversion interaction in a 30-day lookback window. This dimension includes both goal completions and transactions.
  • metric - mcf:impressionAssistedConversions - The number of conversions for which a DCM campaign impression appeared on the conversion path, but was not the final conversion interaction. This dimension includes both goal completions and transactions.
  • metric - mcf:impressionAssistedValue - The value of conversions for which a DCM campaign campaign impression appeared on the conversion path, but was not the final conversion interaction. This dimension includes both goal completions and transactions.

This release includes the addition of a new session metric, a new traffic sources dimension, and new DoubleClick Campaign Manager dimensions and metrics.

Dimensions and Metrics

Review the Dimensions and Metrics Reference for the complete list of definitions.

Session

  • Metric - ga:hits - Total number of hits sent to Google Analytics. This metric sums all hit types (e.g. pageview, event, timing, etc.)

Traffic Sources

  • Dimension - ga:campaignCode - When using manual campaign tracking, the value of the utm_id campaign tracking parameter.

DoubleClick Campaign Manager

  • Dimension - ga:dcmClickAd - DCM ad name of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickAdId - DCM ad ID of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickAdType - DCM ad type name of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickAdTypeId - DCM ad type ID of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickAdvertiser - DCM advertiser name of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickAdvertiserId - DCM advertiser ID of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickCampaign - DCM campaign name of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickCampaignId - DCM campaign ID of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickCreative - DCM creative name of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickCreativeId - DCM creative ID of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickCreativeType - DCM creative type name of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickCreativeTypeId - DCM creative type ID of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickCreativeVersion - DCM creative version of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickRenderingId - DCM rendering ID of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickSite - Site name where the DCM creative was shown and clicked on for the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickSiteId - DCM site ID where the DCM creative was shown and clicked on for the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickSitePlacement - DCM site placement name of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickSitePlacementId - DCM site placement ID of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmClickSpotId - DCM Floodlight configuration ID of the DCM click matching the Google Analytics session (premium only).
  • Dimension - ga:dcmFloodlightActivity - DCM Floodlight activity name associated with the floodlight conversion (premium only).
  • Dimension - ga:dcmFloodlightActivityAndGroup - DCM Floodlight activity name and group name associated with the floodlight conversion (premium only).
  • Dimension - ga:dcmFloodlightActivityGroup - DCM Floodlight activity group name associated with the floodlight conversion (premium only).
  • Dimension - ga:dcmFloodlightActivityGroupId - DCM Floodlight activity group ID associated with the floodlight conversion (premium only).
  • Dimension - ga:dcmFloodlightActivityId - DCM Floodlight activity ID associated with the floodlight conversion (premium only).
  • Dimension - ga:dcmFloodlightAdvertiserId - DCM Floodlight advertiser ID associated with the floodlight conversion (premium only).
  • Dimension - ga:dcmFloodlightSpotId - DCM Floodlight configuration ID associated with the floodlight conversion (premium only).
  • Dimension - ga:dcmLastEventAd - DCM ad name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventAdId - DCM ad ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventAdType - DCM ad type name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventAdTypeId - DCM ad type ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventAdvertiser - DCM advertiser name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventAdvertiserId - DCM advertiser ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventAttributionType - There are two possible values (ClickThrough and ViewThrough). If the last DCM event associated with the Google Analytics session was a click, then the value will be ClickThrough. If the last DCM event associated with the Google Analytics session was an ad impression, then the value will be ViewThrough (premium only).
  • Dimension - ga:dcmLastEventCampaign - DCM campaign name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventCampaignId - DCM campaign ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventCreative - DCM creative name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventCreativeId - DCM creative ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventCreativeType - DCM creative type name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventCreativeTypeId - DCM creative type ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventCreativeVersion - DCM creative version of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventRenderingId - DCM rendering ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventSite - Site name where the DCM creative was shown and clicked on for the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventSiteId - DCM site ID where the DCM creative was shown and clicked on for the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventSitePlacement - DCM site placement name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventSitePlacementId - DCM site placement ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Dimension - ga:dcmLastEventSpotId - DCM Floodlight configuration ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (premium only).
  • Metric - ga:dcmFloodlightQuantity - The number of DCM Floodlight conversions (premium only).
  • Metric - dcmFloodlightRevenue - DCM Floodlight revenue (premium only).

This release includes the addition of the new content grouping dimensions and metrics.

Dimensions and Metrics

Review the Dimensions and Metrics Reference for the complete list of definitions.

Content Grouping

  • Dimension - ga:landingContentGroupXX - The first matching content group in a user’s session.
  • Dimension - ga:nextContentGroupXX - Refers to content group that was visited after another content group.
  • Dimension - ga:contentGroupXX - Content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/url regex match, or predefined rules.
  • Dimension - ga:previousContentGroupXX - Refers to content group that was visited before another content group.
  • Metric - ga:contentGroupUniqueViewsXX - The number of different (unique) pages within a session for the specified content group. This takes into account both the pagePath and pageTitle to determine uniqueness.

This release includes a new dateOfSession condition for Segments and the addition of new Enhanced Ecommerce dimensions and metrics.

Segments

Segments now support a new dateOfSession condition which can restrict a segment to a group of users who have initiated a session within a certain date range. See the Segments Developer Guide for details.

Dimensions and Metrics

Review the Dimensions and Metrics Reference for the complete list of definitions for Enhanced Ecommerce.

Enhanced Ecommerce

  • Dimension - ga:internalPromotionCreative - The creative content designed for a promotion.
  • Dimension - ga:internalPromotionId - The ID you are using for the promotion.
  • Dimension - ga:internalPromotionName - The name of the promotion.
  • Dimension - ga:internalPromotionPosition - The position of the promotion on the web page or application screen.
  • Dimension - ga:orderCouponCode - Code for the order-level coupon.
  • Dimension - ga:productBrand - The brand name under which the product is sold.
  • Dimension - ga:productCategoryHierarchy - The hierarchical category in which the product is classified (Enhanced Ecommerce).
  • Dimension - ga:productCategoryLevelXX - Level (1-5) in the product category hierarchy, starting from the top.
  • Dimension - ga:productCouponCode - Code for the product-level coupon.
  • Dimension - ga:productListName - The name of the product list in which the product appears.
  • Dimension - ga:productListPosition - The position of the product in the product list.
  • Dimension - ga:productVariant - The specific variation of a product, e.g., XS, S, M, L for size or Red, Blue, Green, Black for color.
  • Dimension - ga:checkoutOptions - User options specified during the checkout process, e.g., FedEx, DHL, UPS for delivery options or Visa, MasterCard, AmEx for payment options. This dimension should be used along with Shopping Stage.
  • Dimension - ga:shoppingStage - Various stages of the shopping experience that users completed in a session, e.g., PRODUCT_VIEW, ADD_TO_CART, CHECKOUT, etc.
  • Metric - ga:internalPromotionCTR - The rate at which users clicked through to view the internal promotion (number of clicks / number of times promotion appeared).
  • Metric - ga:internalPromotionClicks - The number of clicks on an internal promotion.
  • Metric - ga:internalPromotionViews - The number of views of an internal promotion.
  • Metric - ga:localProductRefundAmount - Refund amount for a given product in the local currency.
  • Metric - ga:localRefundAmount - Total refund amount for the transaction in the local currency.
  • Metric - ga:productAddsToCart - Number of times the product was added to the shopping cart.
  • Metric - ga:productCheckouts - Number of times the product was included in the check-out process.
  • Metric - ga:productDetailViews - Number of times users viewed the product-detail page.
  • Metric - ga:productListClicks - Number of times users clicked the product when it appeared in the product list.
  • Metric - ga:productListViews - Number of times the product appeared in a product list.
  • Metric - ga:productListCTR - The rate at which users clicked through on the product in a product list.
  • Metric - ga:productRefunds - Number of times a refund was issued for the product.
  • Metric - ga:productRefundAmount - Total refund amount associated with the product.
  • Metric - ga:productRemovesFromCart - Number of times the product was removed from shopping carts.
  • Metric - ga:productRevenuePerPurchase - Average product revenue per purchase (commonly used with Product Coupon Code).
  • Metric - ga:buyToDetailRate - Unique purchases divided by views of product detail pages.
  • Metric - ga:cartToDetailRate - Product adds divided by views of product details.
  • Metric - ga:quantityAddedToCart - Number of product units added to cart.
  • Metric - ga:quantityCheckedOut - Number of product units included in check out.
  • Metric - ga:quantityRefunded - Number of product units refunded.
  • Metric - ga:quantityRemovedFromCart - Number of product units removed from cart.
  • Metric - ga:refundAmount - Currency amount refunded for a transaction.
  • Metric - ga:totalRefunds - Number of refunds that have been issued.

This release includes a bug fix for column header names as well as the addition of new dimensions and metrics.

Dimensions and Metrics

Review the Dimensions and Metrics Reference for the complete list of definitions.

System

  • Dimension - ga:sourcePropertyDisplayName - Source property display name of roll-up properties. This is valid only for roll-up properties.
  • Dimension - ga:sourcePropertyTrackingId - Source property tracking ID of roll-up properties. This is valid only for roll-up properties

Channel Grouping

  • Dimension - ga:channelGrouping - The default channel grouping that is shared within the View (Profile).
  • Dimension - ga:correlationModelId - Correlation Model ID for related products.
  • Dimension - ga:queryProductId - ID of the product being queried.
  • Dimension - ga:queryProductName - Name of the product being queried.
  • Dimension - ga:queryProductVariation - Variation of the product being queried.
  • Dimension - ga:relatedProductId - ID of the related product.
  • Dimension - ga:relatedProductName - Name of the related product.
  • Dimension - ga:relatedProductVariation - Variation of the related product.
  • Metric - ga:correlationScore - Correlation Score for related products.
  • Metric - ga:queryProductQuantity - Quantity of the product being queried.
  • Metric - ga:relatedProductQuantity - Quantity of the related product.

Header column name correction

  • There was a bug in the 2014-04-16 release; if you queried for a deprecated dimension or metric, the API would return column headers with the replacement dimension or metric. Now it correctly returns the same dimension or metric name used in the request.

This release includes a naming convention change for the uiName attribute.

uiName Change

  • The uiName attribute for templatized columns now uses XX to represent the numeric index instead of 1. For example, Goal 1 Value is now Goal XX Value.

This is the initial release of the Embed API:

  • 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. Visit the Embed API Overview for more details.
  • Includes components: auth, view selector, data, and data chart.

This release includes the deprecation of the appUiName attribute. Review the Data Deprecation Policy for details on attribute removal:

appUiName Deprecation

  • The appUiName has been deprecated. It is no longer required in the Metadata API because UI names for web and app views (profiles) have been unified. You should remove any code that uses the appUiName attribute and only use the uiName attribute.

This release includes the renaming of dimensions and metrics. Review the Dimensions and Metrics Reference for the complete list of definitions.

Renamed Dimensions and Metrics

The following dimensions and metrics have been renamed. Review the Data Deprecation Policy for details on data renaming:

User

  • Dimension - rt:visitorType - Use rt:userType instead.
  • Metric - rt:activeVisitors - Use rt:activeUsers instead.

This release includes the addition and renaming of dimensions and metrics. Review the Dimensions and Metrics Reference for the complete list of definitions.

New Dimensions and Metrics

The following dimensions have been added to the Core Reporting API:

AdWords

  • Dimension - ga:isTrueViewVideoAd - Yes or No - Indicates whether the ad is an AdWords TrueView video ad.

Time

  • Dimension - ga:nthHour - Index for each hour in the specified date range. Index for the first hour of first day (i.e., start-date) in the date range is 0, 1 for the next hour, and so on.

Renamed Dimensions and Metrics

All visitor and visit based dimensions and metrics have been renamed to instead use user and session respectively.

The following dimensions and metrics have been renamed. Review the Data Deprecation Policy for details on data renaming:

Audience

  • Dimension - ga:visitorAgeBracket - Use ga:userAgeBracket instead.
  • Dimension - ga:visitorGender - Use ga:userGender instead.

Ecommerce

  • Metric - ga:transactionRevenuePerVisit - Use ga:transactionRevenuePerSession instead.
  • Metric - ga:transactionsPerVisit - Use ga:transactionsPerSession instead.

Event Tracking

  • Metric - ga:eventsPerVisitWithEvent - Use ga:eventsPerSessionWithEvent instead.
  • Metric - ga:visitsWithEvent - Use ga:sessionsWithEvent instead.

Goal Conversions

  • Metric - ga:goalValuePerVisit - Use ga:goalValuePerSession instead.
  • Metric - ga:percentVisitsWithSearch - Use ga:percentSessionsWithSearch instead.
  • Metric - ga:searchVisits - Use ga:searchSessions instead.

Page Tracking

  • Metric - ga:pageviewsPerVisit - Use ga:pageviewsPerSession instead.

Session

  • Dimension - ga:visitLength - Use ga:sessionDurationBucket instead.
  • Metric - ga:avgTimeOnSite - Use ga:avgSessionDuration instead.
  • Metric - ga:timeOnSite - Use ga:sessionDuration instead.
  • Metric - ga:visitBounceRate - Use ga:bounceRate instead.
  • Metric - ga:visits - Use ga:sessions instead.

Social Interactions

  • Dimension - ga:socialInteractionNetworkActionVisit - Use ga:socialInteractionNetworkActionSession instead.
  • Metric - ga:socialInteractionsPerVisit - Use ga:socialInteractionsPerSession instead.

User

  • Dimension - ga:daysSinceLastVisit - Use ga:daysSinceLastSession instead.
  • Dimension - ga:visitCount - Use ga:sessionCount instead.
  • Dimension - ga:visitorType - Use ga:userType instead.
  • Dimension - ga:visitsToTransaction - Use ga:sessionsToTransaction instead.
  • Metric - ga:newVisits - Use ga:newUsers instead.
  • Metric - ga:percentNewVisits - Use ga:percentNewSessions instead.
  • Metric - ga:visitors - Use ga:users instead.

Segments: Core Reporting API v2.4 & v3.0

New segments support in the Core Reporting API.

  • The segment parameter now supports user and sequence segments. User level and session level segments created in the web interface can be queried with the segment parameter.
  • A new syntax for dynamic segments is available to use with the segment parameter. For details see the Segments Dev Guide
  • The dynamic:: prefix has been deprecated. It is recommended that you migrate to the new syntax as soon as possible.

ga: Prefix Deprecated

The ga: prefix has been deprecated for all Real Time Dimensions and Metrics and has been replaced by the new rt: prefix. API requests that use the ga: prefix will continue to work for 6 months, after which an error will be returned.

New Dimensions and Metrics

This update adds new dimensions and metrics to the Real Time Reporting API. Check the Dimensions and Metrics Reference for the complete list.

Event Tracking

  • Dimension - rt:eventAction - the action of the event.
  • Dimension - rt:eventCategory - the category of the event.
  • Dimension - rt:eventLabel - the label of the event.
  • Dimension - rt:totalEvents - the total number of events for the profile, across all categories.

Goal Tracking

  • Dimension - rt:goalId - a string corresponding to the goal ID.
  • Metric - rt:goalXXValue - the total numeric value for the requested goal number, where XX is a number between 1 and 20.
  • Metric - rt:goalValueAll - the total numeric value for all goals defined for your profile.
  • Metric - rt:goalXXCompletions - the total number of completions for the requested goal number, where XX is a number between 1 and 20.
  • Metric - rt:goalCompletionsAll - the total number of completions for all goals defined for your profile.

Page Tracking

  • Metric - rt:pageViews - the total number of page views.

App Tracking

  • Metric - rt:screenViews - the total number of screen views.

This release adds new dimensions and metrics to the API. Check the Dimensions and Metrics Reference for the complete list of definitions.

Conversion Paths

  • Dimension - mcf:adwordsCustomerIDPath - Sequence of AdWords customer ID along conversion paths.

Interactions

  • Dimension - mcf:adwordsCustomerID - Corresponds to AdWords API Customer.id.

This release adds new dimensions and metrics to the API. Check the Dimensions and Metrics Reference for the complete list of definitions.

Conversion Paths

  • Dimension - mcf:adwordsAdGroupIDPath - Sequence of AdWords ad group ID along conversion paths.
  • Dimension - mcf:adwordsCampaignIDPath - Sequence of AdWords campaign ID along conversion paths.
  • Dimension - mcf:adwordsCreativeIDPath - Sequence of AdWords creative ID along conversion paths.
  • Dimension - mcf:adwordsCriteriaIDPath - Sequence of AdWords criteria ID along conversion paths.

Interactions

  • Dimension - mcf:adwordsAdGroupID - Corresponds to AdWords API AdGroup.id.
  • Dimension - mcf:adwordsCampaignID - Corresponds to AdWords API Campaign.id.
  • Dimension - mcf:adwordsCreativeID - Corresponds to AdWords API Ad.id.
  • Dimension - mcf:adwordsCriteriaID - Corresponds to AdWords API Criterion.id.

This release includes a new Data Table response format and the addition and deprecation of dimensions and metrics (Review the Dimensions and Metrics Reference for the complete list of definitions).

Data Table Output

To make it easier to render your Google Analytics data using Google Charts visualizations, the API can optionally return a Data Table object in the response.

  • An optional output query parameter has been added to the API. It can be used to select the output format of Analytics data in the response, which is JSON by default. If set to datatable, a dataTable property that contains a Data Table object is included in the response. This object can be used directly with Google Charts. See the Core Reporting API reference for details.

New Dimensions and Metrics

The following dimensions and metrics have been added to the Core Reporting API:

Time

  • Dimension - ga:minute - Returns the minute in the hour. The possible values are between 00 and 59.
  • Dimension - ga:nthMinute - Index for each minute in the specified date range. Index for the first minute of first day (i.e., start-date) in the date range is 0, 1 for the next minute, and so on.

Audience

  • Dimension - ga:visitorAgeBracket - Age bracket of visitor.
  • Dimension - ga:visitorGender - Gender of visitor.
  • Dimension - ga:interestAffinityCategory - Indicates that users are more likely to be interested in learning about the specified category.
  • Dimension - ga:interestInMarketCategory - Indicates that users are more likely to be ready to purchase products or services in the specified category.
  • Dimension - ga:interestOtherCategory - Indicates that users are more likely to be interested in learning about the specified category, and more likely to be ready to purchase.

Dimensions and Metrics Allowed In Segments

These dimensions and metrics can now be used in segments:

  • Dimension - ga:sourceMedium - Combined values of ga:source and ga:medium.
  • Metric - ga:localItemRevenue - Product revenue in local currency.

Deprecated Dimensions and Metrics

These dimensions and metrics have been deprecated. Review the Data Deprecation Policy for details on data removal:

  • Dimension - ga:isMobile - Use ga:deviceCategory instead (e.g., ga:deviceCategory==mobile).
  • Dimension - ga:isTablet - Use ga:deviceCategory instead (e.g., ga:deviceCategory==tablet).
  • Metric - ga:entranceBounceRate - Use ga:visitBounceRate instead.

This release adds new dimensions and metrics to the API. Check the Dimensions and Metrics Reference for the complete list of definitions.

Adsense

  • Access to Adsense data has been added:

    • Met - ga:adsenseRevenue - The total revenue from AdSense ads.
    • Met - ga:adsenseAdUnitsViewed - The number of AdSense ad units viewed. An Ad unit is a set of ads displayed as a result of one piece of the AdSense ad code. Details: https://support.google.com/adsense/answer/32715.
    • Met - ga:adsenseAdsViewed - The number of AdSense ads viewed. Multiple ads can be displayed within an Ad Unit.
    • Met - ga:adsenseAdsClicks - The number of times AdSense ads on your site were clicked.
    • Met - ga:adsensePageImpressions - The number of pageviews during which an AdSense ad was displayed. A page impression can have multiple Ad Units.
    • Met - ga:adsenseCTR - The percentage of page impressions that resulted in a click on an AdSense ad. (ga:adsenseAdsClicks/ga:adsensePageImpressions)
    • Met - ga:adsenseECPM - The estimated cost per thousand page impressions. It is your AdSense Revenue per 1000 page impressions. (ga:adsenseRevenue/(ga:adsensePageImpressions/1000).
    • Met - ga:adsenseExits - The number of sessions that ended due to a user clicking on an AdSense ad.

Time

  • Dim - ga:isoYear - The ISO year of the visit. Details: http://en.wikipedia.org/wiki/ISO_week_date. ga:isoYear should only be used with ga:isoWeek since ga:week represents gregorian calendar.
  • Dim - ga:isoYearIsoWeek - Combined values of ga:isoYear and ga:isoWeek.

Adwords

New Sample Size Control and Relative Dates Features

Relative Dates
  • Support for relative dates has been added to the MCF Reporting API. today, yesterday, and NdaysAgo are now valid values for the start-date and end-date query parameters.
  • Using these values will automatically determine the date range based on the current date at the time the query is made, and on the timezone of the view (profile) specified in the query. See the API Reference for additional details.
Sampling Level
  • A new parameter, samplingLevel, has been introduced that allows you to set the sampling level (i.e. the number of visits used to calculate the result) for a reporting query. Allowed values are: DEFAULT, FASTER, and HIGHER_PRECISION.
  • 2 new fields have been added to the API Response: sampleSize and sampleSpace. You can use these values to calculate the percentage of visits that were used for a sampled response.
  • See the API Reference and Sampling for additional details.

New Sample Size Control and Relative Dates Features

Relative Dates
  • Support for relative dates has been added to the Core Reporting API. today, yesterday, and NdaysAgo are now valid values for the start-date and end-date query parameters.
  • Using these values will automatically determine the date range based on the current date at the time the query is made, and on the timezone of the view (profile) specified in the query. See the API Reference for additional details.
Sampling Level
  • A new parameter, samplingLevel, has been introduced that allows you to set the sampling level (i.e. the number of visits used to calculate the result) for a reporting query. Allowed values are: DEFAULT, FASTER, and HIGHER_PRECISION.
  • 2 new fields have been added to the API Response: sampleSize and sampleSpace. You can use these values to calculate the percentage of visits that were used for a sampled response.
  • See the API Reference and Sampling for additional details.

This is the initial release of the Metadata API:

  • The Metadata API returns information about the dimensions and metrics exposed in Google Analytics reporting APIs. The metadata returned includes attributes like UI name, description, advanced segments support, and more. By using the Metadata API, your applications can automatically stay up to date with the latest data on the dimensions and metrics available for reporting queries. Visit the Metadata API Overview for more details.

This is the initial release of the Real Time Reporting API in limited beta:

  • The Real Time Reporting API allows you to report on activity occurring on your property right now. You can use the Real Time reporting API to query for dimensions and metrics in order to build customer facing web widgets and dashboards. Visit the Real Time Reporting API Overview for more details.

Bug Fixes

  • The ga:adwordsCustomerID now correctly returns the 10-digit AdWords Customer ID corresponding to the AdWords API AccountInfo.customerId. This fix makes it possible to join Analytics data with multiple AdWords accounts.

As part of the new segments launch, we will be rolling out the following changes to the Core Reporting API.

  • The segment parameter now supports the new alphanumeric ID for custom advanced segments, which is returned in the Management API Segments collection.
  • The current numeric IDs for custom segments are now under deprecation. These legacy IDs will continue to be supported for 6 months. We recommend applications that save user segment IDs to switch to the new alphanumeric IDs. Once the deprecation period is over, any queries with the old numeric IDs will return an error.
  • Currently, only the visit level segments created in the web interface will be queryable through the segment parameter.
  • The existing default segments with negative numeric IDs will not be affected. However, the new default segments are currently not supported.

This release adds new dimensions and metrics to the API. Check the Dimensions and Metrics Reference for the complete list of definitions.

App Tracking

  • This data is found in App profile reports:
    • Dim - ga:appId - The id of the application.
    • Dim - ga:appInstallerId - ID of the installer (e.g., Google Play Store) from which the app was downloaded. By default, the app installer id is set based on the PackageManager#getInstallerPackageName method.
    • Dim - ga:appName - The name of the application.
    • Dim - ga:appVersion - The version of the application.
    • Dim - ga:exitScreenName - The name of the screen when the user exited the application.
    • Dim - ga:landingScreenName - The name of the first screen viewed.
    • Dim - ga:screenDepth - The number of screenviews per session reported as a string. Can be useful for historgrams.
    • Dim - ga:screenName - The name of the screen.
    • Met - ga:avgScreenviewDuration - The average amount of time users spent on a screen in seconds.
    • Met - ga:timeOnScreen - The time spent viewing the current screen.
    • Met - ga:screenviews - The total number of screen views. Use this instead of ga:appviews.
    • Met - ga:uniqueScreenviews - The number of different (unique) ga:screenviews within a session. Use this instead of ga:uniqueAppviews.
    • Met - ga:screenviewsPerSession - The average number of ga:screenviews per session. Use this instead of ga:appviewsPerVisit.

Deprecated

The following metrics have been deprecated. Use the new metric name instead.

  • Met - ga:appviews - Use ga:screenviews instead.
  • Met - ga:uniqueAppviews - Use ga:uniqueScreenviews instead.
  • Met - ga:appviewsPerVisit - Use ga:screenviewsPerSession instead.

Custom Variables or Columns

  • Access to custom dimension and metrics:

    • Dim - ga:dimensionXX - The name of the requested custom dimension, where XX refers the number/index of the custom dimension.
    • Met - ga:metricXX - The name of the requested custom metric, where XX refers the number/index of the custom metric.

Documentation Changes

The following Custom Variable dimension and metric have been renamed. This is a documentation change only, it will not require you to update your queries.

  • ga:customVarName(n)ga:customVarNameXX
  • ga:customVarValue(n)ga:customVarValueXX

Ecommerce

  • Dim - ga:currencyCode - The local currency code of the transaction based on ISO 4217 standard.
  • Met - ga:localItemRevenue - Product revenue in local currency.
  • Met - ga:localTransactionRevenue - Transaction revenue in local currency.
  • Met - ga:localTransactionShipping - Transaction shipping cost in local currency.
  • Met - ga:localTransactionTax - Transaction tax in local currency.

Exceptions

  • This data comes from exception tracking.
    • Dim - ga:exceptionDescription - The description for the exception.
    • Met - ga:exceptionsPerScreenview - The number of exceptions thrown divided by the number of screenviews.
    • Met - ga:fatalExceptionsPerScreenview - The number of fatal exceptions thrown divided by the number of screenviews.

Goal Conversions

  • Dim - ga:goalCompletionLocation - The page path or screen name that matched any destination type goal completion.
  • Dim - ga:goalPreviousStep1 - The page path or screen name that matched any destination type goal, one step prior to the goal completion location.
  • Dim - ga:goalPreviousStep2 - The page path or screen name that matched any destination type goal, two steps prior to the goal completion location.
  • Dim - ga:goalPreviousStep3 - The page path or screen name that matched any destination type goal, three steps prior to the goal completion location.

Documentation Changes

The following Goal Conversions dimension and metrics have been renamed. This is a documentation change only, it will not require you to update your queries.

  • ga:goal(n)AbandonRatega:goalXXAbandonRate
  • ga:goal(n)Abandonsga:goalXXAbandons
  • ga:goal(n)Completionsga:goalXXCompletions
  • ga:goal(n)ConversionRatega:goalXXConversionRate
  • ga:goal(n)Startsga:goalXXStarts
  • ga:goal(n)Valuega:goalXXValue
  • ga:searchGoal(n)ConversionRatega:searchGoalXXConversionRate
  • Met - ga:percentSearchRefinements - The percentage of number of times a refinement (i.e., transition) occurs between internal search keywords within a session.

Page Tracking

  • Met - ga:pageValue - The average value of this page or set of pages. Page Value is ((Transaction Revenue + Total Goal Value) divided by Unique Pageviews for the page or set of pages).

Platform or Device

  • This data is derived from the HTTP User-Agent string.

    • Dim - ga:deviceCategory - The type of device: Desktop, Tablet, or Mobile.
    • Dim - ga:isTablet - Indicates tablet visitors. The possible values are Yes or No.
    • Dim - ga:mobileDeviceMarketingName - Marketing name used for mobile device.

Social Interactions

  • This data comes from onsite social interaction tracking.

    • Dim - ga:socialEngagementType - Engagement type. Possible values are Socially Engaged or Not Socially Engaged.

Time

  • Dim - ga:dateHour - Combined values of ga:date and ga:hour.
  • Dim - ga:dayOfWeekName - The name of the day of the week (in English).
  • Dim - ga:isoWeek - The ISO week number, where each week starts with a Monday. Details: http://en.wikipedia.org/wiki/ISO_week_date.
  • Dim - ga:yearMonth - Combined values of ga:year and ga:month.
  • Dim - ga:yearWeek - Combined values of ga:year and ga:week.

Traffic Sources

  • Dim - ga:fullReferrer - The full referring URL including the hostname and path.
  • Dim - ga:sourceMedium - The combined values of ga:source and ga:medium.
  • This release adds 5 new site speed metrics:
    • ga:domInteractiveTime
    • ga:avgDomInteractiveTime
    • ga:domContentLoadedTime
    • ga:avgDomContentLoadedTime
    • ga:domLatencyMetricsSample
  • This release adds a new default segment for Tablet Traffic, gaid::-13.

This release adds new dimensions and metrics to the API. Check the Dimensions and Metrics Reference for definitions.

App Tracking

  • This data is found in Mobile App tracking SDK reports:
    • Met - ga:uniqueAppviews - The number of app views per session.
    • Met - 'ga:appviews - The total number of app views.
    • Met - ga:appviewsPerVisit - The average number of app views per session.

Traffic Sources

  • Dim - ga:socialNetwork - A string representing the social network name. This can be related to the referring social network for traffic sources, or to the social network for social data hub activities. E.g. Google+, Blogger, reddit, etc.
  • Dim - ga:hasSocialSourceReferral - Indicates visits that arrived to the site from a social source (i.e. A social network such as Google+, Facebook, Twitter, etc.). The possible values are Yes or No, where the first letter must be capitalized.

Social Activities

  • This data comes from offsite activity imported from Social Data Hub partners.
    • Dim - ga:socialActivityDisplayName - For a social data hub activity, this string represents the title of the social activity posted by the social network user.
    • Dim - ga:socialActivityEndorsingUrl - For a social data hub activity, this string represents the URL of the social activity (e.g. the Google+ post URL, the blog comment URL, etc.)
    • Dim - ga:socialActivityPost - For a social data hub activity, this string represents the content of the social activity posted by the social network user (e.g. The message content of a Google+ post)
    • Dim - ga:socialActivityTimestamp - For a social data hub activity, this string represents when the social activity occurred on the social network.
    • Dim - ga:socialActivityUserPhotoUrl - For a social data hub activity, this string represents the URL of the photo associated with the user’s social network profile.
    • Dim - ga:socialActivityUserProfileUrl - For a social data hub activity, this string represents the URL of the associated user’s social network profile.
    • Dim - ga:socialActivityContentUrl - For a social data hub activity, this string represents the URL shared by the associated social network user.
    • Dim - ga:socialActivityTagsSummary - For a social data hub activity, this is a comma-separated set of tags associated with the social activity.
    • Dim - ga:socialActivityUserHandle - For a social data hub activity, this string represents the social network handle (i.e. name) of the user who initiated the social activity.
    • Dim - ga:socialActivityAction - For a social data hub activity, this string represents the type of social action associated with the activity (e.g. vote, comment, +1, etc.).
    • Dim - ga:socialActivityNetworkAction - For a social data hub activity, this string represents the type of social action and the social network where the activity originated.
    • Met - ga:socialActivities - The count of activities where a content URL was shared/mentioned on a social data hub partner network.

Social Interactions

  • This data comes from onsite social interaction tracking.
    • Dim - ga:socialInteractionAction - For social interactions, a string representing the social action being tracked (e.g. +1, like, bookmark)
    • Dim - ga:socialInteractionNetwork - For social interactions, a string representing the social network being tracked (e.g. Google, Facebook, Twitter, LinkedIn)
    • Dim - ga:socialInteractionNetworkAction - For social interactions, a string representing the concatenation of the ga:socialInteractionNetwork and ga:socialInteractionAction being tracked (e.g. Google: +1, Facebook: like)
    • Dim - ga:socialInteractionTarget - For social interactions, a string representing the URL (or resource) which receives the social network action.
    • Met - ga:socialInteractions - The total number of social interactions on your site.
    • Met - ga:uniqueSocialInteractions - The total number of unique social interactions on your site. Based on the value pair ga:socialInteractionNetwork and ga:socialInteractionAction
    • Met - ga:socialInteractionsPerVisit - ga:socialInteractions / ga:uniqueSocialInteractions. The average number of social interactions per visit to your site.

Geo / Network

  • Dim - ga:metro - The Designated Market Area (DMA) from where traffic originated.

Page Tracking

  • Dim - ga:pagePathLevel1 - This dimension rolls up all the pagePaths in the first hierarchical level in pagePath.
  • Dim - ga:pagePathLevel2 - This dimension rolls up all the pagePaths in the second hierarchical level in pagePath.
  • Dim - ga:pagePathLevel3 - This dimension rolls up all the pagePaths in the third hierarchical level in pagePath.
  • Dim - ga:pagePathLevel4 - This dimension rolls up all the pagePaths in the fourth hierarchical level in pagePath. All the additional levels in the pagePath hierarchy are also rolled up in this dimension.

Exception Tracking

  • This data come from exception tracking data.

    • Met - ga:exceptions - The number of exceptions that were sent to Google Analytics.
    • Met - ga:fatalExceptions - The number of exceptions where isFatal is set to true.

User Timings

  • This data comes from user timing data.

    • Dim - ga:userTimingCategory - A string for categorizing all user timing variables into logical groups for easier reporting purposes.
    • Dim - ga:userTimingLabel - A string to indicate the name of the action of the resource being tracked.
    • Dim - ga:userTimingVariable - A string that can be used to add flexibility in visualizing user timings in the reports.
    • Dim - ga:userTimingValue The number of milliseconds in elapsed time sent to Google Analytics.
    • Met - ga:userTimingSample - The number of samples that were sent.
    • Met - ga:avgUserTimingValue - The average user timing value. ga:userTimiingValue / ga:userTimiingSample.

Device / Platform

  • This data comes from the user agent of the collected data.
    • Dim - ga:mobileDeviceBranding - Mobile manufacturer or branded name (examples: Samsung, HTC, Verizon, T-Mobile).
    • Dim - ga:mobileDeviceModel - Mobile device model (example: Nexus S)
    • Dim - ga:mobileInputSelector - Selector used on the mobile device (examples: touchscreen, joystick, click-wheel, stylus)
    • Dim - ga:mobileDeviceInfo - The branding, model, and marketing name used to identify the mobile device.

This is the initial release of the Multi-Channel Funnels Reporting API:

  • This new 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 visits prior to converting. This allows you to analyze how multiple marketing channels influence conversions over time. For more details on what data is available and how to use the API see Multi-Channel Funnels Reporting API.

Bug Fixes

  • The API now correctly handles UTF-8 characters in a filter or dynamic segment.

This release enables Google Analytics premium accounts to access up to 50 custom variables.

This release fixes 2 bugs:

Bug Fixes

  • Query filters that contain special characters inside regular expressions no longer return server errors.

  • Combining a metric filter with an advanced segment no longer returns an error.

This release add new site speed metrics to the API.

New Metrics

  • The following site speed metrics have been added:
    • ga:speedMetricsSample
    • ga:domainLookupTime
    • ga:pageDownloadTime
    • ga:redirectionTime
    • ga:serverConnectionTime
    • ga:serverResponseTime
    • ga:avgDomainLookupTime
    • ga:avgPageDownloadTime
    • ga:avgRedirectionTime
    • ga:avgServerConnectionTime
    • ga:avgServerResponseTime

Check the Dimensions and Metrics Reference for definitions.

API Version 2.3 Deprecation Reminder

  • Version 2.3 of the Data Export API has been depreacted for 2 months. In roughly 4 more months we will shut down this service and only support the new Core Reporting API version 3.0 and version 2.4.

  • We highly recommend you migrate your applications to version 3.0.

  • In 4 months requests to the legacy version 2.3 XML data feed will be forwarded to version 2.4 and return a version 2.4 XML response. At that point, all version 2.4 quota policies will apply to the version 2.3 requests.

  • All requests for version 2.3 JSON or the Google Data JavaScript client library that uses version 2.3 JSON output, will return 404 status codes.

  • To get full quota, both version 3.0 and version 2.4 require you to register your application in the Google APIs Console and use an API key (or OAuth 2.0 token) in each request.

We fixed a small bug with ga:visitLength. This dimension now returns correct data.

This release effects all Google Analytics API developers. It announces two new versions of the API, requires applications to register, introduces a new quota policy, and it changes the API name to the Core Reporting API. Finally it deprecates the existing Data Export API version 2.3.

Version 3.0

  • The Core Reporting API version 3.0 is the latest major version of our API and is not backwards compatible. All future development of the API will be done on this version.

  • New Features

    • New JSON based output reduces the size of the response ~10x from the previous XML output.
    • New Google API client libraries that support Java, JavaScript, Python, PHP, Ruby, and .Net.
    • Support for the Google Discovery API.
    • Support for OAuth 2.0 as the new, recommended way to authorize users.
  • Updates

    • New URL to make requests: https://www.googleapis.com/analytics/v3/data/ga….
    • Registration and developers tokens required.
    • All requests for configuration data should be done through the Management API.

Version 2.4

  • The Core Reporting API version 2.4 is a minor version upgrade that is mostly backwards compatible with the existing Data Export API version 2.3.

  • Updates

    • New URL to make requests: https://www.googleapis.com/analytics/v2.4/data…
    • Registration and developers tokens required.
    • XML output consistent with version 2.3, so the other existing Google Data client libraries will continue to work.
    • Error code for quota errors have changed from 503 to 403
    • JSON responses are not supported.
    • Google Data JavaScript client library not supported.
    • No Account Feed. All requests for configuration data should be done through the Management API.

Registration

  • All applications built using the Google Analytics API must be registered as a project through the Google APIs Console.

  • Each request to the API must include either a API key or for OAuth 2.0, a Client Id and Client Secret.

Quota Policy

  • The following quota applies to both Anlaytics APIs (Management API and Data Export API)

    • 50,000 requests per project per day
    • 10 queries per second (QPS) per IP address
  • The following quota applies to the Data Export API

    • 10,000 requests per profile per day
    • 10 concurrent requests per profile
  • For unregistered applications, we provide a very low grace quota to accommodate a small amount of testing.

Deprecations

  • This release also announces the deprecation of Version 2.3 and the upcoming shut down of the Account Feed in the Data Export API. In 6 months:

    • Requests to the version 2.3 XML data feed will be forwarded to version 2.4 and return a version 2.4 response. At that point, all version 2.4 quota policies will apply to the version 2.3 requests.

    • Requests to the version 2.3 JSON output will not be supported by the version 2.4 response and will return 404 Not Found status codes. If you need a JSON response, upgrade to Version 3.0.

    • Requests to the Account Feed in the Data Export API will return 404 Not Found status codes. All requests for configuration data should be done through the Management API.

This release adds fresher AdWords data and more combinations for AdWords dimensions and metrics.

  • AdWords data is now updated within an hour. Before the data was updated daily.

  • We’ve relaxed a number valid combinations restrictions with AdWords data.

A few weeks ago we made a change to disallow API queries that asked for ga:adGroup or ga:adContent with ga:impressions, since this combination returned 0. With this change, this combination is now back and has been fixed to return correct data.

This release fixes some invalid combinations of dimensions and metrics

Fixed invalid metrics/dimensions combinations

  • Last month we announced some upcoming changes to the API to disallow some invalid queries in the data feed that do not return any data. We have now made those changes to the API, and the following combinations are now invalid:

    • Product dimensions cannot be combined with transaction metrics.
    • ga:adContent or ga:adGroup cannot be combined with ga:impressions.

    Instead of returning a response with 0 results, the API now returns 400 error code for all queries that ask for these combinations.

This release deprecates the confidence interval value in metrics.

Deprecation of Confidence Interval

  • If you haven’t already done so, please stop using confidence interval values for metrics. With this release, the Data Export API Data Feed returns 0.0 for all the confidence interval values. In a month or so, we will we will completely remove this attribute from all metric elements.

    To determine if a response has been sampled, please use the containsSampledData field in the response.

This release adds 3 new metrics and updates the return value of two.

New Data Updates

  • We added 3 new metrics dealing with site speed performance to the API:
    • ga:pageLoadSample
    • ga:pageLoadTime
    • ga:avgPageLoadTime

Metric Updates

  • To specify currency values in filters, you must specify the actual value passed in from the tracking code, (e.g. 1 unit will now be specified as 1).

  • ga:CTR now returns the actual percent (e.g. a value of 2% is returned as 2).

This release improves improves Data Feed performance and adds new data:

Performance Improvement

  • This release improves data feed latency by 30 to 35%.

New Data Updates

  • We have updated the list of dimensions and metrics that are allowed in Advanced Segments. Please refer to the updated list to make sure that your requests are valid.

Upcoming Changes

  • Currently, you need to specify a currency filter value as micro units, (e.g 1 unit of currency is specified as 1000000). In the near future, you will need to specify the actual value passed in from the tracking code, (e.g. 1 unit will now be specified as 1).

  • Currently, ga:CTR is a percent and returns the value 0.02. In the near future this will change to return the actual percent (e.g. 2).

This release adds more data to the Data Feed:

New Data Updates

  • The following Time dimension has been added: ga:dayOfWeek

  • The following Internal Search metric has been added: ga:percentVisitsWithSearch

  • The following Event Tracking metrics have been added:

    • ga:visitsWithEvent
    • ga:eventsPerVisitWithEvent

Upcoming Changes

Currently the API returns 401 status codes for for various authorization issues. Within the next couple of weeks, the 401 status will be used exclusively for invalid tokens, giving developers a way to error handle this particular exception.

This release adds significantly more data to the Data Feed:

New Data Updates

  • The calculation of ga:visitors has been changed to return the number of unique visitors across the date range and now supports more dimension and metric combinations.

  • 10 new AdWords dimensions have been added: ga:adDistributionNetwork, ga:adMatchType, ga:adMatchedQuery, ga:adPlacementDomain, ga:adPlacementUrl, ga:adFormat, ga:adTargetingType, ga:adTargetingOption, ga:adDisplayUrl, ga:adDestinationUrl.

  • The metric ga:organicSearches has been added to the campaign group.

  • The metric ga:searchResultViews has been added to the internal site search group.

  • 3 new time-based dimensions have been added: ga:nthDay, ga:nthWeek, ga:nthMonth.

  • The groupings of dimensions and metrics have been changed to better reflect the features they represent.

New Calculated Metrics

The following calculated metrics are derived from calculations using the base metrics. Note: Each name with (n) supports values 1-20.

  • Goal Based: ga:costPerConversion, ga:costPerGoalConversion, ga:costPerTransaction, ga:goal(n)AbandonRate, ga:goal(n)Abandons, ga:goal(n)ConversionRate, ga:goalAbandonRateAll, ga:goalAbandonsAll, ga:goalConversionRateAll, ga:goalValueAllPerSearch, ga:goalValuePerVisit.

  • Content Based: ga:entranceBounceRate, ga:visitBounceRate, ga:entranceRate, ga:exitRate, ga:pageviewsPerVisit, ga:avgTimeOnPage, ga:avgTimeOnSite, ga:avgEventValue.

  • Internal Site Search Based: ga:avgSearchDepth, ga:avgSearchDuration, ga:avgSearchResultViews, ga:searchGoalConversionRateAll, ga:searchGoal(n)ConversionRate, ga:searchExitRate.

  • Ecommerce Based: ga:itemsPerPurchase, ga:margin, ga:percentNewVisits, ga:revenuePerItem, ga:revenuePerTransaction, ga:ROI, ga:RPC, ga:totalValue, ga:transactionRevenuePerVisit, ga:transactionsPerVisit.

This release adds a new feature to the Data Feed:

New Features

  • A new XML element has been added lets users know if the data has been sampled. true. This element will always return whether the data was sampled or not with either true or false. The Java and JavaScript libraries have also been updated with helper methods to access this element.

This release fixes 2 bugs:

Bug Fixes

  • Previously adding an OR operator to a filter expression with a dimension (i.e., ga:keyword==store,ga:keyword==bar) could result in different values than if each filter was applied individually across multiple queries. This has been fixed and using the OR operator now returns consistent values.

  • Some of the API error messages for invalid filters have been updated to NOT include whether it was a dimension or metric filter that caused the error (though the actual offending filter expression will continue to be returned).

This release fixes 3 bugs:

Bug Fixes

  • An encoding issue in the JavaScript Client Library has been fixed. Analytics issue tracker

  • A bug that prevented the Account Feed to not return when a goal name, goal path, goal comparison value, or goal comparison type had been incorrectly set, has now been fixed.

  • It is invalid to OR a dimension and metric in the Data Feed query filter parameter. For example: ga:source==google,ga:visits>5. The error message for this invalid query has been updated to say: Cannot OR dimension filter(s) with metric filter.

This release adds new data and fixes a bug:

New Features

  • The following 5 dimensions have been added in the new category D8. Adwords:

    • ga:adwordsAdGroupId: corresponds to the AdWords API AdGroup.id
    • ga:adwordsCampaignId: corresponds to the AdWords API Campaign.id
    • ga:adwordsCreativeId: corresponds to the AdWords API Ad.id
    • ga:adwordsCriteriaId: corresponds to the AdWords API Criterion.id
    • ga:adwordsCustomerId: cooresponds to the AdWords API AccountInfo.customerId

Bug Fixes

  • We fixed an issue where the Account Feed would not return data if one of the profiles had a misconfigured goal or step.

This release adds a number of new features and fixes a bug:

New Features

  • The iPhone Default Segment (gaid::-11) has been enhanced to now report on all mobile devices. The ID is the same as before (-11), but the name of the segment is now: Mobile Traffic.

  • The sampling rate used by the API is now the same as the web interface. This brings the data for sampled reports inline with the web interface and increases consistency between the two.

  • The quota policy has been updated in an effort to ensure that all users receive equitable access to resources. Please refer to our quota policy documentation for more details. The new policy is:

    • A single web property may make a maximum of 10,000 requests per 24 hours.
    • An application can only make 10 requests in any given 1-second period.
    • An application can only have 4 pending requests at any given time.
  • Some restrictions on dimension and metric combinations have been relaxed. ga:nextPagePath and ga:previousPagePath are now part of the D3. Content group. The D8. Custom Variable group is now called the D6. Custom Variable group. Please see the updated reference guide for these new combinations.

Bug Fixes

  • We fixed a bug on how the API reports the confidenceInterval value for metrics. Previously confidence intervals could have a value of either INF or a number from 0 to 1. Now all confidence intervals will have a value of either INF or a number greater than or equal to 0.

  • ga:itemQuantity and ga:uniquePurchases were previously swapped and returned each other’s value. They are now fixed to return the correct data.

Deprecation of Dimensions and Metrics Reminder

  • If you haven’t done so already, please stop using the previously deprecated dimensions and metrics

This release adds a number of new features:

This release increments the major version number to 2

  • Some features require the use of the latest client libraries. We officially support: Java & Javascript. 3rd party libraries might not be updated yet.

    • Version 2 may be requested by adding the header GData-Version: 2 to each account or data feed request Read the documentation for more details.
    • A new XML namespace has been added to both account and data feeds:
      xmlns:ga='http://schemas.google.com/ga/2009'
  • The API now supports the Google Data protocol version 2.

Advanced segmentation support

  • Dynamic segments query parameter:

    • ...&segment=dynamic::expression
    • allows creation of advanced segments “on the fly.”
    • expression can be any dimension or metric and should follow the same syntax as filters.
  • Default and custom segments query parameter:

    • ...&segment=gaid::number
    • where number is an ID referencing an advanced segment defined in the Google Analytics Web Interface.
    • ID can be found in the account feed.
  • The account feed describes segment data through the following XML elements and attributes:

    • ga:visitorType==Returning Visitor
  • The data feed also provides an XML element indicating whether a segment was applied in the API request.

  • More details on advanced segments in our documentation.

New goal data available

  • Destination and engagement type goals available in the account feed:

  • 48 new goal metrics have been added for goals 5-20 which all follow the convention goal(n)Completions, where (n) is a number between 1 and 20.

    • ga:goal(n)Completions
    • ga:goal(n)Starts
    • ga:goal(n)Value
  • GoalCompletionAll, GoalStartsAll and GoalValueAll have been updated to account for the new goal data.

New custom variable data

  • All custom variables ever collected by each profile have been added as a new XML element to the account feed:

  • 10 new dimensions have been added for custom variables. They follow the convention customVar(n) where (n) can be a number between 1 and 5.

    • ga:customVarName(n)
    • ga:customVarValue(n)

Deprecated dimensions & metrics to be removed!

  • If you haven’t done so already, please stop using the previously deprecated dimensions and metrics. They will be removed soon and will return errors from our API if requested.

    • ga:countOfVisits
    • ga:countOfVisitsToATransaction
    • ga:sourceMedium
    • ga:percentNewVisits
  • The following dimensions have been renamed:

    • ga:countOfVisits is now ga:visitCount
    • ga:countOfVisitsToATransaction is now ga:visitsToTransaction

This release adds new features and deprecates some old functionality:

  • The following dimensions and metrics are now deprecated. We’ll be permanently removing them from our API in one month. Please make sure to update your code so your applications don’t break:

    • ga:countOfVisits
    • ga:countOfVisitsToATransaction
    • ga:sourceMedium
    • ga:percentNewVisits
  • The following Dimensions have been renamed:

    • ga:countOfVisits is now ga:visitCount
    • ga:countOfVisitsToATransaction is now ga:visitsToTransaction
  • All Event Tracking data is now exposed as 2 new groups:

    D7. Events (Dimensions) * ga:eventCategory * ga:eventAction * ga:eventLabel

    M7. Events (Metrics) * ga:eventValue * ga:totalEvents * ga:uniqueEvents

  • Overall site navigation data is is now exposed through the following dimensions:

    D6. Navigation * ga:previousPagePath * ga:nextPagePath

  • Landing page navigation is now exposed through the following dimensions:

    D3. Content * ga:landingPagePath * ga:secondPagePath

  • The maximum length of regular expressions in the Data Feed’s filter query parameter has been raised from 32 to 128 characters.

  • The Length of Visit report (found through the UI under Visitors -> Visitor Loyalty) is now exposed through the new dimension:

    • ga:visitLength

This release updates the Google Analytics Data Export API as follows:

  • Some restrictions on dimension and metric combinations have been relaxed. You can now query most content and visitor level dimensions together, for example ga:pagePath and ga:source is now a valid combination. Please see the updated reference guide for these new combinations: http://code.google.com/apis/analytics/docs/gdata/gdataReferenceValidCombos.html

  • The total number of rows that can be asked for in one request has been increased to 10,000. The default number of rows returned is still 1,000, but can now be increased by setting the max-results query parameter.

  • The Account Feed now returns two new data elements for each Table ID (currency and timezone).

  • We’re now enforcing that data queries must include at least one valid metric.

  • All previous deprecation changes have taken effect.

This release removes deprecated features from our private beta:

  • The account feed requests will no longer support a username in them. Instead, it will only accept requests in the following format:
    https://www.google.com/analytics/feeds/accounts/default

  • The following metrics are being removed and will no longer work. Instead, we have provided instructions on how to calculate these values here: http://code.google.com/apis/analytics/docs/gdata/gdataReferenceCommonCalculations.html

    • ga:avgPageDuration
    • ga:avgPageviews
    • ga:avgSessionTime
    • ga:bounceRate
    • ga:exitRate
    • ga:costPerConversion
    • ga:costPerGoalConversion
    • ga:costPerTransaction
    • ga:revenuePerClick
    • ga:revenuePerTransaction
    • ga:revenuePerVisit
    • ga:abandonedFunnels1
    • ga:abandonedFunnels2
    • ga:abandonedFunnels3
    • ga:abandonedFunnels4
    • ga:goalConversionRate
    • ga:goalConversionRate1
    • ga:goalConversionRate2
    • ga:goalConversionRate3
    • ga:goalConversionRate4
    • ga:goalValuePerVisit
  • The following dimensions and metrics have been renamed. The old names will no longer work. Please verify you are using the official names in our documentation here: http://code.google.com/apis/analytics/docs/gdata/gdataReferenceDimensionsMetrics.html

    Dimensions * ga:subContinentRegion ⇒ ga:subContinent * ga:organization ⇒ ga:networkLocation * ga:domain ⇒ ga:networkDomain * ga:visitNumber ⇒ ga:countOfVisits * ga:platform ⇒ ga:operatingSystem * ga:platformVersion ⇒ ga:operatingSystemVersion * ga:content ⇒ ga:adContent * ga:requestUri ⇒ ga:pagePath * ga:requestUri1 ⇒ ga:landingPagePath * ga:requestUriLast ⇒ ga:exitPagePath * ga:internalSearchNext ⇒ ga:searchKeywordRefinement * ga:internalSearchKeyword ⇒ ga:searchKeyword * ga:internalSearchType ⇒ ga:searchCategory * ga:hasInternalSearch ⇒ ga:searchUsed * ga:requestUriFrom ⇒ ga:searchStartPage * ga:requestUriTo ⇒ ga:searchDestinationPage * ga:productCode ⇒ ga:productSku

    Metrics * ga:newVisitors ⇒ ga:newVisits * ga:pageDuration ⇒ ga:timeOnPage * ga:visitDuration ⇒ ga:timeOnSite * ga:cost ⇒ ga:adCost * ga:clicks ⇒ ga:adClicks * ga:clickThroughRate ⇒ ga:CTR * ga:costPerClick ⇒ ga:CPC * ga:costPerMilleImpressions ⇒ ga:CPM * ga:searchTransitions ⇒ ga:searchRefinements * ga:uniqueInternalSearches ⇒ ga:searchUniques * ga:visitsWithSearches ⇒ ga:searchVisits * ga:productPurchases ⇒ ga:itemQuantity * ga:productRevenue ⇒ ga:itemRevenue * ga:products ⇒ ga:uniquePurchases * ga:revenue ⇒ ga:transactionRevenue * ga:shipping ⇒ ga:transactionShipping * ga:tax ⇒ ga:transactionTax * ga:goalCompletions1 ⇒ ga:goal1Completions * ga:goalCompletions2 ⇒ ga:goal2Completions * ga:goalCompletions3 ⇒ ga:goal3Completions * ga:goalCompletions4 ⇒ ga:goal4Completions * ga:goalStarts1 ⇒ ga:goal1Starts * ga:goalStarts2 ⇒ ga:goal2Starts * ga:goalStarts3 ⇒ ga:goal3Starts * ga:goalStarts4 ⇒ ga:goal4Starts * ga:goalValue1 ⇒ ga:goal1Value * ga:goalValue2 ⇒ ga:goal2Value * ga:goalValue3 ⇒ ga:goal3Value * ga:goalValue4 ⇒ ga:goal4Value