Filters
Filter parameters control which data is included in a query by filtering out any data which does not match the filters.
Different data fields can be filtered on, and they can be combined, allowing multiple filters to be applied on the same request. Each filter also accepts multiple values via a comma-separated string.
Filter parameters
| Filters | Description |
|---|---|
country |
Filter by country using ISO-3166-1 alpha-2 country codes, ex: ZA, DE. |
region |
Filter by country sub-division (region), using ISO 3166-2 codes, ex: ZA-WC or DE-BE. |
device |
Filter by hardware device type, ex Phone see the Device filters list. |
platform |
Filter by operating platform, ex Android see the Platform files list. |
hod |
Filter by hour of day. Accepts integer values between 0 .. 23. |
dow |
Filter by day of week. Values: mon, tue, wed, thu, fri, sat, sun. |
daypart |
Filter by part of day, ex afternoon see the Daypart filters list. |
url_platform |
Filter by custom URL tracker, see the URL platform list. |
Ex: filter results for Overnight listeners from Germany and South-Africa on Mobile or Tablet devices
"<base>/stream/totals/devices?range=last_7_days&country=DE,ZA&daypart=overnight,device=Phone,Tablet"
Filters
This lists the different hard-coded values that be can used as filters.
Filter results by the part of day as determined by UK Rajar dayparts using the daypart parameter.
daypart |
Description | Days | Hours |
|---|---|---|---|
| Week | |||
overnight |
Overnight (Weekday) | Mon - Fri | 0 - 6 |
breakfast_peak |
Breakfast Peak (Weekday) | Mon - Fri | 6 - 10 |
mid_morning |
Mid Morning (Weekday) | Mon - Fri | 10 - 13 |
afternoon |
Afternoon (Weekday) | Mon - Fri | 13 - 16 |
pm_drive |
PM drive (Weekday) | Mon - Fri | 16 - 19 |
evening |
Evening (Weekday) | Mon - Fri | 19 - 24 |
| Saturday | |||
sat_overnight |
Overnight (Saturday) | Sat | 0 - 6 |
sat_breakfast_peak |
Breakfast Peak (Saturday) | Sat | 6 - 10 |
sat_mid_morning |
Mid Morning (Saturday) | Sat | 10 - 13 |
sat_afternoon |
Afternoon (Saturday) | Sat | 13 - 19 |
sat_evening |
Evening (Saturday) | Sat | 19 - 24 |
| Sunday | |||
sun_overnight |
Overnight (Sunday) | Sat | 0 - 6 |
sun_breakfast_peak |
Breakfast Peak (Sunday) | Sun | 6 - 10 |
sun_mid_morning |
Mid Morning (Sunday) | Sun | 10 - 13 |
sun_afternoon |
Afternoon (Sunday) | Sun | 13 - 19 |
sun_evening |
Evening (Sunday) | Sun | 19 - 24 |
Filter results by specific devices using the device parameter.
device |
Description |
|---|---|
phone |
Mobile phone |
assistant |
Home assistant like Alexa |
desktop |
Desktop computer |
tablet |
Tablet like iPad |
tv |
Smart TV |
entertainment_system |
Smart hifi |
vehicle |
In-vehicle entertainment systems |
media_player |
Media players |
watch |
Smart watch |
audio_equipment |
Mixing desks |
console |
Game console |
bot |
Automated system |
unknown |
Unknown devices |
Filter results by operating systems using the platform parameter.
platform values |
Description |
|---|---|
windows |
Microsoft Windows. |
android |
Android devices, phone or tablet. |
macos |
Apple macOS devices. |
ios |
Apple iOS phones, including iPadOS tablets. |
apple_homepod |
Apple Homepod devices. |
apple_watch |
Apple Watch devices. |
apple_tv |
Apple TV devices. |
linux |
Any Linux (or Unix) distribution. |
amazon_echo |
Amazon Echo devices. |
fuchsia |
Google OS used on Nest and other devices. |
tizen |
Linux based OS, developed by Samsung. |
chromeos |
Google Chrome OS used. |
java |
Software running on a Java virtual machine. |
webos |
OS for LG TVs and some phones. |
appliance |
Where we detected the device as an appliance, like a hi-fi or speaker system. |
blackberry |
OS for Blackberry devices. (Discontinued) |
symbianos |
OS for Nokia devices. (Discontinued) |
unknown |
Where the platform could not be determined. |
Filter results by the platform "override" customers can append to their URLs. Used when submitting content to syndicators or distinguishing between links served via a website or app.
| Value | Description |
|---|---|
notset |
All sessions that did not have any url_platform query parameter set. |
website |
|
ios_app |
|
android_app |
|
smart_tv |
|
3p_agg_01 |
|
3p_agg_02 |
|
3p_agg_03 |
|
3p_agg_04 |
|
tunein |
|
spotify |
|
amazon_rsk |
|
amazon_ds |
|
google_nest |
|
apple_pod |
|
fire_app |
|
radiogarden |
|
radioplayer_web |
|
radioplayer_app |
|
bbc_sounds |
|
global |
|
bauer |
|
onlineradiobox |
|
roku |
|
iheart |
|
nationplayer |
|
radiodns |
|
aim_app |
|
hls |