Google-Analytics-Data-Api full reference

This connector is optimized for AI agents. For the data replication connector, see Google Analytics Data Api.

This is the full reference documentation for the Google-Analytics-Data-Api agent connector.

Supported entities and actions

The Google-Analytics-Data-Api connector supports the following entities and actions.

Entity	Actions
Website Overview	List, Context Store Search, Context Store SQL Query
Daily Active Users	List, Context Store Search, Context Store SQL Query
Weekly Active Users	List, Context Store Search, Context Store SQL Query
Four Weekly Active Users	List, Context Store Search, Context Store SQL Query
Traffic Sources	List, Context Store Search, Context Store SQL Query
Pages	List, Context Store Search, Context Store SQL Query
Devices	List, Context Store Search, Context Store SQL Query
Locations	List, Context Store Search, Context Store SQL Query

Website Overview

Website Overview List

Returns website overview metrics including total users, new users, sessions, bounce rate, page views, and average session duration by date.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "website_overview",
  "action": "list",
  "params": {
    "property_id": "<str>"
  }
}'

Python SDK

await google_analytics_data_api.website_overview.list(
    property_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "website_overview",
    "action": "list",
    "params": {
        "property_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
dateRanges	array<object>	No	Date ranges of data to read, in YYYY-MM-DD or relative format (e.g., 30daysAgo, today). Defaults to the last 30 days.
dateRanges.startDate	string	No	Start date in YYYY-MM-DD format or relative (e.g., 30daysAgo)
dateRanges.endDate	string	No	End date in YYYY-MM-DD format or relative (e.g., today)
dimensions	array<object>	No	GA4 dimensions to group results by. Defaults match the equivalent Data Replication report.
dimensions.name	string	No	GA4 API dimension name (e.g., date, country, deviceCategory)
metrics	array<object>	No	GA4 metrics to aggregate. Defaults match the equivalent Data Replication report.
metrics.name	string	No	GA4 API metric name (e.g., totalUsers, sessions, bounceRate)
keepEmptyRows	boolean	No	If false, rows whose metrics are all zero are omitted from the response.
returnPropertyQuota	boolean	No	Whether to include the Analytics property's current quota state in the response.
limit	integer	No	Maximum number of rows to return (the GA4 API caps a single request at 250,000 rows).
property_id	string	Yes	GA4 property ID

Response Schema

Records

Field Name	Type	Description
dimensionValues	array<object>
dimensionValues[].value	string
metricValues	array<object>
metricValues[].value	string

Meta

Field Name	Type	Description
row_count	integer

Website Overview Context Store Search

Search and filter website overview records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "website_overview",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "averageSessionDuration": 0.0
        }
      }
    }
  }
}'

Python SDK

