Google Analytics
Read reports and manage Google Analytics properties.
Authentication
This connector uses OAuth 2.0 authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 66 actions:
| Action | Purpose | Parameters |
|---|---|---|
| admin/properties_get_data_retention_settings | Returns the singleton data retention settings for this property. | name (string) required |
| admin/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. | filter (string) pageToken (string) pageSize (integer) showDeleted (boolean) |
| admin/properties_create | Creates a Google Analytics property with the specified location and attributes. | updateTime (string) displayName (string) timeZone (string) deleteTime (string) currencyCode (string) parent (string) name (string) createTime (string) expireTime (string) propertyType (string) industryCategory (string) serviceLevel (string) account (string) |
| admin/properties_run_access_report | 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. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Exploratio | entity (string) required metricFilter: { . andGroup (object) . notExpression (object) . orGroup (object) . accessFilter (object) } (object) timeZone (string) returnEntityQuota (boolean) includeAllUsers (boolean) dateRanges (array) limit (string) orderBys (array) expandGroups (boolean) metrics (array) offset (string) dimensionFilter: { . andGroup (object) . notExpression (object) . orGroup (object) . accessFilter (object) } (object) dimensions (array) |
| admin/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://support.google.com/analytics/answer/6154772 Returns an error if the target is not found. | name (string) required |
| admin/properties_acknowledge_user_data_collection | 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. | property (string) required acknowledgement (string) |
| admin/properties_patch | Updates a property. | name (string) required updateMask (string) updateTime (string) displayName (string) timeZone (string) deleteTime (string) currencyCode (string) parent (string) createTime (string) expireTime (string) propertyType (string) industryCategory (string) serviceLevel (string) account (string) |
| admin/properties_update_data_retention_settings | Updates the singleton data retention settings for this property. | name (string) required updateMask (string) eventDataRetention (string) userDataRetention (string) resetUserDataOnNewActivity (boolean) |
| admin/properties_get | Lookup for a single GA Property. | name (string) required |
| admin/firebase_links_create | Creates a FirebaseLink. Properties can have at most one FirebaseLink. | parent (string) required name (string) project (string) createTime (string) |
| admin/firebase_links_delete | Deletes a FirebaseLink on a property | name (string) required |
| admin/firebase_links_list | Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink. | pageToken (string) parent (string) required pageSize (integer) |
| admin/conversion_events_delete | Deprecated: Use DeleteKeyEvent instead. Deletes a conversion event in a property. | name (string) required |
| admin/conversion_events_create | Deprecated: Use CreateKeyEvent instead. Creates a conversion event with the specified attributes. | parent (string) required custom (boolean) deletable (boolean) createTime (string) countingMethod (string) name (string) defaultConversionValue: { . value (number) . currencyCode (string) } (object) eventName (string) |
| admin/conversion_events_get | Deprecated: Use GetKeyEvent instead. Retrieve a single conversion event. | name (string) required |
| admin/conversion_events_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. | pageSize (integer) parent (string) required pageToken (string) |
| admin/conversion_events_patch | Deprecated: Use UpdateKeyEvent instead. Updates a conversion event with the specified attributes. | name (string) required updateMask (string) custom (boolean) deletable (boolean) createTime (string) countingMethod (string) defaultConversionValue: { . value (number) . currencyCode (string) } (object) eventName (string) |
| admin/data_streams_patch | Updates a DataStream on a property. | name (string) required updateMask (string) webStreamData: { . firebaseAppId (string) . measurementId (string) . defaultUri (string) } (object) createTime (string) androidAppStreamData: { . firebaseAppId (string) . packageName (string) } (object) iosAppStreamData: { . firebaseAppId (string) . bundleId (string) } (object) updateTime (string) displayName (string) type (string) |
| admin/data_streams_list | Lists DataStreams on a property. | pageSize (integer) parent (string) required pageToken (string) |
| admin/data_streams_get | Lookup for a single DataStream. | name (string) required |
| admin/data_streams_create | Creates a DataStream. | parent (string) required name (string) webStreamData: { . firebaseAppId (string) . measurementId (string) . defaultUri (string) } (object) createTime (string) androidAppStreamData: { . firebaseAppId (string) . packageName (string) } (object) iosAppStreamData: { . firebaseAppId (string) . bundleId (string) } (object) updateTime (string) displayName (string) type (string) |
| admin/data_streams_delete | Deletes a DataStream on a property. | name (string) required |
| admin/measurement_protocol_secrets_create | Creates a measurement protocol secret. | parent (string) required displayName (string) name (string) secretValue (string) |
| admin/measurement_protocol_secrets_delete | Deletes target MeasurementProtocolSecret. | name (string) required |
| admin/measurement_protocol_secrets_patch | Updates a measurement protocol secret. | name (string) required updateMask (string) displayName (string) secretValue (string) |
| admin/measurement_protocol_secrets_get | Lookup for a single MeasurementProtocolSecret. | name (string) required |
| admin/measurement_protocol_secrets_list | Returns child MeasurementProtocolSecrets under the specified parent Property. | parent (string) required pageSize (integer) pageToken (string) |
| admin/custom_metrics_patch | Updates a CustomMetric on a property. | name (string) required updateMask (string) parameterName (string) description (string) measurementUnit (string) scope (string) restrictedMetricType (array) displayName (string) |
| admin/custom_metrics_list | Lists CustomMetrics on a property. | parent (string) required pageSize (integer) pageToken (string) |
| admin/custom_metrics_get | Lookup for a single CustomMetric. | name (string) required |
| admin/custom_metrics_create | Creates a CustomMetric. | parent (string) required parameterName (string) name (string) description (string) measurementUnit (string) scope (string) restrictedMetricType (array) displayName (string) |
| admin/custom_metrics_archive | Archives a CustomMetric on a property. | name (string) required |
| admin/google_ads_links_delete | Deletes a GoogleAdsLink on a property | name (string) required |
| admin/google_ads_links_list | Lists GoogleAdsLinks on a property. | pageSize (integer) parent (string) required pageToken (string) |
| admin/google_ads_links_create | Creates a GoogleAdsLink. | parent (string) required name (string) adsPersonalizationEnabled (boolean) createTime (string) canManageClients (boolean) updateTime (string) creatorEmailAddress (string) customerId (string) |
| admin/google_ads_links_patch | Updates a GoogleAdsLink on a property | name (string) required updateMask (string) adsPersonalizationEnabled (boolean) createTime (string) canManageClients (boolean) updateTime (string) creatorEmailAddress (string) customerId (string) |
| admin/custom_dimensions_patch | Updates a CustomDimension on a property. | name (string) required updateMask (string) displayName (string) disallowAdsPersonalization (boolean) scope (string) parameterName (string) description (string) |
| admin/custom_dimensions_list | Lists CustomDimensions on a property. | pageToken (string) pageSize (integer) parent (string) required |
| admin/custom_dimensions_get | Lookup for a single CustomDimension. | name (string) required |
| admin/custom_dimensions_create | Creates a CustomDimension. | parent (string) required displayName (string) disallowAdsPersonalization (boolean) scope (string) parameterName (string) name (string) description (string) |
| admin/custom_dimensions_archive | Archives a CustomDimension on a property. | name (string) required |
| admin/key_events_patch | Updates a Key Event. | name (string) required updateMask (string) eventName (string) createTime (string) countingMethod (string) defaultValue: { . numericValue (number) . currencyCode (string) } (object) deletable (boolean) custom (boolean) |
| admin/key_events_get | Retrieve a single Key Event. | name (string) required |
| admin/key_events_list | Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found. | pageSize (integer) parent (string) required pageToken (string) |
| admin/key_events_create | Creates a Key Event. | parent (string) required name (string) eventName (string) createTime (string) countingMethod (string) defaultValue: { . numericValue (number) . currencyCode (string) } (object) deletable (boolean) custom (boolean) |
| admin/key_events_delete | Deletes a Key Event. | name (string) required |
| admin/accounts_search_change_history_events | 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. | account (string) required resourceType (array) pageToken (string) action (array) earliestChangeTime (string) pageSize (integer) property (string) actorEmail (array) latestChangeTime (string) |
| admin/accounts_run_access_report | 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. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Exploratio | entity (string) required metricFilter: { . andGroup (object) . notExpression (object) . orGroup (object) . accessFilter (object) } (object) timeZone (string) returnEntityQuota (boolean) includeAllUsers (boolean) dateRanges (array) limit (string) orderBys (array) expandGroups (boolean) metrics (array) offset (string) dimensionFilter: { . andGroup (object) . notExpression (object) . orGroup (object) . accessFilter (object) } (object) dimensions (array) |
| admin/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://support.google.com/analytics/answer/6154772 Returns an error if the target is not found. | name (string) required |
| admin/accounts_get | Lookup for a single Account. | name (string) required |
| admin/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. | pageSize (integer) showDeleted (boolean) pageToken (string) |
| admin/accounts_provision_account_ticket | Requests a ticket for creating an account. | account: { . displayName (string) . regionCode (string) . deleted (boolean) . updateTime (string) . gmpOrganization (string) . createTime (string) . name (string) } (object) redirectUri (string) |
| admin/accounts_get_data_sharing_settings | Get data sharing settings on an account. Data sharing settings are singletons. | name (string) required |
| admin/accounts_patch | Updates an account. | name (string) required updateMask (string) displayName (string) regionCode (string) deleted (boolean) updateTime (string) gmpOrganization (string) createTime (string) |
| admin/account_summaries_list | Returns summaries of all accounts accessible by the caller. | pageToken (string) pageSize (integer) |
| data/properties_run_report | 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 table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name. For a guide to constructing requests and | property (string) required dimensions (array) dateRanges (array) orderBys (array) offset (string) dimensionFilter: { . filter (object) . orGroup (object) . andGroup (object) . notExpression (object) } (object) metricFilter: { . filter (object) . orGroup (object) . andGroup (object) . notExpression (object) } (object) currencyCode (string) cohortSpec: { . cohortsRange (object) . cohortReportSettings (object) . cohorts (array) } (object) returnPropertyQuota (boolean) comparisons (array) metricAggregations (array) limit (string) metrics (array) keepEmptyRows (boolean) |
| data/properties_run_realtime_report | 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 usage data for the periods of time ranging from the present moment to 30 minutes ago up to 60 minutes for Google Analytics 360 properties. For a guide to constructing realtime requests and understanding responses, see Creating a Realtime Reporthttps://developers.google.com/analytics/devguides/reportin | property (string) required orderBys (array) returnPropertyQuota (boolean) dimensions (array) metricFilter: { . filter (object) . orGroup (object) . andGroup (object) . notExpression (object) } (object) metrics (array) dimensionFilter: { . filter (object) . orGroup (object) . andGroup (object) . notExpression (object) } (object) limit (string) minuteRanges (array) metricAggregations (array) |
| data/properties_run_pivot_report | 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. | property (string) required dimensionFilter: { . filter (object) . orGroup (object) . andGroup (object) . notExpression (object) } (object) metrics (array) keepEmptyRows (boolean) cohortSpec: { . cohortsRange (object) . cohortReportSettings (object) . cohorts (array) } (object) returnPropertyQuota (boolean) comparisons (array) dimensions (array) metricFilter: { . filter (object) . orGroup (object) . andGroup (object) . notExpression (object) } (object) currencyCode (string) dateRanges (array) pivots (array) |
| data/properties_batch_run_reports | Returns multiple reports in a batch. All reports must be for the same Google Analytics property. | property (string) required requests (array) |
| data/properties_batch_run_pivot_reports | Returns multiple pivot reports in a batch. All reports must be for the same Google Analytics property. | property (string) required requests (array) |
| data/properties_get_metadata | Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics property identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name levels_unlocked is registered to a property, the Metadata response will contain customEvent:levels_unlocked. Universal metadata are dimensions and me | name (string) required |
| data/properties_check_compatibility | 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 incompatible report until the report is compatible. The Realtime and Core reports have different compatibility rules. This method checks com | property (string) required metrics (array) dimensionFilter: { . filter (object) . orGroup (object) . andGroup (object) . notExpression (object) } (object) compatibilityFilter (string) dimensions (array) metricFilter: { . filter (object) . orGroup (object) . andGroup (object) . notExpression (object) } (object) |
| data/audience_exports_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 Creating an Audience Exporthttps://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics for an introductio | parent (string) required percentageCompleted (number) rowCount (integer) audienceDisplayName (string) creationQuotaTokensCharged (integer) errorMessage (string) name (string) dimensions (array) state (string) beginCreatingTime (string) audience (string) |
| data/audience_exports_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 Exporthttps://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 other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To giv | name (string) required |
| data/audience_exports_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 Exporthttps://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics for an introduction to Audience Exports with examples. Audience Export API | pageToken (string) parent (string) required pageSize (integer) |
| data/audience_exports_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 Exporthttps://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics for an introduction to Audience Exports with examples. Audiences in Google Analyti | name (string) required offset (string) limit (string) |