Skip to content

Google Analytics

Google Analytics

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.

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.

  1. Go to Tools in the side menu (/admin/tools).
  2. Open the Available tab and search for Google Analytics.
  3. Click the card to open the details modal and hit Connect.
  4. You’re taken to the secure connection page hosted by Composio, where you authorize access to your Google Analytics account via OAuth.
  5. 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.)

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.

NameTypeRequiredDescription
namestringYesRequired. 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.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
propertystringYesRequired. The GA4 property resource name. Format: properties/{property_id}.
requestsarrayYesRequired. Up to 5 individual RunPivotReportRequest objects. Every dimension defined in dimensions MUST be used in at least one pivot, filter, or orderBy.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
propertystringYesRequired. The property resource name. Format: properties/{property_id}.
requestsarrayYesRequired. Up to 5 individual RunReportRequest objects (minimum 1, maximum 5). Non-cohort requests MUST contain dateRanges.
unwrapped_filtersarrayNoInternal field to track which filters were unwrapped during validation.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
metricsarrayNoOptional. List of metrics to check compatibility for. Maximum of 10 metrics allowed per request.
propertystringYesRequired. GA4 property resource name. Format: properties/{property_id}.
dimensionsarrayNoOptional. List of dimensions to check compatibility for.
metricFilterobjectNoOptional. A FilterExpression for metrics.
dimensionFilterobjectNoOptional. A FilterExpression for dimensions.
compatibilityFilterstringNoCompatibility status. Valid values: COMPATIBILITY_UNSPECIFIED, COMPATIBLE, INCOMPATIBLE.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesParent property resource name. Format: properties/{property_id}.
audiencestringYesAudience resource name. Format: properties/{property_id}/audiences/{audience_id}.
dimensionsarrayNoOptional list of dimensions requested and displayed in the export.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. The parent property resource name. Format: properties/{property_id}.
audiencestringYesRequired. The audience resource name. Format: properties/{property_id}/audiences/{audience_id}.
dimensionsarrayYesRequired. 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.
webhookNotificationobjectNoWebhook notification configuration for audience list operation updates.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
scopestringYesRequired. Immutable. Must be one of: EVENT, USER, or ITEM.
parentstringYesRequired. The property in which to create the CustomDimension. Format: properties/{property_id}.
descriptionstringNoOptional. Max length of 150 characters.
displayNamestringYesRequired. Display name shown in the Analytics UI. Max length of 82 characters.
parameterNamestringYesRequired. Immutable. Tagging parameter name. Max length of 24 characters for user-scoped, 40 for event-scoped dimensions.
disallowAdsPersonalizationbooleanNoOptional. If true, sets this dimension as NPA (only for user-scoped dimensions).
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
scopestringYesRequired. Immutable. Values: METRIC_SCOPE_UNSPECIFIED or EVENT.
parentstringYesRequired. The property where the custom metric will be created. Format: properties/{property_id}.
descriptionstringNoOptional. Max length of 150 characters.
displayNamestringYesRequired. Display name shown in the Analytics UI. Max length of 82 characters.
parameterNamestringYesRequired. Immutable. Tagging name. Max length of 40 characters for event-scoped metrics.
measurementUnitstringYesRequired. The type for the custom metric’s value: STANDARD, CURRENCY, FEET, METERS, KILOMETERS, MILES, MILLISECONDS, SECONDS, MINUTES, or HOURS.
restrictedMetricTypearrayNoOptional. Required for metrics with CURRENCY measurement unit. Must be empty for non-CURRENCY metrics.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesParent property resource name. Format: properties/{propertyId}.
expandedDataSetobjectYesDefinition of the ExpandedDataSet to create.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesParent property resource name. Format: properties/{property_id}.
audiencestringYesAudience resource name. Format: properties/{property_id}/audiences/{audience_id}.
dimensionsarrayYesList of dimensions requested and displayed in the audience list response.
activeDaysRemainingintegerNoCounter decreasing daily. Defaults to 180 days for Analytics 360 properties (max 365) and 14 days for standard properties (max 30).
webhookNotificationobjectNoConfiguration for receiving webhook notifications about recurring audience list status.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Property identifier in format properties/{propertyId}.
reportDefinitionobjectNoDefines how the report executes.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