await google_analytics_data_api.website_overview.context_store_search(
    query={"filter": {"eq": {"averageSessionDuration": 0.0}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "website_overview",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"averageSessionDuration": 0.0}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
query	object	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filter	object	No	Filter conditions
query.sort	array	No	Sort conditions
limit	integer	No	Maximum results to return (default 1000)
cursor	string	No	Pagination cursor from previous response's meta.cursor
fields	array	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
averageSessionDuration	number	Average duration of sessions in seconds
bounceRate	number	Percentage of sessions that were single-page with no interaction
date	string	Date of the report row in YYYYMMDD format
endDate	string	End date of the reporting period
newUsers	integer	Number of first-time users
property_id	string	GA4 property ID
screenPageViews	integer	Total number of screen or page views
screenPageViewsPerSession	number	Average page views per session
sessions	integer	Total number of sessions
sessionsPerUser	number	Average number of sessions per user
startDate	string	Start date of the reporting period
totalUsers	integer	Total number of unique users

Response Schema

Field Name	Type	Description
data	array	List of matching records
meta	object	Pagination metadata
meta.has_more	boolean	Whether additional pages are available
meta.cursor	string | null	Cursor for next page of results
meta.took_ms	number | null	Query execution time in milliseconds
data[].averageSessionDuration	number	Average duration of sessions in seconds
data[].bounceRate	number	Percentage of sessions that were single-page with no interaction
data[].date	string	Date of the report row in YYYYMMDD format
data[].endDate	string	End date of the reporting period
data[].newUsers	integer	Number of first-time users
data[].property_id	string	GA4 property ID
data[].screenPageViews	integer	Total number of screen or page views
data[].screenPageViewsPerSession	number	Average page views per session
data[].sessions	integer	Total number of sessions
data[].sessionsPerUser	number	Average number of sessions per user
data[].startDate	string	Start date of the reporting period
data[].totalUsers	integer	Total number of unique users

Website Overview Context Store SQL Query

Run a SQL query against website overview records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.

Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "website_overview",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await google_analytics_data_api.website_overview.context_store_sql_query(
    sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "website_overview",
    "action": "context_store_sql_query",
    "params": {
        "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
    }
}'

Parameters

Parameter Name	Type	Required	Description
sql	string	Yes	SQL query to execute against this entity's Context Store data
limit	integer	No	Maximum results to return

Response Schema

Field Name	Type	Description
data	array	Projected rows, with dictionary keys matching the selected columns
meta	object	Query metadata
meta.has_more	boolean	Whether the result was limited and more rows are available
meta.cursor	null	SQL query results do not use cursor pagination
meta.took_ms	number | null	Query execution time in milliseconds

Daily Active Users

Daily Active Users List

Returns daily active user counts (1-day active users) by date.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "daily_active_users",
  "action": "list",
  "params": {
    "property_id": "<str>"
  }
}'

Python SDK

await google_analytics_data_api.daily_active_users.list(
    property_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "daily_active_users",
    "action": "list",
    "params": {
        "property_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
dateRanges	array<object>	No	Date ranges of data to read, in YYYY-MM-DD or relative format (e.g., 30daysAgo, today). Defaults to the last 30 days.
dateRanges.startDate	string	No	Start date in YYYY-MM-DD format or relative (e.g., 30daysAgo)
dateRanges.endDate	string	No	End date in YYYY-MM-DD format or relative (e.g., today)
dimensions	array<object>	No	GA4 dimensions to group results by. Defaults match the equivalent Data Replication report.
dimensions.name	string	No	GA4 API dimension name (e.g., date, country, deviceCategory)
metrics	array<object>	No	GA4 metrics to aggregate. Defaults match the equivalent Data Replication report.
metrics.name	string	No	GA4 API metric name (e.g., totalUsers, sessions, bounceRate)
keepEmptyRows	boolean	No	If false, rows whose metrics are all zero are omitted from the response.
returnPropertyQuota	boolean	No	Whether to include the Analytics property's current quota state in the response.
limit	integer	No	Maximum number of rows to return (the GA4 API caps a single request at 250,000 rows).
property_id	string	Yes	GA4 property ID

Response Schema

Records

Field Name	Type	Description
dimensionValues	array<object>
dimensionValues[].value	string
metricValues	array<object>
metricValues[].value	string

Meta

Field Name	Type	Description
row_count	integer

Daily Active Users Context Store Search

Search and filter daily active users records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "daily_active_users",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "active1DayUsers": 0
        }
      }
    }
  }
}'

Python SDK

