Filters

📘

Guidelines

  1. The chosen dimension determines which filters are supported.

    Unsupported filters are typically ignored.

  2. Certain filters can be passed as a comma-separated list.

    For more detail, refer to the notes below and the Dimensions Cheat Sheet.

🚧

Date range

  1. The maximum date range is 24 hours (and in some cases 1 hour).

    For more detail, see the notes in the Dimensions Cheat Sheet.

  2. Reports should be run against the most recent 24 hours of data.

    If data is no longer available, 0 rows of data will be returned.

Filter

Modifier

Format and description

Notes and examples

start_date

Required

A date-time, indicating the start of the reporting period.

Example:
start_date=2023-03-28T00:00:00


🚧 See the Date range note above.

end_date

Required

A date-time, indicating the end of the reporting period.

Example:
end_date=2023-03-28T23:59:59


🚧 See the Date range note above.

campaign

  • *1 or more** numeric Campaign IDs, as a comma-separated list.

Examples:
campaign=101
campaign=101,102,103

platform

  • *1 or more** platform enums, as a comma-separated list.

Possible values:
DESK
PHON
TBLT

Examples:
platform=DESK
platform=PHON,TBLT

country

  • *1 or more** 2-letter ISO-3166 country codes, passed as a comma-separated list.

Possible values:
Use the Dictionary to fetch a list of supported values.

Examples:
country=us
country=us,ca

site_id

  • *1 or more** numeric Site IDs (publisher Account IDs), as a comma-separated list.

Examples:
site_id=123
site_id=123,124

fetch_config

Boolean

Example:
fetch_config=true

Applies to the by_campaign dimension only.

If set to true, the report will return additional campaign columns, and will be limited to 1,000 rows.