List Player Requests

get

https://analytics.zype.com/v3/platform_dynamics/player_requests

This endpoint will return Player Request analytics data for your property.

Query Params

filters[start_date_gt]

string

Filter records created after the specified start_date (filters[start_date_gte]=2018-11-01). If no start_date is specified, then data returned will date back two weeks ago.

filters[start_date_gte]

string

Filter records created on or after the specified start_date.

filters[start_date_lt]

string

Filter records created before the specified start_date.

filters[start_date_lte]

string

Filter records created on or before the specified start_date.

filters[start_date_eq]

string

Filter records created on the specified start_date. Comparison is date and time specific. If no time values are submitted, 00:00:00 UTC is assumed.

filters[id_eq]

string

Filter records with specified id

filters[browser_eq]

string

Filter records with specified browser

filters[browser_version_eq]

string

Filter records with specified browser_version

filters[os_eq]

string

Filter records with specified os

filters[os_version_eq]

string

Filter records with specified os_version

filters[player_name_eq]

string

Filter records with specified player_name

filters[video_id_eq]

string

Filter records with specified video_id

filters[device_name_eq]

string

Filter records with specified device_name

filters[revenue_model_name_eq]

string

Filter records with specified revenue_model_name

filters[consumer_id_eq]

string

Filter records with specified consumer_id

filters[name_eq]

string

Filter records with specified consumer name

filters[consumer_email_eq]

string

Filter records with specified consumer_email

filters[country_eq]

string | null

enum

Filter records with specified country

filters[domain_eq]

string

Filter records with specified domain

filters[tracking_code_eq]

string

Filter records with specified tracking_code

filters[tracking_partner_eq]

string

Filter records with specified tracking_partner

filters[video_title_eq]

string

Filter records with specified video_title

interval

string | null

enum

Shortcut method to group records by time intervals. Accepted values: day.

Allowed:

group_by

array of strings or null

Group records by one or more properties of the data returned -- accepted values are: browser, browser_version, os, os_version, player_name, video_id, device_name, revenue_model_name, consumer_id, name, consumer_email, country, domain, tracking_code, tracking_partner, video_title, start_date

group_by

counts

array of strings

Return count of records per grouping. Using counts = ["*"] for generic count of all records in grouping, response will include request_count.

counts

limit

integer

Limit the number of records returned

sort_by

string | null

enum

Sort results by value of a specific property + '_' + sort direction (Example - sort_by=start_date_asc, or sort_by=consumer_email_desc)

Responses

200See below for example responses

422Unprocessable entity