List Program Guide Entries

get

https://api.zype.com/v3/program_guides/{id}/entries

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

ID of the program guide

Query Params

string

Filter by keyword

keyword

string

Filter by keyword

string

Filter by search term

string

Filter entries by ID. Example: id=5992f328ce593000ef000008

id!

string

Exclude entries by ID. Alias of id.ne.

id.ne

string

Exclude entries by ID. Alias of id!.

title

string

Filter by the entry's title

sort

string

Sort on the specified field

order

string

enum

Filter by ascending or descending order

Allowed:

page

integer

Page number to return, with per_page dictating page size

per_page

integer

Number of records to return per page

disable_pagination

boolean

When true, all results are returned in a single JSON body without pagination. Default false

hours

integer

Defaults to 1

How many hours forward from the anchor time to return entries for. The anchor is start_time if given, otherwise the current time. Defaults to 1 when omitted.

Both boundaries are rounded to the hour to improve cache hit rates: the start is floored down to the top of its hour, and the end is ceiled up from the unfloored anchor plus hours to guarantee at least the requested hours of real coverage. As a result the actual window returned is typically between hours and just under 2 * hours hours wide, never less than hours.

Must be a positive integer, or the request fails with 400. When hours is given, any end_time param is ignored entirely.

dvr

boolean

Defaults to false

When true, overrides the start of the returned window to now - <DVR retention window>, based on the DVR retention window (start_over_window) of the HLS destination associated with video_id. The end boundary is unaffected.

Requires video_id to also be given, or the request fails with 400 — this applies unconditionally, even if the target program guide isn't Playout-managed.

video_id

string

ID of the video whose playout-channel HLS destination determines the DVR retention window. Required when dvr=true; ignored otherwise.

Validated in order: the video must exist on the site, or the request fails with 404 ("the requested video has not been found"); it must have a playout-channel HLS destination associated, or the request fails with 422 ("the requested video doesn't have a playout destination associated"); and that destination must belong to the same video source as the program guide, or the request fails with 422 ("The requested video is not associated to the same playout channel as the program guide").

start_time

integer

Filter entries by start time, as an integer number of epoch seconds. Floored down to the hour when used without hours. An unrealistically large value fails with 400.

end_time

integer

Upper bound on the returned window, as an integer number of epoch seconds — entries are matched by start_time falling before this value, not by their own end time. Ceiled up to the next hour when used without hours; ignored entirely when hours is given. An unrealistically large value fails with 400.

created_at

integer

Filter entries by created date, as an integer number of epoch seconds. Range filters can be applied via the .gt, .gte, .lt, .lte suffixes below.

created_at.gt

integer

Filter entries created after the given epoch-seconds timestamp.

created_at.gte

integer

Filter entries created on or after the given epoch-seconds timestamp.

created_at.lt

integer

Filter entries created before the given epoch-seconds timestamp.

created_at.lte

integer

Filter entries created on or before the given epoch-seconds timestamp.

Responses

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Return program guide entries

400Invalid hours/start_time/end_time/created_at, or dvr=true without video_id

404Program guide not found, or video_id does not resolve to a video on the site

422video_id has no playout destination, or its destination doesn't match the program guide's video source