await google_analytics_data_api.daily_active_users.context_store_search(
    query={"filter": {"eq": {"active1DayUsers": 0}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "daily_active_users",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"active1DayUsers": 0}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
query	object	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filter	object	No	Filter conditions
query.sort	array	No	Sort conditions
limit	integer	No	Maximum results to return (default 1000)
cursor	string	No	Pagination cursor from previous response's meta.cursor
fields	array	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
active1DayUsers	integer	Number of distinct users active in the last 1 day
date	string	Date of the report row in YYYYMMDD format
endDate	string	End date of the reporting period
property_id	string	GA4 property ID
startDate	string	Start date of the reporting period

Response Schema

Field Name	Type	Description
data	array	List of matching records
meta	object	Pagination metadata
meta.has_more	boolean	Whether additional pages are available
meta.cursor	string | null	Cursor for next page of results
meta.took_ms	number | null	Query execution time in milliseconds
data[].active1DayUsers	integer	Number of distinct users active in the last 1 day
data[].date	string	Date of the report row in YYYYMMDD format
data[].endDate	string	End date of the reporting period
data[].property_id	string	GA4 property ID
data[].startDate	string	Start date of the reporting period

Daily Active Users Context Store SQL Query

Run a SQL query against daily active users records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.

Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "daily_active_users",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await google_analytics_data_api.daily_active_users.context_store_sql_query(
    sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "daily_active_users",
    "action": "context_store_sql_query",
    "params": {
        "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
    }
}'

Parameters

Parameter Name	Type	Required	Description
sql	string	Yes	SQL query to execute against this entity's Context Store data
limit	integer	No	Maximum results to return

Response Schema

Field Name	Type	Description
data	array	Projected rows, with dictionary keys matching the selected columns
meta	object	Query metadata
meta.has_more	boolean	Whether the result was limited and more rows are available
meta.cursor	null	SQL query results do not use cursor pagination
meta.took_ms	number | null	Query execution time in milliseconds

Weekly Active Users

Weekly Active Users List

Returns weekly active user counts (7-day active users) by date.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "weekly_active_users",
  "action": "list",
  "params": {
    "property_id": "<str>"
  }
}'

Python SDK

await google_analytics_data_api.weekly_active_users.list(
    property_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "weekly_active_users",
    "action": "list",
    "params": {
        "property_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
dateRanges	array<object>	No	Date ranges of data to read, in YYYY-MM-DD or relative format (e.g., 30daysAgo, today). Defaults to the last 30 days.
dateRanges.startDate	string	No	Start date in YYYY-MM-DD format or relative (e.g., 30daysAgo)
dateRanges.endDate	string	No	End date in YYYY-MM-DD format or relative (e.g., today)
dimensions	array<object>	No	GA4 dimensions to group results by. Defaults match the equivalent Data Replication report.
dimensions.name	string	No	GA4 API dimension name (e.g., date, country, deviceCategory)
metrics	array<object>	No	GA4 metrics to aggregate. Defaults match the equivalent Data Replication report.
metrics.name	string	No	GA4 API metric name (e.g., totalUsers, sessions, bounceRate)
keepEmptyRows	boolean	No	If false, rows whose metrics are all zero are omitted from the response.
returnPropertyQuota	boolean	No	Whether to include the Analytics property's current quota state in the response.
limit	integer	No	Maximum number of rows to return (the GA4 API caps a single request at 250,000 rows).
property_id	string	Yes	GA4 property ID

Response Schema

Records

Field Name	Type	Description
dimensionValues	array<object>
dimensionValues[].value	string
metricValues	array<object>
metricValues[].value	string

Meta

Field Name	Type	Description
row_count	integer

Weekly Active Users Context Store Search

Search and filter weekly active users records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "weekly_active_users",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "active7DayUsers": 0
        }
      }
    }
  }
}'

Python SDK

await google_analytics_data_api.weekly_active_users.context_store_search(
    query={"filter": {"eq": {"active7DayUsers": 0}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "weekly_active_users",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"active7DayUsers": 0}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
query	object	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filter	object	No	Filter conditions
query.sort	array	No	Sort conditions
limit	integer	No	Maximum results to return (default 1000)
cursor	string	No	Pagination cursor from previous response's meta.cursor
fields	array	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
active7DayUsers	integer	Number of distinct users active in the last 7 days
date	string	Date of the report row in YYYYMMDD format
endDate	string	End date of the reporting period
property_id	string	GA4 property ID
startDate	string	Start date of the reporting period

Response Schema

Field Name	Type	Description
data	array	List of matching records
meta	object	Pagination metadata
meta.has_more	boolean	Whether additional pages are available
meta.cursor	string | null	Cursor for next page of results
meta.took_ms	number | null	Query execution time in milliseconds
data[].active7DayUsers	integer	Number of distinct users active in the last 7 days
data[].date	string	Date of the report row in YYYYMMDD format
data[].endDate	string	End date of the reporting period
data[].property_id	string	GA4 property ID
data[].startDate	string	Start date of the reporting period

Weekly Active Users Context Store SQL Query

Run a SQL query against weekly active users records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.

Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "weekly_active_users",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await google_analytics_data_api.weekly_active_users.context_store_sql_query(
    sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "weekly_active_users",
    "action": "context_store_sql_query",
    "params": {
        "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
    }
}'

Parameters

Parameter Name	Type	Required	Description
sql	string	Yes	SQL query to execute against this entity's Context Store data
limit	integer	No	Maximum results to return

Response Schema

Field Name	Type	Description
data	array	Projected rows, with dictionary keys matching the selected columns
meta	object	Query metadata
meta.has_more	boolean	Whether the result was limited and more rows are available
meta.cursor	null	SQL query results do not use cursor pagination
meta.took_ms	number | null	Query execution time in milliseconds

Four Weekly Active Users

Four Weekly Active Users List

Returns 28-day active user counts by date.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "four_weekly_active_users",
  "action": "list",
  "params": {
    "property_id": "<str>"
  }
}'

Python SDK

await google_analytics_data_api.four_weekly_active_users.list(
    property_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "four_weekly_active_users",
    "action": "list",
    "params": {
        "property_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
dateRanges	array<object>	No	Date ranges of data to read, in YYYY-MM-DD or relative format (e.g., 30daysAgo, today). Defaults to the last 30 days.
dateRanges.startDate	string	No	Start date in YYYY-MM-DD format or relative (e.g., 30daysAgo)
dateRanges.endDate	string	No	End date in YYYY-MM-DD format or relative (e.g., today)
dimensions	array<object>	No	GA4 dimensions to group results by. Defaults match the equivalent Data Replication report.
dimensions.name	string	No	GA4 API dimension name (e.g., date, country, deviceCategory)
metrics	array<object>	No	GA4 metrics to aggregate. Defaults match the equivalent Data Replication report.
metrics.name	string	No	GA4 API metric name (e.g., totalUsers, sessions, bounceRate)
keepEmptyRows	boolean	No	If false, rows whose metrics are all zero are omitted from the response.
returnPropertyQuota	boolean	No	Whether to include the Analytics property's current quota state in the response.
limit	integer	No	Maximum number of rows to return (the GA4 API caps a single request at 250,000 rows).
property_id	string	Yes	GA4 property ID

Response Schema

Records

Field Name	Type	Description
dimensionValues	array<object>
dimensionValues[].value	string
metricValues	array<object>
metricValues[].value	string

Meta

Field Name	Type	Description
row_count	integer

Four Weekly Active Users Context Store Search

Search and filter four weekly active users records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "four_weekly_active_users",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "active28DayUsers": 0
        }
      }
    }
  }
}'

Python SDK

await google_analytics_data_api.four_weekly_active_users.context_store_search(
    query={"filter": {"eq": {"active28DayUsers": 0}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "four_weekly_active_users",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"active28DayUsers": 0}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
query	object	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filter	object	No	Filter conditions
query.sort	array	No	Sort conditions
limit	integer	No	Maximum results to return (default 1000)
cursor	string	No	Pagination cursor from previous response's meta.cursor
fields	array	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
active28DayUsers	integer	Number of distinct users active in the last 28 days
date	string	Date of the report row in YYYYMMDD format
endDate	string	End date of the reporting period
property_id	string	GA4 property ID
startDate	string	Start date of the reporting period

Response Schema

Field Name	Type	Description
data	array	List of matching records
meta	object	Pagination metadata
meta.has_more	boolean	Whether additional pages are available
meta.cursor	string | null	Cursor for next page of results
meta.took_ms	number | null	Query execution time in milliseconds
data[].active28DayUsers	integer	Number of distinct users active in the last 28 days
data[].date	string	Date of the report row in YYYYMMDD format
data[].endDate	string	End date of the reporting period
data[].property_id	string	GA4 property ID
data[].startDate	string	Start date of the reporting period

Four Weekly Active Users Context Store SQL Query

Run a SQL query against four weekly active users records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.

Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "four_weekly_active_users",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await google_analytics_data_api.four_weekly_active_users.context_store_sql_query(
    sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "four_weekly_active_users",
    "action": "context_store_sql_query",
    "params": {
        "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
    }
}'

Parameters

Parameter Name	Type	Required	Description
sql	string	Yes	SQL query to execute against this entity's Context Store data
limit	integer	No	Maximum results to return

Response Schema

Field Name	Type	Description
data	array	Projected rows, with dictionary keys matching the selected columns
meta	object	Query metadata
meta.has_more	boolean	Whether the result was limited and more rows are available
meta.cursor	null	SQL query results do not use cursor pagination
meta.took_ms	number | null	Query execution time in milliseconds

Traffic Sources

Traffic Sources List

Returns traffic source metrics broken down by session source, session medium, and date, including users, sessions, bounce rate, and page views.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "traffic_sources",
  "action": "list",
  "params": {
    "property_id": "<str>"
  }
}'

Python SDK

await google_analytics_data_api.traffic_sources.list(
    property_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "traffic_sources",
    "action": "list",
    "params": {
        "property_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
dateRanges	array<object>	No	Date ranges of data to read, in YYYY-MM-DD or relative format (e.g., 30daysAgo, today). Defaults to the last 30 days.
dateRanges.startDate	string	No	Start date in YYYY-MM-DD format or relative (e.g., 30daysAgo)
dateRanges.endDate	string	No	End date in YYYY-MM-DD format or relative (e.g., today)
dimensions	array<object>	No	GA4 dimensions to group results by. Defaults match the equivalent Data Replication report.
dimensions.name	string	No	GA4 API dimension name (e.g., date, country, deviceCategory)
metrics	array<object>	No	GA4 metrics to aggregate. Defaults match the equivalent Data Replication report.
metrics.name	string	No	GA4 API metric name (e.g., totalUsers, sessions, bounceRate)
keepEmptyRows	boolean	No	If false, rows whose metrics are all zero are omitted from the response.
returnPropertyQuota	boolean	No	Whether to include the Analytics property's current quota state in the response.
limit	integer	No	Maximum number of rows to return (the GA4 API caps a single request at 250,000 rows).
property_id	string	Yes	GA4 property ID

Response Schema

Records

Field Name	Type	Description
dimensionValues	array<object>
dimensionValues[].value	string
metricValues	array<object>
metricValues[].value	string

Meta

Field Name	Type	Description
row_count	integer

Traffic Sources Context Store Search

Search and filter traffic sources records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "traffic_sources",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "averageSessionDuration": 0.0
        }
      }
    }
  }
}'

Python SDK

await google_analytics_data_api.traffic_sources.context_store_search(
    query={"filter": {"eq": {"averageSessionDuration": 0.0}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "traffic_sources",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"averageSessionDuration": 0.0}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
query	object	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filter	object	No	Filter conditions
query.sort	array	No	Sort conditions
limit	integer	No	Maximum results to return (default 1000)
cursor	string	No	Pagination cursor from previous response's meta.cursor
fields	array	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
averageSessionDuration	number	Average duration of sessions in seconds
bounceRate	number	Percentage of sessions that were single-page with no interaction
date	string	Date of the report row in YYYYMMDD format
endDate	string	End date of the reporting period
newUsers	integer	Number of first-time users
property_id	string	GA4 property ID
screenPageViews	integer	Total number of screen or page views
screenPageViewsPerSession	number	Average page views per session
sessionMedium	string	The medium of the traffic source (e.g., organic, cpc, referral)
sessionSource	string	The source of the traffic (e.g., google, direct)
sessions	integer	Total number of sessions
sessionsPerUser	number	Average number of sessions per user
startDate	string	Start date of the reporting period
totalUsers	integer	Total number of unique users

Response Schema

Field Name	Type	Description
data	array	List of matching records
meta	object	Pagination metadata
meta.has_more	boolean	Whether additional pages are available
meta.cursor	string | null	Cursor for next page of results
meta.took_ms	number | null	Query execution time in milliseconds
data[].averageSessionDuration	number	Average duration of sessions in seconds
data[].bounceRate	number	Percentage of sessions that were single-page with no interaction
data[].date	string	Date of the report row in YYYYMMDD format
data[].endDate	string	End date of the reporting period
data[].newUsers	integer	Number of first-time users
data[].property_id	string	GA4 property ID
data[].screenPageViews	integer	Total number of screen or page views
data[].screenPageViewsPerSession	number	Average page views per session
data[].sessionMedium	string	The medium of the traffic source (e.g., organic, cpc, referral)
data[].sessionSource	string	The source of the traffic (e.g., google, direct)
data[].sessions	integer	Total number of sessions
data[].sessionsPerUser	number	Average number of sessions per user
data[].startDate	string	Start date of the reporting period
data[].totalUsers	integer	Total number of unique users

Traffic Sources Context Store SQL Query

Run a SQL query against traffic sources records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.

Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "traffic_sources",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await google_analytics_data_api.traffic_sources.context_store_sql_query(
    sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "traffic_sources",
    "action": "context_store_sql_query",
    "params": {
        "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
    }
}'

Parameters

Parameter Name	Type	Required	Description
sql	string	Yes	SQL query to execute against this entity's Context Store data
limit	integer	No	Maximum results to return

Response Schema

Field Name	Type	Description
data	array	Projected rows, with dictionary keys matching the selected columns
meta	object	Query metadata
meta.has_more	boolean	Whether the result was limited and more rows are available
meta.cursor	null	SQL query results do not use cursor pagination
meta.took_ms	number | null	Query execution time in milliseconds

Pages

Pages List

Returns page-level metrics including page views and bounce rate, broken down by host name, page path, and date.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "pages",
  "action": "list",
  "params": {
    "property_id": "<str>"
  }
}'

Python SDK

await google_analytics_data_api.pages.list(
    property_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "pages",
    "action": "list",
    "params": {
        "property_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
dateRanges	array<object>	No	Date ranges of data to read, in YYYY-MM-DD or relative format (e.g., 30daysAgo, today). Defaults to the last 30 days.
dateRanges.startDate	string	No	Start date in YYYY-MM-DD format or relative (e.g., 30daysAgo)
dateRanges.endDate	string	No	End date in YYYY-MM-DD format or relative (e.g., today)
dimensions	array<object>	No	GA4 dimensions to group results by. Defaults match the equivalent Data Replication report.
dimensions.name	string	No	GA4 API dimension name (e.g., date, country, deviceCategory)
metrics	array<object>	No	GA4 metrics to aggregate. Defaults match the equivalent Data Replication report.
metrics.name	string	No	GA4 API metric name (e.g., totalUsers, sessions, bounceRate)
keepEmptyRows	boolean	No	If false, rows whose metrics are all zero are omitted from the response.
returnPropertyQuota	boolean	No	Whether to include the Analytics property's current quota state in the response.
limit	integer	No	Maximum number of rows to return (the GA4 API caps a single request at 250,000 rows).
property_id	string	Yes	GA4 property ID

Response Schema

Records

Field Name	Type	Description
dimensionValues	array<object>
dimensionValues[].value	string
metricValues	array<object>
metricValues[].value	string

Meta

Field Name	Type	Description
row_count	integer

Pages Context Store Search

Search and filter pages records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "pages",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "bounceRate": 0.0
        }
      }
    }
  }
}'

