Google Analytics 4 Properties API
The properties API from Google Analytics 4 — 120 operation(s) for properties.
Operations 220
POST
/v1alpha/properties/{propertiesId}:acknowledgeUserDataCollection
Acknowledges the terms of user data collection for the specified property
#
POST
/v1alpha/properties
Creates a Google Analytics property with the specified location and attributes
#
POST
/v1alpha/properties:createRollupProperty
Create a roll-up property and all roll-up property source links
#
DELETE
/v1alpha/properties/{propertiesId}
Marks target Property as soft-deleted (ie: "trashed") and returns it
#
GET
/v1alpha/properties/{propertiesId}/attributionSettings
Lookup for a AttributionSettings singleton
#
PATCH
/v1alpha/properties/{propertiesId}/attributionSettings
Updates attribution settings on a property
#
GET
/v1alpha/properties/{propertiesId}/dataRetentionSettings
Returns the singleton data retention settings for this property
#
PATCH
/v1alpha/properties/{propertiesId}/dataRetentionSettings
Updates the singleton data retention settings for this property
#
GET
/v1alpha/properties/{propertiesId}/googleSignalsSettings
Lookup for Google Signals settings for a property
#
PATCH
/v1alpha/properties/{propertiesId}/googleSignalsSettings
Updates Google Signals settings for a property
#
GET
/v1alpha/properties/{propertiesId}/reportingIdentitySettings
Returns the reporting identity settings for this property
#
PATCH
/v1alpha/properties/{propertiesId}/reportingIdentitySettings
Updates the reporting identity settings for this property
#
GET
/v1alpha/properties/{propertiesId}/userProvidedDataSettings
Looks up settings related to user-provided data for a property
#
POST
/v1alpha/properties:provisionSubproperty
Create a subproperty and a subproperty event filter that applies to the created subproperty
#
POST
/v1alpha/properties/{propertiesId}:runAccessReport
Returns a customized report of data access records
#
POST
/v1alpha/properties/{propertiesId}:submitUserDeletion
Submits a request for user deletion for a property
#
POST
/v1alpha/properties/{propertiesId}/accessBindings:batchCreate
Creates information about multiple access bindings to an account or property
#
POST
/v1alpha/properties/{propertiesId}/accessBindings:batchDelete
Deletes information about multiple users' links to an account or property
#
GET
/v1alpha/properties/{propertiesId}/accessBindings:batchGet
Gets information about multiple access bindings to an account or property
#
POST
/v1alpha/properties/{propertiesId}/accessBindings:batchUpdate
Updates information about multiple access bindings to an account or property
#
POST
/v1alpha/properties/{propertiesId}/accessBindings
Creates an access binding on an account or property
#
GET
/v1alpha/properties/{propertiesId}/accessBindings
Lists all access bindings on an account or property
#
DELETE
/v1alpha/properties/{propertiesId}/accessBindings/{accessBindingsId}
Deletes an access binding on an account or property
#
GET
/v1alpha/properties/{propertiesId}/accessBindings/{accessBindingsId}
Gets information about an access binding
#
PATCH
/v1alpha/properties/{propertiesId}/accessBindings/{accessBindingsId}
Updates an access binding on an account or property
#
GET
/v1alpha/properties/{propertiesId}/adSenseLinks/{adSenseLinksId}
Looks up a single AdSenseLink
#
POST
/v1alpha/properties/{propertiesId}/audiences/{audiencesId}:archive
Archives an Audience on a property
#
PATCH
/v1alpha/properties/{propertiesId}/audiences/{audiencesId}
Updates an Audience on a property
#
DELETE
/v1alpha/properties/{propertiesId}/bigQueryLinks/{bigQueryLinksId}
Deletes a BigQueryLink on a property
#
GET
/v1alpha/properties/{propertiesId}/bigQueryLinks/{bigQueryLinksId}
Lookup for a single BigQuery Link
#
DELETE
/v1alpha/properties/{propertiesId}/calculatedMetrics/{calculatedMetricsId}
Deletes a CalculatedMetric on a property
#
GET
/v1alpha/properties/{propertiesId}/calculatedMetrics/{calculatedMetricsId}
Lookup for a single CalculatedMetric
#
PATCH
/v1alpha/properties/{propertiesId}/calculatedMetrics/{calculatedMetricsId}
Updates a CalculatedMetric on a property
#
DELETE
/v1alpha/properties/{propertiesId}/channelGroups/{channelGroupsId}
Deletes a ChannelGroup on a property
#
GET
/v1alpha/properties/{propertiesId}/channelGroups/{channelGroupsId}
Lookup for a single ChannelGroup
#
DELETE
/v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}
Deprecated: Use `DeleteKeyEvent` instead
#
GET
/v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}
Deprecated: Use `GetKeyEvent` instead
#
PATCH
/v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}
Deprecated: Use `UpdateKeyEvent` instead
#
POST
/v1alpha/properties/{propertiesId}/customDimensions/{customDimensionsId}:archive
Archives a CustomDimension on a property
#
GET
/v1alpha/properties/{propertiesId}/customDimensions/{customDimensionsId}
Lookup for a single CustomDimension
#
PATCH
/v1alpha/properties/{propertiesId}/customDimensions/{customDimensionsId}
Updates a CustomDimension on a property
#
POST
/v1alpha/properties/{propertiesId}/customMetrics/{customMetricsId}:archive
Archives a CustomMetric on a property
#
GET
/v1alpha/properties/{propertiesId}/customMetrics/{customMetricsId}
Lookup for a single CustomMetric
#
PATCH
/v1alpha/properties/{propertiesId}/customMetrics/{customMetricsId}
Updates a CustomMetric on a property
#
DELETE
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}
Deletes a DataStream on a property
#
PATCH
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}
Updates a DataStream on a property
#
GET
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/dataRedactionSettings
Lookup for a single DataRedactionSettings
#
PATCH
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/dataRedactionSettings
Updates a DataRedactionSettings on a property
#
GET
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/enhancedMeasurementSettings
Returns the enhanced measurement settings for this data stream
#
PATCH
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/enhancedMeasurementSettings
Updates the enhanced measurement settings for this data stream
#
GET
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/globalSiteTag
Returns the Site Tag for the specified web stream
#
POST
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventCreateRules
Creates an EventCreateRule
#
GET
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventCreateRules
Lists EventCreateRules on a web data stream
#
DELETE
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventCreateRules/{eventCreateRulesId}
Deletes an EventCreateRule
#
GET
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventCreateRules/{eventCreateRulesId}
Lookup for a single EventCreateRule
#
PATCH
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventCreateRules/{eventCreateRulesId}
Updates an EventCreateRule
#
POST
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules
Creates an EventEditRule
#
GET
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules
Lists EventEditRules on a web data stream
#
DELETE
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules/{eventEditRulesId}
Deletes an EventEditRule
#
GET
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules/{eventEditRulesId}
Lookup for a single EventEditRule
#
PATCH
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules/{eventEditRulesId}
Updates an EventEditRule
#
POST
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules:reorder
Changes the processing order of event edit rules on the specified stream
#
POST
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets
Creates a measurement protocol secret
#
GET
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets
Returns child MeasurementProtocolSecrets under the specified parent Property
#
DELETE
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}
Deletes target MeasurementProtocolSecret
#
GET
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}
Lookup for a single MeasurementProtocolSecret
#
PATCH
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}
Updates a measurement protocol secret
#
POST
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/sKAdNetworkConversionValueSchema
Creates a SKAdNetworkConversionValueSchema
#
GET
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/sKAdNetworkConversionValueSchema
Lists SKAdNetworkConversionValueSchema on a stream
#
DELETE
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/sKAdNetworkConversionValueSchema/{sKAdNetworkConversionValueSchemaId}
Deletes target SKAdNetworkConversionValueSchema
#
GET
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/sKAdNetworkConversionValueSchema/{sKAdNetworkConversionValueSchemaId}
Looks up a single SKAdNetworkConversionValueSchema
#
PATCH
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/sKAdNetworkConversionValueSchema/{sKAdNetworkConversionValueSchemaId}
Updates a SKAdNetworkConversionValueSchema
#
POST
/v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals/{displayVideo360AdvertiserLinkProposalsId}:approve
Approves a DisplayVideo360AdvertiserLinkProposal
#
POST
/v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals/{displayVideo360AdvertiserLinkProposalsId}:cancel
Cancels a DisplayVideo360AdvertiserLinkProposal
#
POST
/v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals
Creates a DisplayVideo360AdvertiserLinkProposal
#
GET
/v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals
Lists DisplayVideo360AdvertiserLinkProposals on a property
#
DELETE
/v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals/{displayVideo360AdvertiserLinkProposalsId}
Deletes a DisplayVideo360AdvertiserLinkProposal on a property
#
GET
/v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals/{displayVideo360AdvertiserLinkProposalsId}
Lookup for a single DisplayVideo360AdvertiserLinkProposal
#
POST
/v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinks
Creates a DisplayVideo360AdvertiserLink
#
GET
/v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinks
Lists all DisplayVideo360AdvertiserLinks on a property
#
DELETE
/v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinks/{displayVideo360AdvertiserLinksId}
Deletes a DisplayVideo360AdvertiserLink on a property
#
GET
/v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinks/{displayVideo360AdvertiserLinksId}
Look up a single DisplayVideo360AdvertiserLink
#
PATCH
/v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinks/{displayVideo360AdvertiserLinksId}
Updates a DisplayVideo360AdvertiserLink on a property
#
DELETE
/v1alpha/properties/{propertiesId}/expandedDataSets/{expandedDataSetsId}
Deletes a ExpandedDataSet on a property
#
GET
/v1alpha/properties/{propertiesId}/expandedDataSets/{expandedDataSetsId}
Lookup for a single ExpandedDataSet
#
PATCH
/v1alpha/properties/{propertiesId}/expandedDataSets/{expandedDataSetsId}
Updates a ExpandedDataSet on a property
#
DELETE
/v1alpha/properties/{propertiesId}/firebaseLinks/{firebaseLinksId}
Deletes a FirebaseLink on a property
#
DELETE
/v1alpha/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}
Deletes a GoogleAdsLink on a property
#
PATCH
/v1alpha/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}
Updates a GoogleAdsLink on a property
#
GET
/v1alpha/properties/{propertiesId}/keyEvents
Returns a list of Key Events in the specified parent property
#
POST
/v1alpha/properties/{propertiesId}/reportingDataAnnotations
Creates a Reporting Data Annotation
#
GET
/v1alpha/properties/{propertiesId}/reportingDataAnnotations
List all Reporting Data Annotations on a property
#
DELETE
/v1alpha/properties/{propertiesId}/reportingDataAnnotations/{reportingDataAnnotationsId}
Deletes a Reporting Data Annotation
#
GET
/v1alpha/properties/{propertiesId}/reportingDataAnnotations/{reportingDataAnnotationsId}
Lookup a single Reporting Data Annotation
#
PATCH
/v1alpha/properties/{propertiesId}/reportingDataAnnotations/{reportingDataAnnotationsId}
Updates a Reporting Data Annotation
#
POST
/v1alpha/properties/{propertiesId}/rollupPropertySourceLinks
Creates a roll-up property source link
#
GET
/v1alpha/properties/{propertiesId}/rollupPropertySourceLinks
Lists roll-up property source Links on a property
#
DELETE
/v1alpha/properties/{propertiesId}/rollupPropertySourceLinks/{rollupPropertySourceLinksId}
Deletes a roll-up property source link
#
GET
/v1alpha/properties/{propertiesId}/rollupPropertySourceLinks/{rollupPropertySourceLinksId}
Lookup for a single roll-up property source Link
#
GET
/v1alpha/properties/{propertiesId}/searchAds360Links
Lists all SearchAds360Links on a property
#
DELETE
/v1alpha/properties/{propertiesId}/searchAds360Links/{searchAds360LinksId}
Deletes a SearchAds360Link on a property
#
GET
/v1alpha/properties/{propertiesId}/searchAds360Links/{searchAds360LinksId}
Look up a single SearchAds360Link
#
PATCH
/v1alpha/properties/{propertiesId}/searchAds360Links/{searchAds360LinksId}
Updates a SearchAds360Link on a property
#
POST
/v1alpha/properties/{propertiesId}/subpropertyEventFilters
Creates a subproperty Event Filter
#
GET
/v1alpha/properties/{propertiesId}/subpropertyEventFilters
List all subproperty Event Filters on a property
#
DELETE
/v1alpha/properties/{propertiesId}/subpropertyEventFilters/{subpropertyEventFiltersId}
Deletes a subproperty event filter
#
GET
/v1alpha/properties/{propertiesId}/subpropertyEventFilters/{subpropertyEventFiltersId}
Lookup for a single subproperty Event Filter
#
PATCH
/v1alpha/properties/{propertiesId}/subpropertyEventFilters/{subpropertyEventFiltersId}
Updates a subproperty Event Filter
#
GET
/v1alpha/properties/{propertiesId}/subpropertySyncConfigs/{subpropertySyncConfigsId}
Lookup for a single `SubpropertySyncConfig`
#
PATCH
/v1alpha/properties/{propertiesId}/subpropertySyncConfigs/{subpropertySyncConfigsId}
Updates a `SubpropertySyncConfig`
#
GET
/v1alpha/properties/{propertiesId}/subpropertySyncConfigs
List all `SubpropertySyncConfig` resources for a property
#
POST
/v1beta/properties/{propertiesId}:acknowledgeUserDataCollection
Acknowledges the terms of user data collection for the specified property
#
POST
/v1beta/properties
Creates a Google Analytics property with the specified location and attributes
#
DELETE
/v1beta/properties/{propertiesId}
Marks target Property as soft-deleted (ie: "trashed") and returns it
#
GET
/v1beta/properties/{propertiesId}/dataRetentionSettings
Returns the singleton data retention settings for this property
#
PATCH
/v1beta/properties/{propertiesId}/dataRetentionSettings
Updates the singleton data retention settings for this property
#
POST
/v1beta/properties/{propertiesId}:runAccessReport
Returns a customized report of data access records
#
DELETE
/v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}
Deprecated: Use `DeleteKeyEvent` instead
#
GET
/v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}
Deprecated: Use `GetKeyEvent` instead
#
PATCH
/v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}
Deprecated: Use `UpdateKeyEvent` instead
#
POST
/v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}:archive
Archives a CustomDimension on a property
#
GET
/v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}
Lookup for a single CustomDimension
#
PATCH
/v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}
Updates a CustomDimension on a property
#
POST
/v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}:archive
Archives a CustomMetric on a property
#
GET
/v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}
Lookup for a single CustomMetric
#
PATCH
/v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}
Updates a CustomMetric on a property
#
DELETE
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}
Deletes a DataStream on a property
#
PATCH
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}
Updates a DataStream on a property
#
POST
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets
Creates a measurement protocol secret
#
GET
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets
Returns child MeasurementProtocolSecrets under the specified parent Property
#
DELETE
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}
Deletes target MeasurementProtocolSecret
#
GET
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}
Lookup for a single MeasurementProtocolSecret
#
PATCH
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}
Updates a measurement protocol secret
#
DELETE
/v1beta/properties/{propertiesId}/firebaseLinks/{firebaseLinksId}
Deletes a FirebaseLink on a property
#
DELETE
/v1beta/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}
Deletes a GoogleAdsLink on a property
#
PATCH
/v1beta/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}
Updates a GoogleAdsLink on a property
#
GET
/v1beta/properties/{propertiesId}/keyEvents
Returns a list of Key Events in the specified parent property
#
GET
/v1alpha/properties/{propertiesId}/metadata
Returns metadata for dimensions and metrics available in reporting methods
#
GET
/v1alpha/properties/{propertiesId}/propertyQuotasSnapshot
Get all property quotas organized by quota category for a given property
#
POST
/v1alpha/properties/{propertiesId}:runFunnelReport
Returns a customized funnel report of your Google Analytics event data
#
POST
/v1alpha/properties/{propertiesId}:runReport
Returns a customized report of your Google Analytics event data
#
POST
/v1alpha/properties/{propertiesId}/audienceLists
Creates an audience list for later retrieval
#
GET
/v1alpha/properties/{propertiesId}/audienceLists/{audienceListsId}
Gets configuration metadata about a specific audience list
#
POST
/v1alpha/properties/{propertiesId}/audienceLists/{audienceListsId}:query
Retrieves an audience list of users
#
GET
/v1alpha/properties/{propertiesId}/recurringAudienceLists
Lists all recurring audience lists for a property
#
GET
/v1alpha/properties/{propertiesId}/recurringAudienceLists/{recurringAudienceListsId}
Gets configuration metadata about a specific recurring audience list
#
GET
/v1alpha/properties/{propertiesId}/reportTasks/{reportTasksId}
Gets report metadata about a specific report task
#
POST
/v1alpha/properties/{propertiesId}/reportTasks/{reportTasksId}:query
Retrieves a report task's content
#
POST
/v1beta/properties/{propertiesId}:batchRunPivotReports
Returns multiple pivot reports in a batch
#
POST
/v1beta/properties/{propertiesId}:checkCompatibility
This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility
#
GET
/v1beta/properties/{propertiesId}/metadata
Returns metadata for dimensions and metrics available in reporting methods
#
POST
/v1beta/properties/{propertiesId}:runPivotReport
Returns a customized pivot report of your Google Analytics event data
#
POST
/v1beta/properties/{propertiesId}:runRealtimeReport
Returns a customized report of realtime event data for your property
#
POST
/v1beta/properties/{propertiesId}:runReport
Returns a customized report of your Google Analytics event data
#
POST
/v1beta/properties/{propertiesId}/audienceExports
Creates an audience export for later retrieval
#
GET
/v1beta/properties/{propertiesId}/audienceExports/{audienceExportsId}
Gets configuration metadata about a specific audience export
#
POST
/v1beta/properties/{propertiesId}/audienceExports/{audienceExportsId}:query
Retrieves an audience export of users
#
Documentation
📖
Documentation
https://developers.google.com/analytics/devguides/reporting/data/v1
📖
APIReference
https://developers.google.com/analytics/devguides/reporting/data/v1/rest
📖
Authentication
https://developers.google.com/analytics/devguides/reporting/data/v1/basics#authentication
📖
GettingStarted
https://developers.google.com/analytics/devguides/reporting/data/v1/quickstart-client-libraries
📖
RateLimits
https://developers.google.com/analytics/devguides/reporting/data/v1/quotas
📖
Documentation
https://developers.google.com/analytics/devguides/config/admin/v1
📖
APIReference
https://developers.google.com/analytics/devguides/config/admin/v1/rest
📖
Authentication
https://developers.google.com/analytics/devguides/config/admin/v1/rest
📖
GettingStarted
https://developers.google.com/analytics/devguides/config/admin/v1/quickstart-client-libraries
📖
RateLimits
https://developers.google.com/analytics/devguides/config/admin/v1/quotas
Specifications
Other Resources
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-analytics-4/refs/heads/main/grpc/google-analytics-4-data-v1beta-analytics_data_api.proto
🔗
ChangeLog
https://developers.google.com/analytics/devguides/reporting/data/v1/changelog
🔗
ErrorCatalog
https://developers.google.com/analytics/devguides/reporting/data/v1/errors
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/google-analytics-4/refs/heads/main/asyncapi/google-analytics-4-webhooks.yml
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-analytics-4/refs/heads/main/grpc/google-analytics-4-admin-v1beta-analytics_admin.proto
🔗
ChangeLog
https://developers.google.com/analytics/devguides/config/admin/v1/changelog