API Reference

MANAGEMENT API

This is the reference guide for the Management API Version 3.0. It provides complete details on queries and responses for Google Analytics configuration data. For a guide to concepts and structure of configuration data, see the Version 3.0 Overview.

Each section in this guide defines the request method and response for one kind of entity in the configuration data for an authenticated user.  Requests are all shown in REST format.  At the end of the page for each method, you can try out the request interactively in the APIs Explorer by using the "Try it!" link.

Resource types

  1. Account Summaries
  2. Account User Links
  3. Accounts
  4. AdWords Links
  5. Custom Data Sources
  6. Custom Dimensions
  7. Custom Metrics
  8. Experiments
  9. Filters
  10. Goals
  11. Client ID
  12. Profile Filter Links
  13. Profile User Links
  14. Remarketing Audiences
  15. Segments
  16. Unsampled Reports
  17. Uploads
  18. Views (Profiles)
  19. Web Properties
  20. Webproperty User Links

Account Summaries

For Account Summaries Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
list GET  /management/accountSummaries Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.

For Account User Links Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
delete DELETE  /management/accounts/accountId/entityUserLinks/linkId Removes a user from the given account.
insert POST  /management/accounts/accountId/entityUserLinks Adds a new user to the given account if the user has fewer than 100 accounts.
list GET  /management/accounts/accountId/entityUserLinks Lists account-user links for a given account.
update PUT  /management/accounts/accountId/entityUserLinks/linkId Updates permissions for an existing user on the given account.

Accounts

For Accounts Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
list GET  /management/accounts Lists all accounts to which the user has access.

For AdWords Links Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId Deletes a web property-AdWords link.
get GET  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId Returns a web property-AdWords link to which the user has access.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks Creates a webProperty-AdWords link.
list GET  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks Lists webProperty-AdWords links for a given web property.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId Updates an existing webProperty-AdWords link. This method supports patch semantics.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId Updates an existing webProperty-AdWords link.

Custom Data Sources

For Custom Data Sources Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDataSources List custom data sources to which the user has access.

Custom Dimensions

For Custom Dimensions Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
get GET  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId Get a custom dimension to which the user has access.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/customDimensions Create a new custom dimension.
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDimensions Lists custom dimensions to which the user has access.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId Updates an existing custom dimension. This method supports patch semantics.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId Updates an existing custom dimension.

Custom Metrics

For Custom Metrics Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
get GET  /management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId Get a custom metric to which the user has access.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/customMetrics Create a new custom metric.
list GET  /management/accounts/accountId/webproperties/webPropertyId/customMetrics Lists custom metrics to which the user has access.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId Updates an existing custom metric. This method supports patch semantics.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId Updates an existing custom metric.

Experiments

For Experiments Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId Delete an experiment.
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId Returns an experiment to which the user has access.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments Create a new experiment.
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments Lists experiments to which the user has access.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId Update an existing experiment. This method supports patch semantics.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId Update an existing experiment.

Filters

For Filters Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
delete DELETE  /management/accounts/accountId/filters/filterId Delete a filter.
get GET  /management/accounts/accountId/filters/filterId Returns a filters to which the user has access.
insert POST  /management/accounts/accountId/filters Create a new filter.
list GET  /management/accounts/accountId/filters Lists all filters for an account
patch PATCH  /management/accounts/accountId/filters/filterId Updates an existing filter. This method supports patch semantics.
update PUT  /management/accounts/accountId/filters/filterId Updates an existing filter.

Goals

For Goals Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId Gets a goal to which the user has access.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals Create a new goal.
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals Lists goals to which the user has access.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId Updates an existing goal. This method supports patch semantics.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId Updates an existing goal.

Client ID

For Management.clientId Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
hashClientId POST  /management/clientId:hashClientId Hashes the given Client ID.

For Profile Filter Links Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId Delete a profile filter link.
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId Returns a single profile filter link.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks Create a new profile filter link.
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks Lists all profile filter links for a profile.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId Update an existing profile filter link. This method supports patch semantics.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId Update an existing profile filter link.

For Profile User Links Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks/linkId Removes a user from the given view (profile).
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks Adds a new user to the given view (profile).
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks Lists profile-user links for a given view (profile).
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks/linkId Updates permissions for an existing user on the given view (profile).

Remarketing Audiences

For Remarketing Audiences Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId Delete a remarketing audience.
get GET  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId Gets a remarketing audience to which the user has access.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences Creates a new remarketing audience.
list GET  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences Lists remarketing audiences to which the user has access.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId Updates an existing remarketing audience. This method supports patch semantics.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId Updates an existing remarketing audience.

Segments

For Segments Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
list GET  /management/segments Lists segments to which the user has access.

Unsampled Reports

For Unsampled Reports Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports/unsampledReportId Deletes an unsampled report.
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports/unsampledReportId Returns a single unsampled report.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports Create a new unsampled report.
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports Lists unsampled reports to which the user has access.

Uploads

For Uploads Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
deleteUploadData POST  /management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/deleteUploadData Delete data associated with a previous upload.
get GET  /management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads/uploadId List uploads to which the user has access.
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads List uploads to which the user has access.
uploadData POST
https://www.googleapis.com/upload/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads
Upload data for a custom data source.

Views (Profiles)

For Views (Profiles) Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId Deletes a view (profile).
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId Gets a view (profile) to which the user has access.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles Create a new view (profile).
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles Lists views (profiles) to which the user has access.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId Updates an existing view (profile). This method supports patch semantics.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId Updates an existing view (profile).

Web Properties

For Web Properties Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
get GET  /management/accounts/accountId/webproperties/webPropertyId Gets a property to which the user has access.
insert POST  /management/accounts/accountId/webproperties Creates a new property.
list GET  /management/accounts/accountId/webproperties Lists properties to which the user has access.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId Updates an existing property. This method supports patch semantics.
update PUT  /management/accounts/accountId/webproperties/webPropertyId Updates an existing property.

For Webproperty User Links Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/analytics/v3, unless otherwise noted
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks/linkId Removes a user from the given web property.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks Adds a new user to the given web property.
list GET  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks Lists webProperty-user links for a given web property.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks/linkId Updates permissions for an existing user on the given web property.