Python SDK

await google_analytics_data_api.pages.context_store_search(
    query={"filter": {"eq": {"bounceRate": 0.0}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "pages",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"bounceRate": 0.0}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
query	object	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filter	object	No	Filter conditions
query.sort	array	No	Sort conditions
limit	integer	No	Maximum results to return (default 1000)
cursor	string	No	Pagination cursor from previous response's meta.cursor
fields	array	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
bounceRate	number	Percentage of sessions that were single-page with no interaction
date	string	Date of the report row in YYYYMMDD format
endDate	string	End date of the reporting period
hostName	string	The hostname of the page
pagePathPlusQueryString	string	The page path and query string
property_id	string	GA4 property ID
screenPageViews	integer	Total number of screen or page views
startDate	string	Start date of the reporting period

Response Schema

Field Name	Type	Description
data	array	List of matching records
meta	object	Pagination metadata
meta.has_more	boolean	Whether additional pages are available
meta.cursor	string | null	Cursor for next page of results
meta.took_ms	number | null	Query execution time in milliseconds
data[].bounceRate	number	Percentage of sessions that were single-page with no interaction
data[].date	string	Date of the report row in YYYYMMDD format
data[].endDate	string	End date of the reporting period
data[].hostName	string	The hostname of the page
data[].pagePathPlusQueryString	string	The page path and query string
data[].property_id	string	GA4 property ID
data[].screenPageViews	integer	Total number of screen or page views
data[].startDate	string	Start date of the reporting period

Pages Context Store SQL Query

Run a SQL query against pages records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.

Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "pages",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await google_analytics_data_api.pages.context_store_sql_query(
    sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "pages",
    "action": "context_store_sql_query",
    "params": {
        "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
    }
}'

Parameters

Parameter Name	Type	Required	Description
sql	string	Yes	SQL query to execute against this entity's Context Store data
limit	integer	No	Maximum results to return

Response Schema

Field Name	Type	Description
data	array	Projected rows, with dictionary keys matching the selected columns
meta	object	Query metadata
meta.has_more	boolean	Whether the result was limited and more rows are available
meta.cursor	null	SQL query results do not use cursor pagination
meta.took_ms	number | null	Query execution time in milliseconds

Devices

Devices List

Returns device-related metrics broken down by device category, operating system, browser, and date, including users, sessions, and page views.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "devices",
  "action": "list",
  "params": {
    "property_id": "<str>"
  }
}'

Python SDK

await google_analytics_data_api.devices.list(
    property_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "devices",
    "action": "list",
    "params": {
        "property_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
dateRanges	array<object>	No	Date ranges of data to read, in YYYY-MM-DD or relative format (e.g., 30daysAgo, today). Defaults to the last 30 days.
dateRanges.startDate	string	No	Start date in YYYY-MM-DD format or relative (e.g., 30daysAgo)
dateRanges.endDate	string	No	End date in YYYY-MM-DD format or relative (e.g., today)
dimensions	array<object>	No	GA4 dimensions to group results by. Defaults match the equivalent Data Replication report.
dimensions.name	string	No	GA4 API dimension name (e.g., date, country, deviceCategory)
metrics	array<object>	No	GA4 metrics to aggregate. Defaults match the equivalent Data Replication report.
metrics.name	string	No	GA4 API metric name (e.g., totalUsers, sessions, bounceRate)
keepEmptyRows	boolean	No	If false, rows whose metrics are all zero are omitted from the response.
returnPropertyQuota	boolean	No	Whether to include the Analytics property's current quota state in the response.
limit	integer	No	Maximum number of rows to return (the GA4 API caps a single request at 250,000 rows).
property_id	string	Yes	GA4 property ID

Response Schema

Records

Field Name	Type	Description
dimensionValues	array<object>
dimensionValues[].value	string
metricValues	array<object>
metricValues[].value	string

Meta

Field Name	Type	Description
row_count	integer

Devices Context Store Search

Search and filter devices records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "devices",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "averageSessionDuration": 0.0
        }
      }
    }
  }
}'