GOOGLE_ANALYTICS_CREATE_ROLLUP_PROPERTY

Tool to create a roll-up property. Use when consolidating multiple GA4 properties into one aggregated view.

NameTypeRequiredDescription
accountstringYesRequired. Parent account resource. Format: accounts/{account_id}.
timeZonestringYesRequired. IANA time zone for the roll-up property.
displayNamestringYesRequired. Display name for the roll-up property.
sourcePropertiesarrayNoOptional. List of source property resource names to link. Format: properties/{property_id}.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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).

NameTypeRequiredDescription
namestringYesRequired. The resource name of the Account to retrieve. Format: accounts/{account_id}. Valid example: accounts/100.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
namestringYesRequired. The resource name of the attribution settings. Format: properties/{property_id}/attributionSettings.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
audienceIdstringYesRequired. The numeric audience ID (e.g., 11228260226).
propertyIdstringYesRequired. The Google Analytics property identifier (e.g., 123456789 or properties/123456789).
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
namestringYesRequired. The audience export resource name. Format: properties/{property}/audienceExports/{audience_export}.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

GOOGLE_ANALYTICS_GET_AUDIENCE_LIST

Tool to get configuration metadata about a specific audience list. Use after confirming the audience list resource name.

NameTypeRequiredDescription
namestringYesRequired. The resource name of the Audience List. Format: properties/{property}/audienceLists/{audienceList}.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
namestringYesRequired. The resource name of the CustomDimension. Format: properties/{property_id}/customDimensions/{customDimension_id}.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
namestringYesRequired. Format: properties/{property_id}/dataRetentionSettings.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
namestringYesRequired. Format: accounts/{account_id}/dataSharingSettings.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
namestringYesRequired. Format: properties/{property_id}/googleSignalsSettings.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
namestringYesRequired. Resource name of the Key Event. Format: properties/{property}/keyEvents/{keyEvent}.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
namestringYesResource name of the metadata. Format: properties/{property_id}/metadata. Use property_id=0 to return only universal metadata.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
namestringYesRequired. Format: properties/{property_id}. Valid example: properties/489591273.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
propertystringYesRequired. The property resource. Format: properties/{property_id}.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
namestringYesRequired. Format: properties/{property}/recurringAudienceLists/{recurring_audience_list}.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
namestringYesRequired. Format: properties/{property}/reportTasks/{reportTask}.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
pageSizeintegerNoOptional. Maximum number of accounts to return. Must be ≥1.
pageTokenstringNoOptional. Token for retrieving the next page of results.
showDeletedbooleanNoOptional. Whether to include soft-deleted (trashed) Accounts.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
pageSizeintegerNoMaximum number of account summaries to return. Default: 50, maximum: 200.
pageTokenstringNoPage token received from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
pageSizeintegerNoMaximum number of resources to return. Default: 50, maximum: 200.
pageTokenstringNoA page token from a previous ListAccounts call.
showDeletedbooleanNoWhether to include soft-deleted Accounts. Defaults to false.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Resource name of the property. Format: properties/{propertyId}.
pageSizeintegerNoOptional. Maximum number of results (1–200). Defaults to 50.
pageTokenstringNoOptional. Token for retrieving the next page.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Property identifier: properties/{propertyId}.
pageSizeintegerNoOptional. Default: 200, maximum: 1000.
pageTokenstringNoOptional. Token for pagination.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Resource name of the parent property. Format: properties/{property_id}.
pageSizeintegerNoOptional. Default: 200, maximum: 1000.
pageTokenstringNoOptional. Token for retrieving the next page.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

GOOGLE_ANALYTICS_LIST_AUDIENCES

