Measures the reach of an audience by combining multiple cohorts — how many users are in it and how many page views they generate.
Example prompt
How many users and page views would I reach if I combined the luxury car cohort with the premium travel cohort, broken down by country?
Parameters
string[]
required
One or more audience expressions to measure, each a string in LISP S-expression form. min 1 item.
enum[]
Which breakdowns to include beyond total reach. each one of: cohort_contributions, domain_breakdown, device_breakdown, country_breakdown, workspace_breakdown, engagement, time_series_daily, time_series_weekly.
RestrictTo object
Narrow the measured population to activity matching these dimensions.
Show RestrictTo
string[]
ISO 3166-1 alpha-3 country codes (e.g. GBR, USA). When set, only activity in these countries is counted. Use get_workspace_details to find which workspaces have user activities in which countries.
string[]
Domain names (e.g. example.co.uk). When set, only activity on these domains is counted. Use the workspace’s own domains, from get_workspace_details.
Window object
The date window to measure over.
Show Window
string (date)
End of the window (inclusive), ISO date e.g. 2026-06-30. Omit to default to today.
string (date)
Start of the window (inclusive), ISO date e.g. 2026-06-01. Omit to default to 30 days before end.
string[]
required
Workspaces whose user-behaviour data is aggregated across. min 1 item.
Returns
AudienceMeasurement[]
One measurement per measurable expression.
Show AudienceMeasurement
CohortContribution[]
Per-cohort contribution to this expression.
Show CohortContribution
string
required
Cohort short id.
integer (int64)
required
Cohort’s standalone size within the restrict_to filters.
integer (int64)
required
Cohort’s incremental contribution of unique users to the composed expression.
CountryBreakdownEntry[]
Users per country (ISO 3166-1 alpha-3 code) within this expression’s audience.
Show CountryBreakdownEntry
string
required
ISO 3166-1 alpha-3 country code (e.g. GBR, USA).
integer (int64)
required
Estimated page views in this country.
integer (int64)
required
Estimated unique users in this country.
DeviceBreakdownEntry[]
Users per device type within this expression’s audience.
Show DeviceBreakdownEntry
string
required
Device type (e.g. Desktop, Mobile, Tablet, CTV).
integer (int64)
required
Estimated page views on this device type.
integer (int64)
required
Estimated unique users on this device type.
DomainBreakdownEntry[]
Users per publisher domain within this expression’s audience.
Show DomainBreakdownEntry
string
required
Publisher domain name.
integer (int64)
required
Estimated page views on this domain.
integer (int64)
required
Estimated unique users on this domain.
Engagement object
How engaged this expression’s audience is, beyond its size.
Show Engagement
integer (int64)
required
Total engaged time across the audience, in seconds.
number (double)
required
Average engaged time per user, in seconds.
number (double)
required
Average page views per user.
string
required
The expression that was evaluated, echoed back so results can be paired with inputs.
TimeSeriesBucket[]
Daily time-series: one bucket per calendar day in the window, users and page views for each.
Show TimeSeriesBucket
string
required
The time bucket: an ISO date (e.g. 2026-06-01) for a daily series, an ISO week-of-year number (e.g. 22) for a weekly series.
integer (int64)
required
Estimated page views in this bucket.
integer (int64)
required
Estimated unique users in this bucket.
TimeSeriesBucket[]
Weekly time-series: one bucket per ISO week in the window, users and page views for each.
Show TimeSeriesBucket
string
required
The time bucket: an ISO date (e.g. 2026-06-01) for a daily series, an ISO week-of-year number (e.g. 22) for a weekly series.
integer (int64)
required
Estimated page views in this bucket.
integer (int64)
required
Estimated unique users in this bucket.
CohortReach object
required
Total reach for this expression across the requested workspaces, within the restrict_to filters.
Show CohortReach
integer (int64)
required
Estimated page views over the measurement window.
integer (int64)
required
Estimated unique users over the measurement window.
integer (int64)
required
Estimated video views over the measurement window.
WorkspaceBreakdownEntry[]
Users per requested workspace within this expression’s audience.
Show WorkspaceBreakdownEntry
integer (int64)
required
Estimated unique users in this workspace matching the expression.
string (uuid)
required
One of the requested workspace IDs.
ExpressionUnavailable[]
Expressions that were not measured because one or more of their cohorts aren’t available in any of the requested workspaces.
Show ExpressionUnavailable
string
required
The expression that could not be measured, echoed back so it can be paired with your input.
string[]
required
The cohort short ids in this expression that aren’t available in any of the requested workspaces. min 1 item.
Assistant
Responses are generated using AI and may contain mistakes.