Google Analytics
Overview
Section titled “Overview”Google Analytics tracks and reports website traffic, user behavior, and conversion data, enabling marketers to optimize online performance and customer journeys. With this integration in SquadOS, your agents can run custom reports, query audiences, check quotas, and send events directly to GA4 properties.
- Official website: https://analytics.google.com/
- Composio documentation: docs.composio.dev/toolkits/google_analytics
Authentication
Section titled “Authentication”This tool uses OAuth 2.0 (OAUTH2) to connect.
You will need to authorize access to your Google Analytics account via OAuth. When you click Connect, you will be redirected to Google’s authorization page, where you can grant access to the desired account.
How to connect in SquadOS
Section titled “How to connect in SquadOS”- Go to Tools in the side menu (
/admin/tools). - Open the Available tab and search for
Google Analytics. - Click the card to open the details modal and hit Connect.
- You’re taken to the secure connection page hosted by Composio, where you authorize access to your Google Analytics account via OAuth.
- Once done, you’re sent back to SquadOS with the account connected and the tool available to your agents. (Connection-flow details in Organization Tools.)
Available actions
Section titled “Available actions”Archive Custom Dimension
Section titled “Archive Custom Dimension”GOOGLE_ANALYTICS_ARCHIVE_CUSTOM_DIMENSION
Tool to archive a CustomDimension on a property. Use when you need to remove a custom dimension from active use without permanently deleting it. Archived dimensions cannot be used in new reports.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. The resource name of the CustomDimension to archive. Must be in the exact format: properties/{property_id}/customDimensions/{dimension_id}. Valid example: properties/489591273/customDimensions/13661259421. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Batch Run Pivot Reports
Section titled “Batch Run Pivot Reports”GOOGLE_ANALYTICS_BATCH_RUN_PIVOT_REPORTS
Tool to return multiple pivot reports in a batch for a GA4 property. Use when you need to fetch multiple pivot table reports with multi-dimensional analysis in a single request.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
property | string | Yes | Required. The GA4 property resource name. Format: properties/{property_id}. |
requests | array | Yes | Required. Up to 5 individual RunPivotReportRequest objects. Every dimension defined in dimensions MUST be used in at least one pivot, filter, or orderBy. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Batch Run Reports
Section titled “Batch Run Reports”GOOGLE_ANALYTICS_BATCH_RUN_REPORTS
Tool to return multiple analytics data reports in a batch. Use when you need to fetch multiple reports for one GA4 property in a single request.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
property | string | Yes | Required. The property resource name. Format: properties/{property_id}. |
requests | array | Yes | Required. Up to 5 individual RunReportRequest objects (minimum 1, maximum 5). Non-cohort requests MUST contain dateRanges. |
unwrapped_filters | array | No | Internal field to track which filters were unwrapped during validation. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Check Compatibility
Section titled “Check Compatibility”GOOGLE_ANALYTICS_CHECK_COMPATIBILITY
Tool to list dimensions and metrics compatible with a GA4 report request. Use when you need to validate compatibility of chosen dimensions or metrics before running a report.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
metrics | array | No | Optional. List of metrics to check compatibility for. Maximum of 10 metrics allowed per request. |
property | string | Yes | Required. GA4 property resource name. Format: properties/{property_id}. |
dimensions | array | No | Optional. List of dimensions to check compatibility for. |
metricFilter | object | No | Optional. A FilterExpression for metrics. |
dimensionFilter | object | No | Optional. A FilterExpression for dimensions. |
compatibilityFilter | string | No | Compatibility status. Valid values: COMPATIBILITY_UNSPECIFIED, COMPATIBLE, INCOMPATIBLE. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create Audience Export
Section titled “Create Audience Export”GOOGLE_ANALYTICS_CREATE_AUDIENCE_EXPORT
Tool to create an audience export for Google Analytics. Use when you need to export a snapshot of users in an audience at a specific point in time. This initiates a long-running asynchronous request that returns an operation resource name immediately.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Parent property resource name. Format: properties/{property_id}. |
audience | string | Yes | Audience resource name. Format: properties/{property_id}/audiences/{audience_id}. |
dimensions | array | No | Optional list of dimensions requested and displayed in the export. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create Audience List
Section titled “Create Audience List”GOOGLE_ANALYTICS_CREATE_AUDIENCE_LIST
Tool to create an audience list for later retrieval by initiating a long-running asynchronous request. Use when you need to create a snapshot of users currently in an audience.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. The parent property resource name. Format: properties/{property_id}. |
audience | string | Yes | Required. The audience resource name. Format: properties/{property_id}/audiences/{audience_id}. |
dimensions | array | Yes | Required. The dimensions requested and displayed in the query response. At least one dimension is required. Each entry must be an object with a dimensionName key. |
webhookNotification | object | No | Webhook notification configuration for audience list operation updates. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create Custom Dimension
Section titled “Create Custom Dimension”GOOGLE_ANALYTICS_CREATE_CUSTOM_DIMENSION
Tool to create a CustomDimension for a Google Analytics property. Use when you need to add a new custom dimension to track specific user properties, event parameters, or eCommerce item parameters.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
scope | string | Yes | Required. Immutable. Must be one of: EVENT, USER, or ITEM. |
parent | string | Yes | Required. The property in which to create the CustomDimension. Format: properties/{property_id}. |
description | string | No | Optional. Max length of 150 characters. |
displayName | string | Yes | Required. Display name shown in the Analytics UI. Max length of 82 characters. |
parameterName | string | Yes | Required. Immutable. Tagging parameter name. Max length of 24 characters for user-scoped, 40 for event-scoped dimensions. |
disallowAdsPersonalization | boolean | No | Optional. If true, sets this dimension as NPA (only for user-scoped dimensions). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create Custom Metric
Section titled “Create Custom Metric”GOOGLE_ANALYTICS_CREATE_CUSTOM_METRIC
Tool to create a custom metric in Google Analytics. Use when you need to define a new custom metric for tracking specific event parameters.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
scope | string | Yes | Required. Immutable. Values: METRIC_SCOPE_UNSPECIFIED or EVENT. |
parent | string | Yes | Required. The property where the custom metric will be created. Format: properties/{property_id}. |
description | string | No | Optional. Max length of 150 characters. |
displayName | string | Yes | Required. Display name shown in the Analytics UI. Max length of 82 characters. |
parameterName | string | Yes | Required. Immutable. Tagging name. Max length of 40 characters for event-scoped metrics. |
measurementUnit | string | Yes | Required. The type for the custom metric’s value: STANDARD, CURRENCY, FEET, METERS, KILOMETERS, MILES, MILLISECONDS, SECONDS, MINUTES, or HOURS. |
restrictedMetricType | array | No | Optional. Required for metrics with CURRENCY measurement unit. Must be empty for non-CURRENCY metrics. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create Expanded Data Set
Section titled “Create Expanded Data Set”GOOGLE_ANALYTICS_CREATE_EXPANDED_DATA_SET
Tool to create an expanded data set for a property. Use when you need to combine specific dimensions and metrics into a custom dataset after property creation.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Parent property resource name. Format: properties/{propertyId}. |
expandedDataSet | object | Yes | Definition of the ExpandedDataSet to create. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create Recurring Audience List
Section titled “Create Recurring Audience List”GOOGLE_ANALYTICS_CREATE_RECURRING_AUDIENCE_LIST
Tool to create a recurring audience list that automatically generates new audience lists daily based on the latest data. Use when you need to automate audience list creation and reduce quota token consumption.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Parent property resource name. Format: properties/{property_id}. |
audience | string | Yes | Audience resource name. Format: properties/{property_id}/audiences/{audience_id}. |
dimensions | array | Yes | List of dimensions requested and displayed in the audience list response. |
activeDaysRemaining | integer | No | Counter decreasing daily. Defaults to 180 days for Analytics 360 properties (max 365) and 14 days for standard properties (max 30). |
webhookNotification | object | No | Configuration for receiving webhook notifications about recurring audience list status. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create Report Task
Section titled “Create Report Task”GOOGLE_ANALYTICS_CREATE_REPORT_TASK
Tool to create a report task as a long-running asynchronous request for customized Google Analytics event data reports. Use when you need to generate large or complex reports that process asynchronously.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Property identifier in format properties/{propertyId}. |
reportDefinition | object | No | Defines how the report executes. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create Rollup Property
Section titled “Create Rollup Property”GOOGLE_ANALYTICS_CREATE_ROLLUP_PROPERTY
Tool to create a roll-up property. Use when consolidating multiple GA4 properties into one aggregated view.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
account | string | Yes | Required. Parent account resource. Format: accounts/{account_id}. |
timeZone | string | Yes | Required. IANA time zone for the roll-up property. |
displayName | string | Yes | Required. Display name for the roll-up property. |
sourceProperties | array | No | Optional. List of source property resource names to link. Format: properties/{property_id}. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get Account
Section titled “Get Account”GOOGLE_ANALYTICS_GET_ACCOUNT
Tool to retrieve a single Account by its resource name. Use when you need detailed account info after confirming the account resource name (e.g., accounts/100).
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. The resource name of the Account to retrieve. Format: accounts/{account_id}. Valid example: accounts/100. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get Attribution Settings
Section titled “Get Attribution Settings”GOOGLE_ANALYTICS_GET_ATTRIBUTION_SETTINGS
Tool to retrieve attribution configuration for a Google Analytics property. Use when you need to check attribution models, lookback windows, and conversion export settings.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. The resource name of the attribution settings. Format: properties/{property_id}/attributionSettings. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get Audience
Section titled “Get Audience”GOOGLE_ANALYTICS_GET_AUDIENCE
Tool to retrieve a single Audience configuration from a Google Analytics property. Use when you need detailed audience information including membership criteria and filter clauses.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
audienceId | string | Yes | Required. The numeric audience ID (e.g., 11228260226). |
propertyId | string | Yes | Required. The Google Analytics property identifier (e.g., 123456789 or properties/123456789). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get Audience Export
Section titled “Get Audience Export”GOOGLE_ANALYTICS_GET_AUDIENCE_EXPORT
Tool to get configuration metadata about a specific audience export. Use when you need to understand an audience export after it has been created or check its status.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. The audience export resource name. Format: properties/{property}/audienceExports/{audience_export}. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get Audience List
Section titled “Get Audience List”GOOGLE_ANALYTICS_GET_AUDIENCE_LIST
Tool to get configuration metadata about a specific audience list. Use after confirming the audience list resource name.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. The resource name of the Audience List. Format: properties/{property}/audienceLists/{audienceList}. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get Custom Dimension
Section titled “Get Custom Dimension”GOOGLE_ANALYTICS_GET_CUSTOM_DIMENSION
Tool to retrieve a single CustomDimension by its resource name. Use when you need detailed information about a specific custom dimension including its display name, scope, and parameter name.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. The resource name of the CustomDimension. Format: properties/{property_id}/customDimensions/{customDimension_id}. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get Data Retention Settings
Section titled “Get Data Retention Settings”GOOGLE_ANALYTICS_GET_DATA_RETENTION_SETTINGS
Tool to retrieve data retention configuration for a Google Analytics property. Use when you need to check event-level and user-level data retention durations.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. Format: properties/{property_id}/dataRetentionSettings. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get Data Sharing Settings
Section titled “Get Data Sharing Settings”GOOGLE_ANALYTICS_GET_DATA_SHARING_SETTINGS
Tool to retrieve data sharing configuration for a Google Analytics account. Use when you need to check which data sharing settings are enabled for an account.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. Format: accounts/{account_id}/dataSharingSettings. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get Google Signals Settings
Section titled “Get Google Signals Settings”GOOGLE_ANALYTICS_GET_GOOGLE_SIGNALS_SETTINGS
Tool to retrieve Google Signals configuration settings for a GA4 property. Use when you need to check whether Google Signals is enabled and the consent status for a property.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. Format: properties/{property_id}/googleSignalsSettings. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get Key Event
Section titled “Get Key Event”GOOGLE_ANALYTICS_GET_KEY_EVENT
Tool to retrieve a Key Event. Use after confirming the key event resource name. Read-only; create, update, or delete operations require the Google Analytics UI.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. Resource name of the Key Event. Format: properties/{property}/keyEvents/{keyEvent}. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get Metadata
Section titled “Get Metadata”GOOGLE_ANALYTICS_GET_METADATA
Tool to get metadata for dimensions, metrics, and comparisons for a GA4 property. Use to discover available fields before building a report — always derive dimension/metric apiNames from this output rather than hardcoding from GA4 UI labels, which differ.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Resource name of the metadata. Format: properties/{property_id}/metadata. Use property_id=0 to return only universal metadata. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get Property
Section titled “Get Property”GOOGLE_ANALYTICS_GET_PROPERTY
Tool to retrieve a single GA4 Property by its resource name. Use when you need detailed property configuration including display name, time zone, currency, and other settings.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. Format: properties/{property_id}. Valid example: properties/489591273. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get Property Quotas Snapshot
Section titled “Get Property Quotas Snapshot”GOOGLE_ANALYTICS_GET_PROPERTY_QUOTAS_SNAPSHOT
Tool to retrieve all property quotas organized by category for a given GA4 property. Use when you need to check current quota usage. Snapshot data can lag real consumption by several minutes.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
property | string | Yes | Required. The property resource. Format: properties/{property_id}. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get Recurring Audience List
Section titled “Get Recurring Audience List”GOOGLE_ANALYTICS_GET_RECURRING_AUDIENCE_LIST
Tool to get configuration metadata about a specific recurring audience list. Use when you need to understand a recurring audience list’s state after it has been created.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. Format: properties/{property}/recurringAudienceLists/{recurring_audience_list}. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get Report Task
Section titled “Get Report Task”GOOGLE_ANALYTICS_GET_REPORT_TASK
Tool to get report metadata about a specific report task. Use after creating a report task to check its processing state or inspect its report definition.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. Format: properties/{property}/reportTasks/{reportTask}. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Accounts (Deprecated)
Section titled “List Accounts (Deprecated)”GOOGLE_ANALYTICS_LIST_ACCOUNTS
DEPRECATED: Use GOOGLE_ANALYTICS_LIST_ACCOUNTS_V1_BETA instead. Tool to list all Accounts accessible by the caller. Empty or partial results may indicate a permissions issue.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
pageSize | integer | No | Optional. Maximum number of accounts to return. Must be ≥1. |
pageToken | string | No | Optional. Token for retrieving the next page of results. |
showDeleted | boolean | No | Optional. Whether to include soft-deleted (trashed) Accounts. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Account Summaries
Section titled “List Account Summaries”GOOGLE_ANALYTICS_LIST_ACCOUNT_SUMMARIES
Tool to retrieve summaries of all Google Analytics accounts accessible by the caller. Use when you need a high-level overview of accounts and their properties.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
pageSize | integer | No | Maximum number of account summaries to return. Default: 50, maximum: 200. |
pageToken | string | No | Page token received from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Accounts (v1beta)
Section titled “List Accounts (v1beta)”GOOGLE_ANALYTICS_LIST_ACCOUNTS_V1_BETA
Tool to list all Google Analytics accounts accessible by the caller using v1beta API. Soft-deleted accounts are excluded by default.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
pageSize | integer | No | Maximum number of resources to return. Default: 50, maximum: 200. |
pageToken | string | No | A page token from a previous ListAccounts call. |
showDeleted | boolean | No | Whether to include soft-deleted Accounts. Defaults to false. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List AdSense Links
Section titled “List AdSense Links”GOOGLE_ANALYTICS_LIST_ADSENSE_LINKS
Tool to list all AdSenseLinks on a property. Use when you need to fetch all AdSense links for a given Google Analytics property.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Resource name of the property. Format: properties/{propertyId}. |
pageSize | integer | No | Optional. Maximum number of results (1–200). Defaults to 50. |
pageToken | string | No | Optional. Token for retrieving the next page. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Audience Exports
Section titled “List Audience Exports”GOOGLE_ANALYTICS_LIST_AUDIENCE_EXPORTS
Tool to list all audience exports for a property. Use when you need to find and reuse existing audience exports rather than creating new ones.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Property identifier: properties/{propertyId}. |
pageSize | integer | No | Optional. Default: 200, maximum: 1000. |
pageToken | string | No | Optional. Token for pagination. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Audience Lists
Section titled “List Audience Lists”GOOGLE_ANALYTICS_LIST_AUDIENCE_LISTS
Tool to list all audience lists for a specified property. Use when you need to retrieve a property’s configured audience lists.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Resource name of the parent property. Format: properties/{property_id}. |
pageSize | integer | No | Optional. Default: 200, maximum: 1000. |
pageToken | string | No | Optional. Token for retrieving the next page. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Audiences
Section titled “List Audiences”GOOGLE_ANALYTICS_LIST_AUDIENCES
Tool to list Audiences on a property. Audiences created before 2020 may not be supported.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. The property for which to list Audiences. Format: properties/{propertyId}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. A page token from a previous ListAudiences call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List BigQuery Links
Section titled “List BigQuery Links”GOOGLE_ANALYTICS_LIST_BIGQUERY_LINKS
Tool to list BigQuery Links on a property. Use when you need to retrieve BigQuery link resources associated with a Google Analytics property.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Format: properties/{property_id}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. A page token from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Calculated Metrics
Section titled “List Calculated Metrics”GOOGLE_ANALYTICS_LIST_CALCULATED_METRICS
List Calculated Metrics for a property.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Property identifier: properties/{propertyId}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. Token for pagination. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Channel Groups
Section titled “List Channel Groups”GOOGLE_ANALYTICS_LIST_CHANNEL_GROUPS
Tool to list ChannelGroups on a property. Use when you need to retrieve channel groups that categorize traffic sources in Analytics reports.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Format: properties/{property_id}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. A page token from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Conversion Events
Section titled “List Conversion Events”GOOGLE_ANALYTICS_LIST_CONVERSION_EVENTS
Tool to list conversion events on a property. Use when you need to retrieve conversion events configured for a given property.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Format: properties/{propertyId}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. A page token from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Custom Dimensions
Section titled “List Custom Dimensions”GOOGLE_ANALYTICS_LIST_CUSTOM_DIMENSIONS
List Custom Dimensions for a property.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Format: properties/{property_id}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. A page token from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Custom Metrics
Section titled “List Custom Metrics”GOOGLE_ANALYTICS_LIST_CUSTOM_METRICS
Tool to list CustomMetrics on a property. Use when you need to retrieve all custom metrics configured for a given property.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Property identifier: properties/{propertyId}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. Token for pagination. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List DataStreams
Section titled “List DataStreams”GOOGLE_ANALYTICS_LIST_DATA_STREAMS
Tool to list DataStreams on a property. Use when you need to retrieve data stream configurations for a Google Analytics property.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. GA4 property identifier. Format: properties/{NUMERIC_ID}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. A page token from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Display & Video 360 Advertiser Links
Section titled “List Display & Video 360 Advertiser Links”GOOGLE_ANALYTICS_LIST_DV360_AD_LINKS
Tool to list Display & Video 360 advertiser links on a property. Use when you need to retrieve DisplayVideo360AdvertiserLink resources associated with a Google Analytics property.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Format: properties/{property_id}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. A page token from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List DisplayVideo360 Advertiser Link Proposals
Section titled “List DisplayVideo360 Advertiser Link Proposals”GOOGLE_ANALYTICS_LIST_DV360_LINK_PROPOSALS
Tool to list DisplayVideo360AdvertiserLinkProposals on a property. Use when you need to retrieve Display & Video 360 advertiser link proposals associated with a Google Analytics property.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Format: properties/{property_id}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. A page token from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Event Create Rules
Section titled “List Event Create Rules”GOOGLE_ANALYTICS_LIST_EVENT_CREATE_RULES
Tool to list EventCreateRules configured on a web data stream. Use when you need to retrieve event create rules for a specific GA4 property data stream.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Resource name of the parent data stream. Format: properties/{propertyId}/dataStreams/{dataStreamId}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. A page token from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Expanded Data Sets
Section titled “List Expanded Data Sets”GOOGLE_ANALYTICS_LIST_EXPANDED_DATA_SETS
Tool to list ExpandedDataSets on a property. Use when you need to retrieve expanded data set configurations for a Google Analytics 360 property.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Format: properties/{property_id}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. A page token from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Firebase Links
Section titled “List Firebase Links”GOOGLE_ANALYTICS_LIST_FIREBASE_LINKS
Tool to list FirebaseLinks on a property. Each property can have at most one FirebaseLink.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Format: properties/{property_id}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. A page token from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Google Ads Links
Section titled “List Google Ads Links”GOOGLE_ANALYTICS_LIST_GOOGLE_ADS_LINKS
Tool to list GoogleAdsLinks on a property. Use when you need to retrieve Google Ads account links configured for a Google Analytics property.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Format: properties/{propertyId}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. A page token from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Key Events
Section titled “List Key Events”GOOGLE_ANALYTICS_LIST_KEY_EVENTS
Tool to list Key Events. Key events are read-only via API; creation, updates, and deletion require the Google Analytics UI. An empty results list means no key events are configured, not a failure.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Resource name of the parent property. Format: properties/{property_id}. |
pageSize | integer | No | Optional. Must be between 1 and 200. |
pageToken | string | No | Optional. Token for retrieving the next page. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Measurement Protocol Secrets
Section titled “List Measurement Protocol Secrets”GOOGLE_ANALYTICS_LIST_MEASUREMENT_PROTOCOL_SECRETS
Tool to list MeasurementProtocolSecrets under a data stream. Use when you need to retrieve measurement protocol secrets for server-side event tracking.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Format: properties/{property}/dataStreams/{dataStream}. |
pageSize | integer | No | Optional. Default: 10, maximum: 10. |
pageToken | string | No | Optional. A page token from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Properties (Deprecated)
Section titled “List Properties (Deprecated)”GOOGLE_ANALYTICS_LIST_PROPERTIES
DEPRECATED: Use GOOGLE_ANALYTICS_LIST_PROPERTIES_FILTERED instead. Tool to list GA4 properties under a specific account. Supports pagination and including soft-deleted properties.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
account | string | Yes | Required. Google Analytics account resource name. Format: accounts/{account_id}. |
pageSize | integer | No | Optional. Maximum number of properties to return (1–200). |
pageToken | string | No | Optional. Token to retrieve the next page. |
showDeleted | boolean | No | Optional. Whether to include soft-deleted properties. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Property
Section titled “List Property”GOOGLE_ANALYTICS_LIST_PROPERTIES_FILTERED
Tool to list GA4 properties based on filter criteria. Use when you need to find properties under a specific parent account or with specific Firebase projects.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
filter | string | Yes | Required. Expression for filtering results. Eligible fields: parent:, ancestor:, firebase_project:. Examples: parent:accounts/123, firebase_project:project-id. |
pageSize | integer | No | Optional. Maximum number of properties (1–200). Default: 50. |
pageToken | string | No | Optional. Token from a previous call. |
showDeleted | boolean | No | Optional. Whether to include soft-deleted properties. Default: false. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Recurring Audience Lists
Section titled “List Recurring Audience Lists”GOOGLE_ANALYTICS_LIST_RECURRING_AUDIENCE_LISTS
Tool to list all recurring audience lists for a GA4 property. Use when you need to find and reuse existing recurring audience lists.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Format: properties/{property_id}. |
pageSize | integer | No | Optional. Default: 200, maximum: 1000. |
pageToken | string | No | Optional. Token for retrieving the next page. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Reporting Data Annotations
Section titled “List Reporting Data Annotations”GOOGLE_ANALYTICS_LIST_REPORTING_DATA_ANNOTATIONS
Tool to list all Reporting Data Annotations for a specific property. Use when you need to retrieve annotations that document important events or periods in GA4 reporting data.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional. Expression to refine results. Supported fields: name, title, description, annotationDate, annotationDateRange, color. |
parent | string | Yes | Required. Format: properties/{property_id}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. Pagination token from a previous response. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Report Tasks
Section titled “List Report Tasks”GOOGLE_ANALYTICS_LIST_REPORT_TASKS
Tool to list all report tasks for a Google Analytics property. Use when you need to retrieve report task definitions and their execution status.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Property identifier: properties/{propertyId}. |
pageSize | integer | No | Optional. Page size determined by server if unspecified. |
pageToken | string | No | Optional. Pagination token from a previous response. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Search Ads 360 Links
Section titled “List Search Ads 360 Links”GOOGLE_ANALYTICS_LIST_SEARCH_ADS360_LINKS
Tool to list all SearchAds360Links on a property. Use when you need to retrieve all Search Ads 360 links for a given Google Analytics property.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Format: properties/{propertyId}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. A page token from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List SKAdNetwork Conversion Value Schemas
Section titled “List SKAdNetwork Conversion Value Schemas”GOOGLE_ANALYTICS_LIST_SK_AD_NETWORK_CONVERSION_VALUE_SCHEMAS
Tool to list SKAdNetworkConversionValueSchema configurations for an iOS data stream. Use when you need to retrieve conversion value schemas for iOS app tracking. Maximum one schema per property is supported.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. The DataStream resource. Format: properties/{property_id}/dataStreams/{dataStream}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. Token for pagination. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Subproperty Event Filters
Section titled “List Subproperty Event Filters”GOOGLE_ANALYTICS_LIST_SUBPROPERTY_EVENT_FILTERS
Tool to list all subproperty event filters on a property. Use when you need to retrieve event filters that route events to subproperties.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Resource name of the ordinary property. Format: properties/{property_id}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. Page token from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List Subproperty Sync Configs
Section titled “List Subproperty Sync Configs”GOOGLE_ANALYTICS_LIST_SUBPROPERTY_SYNC_CONFIGS
Tool to list SubpropertySyncConfig resources for managing subproperty synchronization configurations.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
parent | string | Yes | Required. Format: properties/{property_id}. |
pageSize | integer | No | Optional. Default: 50, maximum: 200. |
pageToken | string | No | Optional. A page token from a previous call. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Provision Account Ticket
Section titled “Provision Account Ticket”GOOGLE_ANALYTICS_PROVISION_ACCOUNT_TICKET
Tool to request a ticket for creating a Google Analytics account. Use when you need to initiate the account creation flow that requires user acceptance of Terms of Service.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
account | object | Yes | Required. Account details including display name and region code. |
redirectUri | string | Yes | Required. Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Cloud Console as a Redirect URI. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Query Audience Export
Section titled “Query Audience Export”GOOGLE_ANALYTICS_QUERY_AUDIENCE_EXPORT
Tool to query a completed audience export. Use when you need to fetch user rows with pagination.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. Resource name of the audience export. Format: properties/{property}/audienceExports/{audienceExport}. |
limit | integer | No | Optional. Number of rows to return (1–250,000). Defaults to 10,000. |
offset | integer | No | Optional. Zero-based start row index for pagination. Defaults to 0. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Query Audience List
Section titled “Query Audience List”GOOGLE_ANALYTICS_QUERY_AUDIENCE_LIST
Tool to query an audience list. Use when you need to retrieve user rows from a GA4 audience list with pagination.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. Audience list resource to query. Format: properties/{property}/audienceLists/{audienceList}. |
limit | integer | No | Optional. Number of rows to return; default 10,000; maximum 250,000. |
offset | integer | No | Optional. Zero-based row offset for pagination. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Query Report Task
Section titled “Query Report Task”GOOGLE_ANALYTICS_QUERY_REPORT_TASK
Tool to retrieve a report task’s content. Use after creating a report task with GOOGLE_ANALYTICS_CREATE_REPORT_TASK and confirming it is in ACTIVE state. This method returns an error if the report task’s state is not ACTIVE.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. Report task name: properties/{propertyId}/reportTasks/{reportTaskId}. The report task must be in ACTIVE state. |
limit | integer | No | Optional. Number of rows to return (max 250,000). Defaults to 10,000. |
offset | integer | No | Optional. Row offset for pagination (0-indexed). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Run Funnel Report
Section titled “Run Funnel Report”GOOGLE_ANALYTICS_RUN_FUNNEL_REPORT
Tool to run a GA4 funnel report. Use when you need a customized funnel analysis report for a given property. Funnel step sequence is determined by step attributes in the response, not row order.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Number of rows to return. Default 10,000; max 250,000. |
funnel | object | Yes | Funnel configuration object. Must include a steps key with at least one step. Each step requires a name and optionally a filterExpression. |
property | string | Yes | GA4 property resource name. Format: properties/{property_id}. |
segments | array | No | Up to 4 segments; each yields its own row in the report. |
dateRanges | array | No | List of date ranges to read. |
dimensionFilter | object | No | Dimension-only filter expression. |
funnelBreakdown | object | No | Breakdown dimension configuration for the funnel table sub-report. |
funnelNextAction | object | No | Next-action dimension configuration for the funnel visualization sub-report. |
returnPropertyQuota | boolean | No | If true, includes the property’s current quota state. |
funnelVisualizationType | string | No | Visualization type: STANDARD_FUNNEL (default) or TRENDED_FUNNEL. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Run Pivot Report
Section titled “Run Pivot Report”GOOGLE_ANALYTICS_RUN_PIVOT_REPORT
Tool to run a customized pivot report of Google Analytics event data. Use when you need a pivot table view with advanced segmentation and multi-dimensional analysis of GA4 data.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
pivots | array | No | Optional. Visual format configuration for dimensions. |
metrics | array | Yes | Required. At least one metric is required. Each metric has a name field. |
property | string | Yes | Required. Format: properties/{property_id}. |
cohortSpec | object | No | Optional. Cohort configuration. |
dateRanges | array | No | Optional. Date ranges for event data retrieval. |
dimensions | array | No | Optional. Dimensions to request. Must be used in pivots, filters, or orderBys. |
comparisons | array | No | Optional. Comparison configurations. |
currencyCode | string | No | Optional. ISO4217 currency code (e.g., USD, EUR). |
metricFilter | object | No | Optional. Post-aggregation filter. |
keepEmptyRows | boolean | No | Optional. If true, includes rows where all metrics equal 0. |
dimensionFilter | object | No | Optional. Filter clause for dimensions only. |
returnPropertyQuota | boolean | No | Optional. If true, returns current quota state. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Run Realtime Report
Section titled “Run Realtime Report”GOOGLE_ANALYTICS_RUN_REALTIME_REPORT
Tool to run a customized realtime report of Google Analytics event data. Use when you need realtime data (last 30–60 minutes) with dimensions and metrics for a GA4 property.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Max rows to return (default 10,000, max 250,000). |
metrics | array | No | Metrics to measure (max 10). Valid names: activeUsers, eventCount, keyEvents, screenPageViews. |
orderBys | array | No | Sorting specification. |
property | string | Yes | Required. Format: properties/{property_id}. |
dimensions | array | No | Dimensions to group by (max 9). Valid names: appVersion, audienceId, city, country, deviceCategory, eventName, minutesAgo, platform etc. |
metricFilter | object | No | Post-aggregation filter on metric values. |
minuteRanges | array | No | Time ranges to report on. Default is last 30 minutes. |
dimensionFilter | object | No | Filter to restrict data by dimension values. |
metricAggregations | array | No | Request aggregated metric values: TOTAL, MINIMUM, MAXIMUM, COUNT. |
returnPropertyQuota | boolean | No | If true, includes API quota usage info in the response. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Run Report
Section titled “Run Report”GOOGLE_ANALYTICS_RUN_REPORT
Tool to run a customized GA4 data report. Use when you need event data after specifying dimensions, metrics, and date ranges. If you receive a 400 error about incompatible dimensions/metrics, use GOOGLE_ANALYTICS_CHECK_COMPATIBILITY first to validate your combinations.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Optional. Number of rows to return (1–250,000). |
offset | integer | No | Optional. 0-based start row for pagination. |
metrics | array | No | Optional. The metrics to request. Maximum 10 per request. Common valid names: activeUsers, totalUsers, newUsers, sessions, engagedSessions, screenPageViews, eventCount, conversions, purchaseRevenue, transactions etc. |
orderBys | array | No | Optional. Specify how rows are ordered. |
property | string | Yes | Required. Format: properties/{property_id}. |
cohortSpec | object | No | Optional. Cohort specification. |
dateRanges | array | No | The date ranges to read. Required for standard reports. |
dimensions | array | No | Optional. The dimensions to request. Maximum 9 per request. Common valid names: date, city, country, deviceCategory, sessionSource, pagePath, eventName, userAgeBracket etc. |
comparisons | array | No | Optional. The comparison configuration. |
currencyCode | string | No | Optional. The currency code to apply, in ISO 4217 format. |
metricFilter | object | No | Optional. Filter expression to restrict rows by metric values. Use only metric field names here. |
keepEmptyRows | boolean | No | Optional. If true, rows with all zero metrics will be returned. |
dimensionFilter | object | No | Optional. Filter expression to restrict rows by dimension values. Use only dimension field names here. |
metricAggregations | array | No | Optional. Aggregation types: TOTAL, MINIMUM, MAXIMUM. |
returnPropertyQuota | boolean | No | Optional. If true, include the property’s current quota state in the response. |
removed_dimensions_internal | array | No | Internal field to store filtered dimension names for execution message. Not sent to API. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Send Events
Section titled “Send Events”GOOGLE_ANALYTICS_SEND_EVENTS
Tool to send event data to Google Analytics 4 using the Measurement Protocol. Use when you need to track server-side events that supplement client-side gtag.js or Firebase tracking. Events are processed asynchronously and typically appear in reports within 24–48 hours.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
events | array | Yes | Required. Array of event objects to send. Maximum 25 events per request. Each event must have a name and can optionally include params. |
consent | object | No | Consent settings for Google Analytics 4. |
user_id | string | No | Optional. A unique identifier for a logged-in user. Maximum 256 characters. |
client_id | string | Yes | Required. A unique identifier for a user/client. Maximum 256 characters. |
api_secret | string | Yes | Required. The API secret generated in the Google Analytics UI under Admin > Data Streams > Measurement Protocol API secrets. |
measurement_id | string | Yes | Required. The measurement ID for the web stream in the format G-XXXXXXX. |
user_properties | object | No | Optional. User properties to set for this measurement. Persist across events. |
timestamp_micros | integer | No | Optional. Unix timestamp in microseconds. Can be up to 72 hours in the past. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Update Property
Section titled “Update Property”GOOGLE_ANALYTICS_UPDATE_PROPERTY
Tool to update an existing GA4 Property. Use when you need to modify property settings such as display name, time zone, currency code, or industry category.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Required. Format: properties/{property_id}. |
parent | string | No | Immutable. Resource name of this property’s logical parent. Format: accounts/{account} or properties/{property}. |
timeZone | string | No | Reporting Time Zone. Format: IANA time zone. Example: America/Los_Angeles. |
updateMask | string | Yes | Required. The list of fields to be updated in snake_case. Example: display_name,time_zone,currency_code. |
displayName | string | No | Human-readable display name. Max 100 UTF-16 code units. |
currencyCode | string | No | Currency type in ISO 4217 format. Examples: USD, EUR, JPY. |
propertyType | string | No | Property type: PROPERTY_TYPE_ORDINARY, PROPERTY_TYPE_SUBPROPERTY, or PROPERTY_TYPE_ROLLUP. |
industryCategory | string | No | Industry category for the property (e.g., TECHNOLOGY, FINANCE, HEALTHCARE). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Validate Events
Section titled “Validate Events”GOOGLE_ANALYTICS_VALIDATE_EVENTS
Tool to validate Measurement Protocol events before sending them to production. Use when you need to verify event structure and parameters are correct before sending real data.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
events | array | Yes | Required. Array of events to validate. Each event must have a name field and optional params object. |
consent | object | No | Optional. The consent state for the user. |
user_id | string | No | Optional. A unique identifier for a user. |
client_id | string | Yes | Required. Unique client identifier. |
api_secret | string | Yes | Required. The API secret from Google Analytics for the Measurement Protocol. |
measurement_id | string | Yes | Required. The measurement ID for web streams. Format: G-XXXXXXXXXX. |
user_properties | object | No | Optional. The user properties for the measurement. |
timestamp_micros | string | No | Optional. A Unix timestamp (in microseconds) for the time to associate with the event. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |