Skip to main content
Google Analytics logo
  • Category: analytics
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 69
  • Triggers: 0
  • Slug: GOOGLE_ANALYTICS
  • Version: 20261101_00

Tools

Slug: GOOGLE_ANALYTICS_ARCHIVE_CUSTOM_DIMENSIONTool 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

string
required
Required. The resource name of the CustomDimension to archive. Must be in the exact format: properties/{property_id}/customDimensions/{dimension_id} where property_id and dimension_id are numeric identifiers. IMPORTANT: Must start with ‘properties/’ prefix, contain ‘/customDimensions/’ in the middle, have no trailing slashes, and no additional path segments. Valid example: ‘properties/489591273/customDimensions/13661259421’. Invalid examples: ‘489591273/13661259421’ (missing prefix), ‘properties/489591273/customDimensions/13661259421/’ (trailing slash), ‘properties/489591273/customDimensions/13661259421/extra’ (extra segments)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_BATCH_RUN_PIVOT_REPORTSTool 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

string
required
Required. The GA4 property resource name. Format: properties/{property_id}
array
required
Required. Up to 5 individual RunPivotReportRequest objects. Each request can have dimensions, metrics, dateRanges, pivots, dimensionFilter, metricFilter, currencyCode, cohortSpec, keepEmptyRows, returnPropertyQuota, and comparisons fields. CRITICAL CONSTRAINT: Every dimension defined in ‘dimensions’ MUST be used in at least one of: pivots (fieldNames), dimensionFilter, or orderBys. Dimensions not used anywhere will cause a 400 error. The only exception is ‘dateRange’ dimensions. Additionally, all fieldNames in pivots must reference dimensions defined in the request’s ‘dimensions’ array, and no two pivots can share the same dimension.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_BATCH_RUN_REPORTSRuns multiple analytics data reports for one GA4 property in a single request. Report metadata returned by this tool does not include data truncation reasons.

Input Parameters

string
required
Required. The property resource name. Format: properties/{property_id}
array
required
Required. Up to 5 individual RunReportRequest objects (minimum 1, maximum 5). CRITICAL: Non-cohort requests MUST contain ‘dateRanges’ (list of {startDate, endDate}); cohort requests (containing ‘cohortSpec’) must NOT include ‘dateRanges’. Key fields per request: dateRanges, dimensions (list of {name}), metrics (list of {name}), dimensionFilter/metricFilter (FilterExpression: use andGroup/orGroup/notExpression/filter at top level), cohortSpec, offset, limit, orderBys, keepEmptyRows. NOTE: Do NOT include ‘pivots’ field - use batchRunPivotReports action for pivot reports.
array
Internal field to track which filters were unwrapped during validation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_CHECK_COMPATIBILITYTool 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

array
Optional. List of metrics to check compatibility for. Maximum of 10 metrics allowed per request.
string
required
Required. GA4 property resource name. Format: properties/{property_id}.
array
Optional. List of dimensions to check compatibility for.
object
Optional. A FilterExpression for metrics; must follow GA4 FilterExpression JSON schema.
object
Optional. A FilterExpression for dimensions; must follow GA4 FilterExpression JSON schema.
string ("COMPATIBILITY_UNSPECIFIED" | "COMPATIBLE" | "INCOMPATIBLE")
Compatibility status for dimensions or metrics per Google Analytics Data API v1beta. Valid values: COMPATIBILITY_UNSPECIFIED, COMPATIBLE, INCOMPATIBLE. Note: Values like ‘REPORT_COMPATIBLE’ are NOT valid - use ‘COMPATIBLE’ instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_CREATE_AUDIENCE_EXPORTTool 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. The export begins in CREATING state with rowCount=0; the operation must complete before export data is accessible for querying.

Input Parameters

string
required
Parent property resource name where the audience export will be created. Format: properties/{property_id}.
string
required
Audience resource name identifying the audience to export. Format: properties/{property_id}/audiences/{audience_id}.
array
Optional list of dimensions requested and displayed in the export. Each dimension is specified by dimensionName.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_CREATE_AUDIENCE_LISTTool 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. The method returns quickly with an Operation resource while processing occurs in the background.

Input Parameters

string
required
Required. The parent property resource name. Format: ‘properties/{property_id}’. Example: ‘properties/489591273’
string
required
Required. The audience resource name identifying the audience being listed. Format: ‘properties/{property_id}/audiences/{audience_id}’. Example: ‘properties/489591273/audiences/11228260226’
array
required
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 (e.g., [{'dimensionName': 'deviceId'}]). Only dimensions supported for audience lists on that property are valid; unsupported values return a 400 INVALID_ARGUMENT error. Use GOOGLE_ANALYTICS_GET_METADATA to retrieve valid dimension names.
object
Webhook notification configuration for audience list operation updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_CREATE_CUSTOM_DIMENSIONTool 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

string ("DIMENSION_SCOPE_UNSPECIFIED" | "EVENT" | "USER" | "ITEM")
required
Required. Immutable. The scope of this dimension. Must be one of: EVENT, USER, or ITEM
string
required
Required. The property in which to create the CustomDimension. Format: properties/{property_id}
string
Optional. Description for this custom dimension. Max length of 150 characters
string
required
Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter
string
required
Required. Immutable. Tagging parameter name for this custom dimension. For user-scoped dimensions, this is the user property name. For event-scoped dimensions, this is the event parameter name. For item-scoped dimensions, this is the parameter name in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions
boolean
Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_CREATE_CUSTOM_METRICTool 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

string ("METRIC_SCOPE_UNSPECIFIED" | "EVENT")
required
Required. Immutable. The scope of this custom metric.
string
required
Required. The property where the custom metric will be created. Format: properties/{property_id}
string
Optional. Description for this custom metric. Max length of 150 characters.
string
required
Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter.
string
required
Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 40 characters for event-scoped metrics.
string ("MEASUREMENT_UNIT_UNSPECIFIED" | "STANDARD" | "CURRENCY" | "FEET" | "METERS" | "KILOMETERS" | "MILES" | "MILLISECONDS" | "SECONDS" | "MINUTES" | "HOURS")
required
Required. The type for the custom metric’s value.
array
Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_CREATE_EXPANDED_DATA_SETCreate an expanded data set for a Google Analytics 360 property using specified dimensions and metrics.

Input Parameters

string
required
Parent property resource name. Format: properties/{propertyId}
object
required
Definition of the ExpandedDataSet to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_CREATE_RECURRING_AUDIENCE_LISTTool 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

string
required
Parent property resource name where the recurring audience list will be created. Format: properties/{property_id}.
string
required
Audience resource name identifying the audience being listed. Format: properties/{property_id}/audiences/{audience_id}.
array
required
List of dimensions requested and displayed in the audience list response.
integer
Counter decreasing daily. Defaults to 180 days for Analytics 360 properties (max 365) and 14 days for standard properties (max 30).
object
Configuration for receiving webhook notifications about recurring audience list status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_CREATE_REPORT_TASKTool 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

string
required
Required. Property identifier in format ‘properties/{propertyId}’. The Google Analytics property for which to create the report task.
object
Defines how the report executes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_CREATE_ROLLUP_PROPERTYTool to create a roll-up property. Use when consolidating multiple GA4 properties into one aggregated view.

Input Parameters

string
required
Required. Parent account resource. Format: accounts/{account_id}
string
required
Required. IANA time zone for the roll-up property.
string
required
Required. Display name for the roll-up property.
array
Optional. List of source property resource names to link. Format: properties/{property_id}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_GET_ACCOUNTTool 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

string
required
Required. The resource name of the Account to retrieve. Must be in the exact format: accounts/{account_id} where account_id is a numeric identifier. IMPORTANT: Must start with ‘accounts/’ prefix, contain no forward slashes in the account_id, have no trailing slashes, and no additional path segments. Valid example: ‘accounts/100’. Invalid examples: ‘100’ (missing prefix), ‘accounts/100/’ (trailing slash), ‘accounts/100/extra’ (extra segments)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_GET_ATTRIBUTION_SETTINGSTool 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

string
required
Required. The resource name of the attribution settings to retrieve. Must be in the exact format: properties/{property_id}/attributionSettings where property_id is a numeric identifier. IMPORTANT: Must start with ‘properties/’ prefix, contain no forward slashes in the property_id, have no trailing slashes, and must end with ‘/attributionSettings’. Valid example: ‘properties/489591273/attributionSettings’. Invalid examples: ‘489591273’ (missing prefix), ‘properties/489591273’ (missing suffix), ‘properties/489591273/attributionSettings/’ (trailing slash)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_GET_AUDIENCETool 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

