Google Analytics properties API
The properties API from Google Analytics — 20 operation(s) for properties.
Google Analytics properties API is one of 13 APIs that Google Analytics 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, a getting-started guide, authentication docs, and rate-limit docs.
This API exposes 31 operations across 20 paths, and defines 110 schemas. It is described by OpenAPI 3.0.0, at version v1.
Requests are made against a single base URL, https://analyticsadmin.googleapis.com/.
31 operations
20 paths
110 schemas
1 DELETE10 GET1 PATCH19 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Google Analytics properties API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (Oauth2) using the implicit flow, exposing 2 scopes.
It supports OAuth 2.0 (Oauth2c) using the authorizationCode flow, exposing 2 scopes.
Oauth2— Oauth 2.0 implicit authenticationOauth2c— Oauth 2.0 authorizationCode authentication
Paths & Operations 31
Across 20 paths, the API surfaces 31 operations — 1 DELETE, 10 GET, 1 PATCH, 19 POST. Each is listed below with its method, path, parameters, and response codes.
properties 31
GET
/v1beta/properties
Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") prope…
POST
/v1beta/properties
Creates an "GA4" property with the specified location and attributes.
POST
/v1beta/{entity}:runAccessReport
Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access R…
DELETE
/v1beta/{name}
Deletes a GoogleAdsLink on a property
GET
/v1beta/{name}
Lookup for a single "GA4" MeasurementProtocolSecret.
PATCH
/v1beta/{name}
Updates a GoogleAdsLink on a property
POST
/v1beta/{name}:archive
Archives a CustomMetric on a property.
GET
/v1beta/{parent}/conversionEvents
Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
POST
/v1beta/{parent}/conversionEvents
Creates a conversion event with the specified attributes.
GET
/v1beta/{parent}/customDimensions
Lists CustomDimensions on a property.
POST
/v1beta/{parent}/customDimensions
Creates a CustomDimension.
GET
/v1beta/{parent}/customMetrics
Lists CustomMetrics on a property.
POST
/v1beta/{parent}/customMetrics
Creates a CustomMetric.
GET
/v1beta/{parent}/dataStreams
Lists DataStreams on a property.
POST
/v1beta/{parent}/dataStreams
Creates a DataStream.
GET
/v1beta/{parent}/firebaseLinks
Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
POST
/v1beta/{parent}/firebaseLinks
Creates a FirebaseLink. Properties can have at most one FirebaseLink.
GET
/v1beta/{parent}/googleAdsLinks
Lists GoogleAdsLinks on a property.
POST
/v1beta/{parent}/googleAdsLinks
Creates a GoogleAdsLink.
GET
/v1beta/{parent}/measurementProtocolSecrets
Returns child MeasurementProtocolSecrets under the specified parent Property.
POST
/v1beta/{parent}/measurementProtocolSecrets
Creates a measurement protocol secret.
POST
/v1beta/{property}:acknowledgeUserDataCollection
Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSec…
POST
/v1beta/{name}:query
Retrieves an audience export of users. After creating an audience, the users are not immediately available for exporting. First, a request to CreateAudienceExport is necessary to create an audience e…
GET
/v1beta/{parent}/audienceExports
Lists all audience exports for a property. This method can be used for you to find and reuse existing audience exports rather than creating unnecessary new audience exports. The same audience can hav…
POST
/v1beta/{parent}/audienceExports
Creates an audience export for later retrieval. This method quickly returns the audience export's resource name and initiates a long running asynchronous request to form an audience export. To export…
POST
/v1beta/{property}:batchRunPivotReports
Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property.
POST
/v1beta/{property}:batchRunReports
Returns multiple reports in a batch. All reports must be for the same GA4 Property.
POST
/v1beta/{property}:checkCompatibility
This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible. In…
POST
/v1beta/{property}:runPivotReport
Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if t…
POST
/v1beta/{property}:runRealtimeReport
Returns a customized report of realtime event data for your property. Events appear in realtime reports seconds after they have been sent to the Google Analytics. Realtime reports show events and usa…
POST
/v1beta/{property}:runReport
Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a t…
Schemas 110
The contract defines 110 schemas that model the data the API accepts and returns. The most detailed are RunReportRequest (14 properties), GoogleAnalyticsAdminV1betaProperty (13 properties), GoogleAnalyticsAdminV1betaRunAccessReportRequest (12 properties), RunPivotReportRequest (11 properties). Each schema is shown below with its type and property counts.
GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData
object
Data specific to iOS app streams.
2 properties
QueryAudienceExportRequest
object
A request to list users in an audience export.
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
CohortsRange
object
Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.
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
GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest
object
Request message for AcknowledgeUserDataCollection RPC.
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…
4 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…
GoogleAnalyticsAdminV1betaListCustomDimensionsResponse
object
Response message for ListCustomDimensions RPC.
2 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
ResponseMetaData
object
Response's metadata carrying additional information about the report content.
7 properties
GoogleAnalyticsAdminV1betaAccessMetric
object
The quantitative measurements of a report. For example, the metric accessCount is the total number of data access records.
1 property
CheckCompatibilityResponse
object
The compatibility response with the compatibility of each dimension & metric.
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
GoogleAnalyticsAdminV1betaRunAccessReportRequest
object
The request for a Data Access Record Report.
12 properties
MetricMetadata
object
Explains a metric.
9 properties
GoogleAnalyticsAdminV1betaDataStream
object
A resource message representing a data stream.
8 properties
QuotaStatus
object
Current state for a particular quota group.
2 properties
GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse
object
Response message for ListGoogleAdsLinks RPC.
2 properties
DimensionCompatibility
object
The compatibility for a single dimension.
2 properties
NumericFilter
object
Filters for numeric or date values.
2 properties
GoogleAnalyticsAdminV1betaAccessDimensionValue
object
The value of a dimension.
1 property
RunRealtimeReportResponse
object
The response realtime report table corresponding to a request.
9 properties
GoogleAnalyticsAdminV1betaConversionEvent
object
A conversion event in a Google Analytics property.
7 properties
SamplingMetadata
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
GoogleAnalyticsAdminV1betaListConversionEventsResponse
object
Response message for ListConversionEvents RPC.
2 properties
GoogleAnalyticsAdminV1betaAccessFilterExpressionList
object
A list of filter expressions.
1 property
Operation
object
This resource represents a long-running operation that is the result of a network API call.
5 properties
GoogleAnalyticsAdminV1betaAccessNumericFilter
object
Filters for numeric or date values.
2 properties
BetweenFilter
object
To express that the result needs to be between two numbers (inclusive).
2 properties
GoogleAnalyticsAdminV1betaAccessMetricValue
object
The value of a metric.
1 property
MinuteRange
object
A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Requests are allowed up to 2 minute ranges.
3 properties
StringFilter
object
The filter for string
3 properties
GoogleAnalyticsAdminV1betaFirebaseLink
object
A link between a GA4 property and a Firebase project.
3 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
QueryAudienceExportResponse
object
A list of users in an audience export.
3 properties
GoogleAnalyticsAdminV1betaListFirebaseLinksResponse
object
Response message for ListFirebaseLinks RPC
2 properties
CaseExpression
object
Used to convert a dimension value to a single case.
1 property
RunRealtimeReportRequest
object
The request to generate a realtime report.
9 properties
GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData
object
Data specific to Android app streams.
2 properties
GoogleAnalyticsAdminV1betaListDataStreamsResponse
object
Response message for ListDataStreams RPC.
2 properties
GoogleAnalyticsAdminV1betaListPropertiesResponse
object
Response message for ListProperties RPC.
2 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
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
Row
object
Report data for each row. For example if RunReportRequest contains: none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "na…
2 properties
MetricValue
object
The value of a metric.
1 property
PivotHeader
object
Dimensions' values in a single pivot.
2 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
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
GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy
object
Sorts by metric values.
1 property
PivotOrderBy
object
Sorts by a pivot column group.
2 properties
GoogleAnalyticsAdminV1betaMeasurementProtocolSecret
object
A secret value used for sending hits to Measurement Protocol.
3 properties
InListFilter
object
The result needs to be in a list of string values.
2 properties
GoogleAnalyticsAdminV1betaAccessInListFilter
object
The result needs to be in a list of string values.
2 properties
V1betaAudienceRow
object
Dimension value attributes for the audience user row.
1 property
V1betaAudienceDimensionValue
object
The value of a dimension.
1 property
BatchRunPivotReportsRequest
object
The batch request containing multiple pivot report requests.
1 property
BatchRunReportsResponse
object
The batch response containing multiple reports.
2 properties
GoogleAnalyticsAdminV1betaProperty
object
A resource message representing a Google Analytics GA4 property.
13 properties
GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse
object
Response message for AcknowledgeUserDataCollection RPC.
NumericValue
object
To represent a number.
2 properties
RunPivotReportResponse
object
The response pivot report table corresponding to a pivot request.
8 properties
CohortReportSettings
object
Optional settings of a cohort report.
1 property
PivotDimensionHeader
object
Summarizes dimension values from a row for this pivot.
1 property
GoogleAnalyticsAdminV1betaAccessQuotaStatus
object
Current state for a particular quota group.
2 properties
GoogleAnalyticsAdminV1betaAccessDateRange
object
A contiguous range of days: startDate, startDate + 1, ..., endDate.
2 properties
Pivot
object
Describes the visible dimension columns and rows in the report response.
5 properties
GoogleAnalyticsAdminV1betaGoogleAdsLink
object
A link between a GA4 property and a Google Ads account.
7 properties
GoogleAnalyticsAdminV1betaDataStreamWebStreamData
object
Data specific to web streams.
3 properties
BatchRunPivotReportsResponse
object
The batch response containing multiple pivot reports.
2 properties
GoogleAnalyticsAdminV1betaListCustomMetricsResponse
object
Response message for ListCustomMetrics RPC.
2 properties
MetricOrderBy
object
Sorts by metric values.
1 property
ListAudienceExportsResponse
object
A list of all audience exports for a property.
2 properties
GoogleAnalyticsAdminV1betaAccessRow
object
Access report data for each row.
2 properties
V1betaAudienceDimension
object
An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the QueryAudienceExportResponse.
1 property
GoogleAnalyticsAdminV1betaAccessFilter
object
An expression to filter dimension or metric values.
5 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
RunPivotReportRequest
object
The request to generate a pivot report.
11 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
FilterExpressionList
object
A list of filter expressions.
1 property
Filter
object
An expression to filter dimension or metric values.
5 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
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
DimensionMetadata
object
Explains a dimension.
6 properties
ActiveMetricRestriction
object
A metric actively restricted in creating the report.
2 properties
DimensionValue
object
The value of a dimension.
1 property
GoogleAnalyticsAdminV1betaCustomDimension
object
A definition for a CustomDimension.
6 properties
RunReportRequest
object
The request to generate a report.
14 properties
GoogleAnalyticsAdminV1betaRunAccessReportResponse
object
The customized Data Access Record Report response.
5 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
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
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
GoogleAnalyticsAdminV1betaNumericValue
object
To represent a number.
2 properties
MetricCompatibility
object
The compatibility for a single metric.
2 properties
GoogleAnalyticsAdminV1betaCustomMetric
object
A definition for a custom metric.
7 properties
GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse
object
Response message for ListMeasurementProtocolSecret RPC
2 properties
GoogleAnalyticsAdminV1betaAccessBetweenFilter
object
To express that the result needs to be between two numbers (inclusive).
2 properties
GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy
object
Sorts by dimension values.
2 properties
GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue
object
Defines a default value/currency for a conversion event. Both value and currency must be provided.
2 properties
RunReportResponse
object
The response report table corresponding to a request.
10 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
GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest
object
Request message for ArchiveCustomMetric RPC.
GoogleAnalyticsAdminV1betaAccessStringFilter
object
The filter for strings.
3 properties
DimensionOrderBy
object
Sorts by dimension values.
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
DateRange
object
A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.
3 properties
BatchRunReportsRequest
object
The batch request containing multiple report requests.
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
ConcatenateExpression
object
Used to combine dimension values to a single dimension.
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
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Google Analytics 12
Other APIs Google Analytics publishes across the network.
Google Analytics accounts API
Google Analytics accountSummaries API
Google Analytics data API
Google Analytics Events API
Google Analytics management API
Google Analytics metadata API
Google Analytics provisioning API
Google Analytics reports API
Google Analytics User Deletion API
Google Analytics userActivity API
Google Analytics userDeletion API
Google Analytics Validation API
#Properties
Where this information came from
This is an independent, third-party profile of Google Analytics 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.