Python SDK

await google_analytics_data_api.devices.context_store_search(
    query={"filter": {"eq": {"averageSessionDuration": 0.0}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "devices",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"averageSessionDuration": 0.0}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
query	object	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filter	object	No	Filter conditions
query.sort	array	No	Sort conditions
limit	integer	No	Maximum results to return (default 1000)
cursor	string	No	Pagination cursor from previous response's meta.cursor
fields	array	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
averageSessionDuration	number	Average duration of sessions in seconds
bounceRate	number	Percentage of sessions that were single-page with no interaction
browser	string	The web browser used (e.g., Chrome, Safari, Firefox)
date	string	Date of the report row in YYYYMMDD format
deviceCategory	string	The device category (desktop, mobile, tablet)
endDate	string	End date of the reporting period
newUsers	integer	Number of first-time users
operatingSystem	string	The operating system used (e.g., Windows, iOS, Android)
property_id	string	GA4 property ID
screenPageViews	integer	Total number of screen or page views
screenPageViewsPerSession	number	Average page views per session
sessions	integer	Total number of sessions
sessionsPerUser	number	Average number of sessions per user
startDate	string	Start date of the reporting period
totalUsers	integer	Total number of unique users

Response Schema

Field Name	Type	Description
data	array	List of matching records
meta	object	Pagination metadata
meta.has_more	boolean	Whether additional pages are available
meta.cursor	string | null	Cursor for next page of results
meta.took_ms	number | null	Query execution time in milliseconds
data[].averageSessionDuration	number	Average duration of sessions in seconds
data[].bounceRate	number	Percentage of sessions that were single-page with no interaction
data[].browser	string	The web browser used (e.g., Chrome, Safari, Firefox)
data[].date	string	Date of the report row in YYYYMMDD format
data[].deviceCategory	string	The device category (desktop, mobile, tablet)
data[].endDate	string	End date of the reporting period
data[].newUsers	integer	Number of first-time users
data[].operatingSystem	string	The operating system used (e.g., Windows, iOS, Android)
data[].property_id	string	GA4 property ID
data[].screenPageViews	integer	Total number of screen or page views
data[].screenPageViewsPerSession	number	Average page views per session
data[].sessions	integer	Total number of sessions
data[].sessionsPerUser	number	Average number of sessions per user
data[].startDate	string	Start date of the reporting period
data[].totalUsers	integer	Total number of unique users

Devices Context Store SQL Query

Run a SQL query against devices records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.

Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "devices",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await google_analytics_data_api.devices.context_store_sql_query(
    sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "devices",
    "action": "context_store_sql_query",
    "params": {
        "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
    }
}'

Parameters

Parameter Name	Type	Required	Description
sql	string	Yes	SQL query to execute against this entity's Context Store data
limit	integer	No	Maximum results to return

Response Schema

Field Name	Type	Description
data	array	Projected rows, with dictionary keys matching the selected columns
meta	object	Query metadata
meta.has_more	boolean	Whether the result was limited and more rows are available
meta.cursor	null	SQL query results do not use cursor pagination
meta.took_ms	number | null	Query execution time in milliseconds

Locations

Locations List

Returns geographic metrics broken down by region, country, city, and date, including users, sessions, bounce rate, and page views.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "locations",
  "action": "list",
  "params": {
    "property_id": "<str>"
  }
}'

Python SDK

await google_analytics_data_api.locations.list(
    property_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "locations",
    "action": "list",
    "params": {
        "property_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
dateRanges	array<object>	No	Date ranges of data to read, in YYYY-MM-DD or relative format (e.g., 30daysAgo, today). Defaults to the last 30 days.
dateRanges.startDate	string	No	Start date in YYYY-MM-DD format or relative (e.g., 30daysAgo)
dateRanges.endDate	string	No	End date in YYYY-MM-DD format or relative (e.g., today)
dimensions	array<object>	No	GA4 dimensions to group results by. Defaults match the equivalent Data Replication report.
dimensions.name	string	No	GA4 API dimension name (e.g., date, country, deviceCategory)
metrics	array<object>	No	GA4 metrics to aggregate. Defaults match the equivalent Data Replication report.
metrics.name	string	No	GA4 API metric name (e.g., totalUsers, sessions, bounceRate)
keepEmptyRows	boolean	No	If false, rows whose metrics are all zero are omitted from the response.
returnPropertyQuota	boolean	No	Whether to include the Analytics property's current quota state in the response.
limit	integer	No	Maximum number of rows to return (the GA4 API caps a single request at 250,000 rows).
property_id	string	Yes	GA4 property ID

Response Schema

Records

Field Name	Type	Description
dimensionValues	array<object>
dimensionValues[].value	string
metricValues	array<object>
metricValues[].value	string

Meta

Field Name	Type	Description
row_count	integer

Locations Context Store Search

Search and filter locations records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "locations",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "averageSessionDuration": 0.0
        }
      }
    }
  }
}'

