Google Analytics

Learn how to use Google Analytics with Composio

Overview

SLUG: GOOGLE_ANALYTICS

Description

Google Analytics tracks and reports website traffic, user behavior, and conversion data, enabling marketers to optimize online performance and customer journeys

Authentication Details

client_id
stringRequired
client_secret
stringRequired
full
stringDefaults to https://analyticsdata.googleapis.comRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to https://www.googleapis.com/auth/analytics.readonly,https://www.googleapis.com/auth/analytics,https://www.googleapis.com/auth/userinfo.profile
bearer_token
string

Connecting to Google Analytics

Create an auth config

Use the dashboard to create an auth config for the Google Analytics toolkit. This allows you to connect multiple Google Analytics accounts to Composio for agents to use.

1

Select App

Navigate to [Google Analytics](https://platform.composio.dev?next_page=/marketplace/Google Analytics).

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Google Analytics Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4google_analytics_auth_config_id = "ac_YOUR_GOOGLE_ANALYTICS_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Google Analytics: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, google_analytics_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Google Analytics toolkit’s playground](https://app.composio.dev/app/Google Analytics)

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["GOOGLE_ANALYTICS"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Batch Run Reports

Description

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.

Action Parameters

property
stringRequired
requests
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Check Compatibility

Description

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.

Action Parameters

compatibilityFilter
string
dimensionFilter
object
dimensions
array
metricFilter
object
metrics
array
property
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Audience Export

Description

Tool to create an audience export. use after configuring the audience and dimensions to produce a long-running operation.

Action Parameters

audience
stringRequired
dimensions
arrayRequired
parent
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Audience List

Description

Tool to create an audience list. use when you need to define and asynchronously populate a new audiencelist resource under a ga4 property.

Action Parameters

audience
stringRequired
dimensions
arrayRequired
parent
stringRequired
webhookNotification
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Expanded Data Set

Description

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.

Action Parameters

expandedDataSet
objectRequired
parent
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Rollup Property

Description

Tool to create a ga4 roll-up property and optionally initial source links.

Action Parameters

account
stringRequired
displayName
stringRequired
sourceProperties
array
timeZone
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Account

Description

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

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Audience Export

Description

Tool to get configuration metadata for an audience export. use after creating an audience export to retrieve its status and details.

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Audience List

Description

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

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Key Event

Description

Tool to retrieve a key event. use after confirming the key event resource name.

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Metadata

Description

Tool to get metadata for dimensions, metrics, and comparisons for a ga4 property. use when you need to discover available fields before building a report.

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Property Quotas Snapshot

Description

Tool to retrieve all property quotas organized by category for a given property. use when you need to check current quota usage for a ga4 property.

Action Parameters

property
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Accounts

Description

Tool to list all accounts accessible by the caller. use when you need to enumerate all google analytics accounts your credentials can access.

Action Parameters

pageSize
integer
pageToken
string
showDeleted
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Audience Exports

Description

Tool to list all audience exports for a ga4 property. use when you need to fetch its export history after initiating exports.

Action Parameters

pageSize
integer
pageToken
string
parent
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Audience Lists

Description

Tool to list all audience lists for a ga4 property. use when you need to retrieve a property's configured audience lists after confirming the property id.

Action Parameters

pageSize
integer
pageToken
string
parent
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Audiences

Description

Tool to list all audiences on a property. use when you need to fetch all audiences for a ga4 property after confirming its existence.

Action Parameters

pageSize
integer
pageToken
string
parent
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Key Events

Description

Tool to list key events. use when you need to retrieve all key event definitions for a given property.

Action Parameters

pageSize
integer
pageToken
string
parent
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Properties

Description

Tool to list ga4 properties under a specific account. use after obtaining an account id; supports pagination and including soft-deleted properties.

Action Parameters

account
stringRequired
pageSize
integer
pageToken
string
showDeleted
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Reporting Data Annotations

Description

Tool to list all reporting data annotations on a property. use when you need to retrieve or inspect annotations for a ga4 property.

Action Parameters

filter
string
pageSize
integer
pageToken
string
parent
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Rollup Properties

Description

Tool to list roll-up ga4 properties accessible to the caller. use when you need to identify roll-up properties across all accessible accounts.

Action Parameters

pageSize
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Query Audience Export

Description

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

Action Parameters

limit
integer
name
stringRequired
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Query Audience List

Description

Tool to query an audience list. use when you need to retrieve user rows from a ga4 audience list with pagination.

Action Parameters

limit
integer
name
stringRequired
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Run Funnel Report

Description

Tool to run a ga4 funnel report. use when you need a customized funnel analysis report for a given property.

Action Parameters

dateRanges
array
dimensionFilter
object
funnel
objectRequired
funnelBreakdown
object
funnelNextAction
object
funnelVisualizationType
string
limit
integer
property
stringRequired
returnPropertyQuota
boolean
segments
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Run Report

Description

Tool to run a customized ga4 data report. use when you need event data after specifying dimensions, metrics, and date ranges.

Action Parameters

cohortSpec
object
comparisons
array
currencyCode
string
dateRanges
array
dimensionFilter
object
dimensions
array
keepEmptyRows
boolean
limit
integer
metricAggregations
array
metricFilter
object
metrics
array
offset
integer
orderBys
array
property
stringRequired
returnPropertyQuota
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired