Google Analytics Admin API

Stay organized with collections Save and categorize content based on your preferences.

Service: analyticsadmin.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://analyticsadmin.googleapis.com

REST Resource: v1beta.accountSummaries

Methods
list GET /v1beta/accountSummaries
Returns summaries of all accounts accessible by the caller.

REST Resource: v1beta.accounts

Methods
delete DELETE /v1beta/{name=accounts/*}
Marks target Account as soft-deleted (ie: "trashed") and returns it.
get GET /v1beta/{name=accounts/*}
Lookup for a single Account.
getDataSharingSettings GET /v1beta/{name=accounts/*/dataSharingSettings}
Get data sharing settings on an account.
list GET /v1beta/accounts
Returns all accounts accessible by the caller.
patch PATCH /v1beta/{account.name=accounts/*}
Updates an account.
provisionAccountTicket POST /v1beta/accounts:provisionAccountTicket
Requests a ticket for creating an account.
searchChangeHistoryEvents POST /v1beta/{account=accounts/*}:searchChangeHistoryEvents
Searches through all changes to an account or its children given the specified set of filters.

REST Resource: v1beta.properties

Methods
acknowledgeUserDataCollection POST /v1beta/{property=properties/*}:acknowledgeUserDataCollection
Acknowledges the terms of user data collection for the specified property.
create POST /v1beta/properties
Creates an "GA4" property with the specified location and attributes.
delete DELETE /v1beta/{name=properties/*}
Marks target Property as soft-deleted (ie: "trashed") and returns it.
get GET /v1beta/{name=properties/*}
Lookup for a single "GA4" Property.
getDataRetentionSettings GET /v1beta/{name=properties/*/dataRetentionSettings}
Returns the singleton data retention settings for this property.
list GET /v1beta/properties
Returns child Properties under the specified parent Account.
patch PATCH /v1beta/{property.name=properties/*}
Updates a property.
updateDataRetentionSettings PATCH /v1beta/{dataRetentionSettings.name=properties/*/dataRetentionSettings}
Updates the singleton data retention settings for this property.

REST Resource: v1beta.properties.conversionEvents

Methods
create POST /v1beta/{parent=properties/*}/conversionEvents
Creates a conversion event with the specified attributes.
delete DELETE /v1beta/{name=properties/*/conversionEvents/*}
Deletes a conversion event in a property.
get GET /v1beta/{name=properties/*/conversionEvents/*}
Retrieve a single conversion event.
list GET /v1beta/{parent=properties/*}/conversionEvents
Returns a list of conversion events in the specified parent property.

REST Resource: v1beta.properties.customDimensions

Methods
archive POST /v1beta/{name=properties/*/customDimensions/*}:archive
Archives a CustomDimension on a property.
create POST /v1beta/{parent=properties/*}/customDimensions
Creates a CustomDimension.
get GET /v1beta/{name=properties/*/customDimensions/*}
Lookup for a single CustomDimension.
list GET /v1beta/{parent=properties/*}/customDimensions
Lists CustomDimensions on a property.
patch PATCH /v1beta/{customDimension.name=properties/*/customDimensions/*}
Updates a CustomDimension on a property.

REST Resource: v1beta.properties.customMetrics

Methods
archive POST /v1beta/{name=properties/*/customMetrics/*}:archive
Archives a CustomMetric on a property.
create POST /v1beta/{parent=properties/*}/customMetrics
Creates a CustomMetric.
get GET /v1beta/{name=properties/*/customMetrics/*}
Lookup for a single CustomMetric.
list GET /v1beta/{parent=properties/*}/customMetrics
Lists CustomMetrics on a property.
patch PATCH /v1beta/{customMetric.name=properties/*/customMetrics/*}
Updates a CustomMetric on a property.

REST Resource: v1beta.properties.dataStreams

Methods
create POST /v1beta/{parent=properties/*}/dataStreams
Creates a DataStream.
delete DELETE /v1beta/{name=properties/*/dataStreams/*}
Deletes a DataStream on a property.
get GET /v1beta/{name=properties/*/dataStreams/*}
Lookup for a single DataStream.
list GET /v1beta/{parent=properties/*}/dataStreams
Lists DataStreams on a property.
patch PATCH /v1beta/{dataStream.name=properties/*/dataStreams/*}
Updates a DataStream on a property.

REST Resource: v1beta.properties.dataStreams.measurementProtocolSecrets

Methods
create POST /v1beta/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets
Creates a measurement protocol secret.
delete DELETE /v1beta/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}
Deletes target MeasurementProtocolSecret.
get GET /v1beta/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}
Lookup for a single "GA4" MeasurementProtocolSecret.
list GET /v1beta/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets
Returns child MeasurementProtocolSecrets under the specified parent Property.
patch PATCH /v1beta/{measurementProtocolSecret.name=properties/*/dataStreams/*/measurementProtocolSecrets/*}
Updates a measurement protocol secret.

REST Resource: v1alpha.accountSummaries

Methods
list GET /v1alpha/accountSummaries
Returns summaries of all accounts accessible by the caller.

REST Resource: v1alpha.accounts

Methods
delete DELETE /v1alpha/{name=accounts/*}
Marks target Account as soft-deleted (ie: "trashed") and returns it.
get GET /v1alpha/{name=accounts/*}
Lookup for a single Account.
getDataSharingSettings GET /v1alpha/{name=accounts/*/dataSharingSettings}
Get data sharing settings on an account.
list GET /v1alpha/accounts
Returns all accounts accessible by the caller.
patch PATCH /v1alpha/{account.name=accounts/*}
Updates an account.
provisionAccountTicket POST /v1alpha/accounts:provisionAccountTicket
Requests a ticket for creating an account.
searchChangeHistoryEvents POST /v1alpha/{account=accounts/*}:searchChangeHistoryEvents
Searches through all changes to an account or its children given the specified set of filters.

REST Resource: v1alpha.properties

Methods
acknowledgeUserDataCollection POST /v1alpha/{property=properties/*}:acknowledgeUserDataCollection
Acknowledges the terms of user data collection for the specified property.
create POST /v1alpha/properties
Creates an "GA4" property with the specified location and attributes.
delete DELETE /v1alpha/{name=properties/*}
Marks target Property as soft-deleted (ie: "trashed") and returns it.
get GET /v1alpha/{name=properties/*}
Lookup for a single "GA4" Property.
getAttributionSettings GET /v1alpha/{name=properties/*/attributionSettings}
Lookup for a AttributionSettings singleton.
getDataRetentionSettings GET /v1alpha/{name=properties/*/dataRetentionSettings}
Returns the singleton data retention settings for this property.
getGoogleSignalsSettings GET /v1alpha/{name=properties/*/googleSignalsSettings}
Lookup for Google Signals settings for a property.
list GET /v1alpha/properties
Returns child Properties under the specified parent Account.
patch PATCH /v1alpha/{property.name=properties/*}
Updates a property.
runAccessReport POST /v1alpha/{entity=properties/*}:runAccessReport
Returns a customized report of data access records.
updateAttributionSettings PATCH /v1alpha/{attributionSettings.name=properties/*/attributionSettings}
Updates attribution settings on a property.
updateDataRetentionSettings PATCH /v1alpha/{dataRetentionSettings.name=properties/*/dataRetentionSettings}
Updates the singleton data retention settings for this property.
updateGoogleSignalsSettings PATCH /v1alpha/{googleSignalsSettings.name=properties/*/googleSignalsSettings}
Updates Google Signals settings for a property.

REST Resource: v1alpha.properties.audiences

