HomeAPI Reference
API Reference
Start typing to search…

List Playout Hours

get
https://analytics.zype.com/v3/platform_dynamics/playout_hours

This endpoint to retrieve hours requested data for Playout Channels. This allows customers who are distributing Playout Channels where Zype supports the delivery to measure and track detailed information related to their Playout Channel hours requested.

Query Params
string

Filter records created on the specified start_date (UTC).(filters[start_date_eq]=2020-07-01). A start date is required when making a data request.

string

Filter by the Video ID.

string

Filter by the Playout Channel ID. Use the Zype platform channel ID to filter records for a specific Playout channel.

string

Filter by the Playout partner ID. Supported values are pluto_tv, samsung_tv

string

Filter by the Zype Playlist ID.

string

Filter by 2 character country code. (filters[country_code_eq]=US)

string

Filter by the device name.

string

Filter by the DMA code. (filters[dma_code_eq]=501)

string

Filter by the City. (filters[city_eq]=New York)

string

Filter by the State. (filters[state_eq]=New York)

string

Filter by Zip Code.

string

Filter by the Client IP address.

string

Filter by User Agent string.

string

Filter by the Session ID.

string

Filter query by region. Using this overrides the region param and is more granular. -- Accepted regions are: US, EU, AP.

group_by
array of strings or null

Group records by one or more properties of the data returned -- accepted values are: all, video_id, channel_id, partner_id, country_code, device_name, region.

group_by
string

Required when group_by is set to "all". Results will be delivered as downloadable CSV links via email.

string
enum
Defaults to US

Select Playout Analytics Region to query -- default is US.

Allowed:
Response

Updated 5 months ago

Language
Credentials
Query
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago