google-analytics · 69 tools · no triggers
Connect it
run auth google-analytics
run auth google-analytics --scope team # shared with the organization
Use it
run google-analytics # common commands
run google-analytics --all # every command
import { googleAnalytics } from "@boxd/run";
Common tools
| Tool | What it does |
|---|---|
batch-run-pivot-reports | Tool to return multiple pivot reports in a batch for a GA4 property. |
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. |
check-compatibility | Tool to list dimensions and metrics compatible with a GA4 report request. |
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. |
create-audience-list | Tool to create an audience list for later retrieval by initiating a long-running asynchronous request. |
create-custom-dimension | Tool to create a CustomDimension for a Google Analytics property. |
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. |
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. |
create-recurring-audience-list | Tool to create a recurring audience list that automatically generates new audience lists daily based on the latest data. |
create-report-task | Tool to create a report task as a long-running asynchronous request for customized Google Analytics event data reports. |
create-rollup-property | Tool to create a roll-up property. Use when consolidating multiple GA4 properties into one aggregated view. |
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). |
get-attribution-settings | Tool to retrieve attribution configuration for a Google Analytics property. |
get-audience | Tool to retrieve a single Audience configuration from a Google Analytics property. |
get-audience-export | Tool to get configuration metadata about a specific audience export. |
get-audience-list | Tool to get configuration metadata about a specific audience list. |
get-custom-dimension | Tool to retrieve a single CustomDimension by its resource name. |
get-data-retention-settings | Tool to retrieve data retention configuration for a Google Analytics property. |
get-data-sharing-settings | Tool to retrieve data sharing configuration for a Google Analytics account. |
get-google-signals-settings | Tool to retrieve Google Signals configuration settings for a GA4 property. |
get-key-event | Tool to retrieve a Key Event. Use after confirming the key event resource name. |
get-metadata | Tool to get metadata for dimensions, metrics, and comparisons for a GA4 property. |
get-property | Tool to retrieve a single GA4 Property by its resource name. |
get-property-quotas-snapshot | Tool to retrieve all property quotas organized by category (corePropertyQuota, funnelPropertyQuota, realtimePropertyQuota) for a given GA4 property. |
get-recurring-audience-list | Tool to get configuration metadata about a specific recurring audience list. |
All 69 tools
All 69 tools
| Tool | What it does |
|---|---|
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. |
batch-run-pivot-reports | Tool to return multiple pivot reports in a batch for a GA4 property. |
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. |
check-compatibility | Tool to list dimensions and metrics compatible with a GA4 report request. |
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. |
create-audience-list | Tool to create an audience list for later retrieval by initiating a long-running asynchronous request. |
create-custom-dimension | Tool to create a CustomDimension for a Google Analytics property. |
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. |
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. |
create-recurring-audience-list | Tool to create a recurring audience list that automatically generates new audience lists daily based on the latest data. |
create-report-task | Tool to create a report task as a long-running asynchronous request for customized Google Analytics event data reports. |
create-rollup-property | Tool to create a roll-up property. Use when consolidating multiple GA4 properties into one aggregated view. |
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). |
get-attribution-settings | Tool to retrieve attribution configuration for a Google Analytics property. |
get-audience | Tool to retrieve a single Audience configuration from a Google Analytics property. |
get-audience-export | Tool to get configuration metadata about a specific audience export. |
get-audience-list | Tool to get configuration metadata about a specific audience list. |
get-custom-dimension | Tool to retrieve a single CustomDimension by its resource name. |
get-data-retention-settings | Tool to retrieve data retention configuration for a Google Analytics property. |
get-data-sharing-settings | Tool to retrieve data sharing configuration for a Google Analytics account. |
get-google-signals-settings | Tool to retrieve Google Signals configuration settings for a GA4 property. |
get-key-event | Tool to retrieve a Key Event. Use after confirming the key event resource name. |
get-metadata | Tool to get metadata for dimensions, metrics, and comparisons for a GA4 property. |
get-property | Tool to retrieve a single GA4 Property by its resource name. |
get-property-quotas-snapshot | Tool to retrieve all property quotas organized by category (corePropertyQuota, funnelPropertyQuota, realtimePropertyQuota) for a given GA4 property. |
get-recurring-audience-list | Tool to get configuration metadata about a specific recurring audience list. |
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. |
list-accounts | DEPRECATED: Use ListAccountsV1Beta instead. Tool to list all Accounts accessible by the caller. |
list-account-summaries | Tool to retrieve summaries of all Google Analytics accounts accessible by the caller. |
list-accounts-v1-beta | Tool to list all Google Analytics accounts accessible by the caller using v1beta API. |
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. |
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. |
list-audience-lists | Tool to list all audience lists for a specified property to help find and reuse existing lists. |
list-audiences | Tool to list Audiences on a property. Use when you need to retrieve audience configurations for a Google Analytics property. |
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. |
list-calculated-metrics | List Calculated Metrics |
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. |
list-conversion-events | Tool to list conversion events on a property. Use when you need to retrieve conversion events configured for a given property. |
list-custom-dimensions | List Custom Dimensions |
list-custom-metrics | Tool to list CustomMetrics on a property. Use when you need to retrieve all custom metrics configured for a given property. |
list-data-streams | Tool to list DataStreams on a property. Use when you need to retrieve data stream configurations for a Google Analytics property. |
list-dv360-ad-links | Tool to list Display & Video 360 advertiser links on a property. |
list-dv360-link-proposals | Tool to list DisplayVideo360AdvertiserLinkProposals on a property. |
list-event-create-rules | Tool to list EventCreateRules configured on a web data stream. |
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. |
list-firebase-links | Tool to list FirebaseLinks on a property. Use when you need to retrieve Firebase connections associated with a Google Analytics property. |
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. |
list-key-events | Tool to list Key Events. Use when you need to retrieve all key event definitions for a given property. |
list-measurement-protocol-secrets | Tool to list MeasurementProtocolSecrets under a data stream. |
list-properties | DEPRECATED: Use ListPropertiesV1Beta instead. Tool to list GA4 properties under a specific account. |
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. |
list-recurring-audience-lists | Tool to list all recurring audience lists for a GA4 property. |
list-reporting-data-annotations | Tool to list all Reporting Data Annotations for a specific property. |
list-report-tasks | Tool to list all report tasks for a Google Analytics property. |
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. |
list-sk-ad-network-conversion-value-schemas | Tool to list SKAdNetworkConversionValueSchema configurations for an iOS data stream. |
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. |
list-subproperty-sync-configs | Tool to list SubpropertySyncConfig resources for managing subproperty synchronization configurations. |
provision-account-ticket | Tool to request a ticket for creating a Google Analytics account. |
query-audience-export | Tool to query a completed audience export. Use when you need to fetch user rows with pagination. |
query-audience-list | Tool to query an audience list. Use when you need to retrieve user rows from a GA4 audience list with pagination. |
query-report-task | Tool to retrieve a report task’s content. Use this after creating a report task with CreateReportTask and confirming it is in ACTIVE state. |
run-funnel-report | Tool to run a GA4 funnel report. Use when you need a customized funnel analysis report for a given property. |
run-pivot-report | Tool to run a customized pivot report of Google Analytics event data. |
run-realtime-report | Tool to run a customized realtime report of Google Analytics event data. |
run-report | Tool to run a customized GA4 data report. Use when you need event data after specifying dimensions, metrics, and date ranges. |
send-events | Tool to send event data to Google Analytics 4 using the Measurement Protocol. |
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. |
validate-events | Tool to validate Measurement Protocol events before sending them to production. |