Skip to main content
Tool name measure_audiences
Read-only · Idempotent
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

expressions
string[]
required
One or more audience expressions to measure, each a string in LISP S-expression form. min 1 item.
include
enum[]
Which breakdowns to include beyond total reach. each one of: cohort_contributions, domain_breakdown, device_breakdown, country_breakdown, workspace_breakdown.
restrict_to
RestrictTo object
Narrow the measured population to activity matching these dimensions.
workspace_ids
string[]
required
Workspaces whose user-behaviour data is aggregated across. min 1 item.

Returns

measurements
AudienceMeasurement[]
One measurement per measurable expression.
unavailable
ExpressionUnavailable[]
Expressions that were not measured because one or more of their cohorts aren’t available in any of the requested workspaces.