Filters Description

Filters Description

Below you can find all fieds that can be used on custom reports for Videos and Podcast Reports.

Video Filter Description

Parameter Name	Type	Description
dimensions	object	Categories of dimensions that include various items. Examples: Device: Devices, Operating System, Browser Content: Media, Player, Playlist, Date Geography: Country Placement: Host, Host & Path, URL Project: Player ProjectId, Video ProjectId
metrics	object	Categories of metrics that include various items. Examples: Performance: Embeds, Ad Impressions, Plays, Completes, Time Watched, Average Watch Time, 20s View, True View Viewers: Unique Viewers, Play per Viewer, Ad Impressions per Viewer Engagement: Complete Rate, 25% Completes, 50% Completes, 75% Completes Ads: Ad Clicks, Ad Skips, Ad Completes
dateRanges	array	A list of date range options. Examples: Custom 7 Days 30 Days 90 Days Month to Date Yesterday Last Quarter Last Month
filters	array	A list of available filters. Examples: Videos Country Device Playlist Player Domain Subtitles IsLive Video Project Id

Podcast Filter Description

Parameter Name	Type	Description
dimensions	object	Categories of dimensions that include various items. Examples: Device: Devices, Operating System, Browser Content: Media, Player, Podcast, Date Geography: Country Placement: Host, Host & Path, URL Project: Player ProjectId
metrics	object	Categories of metrics that track performance, engagement, and viewers. Examples: Performance: Embeds, Completes, Time Listened, Average Listen Time Viewers: Unique Listeners, Listen per View Engagement: Complete Rate, 25% Completes, 50% Completes, 75% Completes
dateRanges	array	Predefined date ranges for filtering data. Examples: Custom, 7 Days, 30 Days, 90 Days Month to Date, Yesterday, Last Quarter, Last Month
filters	array	Filters to refine data based on specific dimensions. Examples: Country, Device, Player, Domain, Podcast

tip

To write a query with the desired fields, use the key's value for the desired filter as the value for the field key in the query. For example, "field":"embeds".

Query Examples

Examples how to write filters on a query :

{
"startDate":"2024-08-19T00:00:00",
"endDate":"2024-08-19T00:00:00",
"dimensions":["date"],
"metrics":[{"field":"completes"},
{"field":"embeds"},
{"field":"play_per_viewer"},
{"field":"unique_viewers"},
{"field":"ad_clicks"},
{"field":"25_completes"},
{"field":"ad_completes"},
{"field":"time_watched"},
{"field":"complete_rate"},
{"field":"plays"}],
"filters":[{"field":"video",
"operator":"equal",
"value":"{videoId}"}]
}

tip

To find the complete list of key values for all fields, visit the Custom Report Fields API

Available operators that can be used for filters :

Filter Option	Description
Equals	Matches exactly with the specified value.
Not Equals	Does not match the specified value.
In	Matches any of the values in the specified list.
Not In	Does not match any of the values in the specified list.
Contains	Includes the specified value as a substring.
Not Contains	Does not include the specified value as a substring.