Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 2.62 KB

FilterBy1.md

File metadata and controls

42 lines (28 loc) · 2.62 KB

FilterBy1

Properties

Name Type Description Notes
mediaId Array<string> Returns analytics based on the unique identifiers of a video or a live stream. [optional]
mediaType FilterBy1MediaTypeEnum [optional]
continent Array<FilterBy1ContinentEnum> Returns analytics based on the viewers' continent. The list of supported continents names are based on the GeoNames public database. You must use the ISO-3166 alpha2 format, for example `EU`. [optional]
country Array<string> Returns analytics based on the viewers' country. The list of supported country names are based on the GeoNames public database. You must use the ISO-3166 alpha2 format, for example `FR`. [optional]
deviceType Array<string> Returns analytics based on the type of device used by the viewers. Response values can include: `computer`, `phone`, `tablet`, `tv`, `console`, `wearable`, `unknown`. [optional]
operatingSystem Array<string> Returns analytics based on the operating system used by the viewers. Response values can include `windows`, `mac osx`, `android`, `ios`, `linux`. [optional]
browser Array<string> Returns analytics based on the browser used by the viewers. Response values can include `chrome`, `firefox`, `edge`, `opera`. [optional]
tag string Returns analytics for videos using this tag. This filter only accepts a single value and is case sensitive. Read more about tagging your videos here. [optional]
referrer Array<string> Filters data based on the URL where the view is originating from. This filter parameter accepts an empty string to filter view events where no referrer is available. - The API filters for exact matches. Include the trailing `/` characters if needed. - The URLs you add must be URL encoded. [optional]

Enum: FilterBy1MediaTypeEnum

Name Value
Video 'video'
LiveStream 'live-stream'

Enum: Array<FilterBy1ContinentEnum>

Name Value
AS 'AS'
AF 'AF'
NA 'NA'
SA 'SA'
AN 'AN'
EU 'EU'
AZ 'AZ'