Google Analytics API: Tools & Pricing

List the dimensions and metrics your GA4 property supports, including custom ones

See who is on your site right now (active users by page, source and country)

Run a traffic or behaviour report on your own Google Analytics property

accounts.delete — Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://su

accounts.get — Lookup for a single Account.

accounts.getDataSharingSettings — Get data sharing settings on an account. Data sharing settings are singletons.

accounts.list — Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found. Note: The easiest way to retrieve a list of all properties you have access to is by using `ListAccountSummaries`.

accounts.patch — Updates an account.

accounts.provisionAccountTicket — Requests a ticket for creating an account.

accounts.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 Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 p

accounts.searchChangeHistoryEvents — Searches through all changes to an account or its children given the specified set of filters. Only returns the subset of changes supported by the API. The UI may return additional changes.

accountSummaries.list — Returns summaries of all accounts accessible by the caller.

properties.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 MeasurementProtocolSecret resources may be created.

conversionEvents.create — Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.

conversionEvents.delete — Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.

conversionEvents.get — Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.

conversionEvents.list — Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.

conversionEvents.patch — Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.

properties.create — Creates a Google Analytics property with the specified location and attributes.

customDimensions.archive — Archives a CustomDimension on a property.

customDimensions.create — Creates a CustomDimension.

customDimensions.get — Lookup for a single CustomDimension.

customDimensions.list — Lists CustomDimensions on a property.

customDimensions.patch — Updates a CustomDimension on a property.

customMetrics.archive — Archives a CustomMetric on a property.

customMetrics.create — Creates a CustomMetric.

customMetrics.get — Lookup for a single CustomMetric.

customMetrics.list — Lists CustomMetrics on a property.

customMetrics.patch — Updates a CustomMetric on a property.

dataStreams.create — Creates a DataStream.

dataStreams.delete — Deletes a DataStream on a property.

dataStreams.get — Lookup for a single DataStream.

dataStreams.list — Lists DataStreams on a property.

measurementProtocolSecrets.create — Creates a measurement protocol secret.

measurementProtocolSecrets.delete — Deletes target MeasurementProtocolSecret.

measurementProtocolSecrets.get — Lookup for a single MeasurementProtocolSecret.

measurementProtocolSecrets.list — Returns child MeasurementProtocolSecrets under the specified parent Property.

measurementProtocolSecrets.patch — Updates a measurement protocol secret.

dataStreams.patch — Updates a DataStream on a property.

properties.delete — Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://suppor

firebaseLinks.create — Creates a FirebaseLink. Properties can have at most one FirebaseLink.

firebaseLinks.delete — Deletes a FirebaseLink on a property

firebaseLinks.list — Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.

properties.get — Lookup for a single GA Property.

properties.getDataRetentionSettings — Returns the singleton data retention settings for this property.

googleAdsLinks.create — Creates a GoogleAdsLink.

googleAdsLinks.delete — Deletes a GoogleAdsLink on a property

googleAdsLinks.list — Lists GoogleAdsLinks on a property.

googleAdsLinks.patch — Updates a GoogleAdsLink on a property

keyEvents.create — Creates a Key Event.

keyEvents.delete — Deletes a Key Event.

keyEvents.get — Retrieve a single Key Event.

keyEvents.list — Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.

keyEvents.patch — Updates a Key Event.

properties.list — Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.

properties.patch — Updates a property.

properties.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 Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360

properties.updateDataRetentionSettings — Updates the singleton data retention settings for this property.

audienceExports.create — 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 the users in an audience export, first create the audience export through this method and then send the audience resource name to the `QueryAudienceExport` method. See [Creati

audienceExports.get — Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and o

audienceExports.list — 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 have multiple audience exports that represent the export of users that were in an audience on different days. See [Creating an Audience Export](https://developers.google.com/analyti

audienceExports.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 export of users, and then second, this method is used to retrieve the users in the audience export. See [Creating an Audience Export](https://developers.google.com/analytics/de

properties.batchRunPivotReports — Returns multiple pivot reports in a batch. All reports must be for the same Google Analytics property.

properties.batchRunReports — Returns multiple reports in a batch. All reports must be for the same Google Analytics property.

properties.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 Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompat

properties.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 they are included in a pivot. Multiple pivots can be specified to further dissect your data.