Tool to list Audiences on a property. Audiences created before 2020 may not be supported.

NameTypeRequiredDescription
parentstringYesRequired. The property for which to list Audiences. Format: properties/{propertyId}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. A page token from a previous ListAudiences call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Format: properties/{property_id}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. A page token from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

GOOGLE_ANALYTICS_LIST_CALCULATED_METRICS

List Calculated Metrics for a property.

NameTypeRequiredDescription
parentstringYesRequired. Property identifier: properties/{propertyId}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. Token for pagination.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Format: properties/{property_id}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. A page token from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Format: properties/{propertyId}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. A page token from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

GOOGLE_ANALYTICS_LIST_CUSTOM_DIMENSIONS

List Custom Dimensions for a property.

NameTypeRequiredDescription
parentstringYesRequired. Format: properties/{property_id}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. A page token from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Property identifier: properties/{propertyId}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. Token for pagination.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. GA4 property identifier. Format: properties/{NUMERIC_ID}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. A page token from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Format: properties/{property_id}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. A page token from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not
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.

NameTypeRequiredDescription
parentstringYesRequired. Format: properties/{property_id}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. A page token from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Resource name of the parent data stream. Format: properties/{propertyId}/dataStreams/{dataStreamId}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. A page token from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Format: properties/{property_id}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. A page token from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

GOOGLE_ANALYTICS_LIST_FIREBASE_LINKS

Tool to list FirebaseLinks on a property. Each property can have at most one FirebaseLink.

NameTypeRequiredDescription
parentstringYesRequired. Format: properties/{property_id}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. A page token from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Format: properties/{propertyId}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. A page token from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Resource name of the parent property. Format: properties/{property_id}.
pageSizeintegerNoOptional. Must be between 1 and 200.
pageTokenstringNoOptional. Token for retrieving the next page.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Format: properties/{property}/dataStreams/{dataStream}.
pageSizeintegerNoOptional. Default: 10, maximum: 10.
pageTokenstringNoOptional. A page token from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
accountstringYesRequired. Google Analytics account resource name. Format: accounts/{account_id}.
pageSizeintegerNoOptional. Maximum number of properties to return (1–200).
pageTokenstringNoOptional. Token to retrieve the next page.
showDeletedbooleanNoOptional. Whether to include soft-deleted properties.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
filterstringYesRequired. Expression for filtering results. Eligible fields: parent:, ancestor:, firebase_project:. Examples: parent:accounts/123, firebase_project:project-id.
pageSizeintegerNoOptional. Maximum number of properties (1–200). Default: 50.
pageTokenstringNoOptional. Token from a previous call.
showDeletedbooleanNoOptional. Whether to include soft-deleted properties. Default: false.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Format: properties/{property_id}.
pageSizeintegerNoOptional. Default: 200, maximum: 1000.
pageTokenstringNoOptional. Token for retrieving the next page.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
filterstringNoOptional. Expression to refine results. Supported fields: name, title, description, annotationDate, annotationDateRange, color.
parentstringYesRequired. Format: properties/{property_id}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. Pagination token from a previous response.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Property identifier: properties/{propertyId}.
pageSizeintegerNoOptional. Page size determined by server if unspecified.
pageTokenstringNoOptional. Pagination token from a previous response.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Format: properties/{propertyId}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. A page token from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. The DataStream resource. Format: properties/{property_id}/dataStreams/{dataStream}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. Token for pagination.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
parentstringYesRequired. Resource name of the ordinary property. Format: properties/{property_id}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. Page token from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

GOOGLE_ANALYTICS_LIST_SUBPROPERTY_SYNC_CONFIGS

Tool to list SubpropertySyncConfig resources for managing subproperty synchronization configurations.

NameTypeRequiredDescription
parentstringYesRequired. Format: properties/{property_id}.
pageSizeintegerNoOptional. Default: 50, maximum: 200.
pageTokenstringNoOptional. A page token from a previous call.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
accountobjectYesRequired. Account details including display name and region code.
redirectUristringYesRequired. Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Cloud Console as a Redirect URI.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

