Google Analytics 4 Properties API
The properties API from Google Analytics 4 — 120 operation(s) for properties.
Google Analytics 4 Properties API is one of 4 APIs that Google Analytics 4 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Properties. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, and rate-limit docs.
This API exposes 220 operations across 120 paths, and defines 339 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://analyticsadmin.googleapis.com, https://analyticsdata.googleapis.com.
220 operations
120 paths
339 schemas
29 DELETE87 GET37 PATCH67 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Google Analytics 4 Properties API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 4 scopes.
It accepts HTTP bearer tokens (BearerAuth).
By default, every request must be authenticated.
OAuth2— Google OAuth 2.0. Scopes are the short form of the full https://www.googleapis.com/auth/ identifier.BearerAuth— Google OAuth 2.0 access token presented as a bearer token.
Paths & Operations 220
Across 120 paths, the API surfaces 220 operations — 29 DELETE, 87 GET, 37 PATCH, 67 POST. Each is listed below with its method, path, parameters, and response codes.
properties 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
GET
/v1alpha/properties
Returns child Properties under the specified parent Account
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}
Lookup for a single GA Property
PATCH
/v1alpha/properties/{propertiesId}
Updates a property
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
POST
/v1alpha/properties/{propertiesId}/adSenseLinks
Creates an AdSenseLink
GET
/v1alpha/properties/{propertiesId}/adSenseLinks
Lists AdSenseLinks on a property
DELETE
/v1alpha/properties/{propertiesId}/adSenseLinks/{adSenseLinksId}
Deletes an AdSenseLink
GET
/v1alpha/properties/{propertiesId}/adSenseLinks/{adSenseLinksId}
Looks up a single AdSenseLink
POST
/v1alpha/properties/{propertiesId}/audiences/{audiencesId}:archive
Archives an Audience on a property
POST
/v1alpha/properties/{propertiesId}/audiences
Creates an Audience
GET
/v1alpha/properties/{propertiesId}/audiences
Lists Audiences on a property
GET
/v1alpha/properties/{propertiesId}/audiences/{audiencesId}
Lookup for a single Audience
PATCH
/v1alpha/properties/{propertiesId}/audiences/{audiencesId}
Updates an Audience on a property
POST
/v1alpha/properties/{propertiesId}/bigQueryLinks
Creates a BigQueryLink
GET
/v1alpha/properties/{propertiesId}/bigQueryLinks
Lists BigQuery Links 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
PATCH
/v1alpha/properties/{propertiesId}/bigQueryLinks/{bigQueryLinksId}
Updates a BigQueryLink
POST
/v1alpha/properties/{propertiesId}/calculatedMetrics
Creates a CalculatedMetric
GET
/v1alpha/properties/{propertiesId}/calculatedMetrics
Lists CalculatedMetrics on a property
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
POST
/v1alpha/properties/{propertiesId}/channelGroups
Creates a ChannelGroup
GET
/v1alpha/properties/{propertiesId}/channelGroups
Lists ChannelGroups 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
PATCH
/v1alpha/properties/{propertiesId}/channelGroups/{channelGroupsId}
Updates a ChannelGroup
POST
/v1alpha/properties/{propertiesId}/conversionEventsdeprecated
Deprecated: Use CreateKeyEvent instead
GET
/v1alpha/properties/{propertiesId}/conversionEventsdeprecated
Deprecated: Use ListKeyEvents instead
DELETE
/v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}deprecated
Deprecated: Use DeleteKeyEvent instead
GET
/v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}deprecated
Deprecated: Use GetKeyEvent instead
PATCH
/v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}deprecated
Deprecated: Use UpdateKeyEvent instead
POST
/v1alpha/properties/{propertiesId}/customDimensions/{customDimensionsId}:archive
Archives a CustomDimension on a property
POST
/v1alpha/properties/{propertiesId}/customDimensions
Creates a CustomDimension
GET
/v1alpha/properties/{propertiesId}/customDimensions
Lists CustomDimensions 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
POST
/v1alpha/properties/{propertiesId}/customMetrics
Creates a CustomMetric
GET
/v1alpha/properties/{propertiesId}/customMetrics
Lists CustomMetrics 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
POST
/v1alpha/properties/{propertiesId}/dataStreams
Creates a DataStream
GET
/v1alpha/properties/{propertiesId}/dataStreams
Lists DataStreams on a property
DELETE
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}
Deletes a DataStream on a property
GET
/v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}
Lookup for a single DataStream
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
POST
/v1alpha/properties/{propertiesId}/expandedDataSets
Creates a ExpandedDataSet
GET
/v1alpha/properties/{propertiesId}/expandedDataSets
Lists ExpandedDataSets 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
POST
/v1alpha/properties/{propertiesId}/firebaseLinks
Creates a FirebaseLink
GET
/v1alpha/properties/{propertiesId}/firebaseLinks
Lists FirebaseLinks on a property
DELETE
/v1alpha/properties/{propertiesId}/firebaseLinks/{firebaseLinksId}
Deletes a FirebaseLink on a property
POST
/v1alpha/properties/{propertiesId}/googleAdsLinks
Creates a GoogleAdsLink
GET
/v1alpha/properties/{propertiesId}/googleAdsLinks
Lists GoogleAdsLinks 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
POST
/v1alpha/properties/{propertiesId}/keyEvents
Creates a Key Event
GET
/v1alpha/properties/{propertiesId}/keyEvents
Returns a list of Key Events in the specified parent property
DELETE
/v1alpha/properties/{propertiesId}/keyEvents/{keyEventsId}
Deletes a Key Event
GET
/v1alpha/properties/{propertiesId}/keyEvents/{keyEventsId}
Retrieve a single Key Event
PATCH
/v1alpha/properties/{propertiesId}/keyEvents/{keyEventsId}
Updates a Key Event
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
POST
/v1alpha/properties/{propertiesId}/searchAds360Links
Creates a SearchAds360Link
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
GET
/v1beta/properties
Returns child Properties under the specified parent Account
DELETE
/v1beta/properties/{propertiesId}
Marks target Property as soft-deleted (ie: "trashed") and returns it
GET
/v1beta/properties/{propertiesId}
Lookup for a single GA Property
PATCH
/v1beta/properties/{propertiesId}
Updates a property
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
POST
/v1beta/properties/{propertiesId}/conversionEventsdeprecated
Deprecated: Use CreateKeyEvent instead
GET
/v1beta/properties/{propertiesId}/conversionEventsdeprecated
Deprecated: Use ListKeyEvents instead
DELETE
/v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}deprecated
Deprecated: Use DeleteKeyEvent instead
GET
/v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}deprecated
Deprecated: Use GetKeyEvent instead
PATCH
/v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}deprecated
Deprecated: Use UpdateKeyEvent instead
POST
/v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}:archive
Archives a CustomDimension on a property
POST
/v1beta/properties/{propertiesId}/customDimensions
Creates a CustomDimension
GET
/v1beta/properties/{propertiesId}/customDimensions
Lists CustomDimensions 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
POST
/v1beta/properties/{propertiesId}/customMetrics
Creates a CustomMetric
GET
/v1beta/properties/{propertiesId}/customMetrics
Lists CustomMetrics 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
POST
/v1beta/properties/{propertiesId}/dataStreams
Creates a DataStream
GET
/v1beta/properties/{propertiesId}/dataStreams
Lists DataStreams on a property
DELETE
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}
Deletes a DataStream on a property
GET
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}
Lookup for a single DataStream
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
POST
/v1beta/properties/{propertiesId}/firebaseLinks
Creates a FirebaseLink
GET
/v1beta/properties/{propertiesId}/firebaseLinks
Lists FirebaseLinks on a property
DELETE
/v1beta/properties/{propertiesId}/firebaseLinks/{firebaseLinksId}
Deletes a FirebaseLink on a property
POST
/v1beta/properties/{propertiesId}/googleAdsLinks
Creates a GoogleAdsLink
GET
/v1beta/properties/{propertiesId}/googleAdsLinks
Lists GoogleAdsLinks 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
POST
/v1beta/properties/{propertiesId}/keyEvents
Creates a Key Event
GET
/v1beta/properties/{propertiesId}/keyEvents
Returns a list of Key Events in the specified parent property
DELETE
/v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}
Deletes a Key Event
GET
/v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}
Retrieve a single Key Event
PATCH
/v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}
Updates a Key Event
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
Lists all audience lists for a property
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
POST
/v1alpha/properties/{propertiesId}/recurringAudienceLists
Creates a recurring audience list
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
POST
/v1alpha/properties/{propertiesId}/reportTasks
Initiates the creation of a report task
GET
/v1alpha/properties/{propertiesId}/reportTasks
Lists all report tasks for a property
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}:batchRunReports
Returns multiple 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
Lists all audience exports for a property
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
Schemas 339
The contract defines 339 schemas that model the data the API accepts and returns. The most detailed are RunReportRequest (15 properties), RunReportRequest_2 (15 properties), ReportDefinition (13 properties), GoogleAnalyticsAdminV1betaProperty (13 properties). Each schema is shown below with its type and property counts.
GoogleTypeDate
object
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is…
3 properties
GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter
object
A filter for a string-type dimension that matches a particular pattern.
3 properties
GoogleAnalyticsAdminV1alphaListExpandedDataSetsResponse
object
Response message for ListExpandedDataSets RPC.
2 properties
GoogleAnalyticsAdminV1alphaFirebaseLink
object
A link between a Google Analytics property and a Firebase project.
3 properties
GoogleAnalyticsAdminV1alphaReportingDataAnnotation
object
A Reporting Data Annotation is a comment connected to certain dates for reporting data.
7 properties
GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse
object
Response message for ListMeasurementProtocolSecret RPC
2 properties
GoogleAnalyticsAdminV1alphaConversionEventDefaultConversionValue
object
Defines a default value/currency for a conversion event. Both value and currency must be provided.
2 properties
GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinksResponse
object
Response message for ListDisplayVideo360AdvertiserLinks RPC.
2 properties
GoogleAnalyticsAdminV1alphaAudienceSimpleFilter
object
Defines a simple filter that a user must satisfy to be a member of the Audience.
2 properties
GoogleAnalyticsAdminV1alphaListAudiencesResponse
object
Response message for ListAudiences RPC.
2 properties
GoogleAnalyticsAdminV1alphaChannelGroupFilter
object
A specific filter for a single dimension.
3 properties
GoogleAnalyticsAdminV1alphaBigQueryLink
object
A link between a Google Analytics property and BigQuery project.
10 properties
GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest
object
Request message for ArchiveCustomMetric RPC.
GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpressionList
object
A list of ExpandedDataSet filter expressions.
1 property
GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsRequest
object
Request message for BatchCreateAccessBindings RPC.
1 property
GoogleAnalyticsAdminV1alphaExpandedDataSet
object
A resource message representing an ExpandedDataSet.
7 properties
GoogleAnalyticsAdminV1alphaUpdateAccessBindingRequest
object
Request message for UpdateAccessBinding RPC.
1 property
GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse
object
Response message for ListRollupPropertySourceLinks RPC.
2 properties
GoogleAnalyticsAdminV1alphaDeleteAccessBindingRequest
object
Request message for DeleteAccessBinding RPC.
1 property
GoogleAnalyticsAdminV1alphaRunAccessReportRequest
object
The request for a Data Access Record Report.
12 properties
GoogleAnalyticsAdminV1alphaListConversionEventsResponse
object
Response message for ListConversionEvents RPC.
2 properties
GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest
object
Request message for ArchiveCustomDimension RPC.
GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse
object
Response message for ListReportingDataAnnotation RPC.
2 properties
GoogleAnalyticsAdminV1alphaListDataStreamsResponse
object
Response message for ListDataStreams RPC.
2 properties
GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsResponse
object
Response message for BatchCreateAccessBindings RPC.
1 property
GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition
object
A specific filter expression
3 properties
GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression
object
A logical expression of EnhancedDataSet dimension filters.
3 properties
GoogleAnalyticsAdminV1alphaExpandedDataSetFilter
object
A specific filter for a single dimension
3 properties
GoogleAnalyticsAdminV1alphaAudience
object
A resource message representing an Audience.
9 properties
GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse
object
Response message for ListCustomDimensions RPC.
2 properties
GoogleAnalyticsAdminV1alphaAccessNumericFilter
object
Filters for numeric or date values.
2 properties
GoogleAnalyticsAdminV1alphaAttributionSettings
object
The attribution settings used for a given property. This is a singleton resource.
5 properties
GoogleAnalyticsAdminV1alphaSubpropertySyncConfig
object
Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automat…
3 properties
GoogleAnalyticsAdminV1alphaAccessBetweenFilter
object
To express that the result needs to be between two numbers (inclusive).
2 properties
GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter
object
A filter for numeric or date values on a dimension or metric.
2 properties
GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter
object
A filter for numeric or date values between certain values on a dimension or metric.
2 properties
GoogleAnalyticsAdminV1alphaAccessFilter
object
An expression to filter dimension or metric values.
5 properties
GoogleAnalyticsAdminV1alphaEventMapping
object
Event setting conditions to match an event.
5 properties
GoogleAnalyticsAdminV1alphaCustomDimension
object
A definition for a CustomDimension.
6 properties
GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter
object
A filter for a string-type dimension that matches a particular pattern.
3 properties
GoogleAnalyticsAdminV1alphaAccessOrderByMetricOrderBy
object
Sorts by metric values.
1 property
GoogleAnalyticsAdminV1alphaRollupPropertySourceLink
object
A link that references a source property under the parent rollup property.
2 properties
GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList
object
A list of Audience filter expressions.
1 property
GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse
object
Response message for CreateRollupProperty RPC.
2 properties
GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression
object
A logical expression of Channel Group dimension filters.
4 properties
GoogleAnalyticsAdminV1alphaListEventCreateRulesResponse
object
Response message for ListEventCreateRules RPC.
2 properties
GoogleAnalyticsAdminV1alphaAudienceFilterClause
object
A clause for defining either a simple or sequence filter. A filter can be inclusive (For example, users satisfying the filter clause are included in the Audien…
3 properties
GoogleAnalyticsAdminV1alphaGlobalSiteTag
object
Read-only resource with the tag for sending data from a website to a DataStream. Only present for web DataStream resources.
2 properties
GoogleAnalyticsAdminV1alphaSubmitUserDeletionResponse
object
Response message for SubmitUserDeletion RPC.
1 property
GoogleAnalyticsAdminV1alphaCalculatedMetric
object
A definition for a calculated metric.
8 properties
GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalRequest
object
Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
GoogleAnalyticsAdminV1alphaAccessMetric
object
The quantitative measurements of a report. For example, the metric accessCount is the total number of data access records.
1 property
GoogleAnalyticsAdminV1alphaExpandedDataSetFilterInListFilter
object
A filter for a string dimension that matches a particular list of options.
2 properties
GoogleAnalyticsAdminV1alphaGoogleAdsLink
object
A link between a Google Analytics property and a Google Ads account.
7 properties
GoogleAnalyticsAdminV1alphaDataRedactionSettings
object
Settings for client-side data redaction. Singleton resource under a Web Stream.
4 properties
GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpressionList
object
A list of Subproperty event filter expressions.
1 property
GoogleAnalyticsAdminV1alphaProvisionSubpropertyResponse
object
Response message for ProvisionSubproperty RPC.
2 properties
GoogleAnalyticsAdminV1alphaListGoogleAdsLinksResponse
object
Response message for ListGoogleAdsLinks RPC.
2 properties
GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse
object
Response message for ListFirebaseLinks RPC
2 properties
GoogleAnalyticsAdminV1alphaCustomMetric
object
A definition for a custom metric.
7 properties
GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter
object
A filter for a string dimension that matches a particular list of options.
2 properties
GoogleAnalyticsAdminV1alphaChannelGroupFilterStringFilter
object
Filter where the field value is a String. The match is case insensitive.
2 properties
GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings
object
Singleton resource under a web DataStream, configuring measurement of additional site interactions and content.
11 properties
GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep
object
A condition that must occur in the specified step order for this user to match the sequence.
4 properties
GoogleAnalyticsAdminV1alphaListCustomMetricsResponse
object
Response message for ListCustomMetrics RPC.
2 properties
GoogleAnalyticsAdminV1alphaAccessQuotaStatus
object
Current state for a particular quota group.
2 properties
GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink
object
A link between a Google Analytics property and a Display & Video 360 advertiser.
6 properties
GoogleAnalyticsAdminV1alphaAdSenseLink
object
A link between a Google Analytics property and an AdSense for Content ad client.
2 properties
GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause
object
A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty's data) or exclusive (events sat…
2 properties
GoogleAnalyticsAdminV1alphaDataStreamAndroidAppStreamData
object
Data specific to Android app streams.
2 properties
GoogleAnalyticsAdminV1alphaNumericValue
object
To represent a number.
2 properties
GoogleAnalyticsAdminV1alphaDataStreamWebStreamData
object
Data specific to web streams.
3 properties
GoogleAnalyticsAdminV1alphaRunAccessReportResponse
object
The customized Data Access Record Report response.
5 properties
GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest
object
Request message for AcknowledgeUserDataCollection RPC.
1 property
GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsResponse
object
Response message for BatchUpdateAccessBindings RPC.
1 property
GoogleAnalyticsAdminV1alphaAccessStringFilter
object
The filter for strings.
3 properties
GoogleAnalyticsAdminV1alphaListSubpropertySyncConfigsResponse
object
Response message for ListSubpropertySyncConfigs RPC.
2 properties
GoogleAnalyticsAdminV1alphaEventEditRule
object
An Event Edit Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutatio…
5 properties
GoogleAnalyticsAdminV1alphaDataStreamIosAppStreamData
object
Data specific to iOS app streams.
2 properties
GoogleAnalyticsAdminV1alphaSubmitUserDeletionRequest
object
Request message for SubmitUserDeletion RPC.
4 properties
GoogleAnalyticsAdminV1alphaAccessRow
object
Access report data for each row.
2 properties
GoogleAnalyticsAdminV1alphaGroupingRule
object
The rules that govern how traffic is grouped into one channel.
2 properties
GoogleAnalyticsAdminV1alphaAudienceSequenceFilter
object
Defines filters that must occur in a specific order for the user to be a member of the Audience.
3 properties
GoogleAnalyticsAdminV1alphaAudienceEventFilter
object
A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and th…
2 properties
GoogleAnalyticsAdminV1alphaListCalculatedMetricsResponse
object
Response message for ListCalculatedMetrics RPC.
2 properties
GoogleAnalyticsAdminV1alphaParameterMutation
object
Defines an event parameter to mutate.
2 properties
GoogleAnalyticsAdminV1alphaAccessOrderBy
object
Order bys define how rows will be sorted in the response. For example, ordering rows by descending access count is one ordering, and ordering rows by the count…
3 properties
GoogleAnalyticsAdminV1alphaDataRetentionSettings
object
Settings values for data retention. This is a singleton resource.
4 properties
GoogleAnalyticsAdminV1alphaListAdSenseLinksResponse
object
Response message for ListAdSenseLinks method.
2 properties
GoogleAnalyticsAdminV1alphaUserProvidedDataSettings
object
Configuration for user-provided data collection. This is a singleton resource for a Google Analytics property.
3 properties
GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange
object
Represents a Reporting Data Annotation's date range, both start and end dates are inclusive. Time zones are based on the parent property.
2 properties
GoogleAnalyticsAdminV1alphaChannelGroup
object
A resource message representing a Channel Group.
6 properties
GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal
object
A proposal for a link between a Google Analytics property and a Display & Video 360 advertiser. A proposal is converted to a DisplayVideo360AdvertiserLink once…
8 properties
GoogleAnalyticsAdminV1alphaConversionValues
object
Conversion value settings for a postback window for SKAdNetwork conversion value schema.
5 properties
GoogleAnalyticsAdminV1alphaListSubpropertyEventFiltersResponse
object
Response message for ListSubpropertyEventFilter RPC.
2 properties
GoogleProtobufEmpty
object
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the resp…
GoogleAnalyticsAdminV1alphaAccessFilterExpressionList
object
A list of filter expressions.
1 property
GoogleAnalyticsAdminV1alphaAccessOrderByDimensionOrderBy
object
Sorts by dimension values.
2 properties
GoogleAnalyticsAdminV1alphaKeyEvent
object
A key event in a Google Analytics property.
7 properties
GoogleAnalyticsAdminV1alphaAccessInListFilter
object
The result needs to be in a list of string values.
2 properties
GoogleAnalyticsAdminV1alphaListPropertiesResponse
object
Response message for ListProperties RPC.
2 properties
GoogleAnalyticsAdminV1alphaAccessQuota
object
Current state of all quotas for this Analytics property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted…
5 properties
GoogleAnalyticsAdminV1alphaConversionEvent
object
A conversion event in a Google Analytics property.
7 properties
GoogleAnalyticsAdminV1alphaListChannelGroupsResponse
object
Response message for ListChannelGroups RPC.
2 properties
GoogleAnalyticsAdminV1alphaSKAdNetworkConversionValueSchema
object
SKAdNetwork conversion value schema of an iOS stream.
5 properties
GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse
object
Response message for BatchGetAccessBindings RPC.
1 property
GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalResponse
object
Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
1 property
GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue
object
To represent a number.
2 properties
GoogleAnalyticsAdminV1alphaPostbackWindow
object
Settings for a SKAdNetwork conversion postback window.
2 properties
GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinkProposalsResponse
object
Response message for ListDisplayVideo360AdvertiserLinkProposals RPC.
2 properties
GoogleAnalyticsAdminV1alphaGoogleSignalsSettings
object
Settings values for Google Signals. This is a singleton resource.
3 properties
GoogleAnalyticsAdminV1alphaChannelGroupFilterExpressionList
object
A list of Channel Group filter expressions.
1 property
GoogleAnalyticsAdminV1alphaAccessDimensionValue
object
The value of a dimension.
1 property
GoogleAnalyticsAdminV1alphaSearchAds360Link
object
A link between a Google Analytics property and a Search Ads 360 entity.
7 properties
GoogleAnalyticsAdminV1alphaEventCreateRule
object
An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutat…
5 properties
GoogleAnalyticsAdminV1alphaListAccessBindingsResponse
object
Response message for ListAccessBindings RPC.
2 properties
GoogleAnalyticsAdminV1alphaListSKAdNetworkConversionValueSchemasResponse
object
Response message for ListSKAdNetworkConversionValueSchemas RPC
2 properties
GoogleAnalyticsAdminV1alphaAccessMetricValue
object
The value of a metric.
1 property
GoogleAnalyticsAdminV1alphaKeyEventDefaultValue
object
Defines a default value/currency for a key event.
2 properties
GoogleAnalyticsAdminV1alphaProperty
object
A resource message representing a Google Analytics property.
13 properties
GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest
object
Request message for CreateRollupProperty RPC.
2 properties
GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse
object
Response message for ListBigQueryLinks RPC
2 properties
GoogleAnalyticsAdminV1alphaAudienceFilterExpression
object
A logical expression of Audience dimension, metric, or event filters.
5 properties
GoogleAnalyticsAdminV1alphaChannelGroupFilterInListFilter
object
A filter for a string dimension that matches a particular list of options. The match is case insensitive.
1 property
GoogleAnalyticsAdminV1alphaAccessBinding
object
A binding of a user to a set of roles.
3 properties
GoogleAnalyticsAdminV1alphaListEventEditRulesResponse
object
Response message for ListEventEditRules RPC.
2 properties
GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression
object
A logical expression of Subproperty event filters.
3 properties
GoogleAnalyticsAdminV1alphaCreateAccessBindingRequest
object
Request message for CreateAccessBinding RPC.
2 properties
GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest
object
Request message for CreateSubproperty RPC.
3 properties
GoogleAnalyticsAdminV1alphaListKeyEventsResponse
object
Response message for ListKeyEvents RPC.
2 properties
GoogleAnalyticsAdminV1alphaBatchDeleteAccessBindingsRequest
object
Request message for BatchDeleteAccessBindings RPC.
1 property
GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse
object
Response message for ListSearchAds360Links RPC.
2 properties
GoogleAnalyticsAdminV1alphaAccessDateRange
object
A contiguous range of days: startDate, startDate + 1, ..., endDate.
2 properties
GoogleAnalyticsAdminV1alphaSubpropertyEventFilter
object
A resource message representing a Google Analytics subproperty event filter.
3 properties
GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter
object
A specific filter for a single dimension or metric.
7 properties
GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsRequest
object
Request message for BatchUpdateAccessBindings RPC.
1 property
GoogleAnalyticsAdminV1alphaAudienceEventTrigger
object
Specifies an event to log when a user joins the Audience.
2 properties
GoogleAnalyticsAdminV1alphaArchiveAudienceRequest
object
Request message for ArchiveAudience RPC.
GoogleAnalyticsAdminV1alphaAccessDimensionHeader
object
Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used…
1 property
GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse
object
Response message for AcknowledgeUserDataCollection RPC.
GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails
object
Status information for a link proposal.
3 properties
GoogleAnalyticsAdminV1alphaDataStream
object
A resource message representing a data stream.
8 properties
GoogleAnalyticsAdminV1alphaMatchingCondition
object
Defines a condition for when an Event Edit or Event Creation rule applies to an event.
4 properties
GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
object
A secret value used for sending hits to Measurement Protocol.
3 properties
GoogleAnalyticsAdminV1alphaExpandedDataSetFilterStringFilter
object
A filter for a string-type dimension that matches a particular pattern.
3 properties
GoogleAnalyticsAdminV1alphaAccessDimension
object
Dimensions are attributes of your data. For example, the dimension userEmail indicates the email of the user that accessed reporting data. Dimension values in…
1 property
GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest
object
Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC.
GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest
object
Request message for ReorderEventEditRules RPC.
1 property
GoogleAnalyticsAdminV1alphaAccessMetricHeader
object
Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used excl…
1 property
GoogleRpcStatus
object
Canonical google.rpc.Status error payload returned by Google APIs.
3 properties
GoogleAnalyticsAdminV1alphaReportingIdentitySettings
object
A resource containing settings related to reporting identity.
2 properties
GoogleAnalyticsAdminV1alphaAccessFilterExpression
object
Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics.
4 properties
GoogleAnalyticsAdminV1betaAccessDimensionValue
object
The value of a dimension.
1 property
GoogleAnalyticsAdminV1betaDataRetentionSettings
object
Settings values for data retention. This is a singleton resource.
4 properties
GoogleAnalyticsAdminV1betaKeyEvent
object
A key event in a Google Analytics property.
7 properties
GoogleAnalyticsAdminV1betaNumericValue
object
To represent a number.
2 properties
GoogleAnalyticsAdminV1betaAccessMetricHeader
object
Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used excl…
1 property
GoogleAnalyticsAdminV1betaListDataStreamsResponse
object
Response message for ListDataStreams RPC.
2 properties
GoogleAnalyticsAdminV1betaCustomDimension
object
A definition for a CustomDimension.
6 properties
GoogleAnalyticsAdminV1betaConversionEvent
object
A conversion event in a Google Analytics property.
7 properties
GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue
object
Defines a default value/currency for a conversion event. Both value and currency must be provided.
2 properties
GoogleAnalyticsAdminV1betaAccessDateRange
object
A contiguous range of days: startDate, startDate + 1, ..., endDate.
2 properties
GoogleAnalyticsAdminV1betaKeyEventDefaultValue
object
Defines a default value/currency for a key event.
2 properties
GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy
object
Sorts by metric values.
1 property
GoogleAnalyticsAdminV1betaDataStreamWebStreamData
object
Data specific to web streams.
3 properties
GoogleAnalyticsAdminV1betaRunAccessReportRequest
object
The request for a Data Access Record Report.
12 properties
GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest
object
Request message for ArchiveCustomMetric RPC.
GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData
object
Data specific to iOS app streams.
2 properties
GoogleAnalyticsAdminV1betaAccessFilterExpression
object
Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics.
4 properties
GoogleAnalyticsAdminV1betaAccessFilterExpressionList
object
A list of filter expressions.
1 property
GoogleAnalyticsAdminV1betaAccessMetricValue
object
The value of a metric.
1 property
GoogleAnalyticsAdminV1betaFirebaseLink
object
A link between a Google Analytics property and a Firebase project.
3 properties
GoogleAnalyticsAdminV1betaMeasurementProtocolSecret
object
A secret value used for sending hits to Measurement Protocol.
3 properties
GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest
object
Request message for ArchiveCustomDimension RPC.
GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy
object
Sorts by dimension values.
2 properties
GoogleAnalyticsAdminV1betaAccessRow
object
Access report data for each row.
2 properties
GoogleAnalyticsAdminV1betaAccessBetweenFilter
object
To express that the result needs to be between two numbers (inclusive).
2 properties
GoogleAnalyticsAdminV1betaListFirebaseLinksResponse
object
Response message for ListFirebaseLinks RPC
2 properties
GoogleAnalyticsAdminV1betaAccessMetric
object
The quantitative measurements of a report. For example, the metric accessCount is the total number of data access records.
1 property
GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse
object
Response message for ListGoogleAdsLinks RPC.
2 properties
GoogleAnalyticsAdminV1betaAccessInListFilter
object
The result needs to be in a list of string values.
2 properties
GoogleAnalyticsAdminV1betaListKeyEventsResponse
object
Response message for ListKeyEvents RPC.
2 properties
GoogleAnalyticsAdminV1betaAccessFilter
object
An expression to filter dimension or metric values.
5 properties
GoogleAnalyticsAdminV1betaAccessQuota
object
Current state of all quotas for this Analytics property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted…
5 properties
GoogleAnalyticsAdminV1betaAccessDimensionHeader
object
Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used…
1 property
GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest
object
Request message for AcknowledgeUserDataCollection RPC.
1 property
GoogleAnalyticsAdminV1betaAccessDimension
object
Dimensions are attributes of your data. For example, the dimension userEmail indicates the email of the user that accessed reporting data. Dimension values in…
1 property
GoogleAnalyticsAdminV1betaAccessStringFilter
object
The filter for strings.
3 properties
GoogleAnalyticsAdminV1betaListCustomDimensionsResponse
object
Response message for ListCustomDimensions RPC.
2 properties
GoogleAnalyticsAdminV1betaAccessNumericFilter
object
Filters for numeric or date values.
2 properties
GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData
object
Data specific to Android app streams.
2 properties
GoogleAnalyticsAdminV1betaListConversionEventsResponse
object
Response message for ListConversionEvents RPC.
2 properties
GoogleAnalyticsAdminV1betaDataStream
object
A resource message representing a data stream.
8 properties
GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse
object
Response message for AcknowledgeUserDataCollection RPC.
GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse
object
Response message for ListMeasurementProtocolSecret RPC
2 properties
GoogleAnalyticsAdminV1betaListPropertiesResponse
object
Response message for ListProperties RPC.
2 properties
GoogleAnalyticsAdminV1betaAccessOrderBy
object
Order bys define how rows will be sorted in the response. For example, ordering rows by descending access count is one ordering, and ordering rows by the count…
3 properties
GoogleAnalyticsAdminV1betaGoogleAdsLink
object
A link between a Google Analytics property and a Google Ads account.
7 properties
GoogleAnalyticsAdminV1betaProperty
object
A resource message representing a Google Analytics property.
13 properties
GoogleAnalyticsAdminV1betaRunAccessReportResponse
object
The customized Data Access Record Report response.
5 properties
GoogleAnalyticsAdminV1betaListCustomMetricsResponse
object
Response message for ListCustomMetrics RPC.
2 properties
GoogleAnalyticsAdminV1betaCustomMetric
object
A definition for a custom metric.
7 properties
GoogleAnalyticsAdminV1betaAccessQuotaStatus
object
Current state for a particular quota group.
2 properties
InListFilter
object
The result needs to be in a list of string values.
2 properties
QueryReportTaskResponse
object
The report content corresponding to a report task.
8 properties
DimensionValue
object
The value of a dimension.
1 property
FunnelStep
object
Steps define the user journey you want to measure. Steps contain one or more conditions that your users must meet to be included in that step of the funnel jou…
4 properties
SchemaRestrictionResponse
object
The schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analy…
1 property
CohortsRange
object
Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.
3 properties
SamplingMetadata
object
If funnel report results are [sampled](https://support.google.com/analytics/answer/13331292), this metadata describes what percentage of events were used in th…
2 properties
Metadata
object
The dimensions, metrics and comparisons currently accepted in reporting methods.
5 properties
Comparison
object
Defines an individual comparison. Most requests will include multiple comparisons so that the report compares between the comparisons.
3 properties
SessionSegmentCriteria
object
A session matches a criteria if the session's events meet the conditions in the criteria.
1 property
Segment
object
A segment is a subset of your Analytics data. For example, of your entire set of users, one segment might be users from a particular country or city. Another s…
4 properties
StringFilter
object
The filter for string
3 properties
SegmentParameterFilterExpressionList
object
A list of segment parameter filter expressions.
1 property
FilterExpressionList
object
A list of filter expressions.
1 property
ConversionSpec
object
Controls conversion reporting. This feature may not be available to your Google Analytics property. The Google Analytics team is actively working to expand thi…
2 properties
SegmentFilterScoping
object
Scopings specify how the dimensions & metrics of multiple events should be considered when evaluating a segment filter.
1 property
AudienceRow
object
Dimension value attributes for the audience user row.
1 property
Filter
object
An expression to filter dimension or metric values.
6 properties
NumericValue
object
To represent a number.
2 properties
UserSegment
object
User segments are subsets of users who engaged with your site or app. For example, users who have previously purchased; users who added items to their shopping…
2 properties
FunnelNextAction
object
Next actions state the value for a dimension after the user has achieved a step but before the same user has achieved the next step. For example if the nextAct…
2 properties
WebhookNotification
object
Configures a long-running operation resource to send a webhook notification from the Google Analytics Data API to your webhook server when the resource updates…
2 properties
FunnelFilterExpression
object
Expresses combinations of funnel filters.
5 properties
FunnelParameterFilter
object
An expression to filter parameter values in a funnel.
6 properties
SessionSegment
object
Session segments are subsets of the sessions that occurred on your site or app: for example, all the sessions that originated from a particular advertising cam…
2 properties
FunnelBreakdown
object
Breakdowns add a dimension to the funnel table sub report response.
2 properties
ComparisonMetadata
object
The metadata for a single comparison.
3 properties
ConcatenateExpression
object
Used to combine dimension values to a single dimension.
2 properties
MetricOrderBy
object
Sorts by metric values.
1 property
SegmentFilterExpressionList
object
A list of segment filter expressions.
1 property
MetricHeader
object
Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used excl…
2 properties
FunnelEventFilter
object
Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the singl…
2 properties
ListAudienceListsResponse
object
A list of all audience lists for a property.
2 properties
RecurringAudienceList
object
A recurring audience list produces new audience lists each day. Audience lists are users in an audience at the time of the list's creation. A recurring audienc…
7 properties
UserSegmentCriteria
object
A user matches a criteria if the user's events meet the conditions in the criteria.
2 properties
FunnelFilterExpressionList
object
A list of funnel filter expressions.
1 property
ActiveMetricRestriction
object
A metric actively restricted in creating the report.
2 properties
PropertyQuotasSnapshot
object
Current state of all Property Quotas organized by quota category.
4 properties
EventSegmentCriteria
object
An event matches a criteria if the event meet the conditions in the criteria.
1 property
CaseExpression
object
Used to convert a dimension value to a single case.
1 property
ReportMetadata
object
The report metadata for a specific report task.
6 properties
DateRange
object
A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.
3 properties
Operation
object
This resource represents a long-running operation that is the result of a network API call.
5 properties
QueryReportTaskRequest
object
A request to fetch the report content for a report task.
2 properties
MetricMetadata
object
Explains a metric.
10 properties
MetricValue
object
The value of a metric.
1 property
EventSegmentExclusion
object
Specifies which events are excluded in this segment.
2 properties
SessionSegmentExclusion
object
Specifies which sessions are excluded in this segment.
2 properties
CohortReportSettings
object
Optional settings of a cohort report.
1 property
FunnelResponseMetadata
object
The funnel report's response metadata carries additional information about the funnel report.
1 property
ConversionMetadata
object
The metadata for a single conversion. This feature may not be available to your Google Analytics property. The Google Analytics team is actively working to exp…
2 properties
Cohort
object
Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same firstSessionDate belong t…
3 properties
QueryAudienceListRequest
object
A request to list users in an audience list.
2 properties
ReportTask
object
A specific report task configuration.
3 properties
SessionSegmentConditionGroup
object
Conditions tell Analytics what data to include in or exclude from the segment.
2 properties
QuotaStatus
object
Current state for a particular quota group.
2 properties
ReportDefinition
object
The definition of how a report should be run.
13 properties
DimensionExpression
object
Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lowercase(dimension) 2) concatenate(dimension1, symbol,…
3 properties
SegmentParameterFilterExpression
object
Expresses combinations of segment filter on parameters.
4 properties
FunnelParameterFilterExpressionList
object
A list of funnel parameter filter expressions.
1 property
RunFunnelReportResponse
object
The funnel report response contains two sub reports. The two sub reports are different combinations of dimensions and metrics.
4 properties
FilterExpression
object
To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.
4 properties
SegmentFilterExpression
object
Expresses combinations of segment filters.
5 properties
SegmentFilter
object
An expression to filter dimension or metric values.
6 properties
ResponseMetaData
object
Response's metadata carrying additional information about the report content.
8 properties
SegmentParameterFilterScoping
object
Scopings specify how multiple events should be considered when evaluating a segment parameter filter.
1 property
OrderBy
object
Order bys define how rows will be sorted in the response. For example, ordering rows by descending event count is one ordering, and ordering rows by the event…
3 properties
UserSegmentConditionGroup
object
Conditions tell Analytics what data to include in or exclude from the segment.
2 properties
ListRecurringAudienceListsResponse
object
A list of all recurring audience lists for a property.
2 properties
AudienceDimension
object
An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the QueryAudienceListResponse.
1 property
EmptyFilter
object
Filter for empty values.
SegmentEventFilter
object
Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the singl…
2 properties
RunReportResponse
object
The response report table corresponding to a request.
11 properties
UserSegmentExclusion
object
Specifies which users are excluded in this segment.
2 properties
DimensionMetadata
object
Explains a dimension.
7 properties
EventSegmentConditionGroup
object
Conditions tell Analytics what data to include in or exclude from the segment.
2 properties
UserSegmentSequenceGroup
object
Define conditions that must occur in a specific order for the user to be a member of the segment.
3 properties
NumericFilter
object
Filters for numeric or date values.
2 properties
Metric
object
The quantitative measurements of a report. For example, the metric eventCount is the total number of events. Requests are allowed up to 10 metrics.
3 properties
PropertyQuota
object
Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted…
6 properties
ListReportTasksResponse
object
A list of all report tasks for a property.
2 properties
FunnelSubReport
object
Funnel sub reports contain the dimension and metric data values. For example, 12 users reached the second step of the funnel.
4 properties
CohortSpec
object
The specification of cohorts for a cohort report. Cohort reports create a time series of user retention for the cohort. For example, you could select the cohor…
3 properties
Dimension
object
Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses…
2 properties
RunFunnelReportRequest
object
The request for a funnel report.
9 properties
SegmentParameterFilter
object
An expression to filter parameter values in a segment.
7 properties
EventSegment
object
Event segments are subsets of events that were triggered on your site or app. for example, all purchase events made in a particular location; appexception even…
2 properties
BetweenFilter
object
To express that the result needs to be between two numbers (inclusive).
2 properties
FunnelParameterFilterExpression
object
Expresses combinations of funnel filters on parameters.
4 properties
QueryAudienceListResponse
object
A list of users in an audience list.
3 properties
UserSequenceStep
object
A condition that must occur in the specified step order for this user to match the sequence.
3 properties
Funnel
object
Configures the funnel in a funnel report request. A funnel reports on users as they pass through a sequence of steps. Funnel exploration lets you visualize the…
2 properties
Status
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
DimensionOrderBy
object
Sorts by dimension values.
2 properties
AudienceList
object
An audience list is a list of users in an audience at the time of the list's creation. One audience may have multiple audience lists created for different days.
12 properties
AudienceDimensionValue
object
The value of a dimension.
1 property
RunReportRequest
object
The request to generate a report.
15 properties
DimensionHeader
object
Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used…
1 property
FunnelFieldFilter
object
An expression to filter dimension or metric values.
5 properties
Row
object
Report data for each row. For example if RunReportRequest contains: none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "na…
2 properties
CheckCompatibilityResponse
object
The compatibility response with the compatibility of each dimension & metric.
2 properties
QueryAudienceExportRequest
object
A request to list users in an audience export.
2 properties
ResponseMetaData_2
object
Response's metadata carrying additional information about the report content.
7 properties
Dimension_2
object
Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses…
2 properties
PivotDimensionHeader
object
Summarizes dimension values from a row for this pivot.
1 property
RunPivotReportRequest
object
The request to generate a pivot report.
12 properties
BatchRunReportsRequest
object
The batch request containing multiple report requests.
1 property
MetricCompatibility
object
The compatibility for a single metric.
2 properties
OrderBy_2
object
Order bys define how rows will be sorted in the response. For example, ordering rows by descending event count is one ordering, and ordering rows by the event…
4 properties
V1betaAudienceDimensionValue
object
The value of a dimension.
1 property
SamplingMetadata_2
object
If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. Samplin…
2 properties
V1betaAudienceRow
object
Dimension value attributes for the audience user row.
1 property
ComparisonMetadata_2
object
The metadata for a single comparison.
3 properties
CheckCompatibilityRequest
object
The request for compatibility information for a report's dimensions and metrics. Check compatibility provides a preview of the compatibility of a report; field…
5 properties
BatchRunPivotReportsRequest
object
The batch request containing multiple pivot report requests.
1 property
Metadata_2
object
The dimensions, metrics and comparisons currently accepted in reporting methods.
4 properties
Pivot
object
Describes the visible dimension columns and rows in the report response.
5 properties
RunReportResponse_2
object
The response report table corresponding to a request.
10 properties
DimensionMetadata_2
object
Explains a dimension.
6 properties
BatchRunPivotReportsResponse
object
The batch response containing multiple pivot reports.
2 properties
PivotHeader
object
Dimensions' values in a single pivot.
2 properties
RunRealtimeReportResponse
object
The response realtime report table corresponding to a request.
9 properties
V1betaAudienceDimension
object
An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the QueryAudienceExportResponse.
1 property
RunRealtimeReportRequest
object
The request to generate a realtime report.
9 properties
AudienceExport
object
An audience export is a list of users in an audience at the time of the list's creation. One audience may have multiple audience exports created for different…
10 properties
PivotOrderBy
object
Sorts by a pivot column group.
2 properties
QueryAudienceExportResponse
object
A list of users in an audience export.
3 properties
DimensionCompatibility
object
The compatibility for a single dimension.
2 properties
PivotSelection
object
A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric's value. For example if pivots = {{"browser", "Chrome"}} an…
2 properties
MetricMetadata_2
object
Explains a metric.
9 properties
Filter_2
object
An expression to filter dimension or metric values.
6 properties
RunReportRequest_2
object
The request to generate a report.
15 properties
RunPivotReportResponse
object
The response pivot report table corresponding to a pivot request.
8 properties
BatchRunReportsResponse
object
The batch response containing multiple reports.
2 properties
ListAudienceExportsResponse
object
A list of all audience exports for a property.
2 properties
MinuteRange
object
A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Requests are allowed up to 2 minute ranges.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Google Analytics 4 3
Other APIs Google Analytics 4 publishes across the network.
Google Analytics Measurement Protocol
Google Analytics 4 Accounts API
Google Analytics 4 Account Summaries API
#Properties
Where this information came from
This is an independent, third-party profile of Google Analytics 4 Properties API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.