List Relative Playlist Videos

get

https://api.zype.com/playlists/{id}/videos/relative

Returns a windowed set of videos from a playlist relative to the anchor video

Path Params

string

required

ID of playlist

Query Params

anchor_video_id

string

required

The selected video ID.

after

integer

Defaults to 3

How many items to return after the anchor video.

before

integer

Defaults to 0

How many items to return before the anchor video.

include_anchor

boolean

Defaults to false

Whether to include the anchor video in the results.

sort

string

Sort order of the playlist videos. Defaults to the playlist's sort order.

order

string

enum

Order of the playlist videos. Defaults to the playlist's order.

Allowed:

zobject_details

boolean

Setting to true will display the full Zobject details, including any custom attributes, for each video record returned in your query.

zobject_types

string

Filter zobject details by Zobject type. Example: zobject_types=episode,season

zobject_fields

string

Filter returned zobject fields. Example: zobject_fields=title,description

Responses

Language

Credentials

Query

Response

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

application/json

200Return videos for a specific playlist

404Playlist not found

422Unprocessable entity