How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Google Analytics 4

Google Analytics Admin API

Configuration API for GA4 — accounts, properties, data streams, Measurement Protocol secrets, custom dimensions and metrics, key events, data retention and redaction settings, audiences, access bindings, and links to Google Ads, Firebase, BigQuery, AdSense, Display & Video 360 and Search Ads 360. 55 operations on v1beta and 166 on v1alpha, harvested from Google's own Discovery documents.

Documentation Provider Profile APIs.io OpenAPI GitHub

Google Analytics Admin API is one of 3 APIs that Google Analytics 4 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Configuration, Administration, V1beta, and V1alpha. 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 55 operations across 30 paths, organized into 3 resource areas, and defines 66 schemas. It is described by OpenAPI 3.1.0, at version v1beta.

Requests are made against a single base URL, https://analyticsadmin.googleapis.com.

55 operations 30 paths 66 schemas 8 DELETE21 GET10 PATCH16 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1beta
Base URL
https://analyticsadmin.googleapis.com
Authentication
OAuth 2.0, HTTP Bearer
Contact
Google
Resource Areas
3

Authentication & Security 2

Google Analytics Admin API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 2 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 55

Across 30 paths, the API surfaces 55 operations — 8 DELETE, 21 GET, 10 PATCH, 16 POST. They span 3 resource areas: accountSummaries, accounts, properties. Each is listed below with its method, path, parameters, and response codes.

