Google Analytics (GA4)
Google Analytics (GA4) · 66 endpoints
- Run a GA4 data access report for your accountaccounts.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
- Search your GA4 account's change historyaccounts.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.
- GA4 account data sharing settings by account idaccounts.getDataSharingSettings — Get data sharing settings on an account. Data sharing settings are singletons.
- Soft-delete a GA4 account by account idaccounts.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
- GA4 account details by account idaccounts.get — Lookup for a single Account.
- List your GA4 accountsaccounts.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`.
- List your GA4 account and property summariesaccountSummaries.list — Returns summaries of all accounts accessible by the caller.
- Update a GA4 account's settingsaccounts.patch — Updates an account.
- Create an audience export on your GA4 propertyaudienceExports.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
- GA4 audience export metadata by export idaudienceExports.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
- List audience exports on your GA4 propertyaudienceExports.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
- List users in a GA4 audience exportaudienceExports.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
- Archive a custom dimension on your GA4 propertycustomDimensions.archive — Archives a CustomDimension on a property.
- Create a custom dimension on your GA4 propertycustomDimensions.create — Creates a CustomDimension.
- GA4 custom dimension details by dimension idcustomDimensions.get — Lookup for a single CustomDimension.
- List custom dimensions on your GA4 propertycustomDimensions.list — Lists CustomDimensions on a property.
- Update a custom dimension on your GA4 propertycustomDimensions.patch — Updates a CustomDimension on a property.
- Archive a custom metric on your GA4 propertycustomMetrics.archive — Archives a CustomMetric on a property.
- Create a custom metric on your GA4 propertycustomMetrics.create — Creates a CustomMetric.
- GA4 custom metric details by metric idcustomMetrics.get — Lookup for a single CustomMetric.
- List custom metrics on your GA4 propertycustomMetrics.list — Lists CustomMetrics on a property.
- Update a custom metric on your GA4 propertycustomMetrics.patch — Updates a CustomMetric on a property.
- GA4 property data retention settingsproperties.getDataRetentionSettings — Returns the singleton data retention settings for this property.
- Update your GA4 property's data retention settingsproperties.updateDataRetentionSettings — Updates the singleton data retention settings for this property.
- Create a data stream on your GA4 propertydataStreams.create — Creates a DataStream.
- Delete a data stream from your GA4 propertydataStreams.delete — Deletes a DataStream on a property.
- GA4 data stream details by stream iddataStreams.get — Lookup for a single DataStream.
- List data streams on your GA4 propertydataStreams.list — Lists DataStreams on a property.
- Update a data stream on your GA4 propertydataStreams.patch — Updates a DataStream on a property.
- Link Firebase to your GA4 propertyfirebaseLinks.create — Creates a FirebaseLink. Properties can have at most one FirebaseLink.
- Delete a Firebase link from your GA4 propertyfirebaseLinks.delete — Deletes a FirebaseLink on a property
- List Firebase links on your GA4 propertyfirebaseLinks.list — Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
- Link Google Ads to your GA4 propertygoogleAdsLinks.create — Creates a GoogleAdsLink.
- Delete a Google Ads link from your GA4 propertygoogleAdsLinks.delete — Deletes a GoogleAdsLink on a property
- List Google Ads links on your GA4 propertygoogleAdsLinks.list — Lists GoogleAdsLinks on a property.
- Update a Google Ads link on your GA4 propertygoogleAdsLinks.patch — Updates a GoogleAdsLink on a property
Create key event
- Create a GA4 conversion event (deprecated)conversionEvents.create — Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.
- Create a key event on your GA4 propertykeyEvents.create — Creates a Key Event.
Delete key event
- Delete a GA4 conversion event (deprecated)conversionEvents.delete — Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.
- Delete a key event from your GA4 propertykeyEvents.delete — Deletes a Key Event.
Key event details
- GA4 conversion event details (deprecated)conversionEvents.get — Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.
- GA4 key event details by key event idkeyEvents.get — Retrieve a single Key Event.
List key events
- List GA4 conversion events (deprecated)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.
- List key events on your GA4 propertykeyEvents.list — Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.
Update key event
- Update a GA4 conversion event (deprecated)conversionEvents.patch — Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.
- Update a key event on your GA4 propertykeyEvents.patch — Updates a Key Event.
- Create a Measurement Protocol secret on a GA4 streammeasurementProtocolSecrets.create — Creates a measurement protocol secret.
- Delete a Measurement Protocol secret from a GA4 streammeasurementProtocolSecrets.delete — Deletes target MeasurementProtocolSecret.
- GA4 Measurement Protocol secret by secret idmeasurementProtocolSecrets.get — Lookup for a single MeasurementProtocolSecret.
- List Measurement Protocol secrets on a GA4 streammeasurementProtocolSecrets.list — Returns child MeasurementProtocolSecrets under the specified parent Property.
- Update a Measurement Protocol secret on a GA4 streammeasurementProtocolSecrets.patch — Updates a measurement protocol secret.
- List your GA4 property's dimensions and metricsList the dimensions and metrics your GA4 property supports, including custom ones
- Run several GA4 pivot reports in one batchproperties.batchRunPivotReports — Returns multiple pivot reports in a batch. All reports must be for the same Google Analytics property.
- Run a GA4 pivot report by property idproperties.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.
- Run a GA4 data access report for your propertyproperties.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
- Acknowledge GA4 user data collection termsproperties.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.
- Create a GA4 propertyproperties.create — Creates a Google Analytics property with the specified location and attributes.
- Soft-delete a GA4 property by property idproperties.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
- GA4 property details by property idproperties.get — Lookup for a single GA Property.
- List GA4 properties under your accountproperties.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.
- Update a GA4 property's settingsproperties.patch — Updates a property.
- GA4 realtime active users by page, source, countrySee who is on your site right now (active users by page, source and country)
- Run a custom GA4 report by property idRun a traffic or behaviour report on your own Google Analytics property
- Run several GA4 reports in one batchproperties.batchRunReports — Returns multiple reports in a batch. All reports must be for the same Google Analytics property.
- Check GA4 dimension and metric compatibilityproperties.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
Account and utility endpoints
- Request a GA4 account creation ticketaccounts.provisionAccountTicket — Requests a ticket for creating an account.
These endpoints are callable but not part of the catalog's browse surface.