Python SDK

await google_analytics_data_api.locations.context_store_search(
    query={"filter": {"eq": {"averageSessionDuration": 0.0}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "locations",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"averageSessionDuration": 0.0}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
query	object	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filter	object	No	Filter conditions
query.sort	array	No	Sort conditions
limit	integer	No	Maximum results to return (default 1000)
cursor	string	No	Pagination cursor from previous response's meta.cursor
fields	array	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
averageSessionDuration	number	Average duration of sessions in seconds
bounceRate	number	Percentage of sessions that were single-page with no interaction
city	string	The city of the user
country	string	The country of the user
date	string	Date of the report row in YYYYMMDD format
endDate	string	End date of the reporting period
newUsers	integer	Number of first-time users
property_id	string	GA4 property ID
region	string	The region (state/province) of the user
screenPageViews	integer	Total number of screen or page views
screenPageViewsPerSession	number	Average page views per session
sessions	integer	Total number of sessions
sessionsPerUser	number	Average number of sessions per user
startDate	string	Start date of the reporting period
totalUsers	integer	Total number of unique users

Response Schema

Field Name	Type	Description
data	array	List of matching records
meta	object	Pagination metadata
meta.has_more	boolean	Whether additional pages are available
meta.cursor	string | null	Cursor for next page of results
meta.took_ms	number | null	Query execution time in milliseconds
data[].averageSessionDuration	number	Average duration of sessions in seconds
data[].bounceRate	number	Percentage of sessions that were single-page with no interaction
data[].city	string	The city of the user
data[].country	string	The country of the user
data[].date	string	Date of the report row in YYYYMMDD format
data[].endDate	string	End date of the reporting period
data[].newUsers	integer	Number of first-time users
data[].property_id	string	GA4 property ID
data[].region	string	The region (state/province) of the user
data[].screenPageViews	integer	Total number of screen or page views
data[].screenPageViewsPerSession	number	Average page views per session
data[].sessions	integer	Total number of sessions
data[].sessionsPerUser	number	Average number of sessions per user
data[].startDate	string	Start date of the reporting period
data[].totalUsers	integer	Total number of unique users

Locations Context Store SQL Query

Run a SQL query against locations records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.

Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "google-analytics-data-api",
  "entity": "locations",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await google_analytics_data_api.locations.context_store_sql_query(
    sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "locations",
    "action": "context_store_sql_query",
    "params": {
        "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
    }
}'

Parameters

Parameter Name	Type	Required	Description
sql	string	Yes	SQL query to execute against this entity's Context Store data
limit	integer	No	Maximum results to return

Response Schema

Field Name	Type	Description
data	array	Projected rows, with dictionary keys matching the selected columns
meta	object	Query metadata
meta.has_more	boolean	Whether the result was limited and more rows are available
meta.cursor	null	SQL query results do not use cursor pagination
meta.took_ms	number | null	Query execution time in milliseconds