Changelog

For official Google Analytics API announcements, please subscribe to Google Analytics API Notify Group.

2022-05-05 Added Funnel reporting functionality to the Alpha channel.

  • runFunnelReport method added to the v1alpha version of the API, which returns a customized funnel report of your Google Analytics event data.

2022-02-16 Added new dimensions.

Manual term & content

  • firstUserManualAdContent First user manual ad content. The ad content that first acquired the user. Populated by the utm_content parameter.

  • firstUserManualTerm First user manual term. The term that first acquired the user. Populated by the utm_term parameter.

  • manualAdContent Manual ad content. The ad content attributed to the conversion event. Populated by the utm_content parameter.

  • manualTerm Manual term. The term attributed to the conversion event. Populated by the utm_term parameter.

  • sessionManualAdContent Session manual ad content. The ad content that led to a session. Populated by the utm_content parameter.

  • sessionManualTerm Session manual term. The term that led to a session. Populated by the utm_term parameter.

Crash analysis

  • crashAffectedUsers Crash-affected users. The number of users that logged a crash in this row of the report.

  • crashFreeUsersRate Crash-free users rate.

App/Web

  • averageSessionDuration The average duration (in seconds) of users' sessions.

  • newVsReturning New / returning users.

  • screenPageViewsPerSession Views per session.

  • landingPage Landing page. The page path + query string associated with the first pageview in a session.

  • platformDeviceCategory The platform and type of device on which your website or mobile app ran.

Mobile App

  • averagePurchaseRevenuePerUser Average purchase revenue per user.

  • firstTimePurchaserConversionRate The percentage of active users who made their first purchase.

  • firstTimePurchasersPerNewUser The average number of first time purchasers per new user.

  • dauPerMau DAU / MAU. The rolling percent of 30-day active users who are also 1-day active users.

  • dauPerWau DAU / WAU. The rolling percent of 7-day active users who are also 1-day active users.

  • wauPerMau WAU / MAU. The rolling percent of 30-day active users who are also 7-day active users.

  • purchaserConversionRate The percentage of active users who made 1 or more purchase transactions.

  • transactionsPerPurchaser Transactions per purchaser.

Google Ads campaign

  • firstUserGoogleAdsCampaignType The campaign type of the Google Ads campaign that first acquired the user.

  • googleAdsCampaignType The campaign type for the Google Ads campaign attributed to the conversion event.

  • sessionGoogleAdsCampaignType The campaign type for the Google Ads campaign that led to this session.

2021-09-07 Added new Date/time dimensions.

  • dateHourMinute The combined values of date, hour, and minute formatted as YYYYMMDDHHMM.

  • minute The two-digit minute of the hour that the event was logged.

  • nthMinute The number of minutes since the start of the date range.

2021-09-07 Added new dimensions populated by event parameters.

  • achievementId The achievement ID in a game for an event.

  • character The player character in a game for an event.

  • fileExtension The extension of the downloaded file.

  • fileName The page path of the downloaded file.

  • groupId The player group ID in a game for an event.

  • linkClasses The HTML class attribute for an outbound link.

  • linkDomain The destination domain of the outbound link.

  • linkId The HTML id attribute for an outbound link or file download.

  • linkText The link text of the file download.

  • linkUrl The full url for an outbound link or file download.

  • method The method by which an event was triggered.

  • outbound Returns 'true' if the link leads to a site is not a part of the property’s domain.

  • pageLocation The protocol, hostname, page path, and query string for web pages visited.

  • pageReferrer The full referring URL including the hostname and path.

  • percentScrolled The percentage down the page that the user has scrolled (for example, '90').

  • searchTerm The term searched by the user.

  • videoProvider The source of the video (for example, 'youtube').

  • videoTitle The title of the video.

  • videoUrl The url of the video.

  • visible Returns 'true' if the content is visible.

  • unifiedPagePathScreen The page path (web) or screen class (app) on which the event was logged.

2021-09-07 API schema changes.

Changes in existing dimensions:

  • unifiedPageScreen For web generated events, this dimension now returns the page path and query string on which the event was logged.

Upcoming changes announcement:

  • firstUserTrafficOrigin The traffic origin that first acquired the user. Please do not depend on this field returning 'Manual' for traffic that uses UTMs; this field will update from returning 'Manual' to returning '(not set)' for an upcoming feature launch.

  • sessionTrafficOrigin The traffic origin of the session's campaign. Please do not depend on this field returning 'Manual' for traffic that uses UTMs; this field will update from returning 'Manual' to returning '(not set)' for an upcoming feature launch.

  • trafficOrigin The traffic origin of the conversion event's campaign. Please do not depend on this field returning 'Manual' for traffic that uses UTMs; this field will update from returning 'Manual' to returning '(not set)' for an upcoming feature launch.