string
required
Required. The audience identifier to retrieve. Provide the numeric audience ID (e.g., ‘11228260226’).
string
required
Required. The Google Analytics property identifier. Can be provided as just the numeric ID (e.g., ‘123456789’) or as full resource name (e.g., ‘properties/123456789’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_GET_AUDIENCE_EXPORTTool 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

string
required
Required. The audience export resource name. Format: properties/{property}/audienceExports/{audience_export}. Example: properties/489591273/audienceExports/19298228

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_GET_AUDIENCE_LISTTool to get configuration metadata about a specific audience list. Use after confirming the audience list resource name.

Input Parameters

string
required
Required. The resource name of the Audience List to retrieve. Format: properties/{property}/audienceLists/{audienceList}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_GET_CUSTOM_DIMENSIONTool 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

string
required
Required. The resource name of the CustomDimension to retrieve. Must be in the exact format: properties/{property_id}/customDimensions/{customDimension_id} where both property_id and customDimension_id are numeric identifiers. IMPORTANT: Must start with ‘properties/’ prefix, contain exactly one ‘/customDimensions/’ segment, have no trailing slashes, and no additional path segments. Valid example: ‘properties/489591273/customDimensions/13661238280’. Invalid examples: ‘489591273/13661238280’ (missing prefix), ‘properties/489591273/customDimensions/13661238280/’ (trailing slash), ‘properties/489591273/customDimensions/13661238280/extra’ (extra segments)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_GET_DATA_RETENTION_SETTINGSTool to retrieve data retention configuration for a Google Analytics property. Use when you need to check event-level and user-level data retention durations and reset settings.

Input Parameters

string
required
Required. The resource name of the data retention settings to retrieve. Must be in the exact format: properties/{property_id}/dataRetentionSettings where property_id is a numeric identifier. IMPORTANT: Must start with ‘properties/’ prefix, contain no forward slashes in the property_id, have no trailing slashes, and must end with ‘/dataRetentionSettings’. Valid example: ‘properties/489591273/dataRetentionSettings’. Invalid examples: ‘489591273’ (missing prefix), ‘properties/489591273’ (missing suffix), ‘properties/489591273/dataRetentionSettings/’ (trailing slash)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_GET_DATA_SHARING_SETTINGSTool 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, including sharing with Google support, sales teams, products, and benchmarking.

Input Parameters

string
required
Required. The resource name of the data sharing settings to retrieve. Must be in the exact format: accounts/{account_id}/dataSharingSettings where account_id is a numeric identifier. IMPORTANT: Must start with ‘accounts/’ prefix, contain no forward slashes in the account_id, have no trailing slashes, and must end with ‘/dataSharingSettings’. Valid example: ‘accounts/1000/dataSharingSettings’. Invalid examples: ‘1000’ (missing prefix), ‘accounts/1000’ (missing suffix), ‘accounts/1000/dataSharingSettings/’ (trailing slash)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_GET_GOOGLE_SIGNALS_SETTINGSTool 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

string
required
Required. The resource name of the Google Signals settings to retrieve. Must be in the exact format: properties/{property_id}/googleSignalsSettings where property_id is a numeric identifier. IMPORTANT: Must start with ‘properties/’ prefix, contain no forward slashes in the property_id, have no trailing slashes, and must end with ‘/googleSignalsSettings’. Valid example: ‘properties/1000/googleSignalsSettings’. Invalid examples: ‘1000’ (missing prefix), ‘properties/1000’ (missing suffix), ‘properties/1000/googleSignalsSettings/’ (trailing slash)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_GET_KEY_EVENTRetrieve a Key Event by its resource name. This operation is read-only.

Input Parameters

string
required
Required. Resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{keyEvent}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_GET_METADATATool 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. Available fields vary per property; skip validation and downstream report tools like GOOGLE_ANALYTICS_RUN_REPORT return 400 INVALID_ARGUMENT on incompatible or invalid field combinations. Response can contain hundreds of fields; filter to relevant subset before passing to downstream logic.

Input Parameters

string
required
Resource name of the metadata to retrieve. Format: properties/{property_id}/metadata. Use property_id=0 to return only universal (non-custom) metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_GET_PROPERTYTool 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

string
required
Required. The resource name of the Property to retrieve. Must be in the exact format: properties/{property_id} where property_id is a numeric identifier. IMPORTANT: Must start with ‘properties/’ prefix, contain no forward slashes in the property_id, have no trailing slashes, and no additional path segments. Valid example: ‘properties/489591273’. Invalid examples: ‘489591273’ (missing prefix), ‘properties/489591273/’ (trailing slash), ‘properties/489591273/extra’ (extra segments)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_GET_PROPERTY_QUOTAS_SNAPSHOTTool to retrieve all property quotas organized by category (corePropertyQuota, funnelPropertyQuota, realtimePropertyQuota) for a given GA4 property. Use when you need to check current quota usage. Snapshot data can lag real consumption by several minutes; treat reported values as approximate and avoid scheduling high-volume jobs at full apparent capacity.

Input Parameters

string
required
Required. The property resource. Format: properties/{property_id}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_GET_RECURRING_AUDIENCE_LISTTool 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 or to get the resource name of the most recent audience list instance.

Input Parameters

string
required
Required. The recurring audience list resource name. Format: properties/{property}/recurringAudienceLists/{recurring_audience_list}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_GET_REPORT_TASKTool 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

string
required
Required. The report task resource name. Format: properties/{property}/reportTasks/{reportTask}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_ACCOUNTSDEPRECATED: Use ListAccountsV1Beta instead. Tool to list all Accounts accessible by the caller. Use when you need to enumerate all Google Analytics accounts your credentials can access. Empty or partial results may indicate a permissions issue rather than no resources existing. Returned resource names follow the format accounts/{account_id}; use these in subsequent calls.

Input Parameters

integer
Optional. Maximum number of accounts to return. Must be ≥1.
string
Optional. Token for retrieving the next page of results.
boolean
Optional. Whether to include soft-deleted (trashed) Accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_ACCOUNT_SUMMARIESTool 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 without fetching full account details.

Input Parameters

integer
Maximum number of account summaries to return. The service may return fewer than this value. If unspecified, at most 50 resources will be returned. Maximum value is 200; higher values will be coerced to the maximum.
string
Page token received from a previous ListAccountSummaries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccountSummaries must match the call that provided the page token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_ACCOUNTS_V1_BETAList Google Analytics accounts accessible to the caller using the v1beta API. Results are paginated and may include accounts without GA properties; soft-deleted accounts are excluded by default.

Input Parameters

integer
The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; higher values will be coerced to the maximum.
string
A page token, received from a previous ListAccounts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccounts must match the call that provided the page token.
boolean
Whether to include soft-deleted (ie: ‘trashed’) Accounts in the results. Accounts can be inspected to determine whether they are deleted or not. Defaults to false (soft-deleted accounts are excluded).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_AUDIENCE_EXPORTSTool 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

string
required
Required. Property identifier in format ‘properties/{propertyId}’. Example: ‘properties/489591273’
integer
Optional. Maximum number of audience exports to return. Default: 200, Maximum: 1000
string
Optional. Token from a previous response for pagination to retrieve the next page of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_AUDIENCE_LISTSTool to list all audience lists for a specified property to help find and reuse existing lists. Use when you need to retrieve a property’s configured audience lists after confirming the property ID.

Input Parameters

string
required
Required. Resource name of the parent property. Format: properties/{property_id}
integer
Optional. Maximum number of audience lists to return. Defaults to 200; maximum is 1000.
string
Optional. Token for retrieving the next page of results. All other parameters must match original request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_AUDIENCESList audience configurations for a Google Analytics property; audiences created before 2020 may not be supported. Returned filter clauses include their types but not the full membership criteria.

Input Parameters

string
required
Required. The property for which to list Audiences. Format: properties/{propertyId} Scoped to a single property per call; invoke separately for each property to list audiences across multiple GA4 properties.
integer
Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200
string
Optional. A page token received from a previous ListAudiences call. Provide this to retrieve the subsequent page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_CALCULATED_METRICSList Calculated Metrics

Input Parameters

string
required
Required. Property identifier in format ‘properties/{propertyId}’. Example: ‘properties/1234’
integer
Optional. Maximum number of results to return per request. Default: 50, Maximum: 200
string
Optional. Token from a previous response for pagination to retrieve the next page of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_CHANNEL_GROUPSTool to list ChannelGroups on a property. Use when you need to retrieve channel groups that categorize traffic sources in Analytics reports.

Input Parameters

string
required
Required. The property for which to list ChannelGroups. Format: properties/{property_id}
integer
Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200
string
Optional. A page token received from a previous ListChannelGroups call. Provide this to retrieve the subsequent page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_CONVERSION_EVENTSLists deprecated conversion event resources configured for a Google Analytics property. Google recommends using key events instead.

Input Parameters

string
required
Required. The resource name of the parent property. Format: ‘properties/{propertyId}’
integer
Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200
string
Optional. A page token received from a previous ListConversionEvents call. Provide this to retrieve the subsequent page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_CUSTOM_DIMENSIONSList Custom Dimensions

Input Parameters

string
required
Required. The property for which to list CustomDimensions. Format: properties/{property_id}
integer
Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200
string
Optional. A page token received from a previous ListCustomDimensions call. Provide this to retrieve the subsequent page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_CUSTOM_METRICSTool to list CustomMetrics on a property. Use when you need to retrieve all custom metrics configured for a given property.

Input Parameters

string
required
Required. Property identifier in format ‘properties/{propertyId}’. Example: ‘properties/1234’
integer
Optional. Maximum number of resources to return. If unspecified, at most 50 resources will be returned. Maximum value is 200
string
Optional. Token from a previous ListCustomMetrics call for pagination to retrieve the next page of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_DATA_STREAMSTool to list DataStreams on a property. Use when you need to retrieve data stream configurations for a Google Analytics property.

Input Parameters

string
required
Required. The Google Analytics property identifier. Must be in format ‘properties/NUMERIC_ID’ where NUMERIC_ID is your actual property ID (e.g., ‘properties/489591273’). Do NOT use placeholder syntax like ‘properties/{propertyId}’ - replace the placeholder with a real numeric property ID.
integer
Optional. Maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200
string
Optional. A page token received from a previous ListDataStreams call. Provide this to retrieve the subsequent page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_EVENT_CREATE_RULESTool 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

string
required
Required. Resource name of the parent data stream. Format: properties/{propertyId}/dataStreams/{dataStreamId}.
integer
Optional. Maximum number of event create rules to return. Default is 50, maximum allowed is 200.
string
Optional. A page token received from a previous list call. Provide this to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_EXPANDED_DATA_SETSTool to list ExpandedDataSets on a property. Use when you need to retrieve expanded data set configurations for a Google Analytics 360 property.

Input Parameters

string
required
Required. The name of the property to list ExpandedDataSets for. Format: properties/{property_id}
integer
Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200
string
Optional. A page token received from a previous ListExpandedDataSets call. Provide this to retrieve the subsequent page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_KEY_EVENTSList key event definitions for a Google Analytics property. Results are paginated, with a next-page token when more results are available.

Input Parameters

string
required
Required. Resource name of the parent property. Format: properties/{property_id}.
integer
Optional. Maximum number of results to return. Must be between 1 and 200. If not specified or 0, the API uses its default page size.
string
Optional. Token for retrieving the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_MEASUREMENT_PROTOCOL_SECRETSTool to list MeasurementProtocolSecrets under a data stream. Use when you need to retrieve measurement protocol secrets for server-side event tracking.

Input Parameters

string
required
Required. The resource name of the parent data stream. Format: properties/{property}/dataStreams/{dataStream}
integer
Optional. Maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10
string
Optional. A page token received from a previous ListMeasurementProtocolSecrets call. Provide this to retrieve the subsequent page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_PROPERTIESDEPRECATED: Use ListPropertiesV1Beta instead. Tool to list GA4 properties under a specific account. Use after obtaining an account ID; supports pagination and including soft-deleted properties. Results may include legacy Universal Analytics properties; verify property type before use.

Input Parameters

string
required
Required. Google Analytics account resource name in format accounts/{account_id} where account_id is a Google Analytics account ID (typically 6-10 digits). Use GOOGLE_ANALYTICS_LIST_ACCOUNTS to get valid account IDs. Note: Do not use Google Account IDs (long numeric IDs from OAuth user info) - only Google Analytics account IDs are valid.
integer
Optional. Maximum number of properties to return; must be between 1 and 200.
string
Optional. Token returned from a previous call to retrieve the next page of results.
boolean
Optional. Whether to include soft-deleted (trashed) properties.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_PROPERTIES_FILTEREDTool 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. Supports pagination and including soft-deleted properties.

Input Parameters

string
required
Required. Expression for filtering the results. Fields eligible for filtering: parent: (resource name of parent account/property), ancestor: (resource name of parent account), or firebase_project: (id or number of linked firebase project). Examples: ‘parent:accounts/123’ (account with id 123), ‘parent:properties/123’ (property with id 123), ‘ancestor:accounts/123’ (account with id 123), ‘firebase_project:project-id’ (firebase project with id project-id), ‘firebase_project:123’ (firebase project with number 123).
integer
Optional. Maximum number of properties to return (1-200). Default is 50.
string
Optional. Token from previous ListProperties call to retrieve the next page.
boolean
Optional. Whether to include soft-deleted (trashed) properties. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_RECURRING_AUDIENCE_LISTSList a page of recurring audience lists for a GA4 property, with a continuation token when more results are available. Use it to find existing recurring audience lists.

Input Parameters

string
required
Required. Resource name of the parent property. Format: properties/{property_id}
integer
Optional. Maximum number of recurring audience lists to return. Defaults to 200; maximum is 1000.
string
Optional. Token for retrieving the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_REPORTING_DATA_ANNOTATIONSList a page of Reporting Data Annotations for a specific GA4 property, optionally filtering the results. Annotations document important events or periods in reporting data.

Input Parameters

string
Optional. Expression to refine results. Supported fields: name, title, description, annotationDate, annotationDateRange, color. Helper functions: annotation_duration(), is_annotation_in_range(). Operators: =, !=, <, >, <=, >=, :, =, !, NOT, AND, OR.
string
required
Required. Resource name of the property. Format: properties/{property_id}. Example: properties/123456789
integer
Optional. Maximum number of resources per response. Default: 50, Max: 200.
string
Optional. Pagination token from previous response to retrieve next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_REPORT_TASKSList a page of report tasks for a Google Analytics property, including task definitions and execution status. A continuation token can be used to retrieve subsequent pages.

Input Parameters

string
required
Required. Property identifier in format ‘properties/{propertyId}’. The Google Analytics property whose report tasks should be listed.
integer
Optional. Maximum number of report tasks to return per page. If unspecified, server determines page size.
string
Optional. Pagination token from previous list response for retrieving next page of results. Omit for first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_SK_AD_NETWORK_CONVERSION_VALUE_SCHEMASTool 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

string
required
Required. The DataStream resource to list schemas for. Format: properties/{property_id}/dataStreams/{dataStream}. Example: ‘properties/123456789/dataStreams/1234567890’
integer
Optional. Maximum number of resources per response. Default: 50, Maximum: 200.
string
Optional. Token from previous call for pagination to retrieve next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_SUBPROPERTY_EVENT_FILTERSList a page of subproperty event filters on a property, including filters that route events to subproperties. Use the returned page token to retrieve subsequent pages.

Input Parameters

string
required
Required. Resource name of the ordinary property. Format: properties/{property_id}
integer
Optional. Maximum number of resources to return; at most 50 by default, maximum 200.
string
Optional. Page token received from a previous call to retrieve the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_LIST_SUBPROPERTY_SYNC_CONFIGSTool to list SubpropertySyncConfig resources for managing subproperty synchronization configurations. Use when you need to fetch subproperty sync configs for a GA4 property.

Input Parameters

string
required
Required. Resource name of the property. Format: properties/{property_id}. Example: properties/123
integer
Optional. The maximum number of resources to return. May return fewer. If unspecified, at most 50 resources will be returned. Maximum value is 200.
string
Optional. A page token received from a previous ListSubpropertySyncConfig call. Provide this to retrieve the subsequent page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_PROVISION_ACCOUNT_TICKETTool 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

object
required
Required. Account details including display name and region code.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_QUERY_AUDIENCE_EXPORTTool to query a completed audience export. Use when you need to fetch user rows with pagination.

Input Parameters

string
required
Required. Resource name of the audience export. Format: properties/{property}/audienceExports/{audienceExport}, where {property} and {audienceExport} must be integers.
integer
Optional. Number of rows to return. Must be between 1 and 250000. Defaults to 10000.
integer
Optional. Zero-based start row index for pagination. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_QUERY_AUDIENCE_LISTTool to query an audience list. Use when you need to retrieve user rows from a GA4 audience list with pagination.

Input Parameters

string
required
Required. Audience list resource to query. Format: properties/{property}/audienceLists/{audienceList}.
integer
Optional. Number of rows to return; default 10,000; maximum 250,000.
integer
Optional. Zero-based row offset for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_QUERY_REPORT_TASKTool to retrieve a report task’s content. Use this after creating a report task with CreateReportTask and confirming it is in ACTIVE state. This method returns an error if the report task’s state is not ACTIVE.

Input Parameters

string
required
Required. Report task name in format ‘properties/{propertyId}/reportTasks/{reportTaskId}’. The report task must be in ACTIVE state.
integer
Optional. Number of rows to return (max 250,000). If unspecified, 10,000 rows are returned. Must be positive. Limited by the ReportTask’s own limit.
integer
Optional. Row offset for pagination (0-indexed). First request omits offset or sets to 0. For subsequent pages, set to the previous limit value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_RUN_FUNNEL_REPORTTool 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

integer
Number of rows to return. Default 10000; max 250000.
object
required
Funnel configuration object. Must include a ‘steps’ key with at least one step. Each step requires a ‘name’ and optionally a ‘filterExpression’. Use ‘funnelEventFilter’ for event filters and ‘funnelFieldFilter’ for field filters. Filter expressions with ‘fieldName’ + ‘stringFilter’ are auto-wrapped in ‘funnelFieldFilter’. Example: {“steps”: [{“name”: “First visit”, “filterExpression”: {“funnelEventFilter”: {“eventName”: “first_visit”}}}]}
string
required
GA4 property resource name, format: properties/{property_id}.
array
Up to 4 segments; each yields its own row in the report.
array
List of date ranges to read; overlapping ranges duplicate days across ranges.
object
Dimension-only filter expression.
object
Breakdown dimension configuration for the funnel table sub-report. The ‘breakdownDimension’ is a GA4 Dimension object whose field is ‘name’ (NOT ‘dimensionName’). Example: {“breakdownDimension”: {“name”: “deviceCategory”}, “limit”: “5”}.
object
Next-action dimension configuration for the funnel visualization sub-report. The ‘nextActionDimension’ is a GA4 Dimension object whose field is ‘name’ (NOT ‘dimensionName’). Example: {“nextActionDimension”: {“name”: “eventName”}, “limit”: “5”}.
boolean
If true, includes the property’s current quota state.
string ("STANDARD_FUNNEL" | "TRENDED_FUNNEL")
Visualization type: STANDARD_FUNNEL (default) or TRENDED_FUNNEL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_RUN_PIVOT_REPORTTool 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

array
Optional. Visual format configuration for dimensions. Each pivot has ‘fieldNames’ (required string array), ‘limit’ (required), optional ‘orderBys’, ‘offset’, and ‘metricAggregations’.
array
required
Required. At least one metric is required. Each metric has a ‘name’ field, optional ‘expression’, and optional ‘invisible’ boolean.
string
required
Required. The GA4 property resource name. Format: properties/{property_id}
object
Optional. Cohort configuration with ‘cohorts’ (required), optional ‘cohortsRange’ and ‘cohortReportSettings’.
array
Optional. Date ranges for event data retrieval. Each range has ‘startDate’ and ‘endDate’ (YYYY-MM-DD format or relative like ‘NdaysAgo’, ‘yesterday’, ‘today’), and optional ‘name’.
array
Optional. Dimensions to request. Each dimension has a ‘name’ field and optional ‘dimensionExpression’. Dimensions must be used in pivots, filters, or orderBys.
array
Optional. Comparison configurations. Each comparison has optional ‘name’ and required ‘dimensionFilter’ or ‘comparison’.
string
Optional. ISO4217 currency code (e.g., ‘USD’, ‘EUR’).
object
Optional. Post-aggregation filter (SQL HAVING clause equivalent).
boolean
Optional. If true, includes rows where all metrics equal 0.
object
Optional. Filter clause for dimensions only. Can use andGroup, orGroup, notExpression, or filter.
boolean
Optional. If true, returns current quota state in PropertyQuota.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_RUN_REALTIME_REPORTTool 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

integer
Max rows to return (default 10000, max 250000).
array
Metrics to measure (max 10). At least one dimension or metric is required. Valid names: activeUsers, eventCount, keyEvents, screenPageViews.
array
Sorting specification. Example: [{‘metric’: {‘metricName’: ‘activeUsers’}, ‘desc’: true}] or [{‘dimension’: {‘dimensionName’: ‘country’}}].
string
required
Required. The GA4 property resource name. Format: properties/{property_id}. Get property IDs from GOOGLE_ANALYTICS_LIST_PROPERTIES.
array
Dimensions to group by (max 9). At least one dimension or metric is required. Valid names: appVersion, audienceId, audienceName, city, cityId, country, countryId, deviceCategory, eventName, minutesAgo, platform, streamId, streamName, unifiedScreenName. Custom: ‘customUser:param_name’.
object
Post-aggregation filter on metric values. Applied after row aggregation.
array
Time ranges to report on. Default is last 30 minutes. Each range has startMinutesAgo (default 29) and endMinutesAgo (default 0).
object
Filter to restrict data by dimension values. Structure: {‘filter’: {‘fieldName’: ‘country’, ‘stringFilter’: {‘value’: ‘United States’}}} or use andGroup/orGroup/notExpression for complex filters.
array
Request aggregated metric values. Values: ‘TOTAL’, ‘MINIMUM’, ‘MAXIMUM’, ‘COUNT’.
boolean
If true, includes API quota usage info in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_RUN_REPORTRun a customized GA4 event-data report for a property using dimensions, metrics, filters and date ranges or a cohort specification. Requests can include up to 9 dimensions and 10 metrics, with offset and limit for pagination. Dimensions, metrics and filters must be compatible; use GOOGLE_ANALYTICS_CHECK_COMPATIBILITY to check combinations. The invalid dateRange dimension is removed from requests; use a date dimension for date-based grouping.

Input Parameters

integer
Optional. Number of rows to return. Must be between 1 and 250000.
integer
Optional. 0-based start row for pagination. Must be >= 0.
array
Optional. The metrics to request and display. Maximum 10 metrics per request. Each metric MUST be an object with a required non-empty ‘name’ field. Common valid metric names: activeUsers, totalUsers, newUsers, sessions, engagedSessions, screenPageViews, eventCount, conversions, userEngagementDuration, engagementRate, bounceRate, averageSessionDuration, sessionsPerUser, screenPageViewsPerSession, purchaseRevenue, totalRevenue, transactions, ecommercePurchases, publisherAdClicks, publisherAdImpressions, totalAdRevenue. Custom metrics use format ‘customEvent:parameter_name’. CRITICAL: ‘averageEngagementTime’ is NOT a valid metric - use ‘userEngagementDuration’ or ‘averageSessionDuration’ instead. ‘exits’ is NOT a valid metric in GA4.
array
Optional. Specify how rows are ordered. Each OrderBy object must have ‘desc’ (boolean) at the top level and exactly one of: ‘metric’ (with ‘metricName’ string), ‘dimension’ (with ‘dimensionName’ or ‘name’ string and optional ‘orderType’: ‘ALPHANUMERIC’, ‘CASE_INSENSITIVE_ALPHANUMERIC’, or ‘NUMERIC’), or ‘pivot’. Note: For dimension ordering, you can use either ‘dimensionName’ or ‘name’ field - both are accepted and normalized. Example for metric ordering: {‘desc’: true, ‘metric’: {‘metricName’: ‘activeUsers’}}. Example for dimension ordering: {‘desc’: false, ‘dimension’: {‘dimensionName’: ‘country’, ‘orderType’: ‘ALPHANUMERIC’}}.
string
required
Required. The property resource on which to run the report. Format: properties/{property_id} where property_id must be a numeric ID (e.g., ‘properties/123456789’).
object
Optional. Cohort specification. Requires requesting the cohort dimension.
array
The date ranges to read. Required for standard reports. Each range MUST be an object with required ‘startDate’ and ‘endDate’ fields (both must be non-empty). Dates can be in YYYY-MM-DD format or special values like ‘today’, ‘yesterday’, ‘7daysAgo’, ‘30daysAgo’. IMPORTANT: For cohort requests (when cohortSpec is provided), dateRanges must be omitted.
array
Optional. The dimensions to request and display. Maximum 9 dimensions per request. Each dimension MUST be an object with a required non-empty ‘name’ field. Common valid dimension names: date, dateHour, dateHourMinute, year, month, week, day, dayOfWeek, hour, city, cityId, country, countryId, continent, continentId, region, subContinent, deviceCategory, browser, operatingSystem, platform, platformDeviceCategory, screenResolution, sessionSource, sessionMedium, sessionSourceMedium, sessionCampaignName, sessionDefaultChannelGroup, firstUserSource, firstUserMedium, firstUserCampaignName, firstUserDefaultChannelGroup, pagePath, pagePathPlusQueryString, pageTitle, landingPage, hostname, eventName, streamName, userAgeBracket, userGender, language, newVsReturning. Custom dimensions: ‘customEvent:parameter_name’ or ‘customUser:parameter_name’. ‘dateRange’ is NOT a valid dimension — use date dimensions (date, dateHour, year, month, etc.) instead. ‘exits’ is NOT a valid dimension in GA4. COMPATIBILITY: Not all dimensions can be combined with each other or with certain metrics/filters. If you receive a compatibility error, use GOOGLE_ANALYTICS_CHECK_COMPATIBILITY to validate combinations, or see https://developers.google.com/analytics/devguides/reporting/data/v1/compatibility
array
Optional. The comparison configuration. Adds a comparison column to the response.
string
Optional. The currency code to apply, in ISO 4217 format. Defaults to property currency.
object
Optional. Filter expression to restrict rows by metric values. Applied after aggregation. IMPORTANT: Only use metric field names here (e.g., ‘activeUsers’, ‘sessions’, ‘ecommercePurchases’, ‘purchaseRevenue’). Do NOT use dimension names in metricFilter - if you need to filter by a dimension (e.g., ‘country’, ‘city’, ‘pagePath’), use dimensionFilter instead. The action validates that only metric names are used in metricFilter and will reject dimension names with a clear error. Structure: {‘filter’: {‘fieldName’: ‘<metric_name>’, ‘numericFilter’: {‘operation’: ‘GREATER_THAN’, ‘value’: {‘int64Value’: ‘0’}}}} or use ‘andGroup’/‘orGroup’ for multiple conditions.
boolean
Optional. If true, rows with all zero metrics will be returned; otherwise omitted.
object
Optional. Filter expression to restrict rows by dimension values. IMPORTANT: Only use dimension field names here (e.g., ‘country’, ‘city’, ‘date’, ‘deviceCategory’, ‘pagePath’). Do NOT use metric names in dimensionFilter - if you need to filter by a metric (e.g., ‘activeUsers’, ‘sessions’, ‘ecommercePurchases’), use metricFilter instead. Structure: {‘filter’: {‘fieldName’: ‘<dimension_name>’, ‘stringFilter’: {…}}} or use ‘andGroup’/‘orGroup’ for multiple conditions. COMPATIBILITY WARNING: Dimension filters must be compatible with the dimensions in your request. For example, filtering on ‘sessionCampaignName’ while using demographic dimensions (userAgeBracket, userGender) will fail. The filter field creates an implicit dimension that must be compatible with all other dimensions and metrics. Use GOOGLE_ANALYTICS_CHECK_COMPATIBILITY to verify your filter dimensions work with your requested dimensions/metrics.
array
Optional. Aggregation types to include over metrics, e.g., ‘TOTAL’, ‘MINIMUM’, ‘MAXIMUM’.
boolean
Optional. If true, include the property’s current quota state in the response.
array
Internal field to store filtered dimension names for execution message. Not sent to API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_SEND_EVENTSSend GA4 web-stream events using the Measurement Protocol and an API secret. A successful response indicates HTTP receipt, not that Google Analytics processed the events.

Input Parameters

array
required
Required. Array of event objects to send. Maximum 25 events per request. Each event must have a ‘name’ and can optionally include ‘params’.
Consent settings for Google Analytics 4.
string
Optional. A unique identifier for a logged-in user. This should be a non-PII identifier that you use internally to identify a user. Maximum 256 characters.
string
required
Required. A unique identifier for a user/client. This should be a UUID or similar unique string that identifies a specific user across sessions. Maximum 256 characters.
string
required
Required. The API secret generated in the Google Analytics UI under Admin > Data Streams > Measurement Protocol API secrets. Used to authenticate requests.
string
required
Required. The measurement ID for the web stream in the format G-XXXXXXX. This is found in the Google Analytics UI under Admin > Data Streams > Web Stream Details.
object
Optional. User properties to set for this measurement. Each property must have a ‘value’ field. User properties persist across events.
integer
Optional. Unix timestamp in microseconds for when the event occurred. If not provided, the current time is used. Can be up to 72 hours in the past.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_UPDATE_PROPERTYTool 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

string
required
Required. The resource name of the Property to update. Must be in the exact format: properties/{property_id} where property_id is a numeric identifier. IMPORTANT: Must start with ‘properties/’ prefix, contain no forward slashes in the property_id, have no trailing slashes, and no additional path segments. Valid example: ‘properties/489591273’. Invalid examples: ‘489591273’ (missing prefix), ‘properties/489591273/’ (trailing slash), ‘properties/489591273/extra’ (extra segments)
string
Immutable. Resource name of this property’s logical parent. Format: accounts/{account}, properties/{property}. Example: ‘accounts/100’, ‘properties/101’
string
Required. Reporting Time Zone, used as the day boundary for reports. Format: IANA time zone. Example: ‘America/Los_Angeles’
string
required
Required. The list of fields to be updated. Field names must be in snake case (e.g., ‘display_name’, ‘time_zone’, ‘currency_code’). Omitted fields will not be updated. To replace the entire entity, use one path with the string ’*’ to match all fields. Common fields: ‘display_name’, ‘time_zone’, ‘currency_code’, ‘industry_category’
string
Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
string
The currency type used in reports involving monetary values. Format: ISO 4217. Examples: ‘USD’, ‘EUR’, ‘JPY’
string ("PROPERTY_TYPE_UNSPECIFIED" | "PROPERTY_TYPE_ORDINARY" | "PROPERTY_TYPE_SUBPROPERTY" | "PROPERTY_TYPE_ROLLUP")
Property type for a property.
string ("INDUSTRY_CATEGORY_UNSPECIFIED" | "AUTOMOTIVE" | "BUSINESS_AND_INDUSTRIAL_MARKETS" | "FINANCE" | "HEALTHCARE" | "TECHNOLOGY" | "TRAVEL" | "OTHER" | "ARTS_AND_ENTERTAINMENT" | "BEAUTY_AND_FITNESS" | "BOOKS_AND_LITERATURE" | "FOOD_AND_DRINK" | "GAMES" | "HOBBIES_AND_LEISURE" | "HOME_AND_GARDEN" | "INTERNET_AND_TELECOM" | "LAW_AND_GOVERNMENT" | "NEWS" | "ONLINE_COMMUNITIES" | "PEOPLE_AND_SOCIETY" | "PETS_AND_ANIMALS" | "REAL_ESTATE" | "REFERENCE" | "SCIENCE" | "SPORTS" | "JOBS_AND_EDUCATION" | "SHOPPING")
Industry category for a property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ANALYTICS_VALIDATE_EVENTSValidate Measurement Protocol events for a web stream before sending them to production, checking event structure and parameters.

Input Parameters

array
required
Required. Array of events to validate. Each event must have a ‘name’ field and optional ‘params’ object.
Optional. The consent state for the user.
string
Optional. A unique identifier for a user.
string
required
Required. Unique client identifier. This uniquely identifies a user instance of a web client.
string
required
Required. The API secret from Google Analytics for the Measurement Protocol.
string
required
Required. The measurement ID for web streams. Format: G-XXXXXXXXXX where X is alphanumeric.
object
Optional. The user properties for the measurement.
string
Optional. A Unix timestamp (in microseconds) for the time to associate with the event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not