accountSummaries 1
GET
/v1beta/accountSummaries
Returns summaries of all accounts accessible by the caller
accountSummaries_list 2 params → 200default
accounts 8
DELETE
/v1beta/accounts/{accountsId}
Marks target Account as soft-deleted (ie: "trashed") and returns it
accounts_delete 2 params → 200default
GET
/v1beta/accounts/{accountsId}
Lookup for a single Account
accounts_get 2 params → 200default
PATCH
/v1beta/accounts/{accountsId}
Updates an account
accounts_patch 3 params body → 200default
GET
/v1beta/accounts/{accountsId}/dataSharingSettings
Get data sharing settings on an account
accounts_getDataSharingSettings 2 params → 200default
GET
/v1beta/accounts
Returns all accounts accessible by the caller
accounts_list 3 params → 200default
POST
/v1beta/accounts:provisionAccountTicket
Requests a ticket for creating an account
accounts_provisionAccountTicket body → 200default
POST
/v1beta/accounts/{accountsId}:runAccessReport
Returns a customized report of data access records
accounts_runAccessReport 2 params body → 200default
POST
/v1beta/accounts/{accountsId}:searchChangeHistoryEvents
Searches through all changes to an account or its children given the specified set of filters
accounts_searchChangeHistoryEvents 2 params body → 200default
properties 46
POST
/v1beta/properties/{propertiesId}:acknowledgeUserDataCollection
Acknowledges the terms of user data collection for the specified property
properties_acknowledgeUserDataCollection 2 params body → 200default
POST
/v1beta/properties
Creates a Google Analytics property with the specified location and attributes
properties_create body → 200default
GET
/v1beta/properties
Returns child Properties under the specified parent Account
properties_list 4 params → 200default
DELETE
/v1beta/properties/{propertiesId}
Marks target Property as soft-deleted (ie: "trashed") and returns it
properties_delete 2 params → 200default
GET
/v1beta/properties/{propertiesId}
Lookup for a single GA Property
properties_get 2 params → 200default
PATCH
/v1beta/properties/{propertiesId}
Updates a property
properties_patch 3 params body → 200default
GET
/v1beta/properties/{propertiesId}/dataRetentionSettings
Returns the singleton data retention settings for this property
properties_getDataRetentionSettings 2 params → 200default
PATCH
/v1beta/properties/{propertiesId}/dataRetentionSettings
Updates the singleton data retention settings for this property
properties_updateDataRetentionSettings 3 params body → 200default
POST
/v1beta/properties/{propertiesId}:runAccessReport
Returns a customized report of data access records
properties_runAccessReport 2 params body → 200default
POST
/v1beta/properties/{propertiesId}/conversionEventsdeprecated
Deprecated: Use CreateKeyEvent instead
properties_conversionEvents_create 2 params body → 200default
GET
/v1beta/properties/{propertiesId}/conversionEventsdeprecated
Deprecated: Use ListKeyEvents instead
properties_conversionEvents_list 4 params → 200default
DELETE
/v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}deprecated
Deprecated: Use DeleteKeyEvent instead
properties_conversionEvents_delete 3 params → 200default
GET
/v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}deprecated
Deprecated: Use GetKeyEvent instead
properties_conversionEvents_get 3 params → 200default
PATCH
/v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}deprecated
Deprecated: Use UpdateKeyEvent instead
properties_conversionEvents_patch 4 params body → 200default
POST
/v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}:archive
Archives a CustomDimension on a property
properties_customDimensions_archive 3 params body → 200default
POST
/v1beta/properties/{propertiesId}/customDimensions
Creates a CustomDimension
properties_customDimensions_create 2 params body → 200default
GET
/v1beta/properties/{propertiesId}/customDimensions
Lists CustomDimensions on a property
properties_customDimensions_list 4 params → 200default
GET
/v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}
Lookup for a single CustomDimension
properties_customDimensions_get 3 params → 200default
PATCH
/v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}
Updates a CustomDimension on a property
properties_customDimensions_patch 4 params body → 200default
POST
/v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}:archive
Archives a CustomMetric on a property
properties_customMetrics_archive 3 params body → 200default
POST
/v1beta/properties/{propertiesId}/customMetrics
Creates a CustomMetric
properties_customMetrics_create 2 params body → 200default
GET
/v1beta/properties/{propertiesId}/customMetrics
Lists CustomMetrics on a property
properties_customMetrics_list 4 params → 200default
GET
/v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}
Lookup for a single CustomMetric
properties_customMetrics_get 3 params → 200default
PATCH
/v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}
Updates a CustomMetric on a property
properties_customMetrics_patch 4 params body → 200default
POST
/v1beta/properties/{propertiesId}/dataStreams
Creates a DataStream
properties_dataStreams_create 2 params body → 200default
GET
/v1beta/properties/{propertiesId}/dataStreams
Lists DataStreams on a property
properties_dataStreams_list 4 params → 200default
DELETE
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}
Deletes a DataStream on a property
properties_dataStreams_delete 3 params → 200default
GET
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}
Lookup for a single DataStream
properties_dataStreams_get 3 params → 200default
PATCH
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}
Updates a DataStream on a property
properties_dataStreams_patch 4 params body → 200default
POST
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets
Creates a measurement protocol secret
properties_dataStreams_measurementProtocolSecrets_create 3 params body → 200default
GET
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets
Returns child MeasurementProtocolSecrets under the specified parent Property
properties_dataStreams_measurementProtocolSecrets_list 5 params → 200default
DELETE
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}
Deletes target MeasurementProtocolSecret
properties_dataStreams_measurementProtocolSecrets_delete 4 params → 200default
GET
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}
Lookup for a single MeasurementProtocolSecret
properties_dataStreams_measurementProtocolSecrets_get 4 params → 200default
PATCH
/v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}
Updates a measurement protocol secret
properties_dataStreams_measurementProtocolSecrets_patch 5 params body → 200default
POST
/v1beta/properties/{propertiesId}/firebaseLinks
Creates a FirebaseLink
properties_firebaseLinks_create 2 params body → 200default
GET
/v1beta/properties/{propertiesId}/firebaseLinks
Lists FirebaseLinks on a property
properties_firebaseLinks_list 4 params → 200default
DELETE
/v1beta/properties/{propertiesId}/firebaseLinks/{firebaseLinksId}
Deletes a FirebaseLink on a property
properties_firebaseLinks_delete 3 params → 200default
POST
/v1beta/properties/{propertiesId}/googleAdsLinks
Creates a GoogleAdsLink
properties_googleAdsLinks_create 2 params body → 200default
GET
/v1beta/properties/{propertiesId}/googleAdsLinks
Lists GoogleAdsLinks on a property
properties_googleAdsLinks_list 4 params → 200default
DELETE
/v1beta/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}
Deletes a GoogleAdsLink on a property
properties_googleAdsLinks_delete 3 params → 200default
PATCH
/v1beta/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}
Updates a GoogleAdsLink on a property
properties_googleAdsLinks_patch 4 params body → 200default
POST
/v1beta/properties/{propertiesId}/keyEvents
Creates a Key Event
properties_keyEvents_create 2 params body → 200default
GET
/v1beta/properties/{propertiesId}/keyEvents
Returns a list of Key Events in the specified parent property
properties_keyEvents_list 4 params → 200default
DELETE
/v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}
Deletes a Key Event
properties_keyEvents_delete 3 params → 200default
GET
/v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}
Retrieve a single Key Event
properties_keyEvents_get 3 params → 200default
PATCH
/v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}
Updates a Key Event
properties_keyEvents_patch 4 params body → 200default

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are GoogleAnalyticsAdminV1betaProperty (13 properties), GoogleAnalyticsAdminV1betaRunAccessReportRequest (12 properties), GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource (8 properties), GoogleAnalyticsAdminV1betaDataStream (8 properties). Each schema is shown below with its type and property counts.

GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue
object
Defines a default value/currency for a conversion event. Both value and currency must be provided.
2 properties
GoogleAnalyticsAdminV1betaCustomDimension
object
A definition for a CustomDimension.
6 properties
GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse
object
Response message for AcknowledgeUserDataCollection RPC.
GoogleAnalyticsAdminV1betaAccessBetweenFilter
object
To express that the result needs to be between two numbers (inclusive).
2 properties
GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData
object
Data specific to iOS app streams.
2 properties
GoogleAnalyticsAdminV1betaPropertySummary
object
A virtual resource representing metadata for a Google Analytics property.
5 properties
GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse
object
Response message for SearchAccounts RPC.
2 properties
GoogleAnalyticsAdminV1betaKeyEventDefaultValue
object
Defines a default value/currency for a key event.
2 properties
GoogleAnalyticsAdminV1betaAccessRow
object
Access report data for each row.
2 properties
GoogleAnalyticsAdminV1betaCustomMetric
object
A definition for a custom metric.
7 properties
GoogleAnalyticsAdminV1betaDataSharingSettings
object
A resource message representing data sharing settings of a Google Analytics account.
6 properties
GoogleAnalyticsAdminV1betaAccessFilter
object
An expression to filter dimension or metric values.
5 properties
GoogleAnalyticsAdminV1betaMeasurementProtocolSecret
object
A secret value used for sending hits to Measurement Protocol.
3 properties
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
GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy
object
Sorts by dimension values.
2 properties
GoogleAnalyticsAdminV1betaRunAccessReportResponse
object
The customized Data Access Record Report response.
5 properties
GoogleAnalyticsAdminV1betaDataStreamWebStreamData
object
Data specific to web streams.
3 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
GoogleAnalyticsAdminV1betaListFirebaseLinksResponse
object
Response message for ListFirebaseLinks RPC
2 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
GoogleAnalyticsAdminV1betaListCustomMetricsResponse
object
Response message for ListCustomMetrics RPC.
2 properties
GoogleAnalyticsAdminV1betaKeyEvent
object
A key event in a Google Analytics property.
7 properties
GoogleAnalyticsAdminV1betaChangeHistoryChange
object
A description of a change to a single Google Analytics resource.
4 properties
GoogleAnalyticsAdminV1betaProperty
object
A resource message representing a Google Analytics property.
13 properties
GoogleAnalyticsAdminV1betaAccessNumericFilter
object
Filters for numeric or date values.
2 properties
GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest
object
Request message for SearchChangeHistoryEvents RPC.
8 properties
GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest
object
Request message for ArchiveCustomDimension RPC.
GoogleAnalyticsAdminV1betaAccount
object
A resource message representing a Google Analytics account.
7 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
GoogleAnalyticsAdminV1betaAccessDateRange
object
A contiguous range of days: startDate, startDate + 1, ..., endDate.
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…
GoogleAnalyticsAdminV1betaListConversionEventsResponse
object
Response message for ListConversionEvents RPC.
2 properties
GoogleAnalyticsAdminV1betaListPropertiesResponse
object
Response message for ListProperties RPC.
2 properties
GoogleAnalyticsAdminV1betaConversionEvent
object
A conversion event in a Google Analytics property.
7 properties
GoogleAnalyticsAdminV1betaDataRetentionSettings
object
Settings values for data retention. This is a singleton resource.
4 properties
GoogleAnalyticsAdminV1betaListAccountsResponse
object
Request message for ListAccounts RPC.
2 properties
GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse
object
Response message for ListMeasurementProtocolSecret RPC
2 properties
GoogleAnalyticsAdminV1betaAccessStringFilter
object
The filter for strings.
3 properties
GoogleAnalyticsAdminV1betaRunAccessReportRequest
object
The request for a Data Access Record Report.
12 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
GoogleAnalyticsAdminV1betaChangeHistoryEvent
object
A set of changes within a Google Analytics account or its child properties that resulted from the same cause. Common causes would be updates made in the Google…
6 properties
GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData
object
Data specific to Android app streams.
2 properties
GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy
object
Sorts by metric values.
1 property
GoogleAnalyticsAdminV1betaAccessFilterExpressionList
object
A list of filter expressions.
1 property
GoogleAnalyticsAdminV1betaListKeyEventsResponse
object
Response message for ListKeyEvents RPC.
2 properties
GoogleAnalyticsAdminV1betaAccessMetricValue
object
The value of a metric.
1 property
GoogleAnalyticsAdminV1betaAccountSummary
object
A virtual resource representing an overview of an account and all its child Google Analytics properties.
4 properties
GoogleAnalyticsAdminV1betaNumericValue
object
To represent a number.
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
GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse
object
Response message for ProvisionAccountTicket RPC.
1 property
GoogleAnalyticsAdminV1betaFirebaseLink
object
A link between a Google Analytics property and a Firebase project.
3 properties
GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest
object
Request message for ProvisionAccountTicket RPC.
2 properties
GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest
object
Request message for ArchiveCustomMetric RPC.
GoogleAnalyticsAdminV1betaListAccountSummariesResponse
object
Response message for ListAccountSummaries RPC.
2 properties
GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource
object
A snapshot of a resource as before or after the result of a change in change history.
8 properties
GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse
object
Response message for ListGoogleAdsLinks RPC.
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
GoogleAnalyticsAdminV1betaListCustomDimensionsResponse
object
Response message for ListCustomDimensions RPC.
2 properties
GoogleAnalyticsAdminV1betaListDataStreamsResponse
object
Response message for ListDataStreams RPC.
2 properties
GoogleAnalyticsAdminV1betaAccessQuotaStatus
object
Current state for a particular quota group.
2 properties
GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest
object
Request message for AcknowledgeUserDataCollection RPC.
1 property
GoogleAnalyticsAdminV1betaAccessInListFilter
object
The result needs to be in a list of string values.
2 properties
GoogleAnalyticsAdminV1betaDataStream
object
A resource message representing a data stream.
8 properties
GoogleAnalyticsAdminV1betaAccessDimensionValue
object
The value of a dimension.
1 property
GoogleRpcStatus
object
Canonical google.rpc.Status error payload returned by Google APIs.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

google-analytics-4-admin-v1beta-openapi.yml Raw ↑

Other APIs Google Analytics 4 publishes across the network.

Google Analytics Measurement Protocol
AE Profile APIs.io
Google Analytics Data API
AE Profile APIs.io
#Configuration#Administration#V1beta#V1alpha
← Back to G APIs
API Details
ID
google-analytics-4:google-analytics-admin-api
Base URL
https://analyticsadmin.googleapis.com
Docs
https://developers.google.com/analytics/devguides/config/admin/v1
Provider
Google Analytics 4
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=google-analytics-admin-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/google-analytics-admin-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Google Analytics Admin 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.