Changelog

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

  • 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.

  • 2020-10-08 getMetadata method added to the API. This method returns Custom dimensions and metrics available for the specified GA4 property ID, as well as Universal metadata.

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

  • 2020-10-19 Client library artifacts updated along with usage instructions and code samples.

  • 2020-11-02 Added a Realtime Reporting Method. See the Creating a Realtime Report for examples and runRealtimeReport for the REST reference documentation.

  • 2020-11-09 The method getUniversalMetadata has been deleted. Please use getMetadata. The one year maximum date range per API request has been removed.

  • 2021-01-28 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.

  • 2021-01-28 The following new dimensions have been added to the API schema: hour, nthHour, nthYear, dateHour.

  • 2021-01-28 Each custom metric that a property registers creates three API metric variants: a sum, an average, and a count.

  • 2021-02-08 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-02-08 New campaign dimensions have been added to the API schema: campaignId, campaignName, googleAdsAccountName, googleAdsAdGroupId, googleAdsAdGroupName, googleAdsAdNetworkType, source, trafficOrigin

  • 2021-02-08 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-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-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.