2021-09-07 checkCompatibility method added to the API.

checkCompatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility.

2021-07-21 Realtime reporting changes.

It is now possible to specify the minute ranges of event data to read using the minuteRanges parameter of the runRealtimeReport method.

2021-07-21 New channel grouping dimensions.

New channel grouping dimensions added to the Data API reporting schema:

  • firstUserDefaultChannelGrouping First user default channel grouping.

  • defaultChannelGrouping Default channel grouping.

2021-06-10 API schema changes.

  • minutesAgo dimension added to the Data API realtime schema and can be used in queries to the runRealtimeReport method. This dimension contains the number of minutes ago that an event was collected. 00 is the current minute, and 01 means the previous minute.

  • googleAdsCreativeId dimension added to the Data API schema. This dimension contains the ID of the Google Ads creative attributed to the conversion event.

  • sessionGoogleAdsCreativeId dimension added to the Data API schema. This dimension contains the ID of the Google Ads creative that lead to a session on your website or app.

  • firstUserCreativeId dimension renamed to firstUserGoogleAdsCreativeId in the Data API schema. This dimension contains the ID of the Google Ads creative that first acquired the user.

2021-04-09 The Google Analytics Data API v1 beta has been released.

  • The API endpoint updated to https://analyticsdata.googleapis.com/v1beta.

  • runReport, runPivotReport, batchRunReports, batchRunPivotReports methods now accept the id of a Google Analytics 4 property in the property parameter of the URL path instead of the entity field of a request body:

    POST https://analyticsdata.googleapis.com/v1beta/GA4_PROPERTY_ID:batchRunReports

  • API client libraries have been updated to use the new API endpoint.

2021-02-19 Pagination changes.

  • The default report response size increased from 10 to 10,000 rows of event data.

  • "limit" : -1 value that was used to indicate an attempt to retrieve all rows is no longer supported in RunReportRequest.

  • The maximum value of the limit field is set to 100000. Use pagination to retrieve reports containing more than 100,000 rows.

2021-02-08 New e-commerce dimensions and metrics.

New e-commerce dimensions and metrics have been added to the API schema:

Dimensions: adFormat, adSourceName, adUnitName, itemBrand, itemCategory, itemCategory2, itemCategory3, itemCategory4, itemCategory5 itemId, itemListId, itemListName, itemName, itemPromotionCreativeName, itemPromotionId, itemPromotionName, orderCoupon, transactionId.

Metrics: adUnitExposure, addToCarts, cartToViewRate, checkouts, ecommercePurchases, firstTimePurchasers, itemListClickThroughRate, itemListClicks, itemListViews, itemPromotionClickThroughRate, itemPromotionClicks, itemPromotionViews, itemPurchaseQuantity, itemRevenue, itemViews, publisherAdClicks, publisherAdImpressions, totalPurchasers.

2021-02-08 Added new campaign dimensions.

New campaign dimensions have been added to the API schema: campaignId, campaignName, googleAdsAccountName, googleAdsAdGroupId, googleAdsAdGroupName, googleAdsAdNetworkType, source, trafficOrigin

2021-02-08 dayOfWeek, week dimension changes.

  • The value of dayOfWeek dimension now starts with 0 instead of 1.

  • The value of week dimension now starts with 01 and returns a two-digit number from 01 to 53. Each week starts on Sunday. January 1st is always in week 01.

2021-01-28 Added aggregation variants for custom metrics.

Each custom metric that a property registers creates three API metric variants: a sum, an average, and a count.

2021-01-28 Added new Date/time dimensions.

The following new dimensions have been added to the API schema: hour, nthHour, nthYear, dateHour.

2021-01-28 The Data API reduced the quota tokens charged per query.

The Data API reduced the quota tokens charged per query. The quota limits for property quota tokens per hour and per day were not changed.

2020-11-09 The method getUniversalMetadata has been deleted.

The method getUniversalMetadata has been deleted. Please use getMetadata. The one year maximum date range per API request has been removed.

2020-11-02 Added a Realtime Reporting Method.

See the Creating a Realtime Report for examples and runRealtimeReport for the REST reference documentation.

2020-10-19 Client library artifacts updated.

Client library artifacts updated along with usage instructions and code samples.

2020-10-13 App + Web properties have been renamed to Google Analytics 4 (GA4).

2020-10-08 getMetadata method added to the API.

getMetadata method returns Custom dimensions and metrics available for the specified GA4 property ID, as well as Universal metadata.

2020-10-08 Custom dimensions and metrics are available in reports.

See the API schema documentation for documentation on custom dimensions and metrics. This update includes Event-scoped Custom Dimensions and metrics as well as User-scoped Custom Dimensions.