GOOGLE_ANALYTICS_QUERY_AUDIENCE_EXPORT

Tool to query a completed audience export. Use when you need to fetch user rows with pagination.

NameTypeRequiredDescription
namestringYesRequired. Resource name of the audience export. Format: properties/{property}/audienceExports/{audienceExport}.
limitintegerNoOptional. Number of rows to return (1–250,000). Defaults to 10,000.
offsetintegerNoOptional. Zero-based start row index for pagination. Defaults to 0.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
namestringYesRequired. Audience list resource to query. Format: properties/{property}/audienceLists/{audienceList}.
limitintegerNoOptional. Number of rows to return; default 10,000; maximum 250,000.
offsetintegerNoOptional. Zero-based row offset for pagination.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
namestringYesRequired. Report task name: properties/{propertyId}/reportTasks/{reportTaskId}. The report task must be in ACTIVE state.
limitintegerNoOptional. Number of rows to return (max 250,000). Defaults to 10,000.
offsetintegerNoOptional. Row offset for pagination (0-indexed).
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
limitintegerNoNumber of rows to return. Default 10,000; max 250,000.
funnelobjectYesFunnel configuration object. Must include a steps key with at least one step. Each step requires a name and optionally a filterExpression.
propertystringYesGA4 property resource name. Format: properties/{property_id}.
segmentsarrayNoUp to 4 segments; each yields its own row in the report.
dateRangesarrayNoList of date ranges to read.
dimensionFilterobjectNoDimension-only filter expression.
funnelBreakdownobjectNoBreakdown dimension configuration for the funnel table sub-report.
funnelNextActionobjectNoNext-action dimension configuration for the funnel visualization sub-report.
returnPropertyQuotabooleanNoIf true, includes the property’s current quota state.
funnelVisualizationTypestringNoVisualization type: STANDARD_FUNNEL (default) or TRENDED_FUNNEL.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
pivotsarrayNoOptional. Visual format configuration for dimensions.
metricsarrayYesRequired. At least one metric is required. Each metric has a name field.
propertystringYesRequired. Format: properties/{property_id}.
cohortSpecobjectNoOptional. Cohort configuration.
dateRangesarrayNoOptional. Date ranges for event data retrieval.
dimensionsarrayNoOptional. Dimensions to request. Must be used in pivots, filters, or orderBys.
comparisonsarrayNoOptional. Comparison configurations.
currencyCodestringNoOptional. ISO4217 currency code (e.g., USD, EUR).
metricFilterobjectNoOptional. Post-aggregation filter.
keepEmptyRowsbooleanNoOptional. If true, includes rows where all metrics equal 0.
dimensionFilterobjectNoOptional. Filter clause for dimensions only.
returnPropertyQuotabooleanNoOptional. If true, returns current quota state.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
limitintegerNoMax rows to return (default 10,000, max 250,000).
metricsarrayNoMetrics to measure (max 10). Valid names: activeUsers, eventCount, keyEvents, screenPageViews.
orderBysarrayNoSorting specification.
propertystringYesRequired. Format: properties/{property_id}.
dimensionsarrayNoDimensions to group by (max 9). Valid names: appVersion, audienceId, city, country, deviceCategory, eventName, minutesAgo, platform etc.
metricFilterobjectNoPost-aggregation filter on metric values.
minuteRangesarrayNoTime ranges to report on. Default is last 30 minutes.
dimensionFilterobjectNoFilter to restrict data by dimension values.
metricAggregationsarrayNoRequest aggregated metric values: TOTAL, MINIMUM, MAXIMUM, COUNT.
returnPropertyQuotabooleanNoIf true, includes API quota usage info in the response.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
limitintegerNoOptional. Number of rows to return (1–250,000).
offsetintegerNoOptional. 0-based start row for pagination.
metricsarrayNoOptional. The metrics to request. Maximum 10 per request. Common valid names: activeUsers, totalUsers, newUsers, sessions, engagedSessions, screenPageViews, eventCount, conversions, purchaseRevenue, transactions etc.
orderBysarrayNoOptional. Specify how rows are ordered.
propertystringYesRequired. Format: properties/{property_id}.
cohortSpecobjectNoOptional. Cohort specification.
dateRangesarrayNoThe date ranges to read. Required for standard reports.
dimensionsarrayNoOptional. The dimensions to request. Maximum 9 per request. Common valid names: date, city, country, deviceCategory, sessionSource, pagePath, eventName, userAgeBracket etc.
comparisonsarrayNoOptional. The comparison configuration.
currencyCodestringNoOptional. The currency code to apply, in ISO 4217 format.
metricFilterobjectNoOptional. Filter expression to restrict rows by metric values. Use only metric field names here.
keepEmptyRowsbooleanNoOptional. If true, rows with all zero metrics will be returned.
dimensionFilterobjectNoOptional. Filter expression to restrict rows by dimension values. Use only dimension field names here.
metricAggregationsarrayNoOptional. Aggregation types: TOTAL, MINIMUM, MAXIMUM.
returnPropertyQuotabooleanNoOptional. If true, include the property’s current quota state in the response.
removed_dimensions_internalarrayNoInternal field to store filtered dimension names for execution message. Not sent to API.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
eventsarrayYesRequired. Array of event objects to send. Maximum 25 events per request. Each event must have a name and can optionally include params.
consentobjectNoConsent settings for Google Analytics 4.
user_idstringNoOptional. A unique identifier for a logged-in user. Maximum 256 characters.
client_idstringYesRequired. A unique identifier for a user/client. Maximum 256 characters.
api_secretstringYesRequired. The API secret generated in the Google Analytics UI under Admin > Data Streams > Measurement Protocol API secrets.
measurement_idstringYesRequired. The measurement ID for the web stream in the format G-XXXXXXX.
user_propertiesobjectNoOptional. User properties to set for this measurement. Persist across events.
timestamp_microsintegerNoOptional. Unix timestamp in microseconds. Can be up to 72 hours in the past.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
namestringYesRequired. Format: properties/{property_id}.
parentstringNoImmutable. Resource name of this property’s logical parent. Format: accounts/{account} or properties/{property}.
timeZonestringNoReporting Time Zone. Format: IANA time zone. Example: America/Los_Angeles.
updateMaskstringYesRequired. The list of fields to be updated in snake_case. Example: display_name,time_zone,currency_code.
displayNamestringNoHuman-readable display name. Max 100 UTF-16 code units.
currencyCodestringNoCurrency type in ISO 4217 format. Examples: USD, EUR, JPY.
propertyTypestringNoProperty type: PROPERTY_TYPE_ORDINARY, PROPERTY_TYPE_SUBPROPERTY, or PROPERTY_TYPE_ROLLUP.
industryCategorystringNoIndustry category for the property (e.g., TECHNOLOGY, FINANCE, HEALTHCARE).
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not

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.

NameTypeRequiredDescription
eventsarrayYesRequired. Array of events to validate. Each event must have a name field and optional params object.
consentobjectNoOptional. The consent state for the user.
user_idstringNoOptional. A unique identifier for a user.
client_idstringYesRequired. Unique client identifier.
api_secretstringYesRequired. The API secret from Google Analytics for the Measurement Protocol.
measurement_idstringYesRequired. The measurement ID for web streams. Format: G-XXXXXXXXXX.
user_propertiesobjectNoOptional. The user properties for the measurement.
timestamp_microsstringNoOptional. A Unix timestamp (in microseconds) for the time to associate with the event.
NameTypeRequiredDescription
datastringYesData from the action execution
errorstringNoError if any occurred during the execution of the action
successfulbooleanYesWhether or not the action execution was successful or not