Methods
archive POST /v1alpha/{name=properties/*/audiences/*}:archive
Archives an Audience on a property.
create POST /v1alpha/{parent=properties/*}/audiences
Creates an Audience.
get GET /v1alpha/{name=properties/*/audiences/*}
Lookup for a single Audience.
list GET /v1alpha/{parent=properties/*}/audiences
Lists Audiences on a property.
patch PATCH /v1alpha/{audience.name=properties/*/audiences/*}
Updates an Audience on a property.

REST Resource: v1alpha.properties.conversionEvents

Methods
create POST /v1alpha/{parent=properties/*}/conversionEvents
Creates a conversion event with the specified attributes.
delete DELETE /v1alpha/{name=properties/*/conversionEvents/*}
Deletes a conversion event in a property.
get GET /v1alpha/{name=properties/*/conversionEvents/*}
Retrieve a single conversion event.
list GET /v1alpha/{parent=properties/*}/conversionEvents
Returns a list of conversion events in the specified parent property.

REST Resource: v1alpha.properties.customDimensions

Methods
archive POST /v1alpha/{name=properties/*/customDimensions/*}:archive
Archives a CustomDimension on a property.
create POST /v1alpha/{parent=properties/*}/customDimensions
Creates a CustomDimension.
get GET /v1alpha/{name=properties/*/customDimensions/*}
Lookup for a single CustomDimension.
list GET /v1alpha/{parent=properties/*}/customDimensions
Lists CustomDimensions on a property.
patch PATCH /v1alpha/{customDimension.name=properties/*/customDimensions/*}
Updates a CustomDimension on a property.

REST Resource: v1alpha.properties.customMetrics

Methods
archive POST /v1alpha/{name=properties/*/customMetrics/*}:archive
Archives a CustomMetric on a property.
create POST /v1alpha/{parent=properties/*}/customMetrics
Creates a CustomMetric.
get GET /v1alpha/{name=properties/*/customMetrics/*}
Lookup for a single CustomMetric.
list GET /v1alpha/{parent=properties/*}/customMetrics
Lists CustomMetrics on a property.
patch PATCH /v1alpha/{customMetric.name=properties/*/customMetrics/*}
Updates a CustomMetric on a property.

REST Resource: v1alpha.properties.dataStreams

Methods
create POST /v1alpha/{parent=properties/*}/dataStreams
Creates a DataStream.
delete DELETE /v1alpha/{name=properties/*/dataStreams/*}
Deletes a DataStream on a property.
get GET /v1alpha/{name=properties/*/dataStreams/*}
Lookup for a single DataStream.
getGlobalSiteTag GET /v1alpha/{name=properties/*/dataStreams/*/globalSiteTag}
Returns the Site Tag for the specified web stream.
list GET /v1alpha/{parent=properties/*}/dataStreams
Lists DataStreams on a property.
patch PATCH /v1alpha/{dataStream.name=properties/*/dataStreams/*}
Updates a DataStream on a property.

REST Resource: v1alpha.properties.dataStreams.measurementProtocolSecrets

Methods
create POST /v1alpha/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets
Creates a measurement protocol secret.
delete DELETE /v1alpha/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}
Deletes target MeasurementProtocolSecret.
get GET /v1alpha/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}
Lookup for a single "GA4" MeasurementProtocolSecret.
list GET /v1alpha/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets
Returns child MeasurementProtocolSecrets under the specified parent Property.
patch PATCH /v1alpha/{measurementProtocolSecret.name=properties/*/dataStreams/*/measurementProtocolSecrets/*}
Updates a measurement protocol secret.

REST Resource: v1alpha.properties.displayVideo360AdvertiserLinkProposals

Methods
approve POST /v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}:approve
Approves a DisplayVideo360AdvertiserLinkProposal.
cancel POST /v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}:cancel
Cancels a DisplayVideo360AdvertiserLinkProposal.
create POST /v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinkProposals
Creates a DisplayVideo360AdvertiserLinkProposal.
delete DELETE /v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}
Deletes a DisplayVideo360AdvertiserLinkProposal on a property.
get GET /v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}
Lookup for a single DisplayVideo360AdvertiserLinkProposal.
list GET /v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinkProposals
Lists DisplayVideo360AdvertiserLinkProposals on a property.