This page documents any changes made to Google Analytics Configuration APIs. It includes changelogs for the Provisioning API and Management 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 Management API and Provisioning API.
hashClientId method added to the Management API
User data retention settings in the Management API
It is now possible to programmatically configure the user data retention settings using new ‘dataRetentionTtl’ and ‘dataRetentionResetOnNewActivity’ fields added to the WebProperty resource.
This is the initial release of the User Deletion API:
- The User Deletion API allows a Google Analytics customer to delete data for a given end user from a project or web property. User Deletion requests can be made using either Firebase projects or Google Analytics properties. Visit the User Deletion API Overview for more details.
Write operations in the Management API
Write operations in the Management API (e.g. create, update, delete, patch) for Web Property, View (Profile), and Goal resources no longer require whitelisting. The default daily limit for all Write operations in the Management API is 50 writes/day. See Limits and Quotas page for more information.
Remarketing Audience - Optimize support
- Remarketing Audience: delete - deletes a remarketing audience.
This is a bug fix release; it fixes the issue where creating a Custom Metric of type
TIME failed when
min_value was not set. Requests without a
min_value now create a custom metric with a default
min_value of 0.
- UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
This release adds Remarketing Audiences to the Management API.
The Management API allows you to
patch remarketing audiences for a Google Analytics property. To learn more about how remarketing audiences work, see the About Remarketing Audiences in Analytics help center article.
Error rate limiting
It has always been our policy that developers should implement exponential backoff, when handling 500 or 503 responses. Today we are introducing a rate limit on 500 and 503 errors to enforce this policy.
- 50 failed write requests per hour.
The unsampled reports API no longer has a 100 reports per day limit. The API uses the same per-property, per-day token system as when creating an unsampled report through the web interface.
Unsampled reports that are not accessible to the current user will no longer have a download link inside the Management API response message. This behavior is now consistent with UI dashboard functionality where only report owners can see the download link for the generated document.
This release adds the
botFilteringEnabled property to the view (profile) resource. This property indicates whether bot filtering is enabled for a view (profile). See the View (Profiles) Reference docs for details.
This release add the
delete method to unsampled reports. See the Unsampled Reports Delete Reference docs for details.
This is a bug fix release. This release fixes an issue which would cause segments with currency values in the definition to appear incorrectly when calling the segments list method.
This is a bug fix release. This release fixes an issue which would cause users with private segments pinned to multiple views (profiles) to get a
500 error response when calling the segments list method.
This release adds an additional parameter to the Provisioning API TOS URL:
- The addition of the URL parameter,
provisioningSignup=false, fixes an issue which occurs when provisioning a Google Analytics account for a user without any Google Analytics accounts. Developers should update their code to add this parameter to the TOS URL.
With this release, in addition to general batching support, we have added special support for the User Permissions API. Batched User Permissions requests will see significant performance gains and reduced quota usage.
With this release the View (Profile)
currency property will now default to USD if not set during an insert operation. Also
list operations will return USD on Views (Profiles) that were previously created without a
This release marks the final removal of the deprecated filter fields
IS_TABLET, which should be replaced with
DEVICE_CATEGORY=tablet. Insert, update and patch requests which set the filter fields to use
IS_TABLET will return an error.
This release adds support to use a custom dimension for a filter field by adding a
fieldIndex property to all the filter details sections. For example it is now possible to set the filter expression with a
"field": "CUSTOM_DIMENSION" and the
"fieldIndex": "1" to have the filter work on the first custom dimension.
Please see the Filter developer guide for details on using filters in the Management API.
Please see the Filters reference for complete list of parameters for the Filter resource.
This release also fixes an issue when creating a goal with
"comparisonValue": "0" would fail.
This release marks the final turndown and removal of the
dailyUpload resouce. The
dailyUpload resource was officially deprecated on June 20, 2014; all cost data import should now be done using the uploads resource.
This release adds two new collections to the Management API, Custom Dimensions and Custom Metrics.
Custom Dimensions and Metrics
It is now possible to create, list, get, patch, and update Custom Dimensions and Metrics with the Management API.
list method response for all collections now include an empty list for the
items property when the collection contains no resources. Previously the
items property would be omitted from the response. See the API Reference for complete details on queries and responses for Google Analytics configuration data.
This release introduces a new scope for the Google Analytics Management API. -
analytics.manage.users.readonly - View Google analytics user permissions.
DEVICE_CATEGORY filters field has been added and
IS_TABLET are now deprecated. Use
The View (Profile) resource now includes an
enhancedECommerceTracking property that indicates whether Enhanced Ecommerce is enabled (
true) or disabled (
This release includes new data import types and the deprecation of the
See the Data Import Developer Guide for details how to use the Management API to import data to your Google Analytics account.
uploadresource now supports the following upload types:
- Campaign Data
- Content Data
- Cost Data
- Product Data
- Refund Data
- User Data
uploadresource has a new
migrateDataImportmethod to migrate existing Cost Data
Daily Uploads Deprecation
dailyUploadresource is now deprecated! see the Migration Guide for details on migrating to use the Data Import feature.
dailyUploadresource will continue to work for six more months, at which point any remaining
uploadTypeproperty set to
analytics#dailyUploadswill be automatically migrated and only work with the
- Current users of the
dailyUploadresource should update their code and migrate to use the Upload resource as soon as possible.
This is the initial release of the Provisioning API:
- The Provisioning API can be used to programmatically create new Google Analytics accounts. This API is invite-only and intended for qualified service providers and large partners. Visit the Provisioning API Overview for more details.
This release adds two new configuration APIs.
AdWords Links in the Management API allows you to create, list, get, update, patch, and delete links between Google AdWords accounts and Google Analytics properties and manage which Views (Profiles) are linked to Adwords data.
Filters in the Management API allows you to create, list, get, update, patch, and delete filters for your Google Analytics account. Profile Filter Links allow you to create, list, get, update, patch, and delete links between Filters and Views (Profiles).
Unsampled Reports: Management API
A new resource is being added to the Management API called Unsampled Reports. Unsampled reports are Google Analytics (GA) reports that have been generated using unsampled data. Unsampled reports are currently only available to GA Premium users.
- See the Developer Guide
Segments: Management API v2.4 & v3.0
The following changes have been made to the Segments Collection:
- User and sequence segments are now supported in the API.
- The Segments Collection now returns all built-in and custom session level and user level segments.
definitionproperty for segments will now use the new segments syntax. This includes definitions for existing session level segments which will change from
- A new
typeproperty has been added to the Segment resource to indicate whether a segment is
CUSTOM(i.e. created by a user in the web interface) or
BUILT_IN(i.e. provided by Google Analytics).
The following AdSense metrics can now be used as optimization objectives:
ga:adsenseAdsClicks— The number of times AdSense ads on your site were clicked.
ga:adsenseAdsViewed— The number of AdSense ads viewed. Multiple ads can be displayed within an Ad Unit.
ga:adsenseRevenue— The total revenue from AdSense ads.
New Account Summaries Collection
The following changes have been made to default segments due to the deprecation of the
gaid::-11has been renamed from Mobile Traffic to Mobile and Tablet Traffic. The definition for this segment has been changed from
ga:deviceCategory==mobile,ga:deviceCategory==tablet. Note that
ga:isMobileincluded tablet traffic, which is reflected in the new definition. If you only want mobile traffic, excluding tablet, then switch to the new Mobile Traffic segment (
gaid::-13definition has changed from
ga:deviceCategory==tablet. This continues to represent Tablet Traffic.
gaid::-14has been added. The name of the segment is Mobile Traffic and the definition is
- Timezone information for views (profiles) has been fixed. Details: Before this fix, in certain cases when listing view (profiles) in the Management API, incorrect timezone information for a view (profile) was returned. Now timezone information for views (profiles) is consistent with what is set in the Google Analytics admin interface.
Uploads (Dimension Widening)
This release introduces write operations for Web Property, View (Profile), and Goal resources and a set of 3 new resources that enable User Permissions management.
Account Setup and Configuration APIs
- Views (Profiles) can now be created, updated, patched, and deleted. Review the View (Profiles) reference for details on the new methods.
- Web Properties and Goals can now be created, updated, and patched. Review the Web Properties reference and Goals reference for details on the new methods.
- A single Web Property, View (Profile), or Goal can now be requested with the
- These features are currently available as a developer preview in limited beta. If you’re interested is signing up, request access to the beta.
User Permissions in the Management API
- The new accountUserLinks resource enables the management of account permissions for users.
- The new webpropertyUserLinks resource enables the management of property permissions for users.
- The new profileUserLinks resource enables the management of view (profile) permissions for users.
- Permissions for an authorized user are now available as part of the Account, Web Property and View (Profile) resources.
- A new scope has been introduced and is required to manage user permissions.
- See the User Permissions Dev Guide for additional details.
- All Segment IDs will be changed from positive integers to alphanumeric strings. If you have saved users’ Segment IDs, we recommend you update them to use the new IDs.
- The Segments Collection will only return the existing visit level segments. The new visitor, cohort, and sequence segments are currently not supported in the API.
- The Segments Collection will continue to return the existing default segments with the same negative numeric IDs, however, the new default segments are currently not supported.
This release adds 2 new properties to the Webproperty resource:
profileCount- Returns profile count for a property. This allows you to filter properties that don’t have any profiles (i.e., profileCount = 0).
industryVertical- Returns the industry vertical/category selected for a property.
eCommerceTrackingproperty of the Profile resource is now consistent with Ecommerce settings in the admin section of the web interface. Returns
truewhen Ecommerce tracking is enabled, and
- The Webproperty resource now includes a
levelproperty to indicate whether the web property is
- A new endpoint has been added to the Management API v3 to access and modify Experiments resources.
- The Profile resource now includes a
typeproperty to identify whether a profile is configured for a Web site or App. The two possible values are:
This release adds helpful error responses to the Management API.
This release adds data, changes existing functionality and fixes a bug.
- The Advanced Segment collection now contains a
segmentIdfield that can be used in the Data Export API segment parameter.
The data type for
max-resultshas been changed to
The default and maximum value for
max-resultshas been changed to 1000.
- Accounts, web properties, and profiles for Google Website Optimizer experiments are no longer included in their corresponding collections.
This release adds two new versions of the API with many new features, and it deprecates the old version. The changes impact the way you request and handle data from the API.
This 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.
- Full representation of event goals
- An internal web property ID that can be used to deep link into the GA user interface
- Profile configurations for the default page and site search query parameters
- A new quota policy
- Integration with the Google APIs Console to manage API access and request more quota
- Support for OAuth 2.0 as the new, recommended way to authorize users
- New URL to make requests:
- More compact API response using JSON
- New Google API client libraries that support many more languages
- Support for the Google Discovery API
This is a minor version upgrade that is mostly backwards compatible with the existing Version 2.3.
- A new quota policy
- Integration with the Google APIs Console to manage API access and request more quota
- Continued support for existing authorization mechanisms and OAuth 2.0
- New URL to make requests:
- Responses in XML only
- XML output consistent with version 2.3, so the other existing Google Data client libraries will continue to work.
- We are announcing the deprecation of the legacy version 2.3 of the Management API. It will continue to work for two months, after which all v2.3 requests will return a v2.4 response.
This is the beta release of the Google Analytics Management API!
Five new feeds have been created to simplify accessing Google Analytics account configuration data:
Updated Client Libraries
- A new section of the Google Analytics developer docs has been created to describe how the new Management API works.