Execute measurement query

Execute a synchronous measurement query to retrieve aggregated OOH metrics.

Query formats (choose one):

  1. DSL string: Provide a SQL-like query in the query field. When present,
    all other fields are ignored.

    SELECT total(imps), total(reach) FROM audience
    FOR AUDIENCE universe_id=1 WHERE dma_id IN (501)
    DURING '2025-01-01' TO '2025-01-28' GROUP BY operator
  2. Structured JSON: Provide the following fields:

    • select (required): At least one metric to calculate (imps, reach, freq, grps, trps)
    • audience (required): Population universe and optional target segment
    • time (required): Date range for the query
    • filters: Geographic, operator, inventory, or campaign constraints
    • groupby: Dimensions to aggregate by (returns one row per unique combination)
    • layer: Exposure measurement layer (ots, lts, audience)
    • model_version_id: Pin to a specific model version for reproducibility

Privacy: Results are subject to aggregation thresholds. Queries returning
results below the minimum threshold will receive a 403 error with code
aggregation_threshold.

For large or complex queries, use the async endpoint (POST /v1/query/async)
to avoid timeouts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for the measurement query endpoint.

Queries return aggregated OOH measurement metrics (impressions, reach,
frequency, GRPs, TRPs) filtered and grouped by various dimensions.

You can submit a query in two ways:

  1. Structured JSON: Provide select, filters, audience, time, and
    other fields as structured objects.

  2. DSL String: Provide a SQL-like query string in the query field.
    When query is provided, all other fields are ignored.

Results are subject to aggregation thresholds to protect privacy.

SQL-like DSL query string. When provided, all other fields are ignored and the query is parsed from this string. Example: SELECT total(imps), total(reach) FROM audience FOR AUDIENCE universe_id=1 WHERE dma_id IN (501) DURING '2025-01-01' TO '2025-01-28' GROUP BY operator ORDER BY imps DESC LIMIT 20. See the Query DSL documentation for full syntax reference.

array | null

Metrics to calculate and return. Required if query is not provided.

array | null

Filter constraints. Multiple filters are combined with OR logic. Required if query is not provided.

AudienceDefinition | null

Population universe and optional target segment for rating calculations. Required if query is not provided.

TimeFilter | null

Time range and temporal settings. Required if query is not provided.

string
enum
Defaults to audience

Exposure measurement layer to use for calculations.

Allowed:

Pin to a specific model version for reproducibility. If omitted, uses the latest published version.

array | null

Dimensions to group results by. If omitted, returns a single total row.

array | null

Sort order for results.

Maximum number of rows to return.

Pagination token from a previous response.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json