For official Google Analytics API announcements, please subscribe to Google Analytics API Notify Group.
2021-09-07 Added new Date/time dimensions.
dateHourMinuteThe combined values of date, hour, and minute formatted as YYYYMMDDHHMM.
minuteThe two-digit minute of the hour that the event was logged.
nthMinuteThe number of minutes since the start of the date range.
2021-09-07 Added new dimensions populated by event parameters.
achievementIdThe achievement ID in a game for an event.
characterThe player character in a game for an event.
fileExtensionThe extension of the downloaded file.
fileNameThe page path of the downloaded file.
groupIdThe player group ID in a game for an event.
linkClassesThe HTML class attribute for an outbound link.
linkDomainThe destination domain of the outbound link.
linkIdThe HTML id attribute for an outbound link or file download.
linkTextThe link text of the file download.
linkUrlThe full url for an outbound link or file download.
methodThe method by which an event was triggered.
outboundReturns 'true' if the link leads to a site is not a part of the property’s domain.
pageLocationThe protocol, hostname, page path, and query string for web pages visited.
pageReferrerThe full referring URL including the hostname and path.
percentScrolledThe percentage down the page that the user has scrolled (for example, '90').
searchTermThe term searched by the user.
videoProviderThe source of the video (for example, 'youtube').
videoTitleThe title of the video.
videoUrlThe url of the video.
visibleReturns 'true' if the content is visible.
unifiedPagePathScreenThe page path (web) or screen class (app) on which the event was logged.
2021-09-07 API schema changes.
Changes in existing dimensions:
unifiedPageScreenFor web generated events, this dimension now returns the page path and query string on which the event was logged.
Upcoming changes announcement:
firstUserTrafficOriginThe 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.
sessionTrafficOriginThe 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.
trafficOriginThe 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.
checkCompatibility method added to the API.
method lists dimensions and metrics that can be added to a report request and
2021-07-21 Realtime reporting changes.
2021-07-21 New channel grouping dimensions.
New channel grouping dimensions added to the Data API reporting schema:
firstUserDefaultChannelGroupingFirst user default channel grouping.
defaultChannelGroupingDefault channel grouping.
2021-06-10 API schema changes.
minutesAgodimension added to the Data API realtime schema and can be used in queries to the
runRealtimeReportmethod. This dimension contains the number of minutes ago that an event was collected. 00 is the current minute, and 01 means the previous minute.
googleAdsCreativeIddimension added to the Data API schema. This dimension contains the ID of the Google Ads creative attributed to the conversion event.
sessionGoogleAdsCreativeIddimension 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.
firstUserCreativeIddimension renamed to
firstUserGoogleAdsCreativeIdin 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
batchRunPivotReportsmethods now accept the id of a Google Analytics 4 property in the
propertyparameter of the URL path instead of the
entityfield of a request body:
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" : -1value that was used to indicate an attempt to retrieve all rows is no longer supported in RunReportRequest.
The maximum value of the
limitfield 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:
2021-02-08 Added new campaign dimensions.
New campaign dimensions have been added to the API schema:
week dimension changes.
The value of
dayOfWeekdimension now starts with 0 instead of 1.
The value of
weekdimension 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:
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.
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.
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).
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.