Videos are the imported videos grouped under Video Groups. They are very similar to videos, but they are grouped under Videos Groups. On this page, we’ll dive into the different video endpoints you can use to read video information programmatically from the Channels library.
The video model
The video model contains all the information about your imported videos that are part of a Video Group, such as its title, summary, poster art, watch status, duration, etc.
Note: Properties with null values will be ommited from the response.
The unique identifier for the video.
The unique identifier for the video's parent video group.
The full path to the video file.
The season number of the video.
The episode number of the video.
The title of the video's parent show.
The title of the video.
The short summary of the video.
The full summary of the video.
The content rating of the video. This is typically a TV rating such as TV-14, TV-PG, etc.
The URL of the poster image for the video.
The URL of the thumbnail image for the video.
The duration of the video in seconds.
The playback position the video will resume at in seconds.
The date the video originated.
An array of strings for the genres of the video.
An array of strings for the tags of the video. Tags indicate information about the video such as HD, 4K, CC, Dolby Digital, etc.
An array of strings for the labels of the video. Labels are self assigned strings used for organizing items in the library.
An array of strings for the categories of the video. Categories describe the type of content the video is such as Internet Video, Concert, etc.
Whether or not the video has been watched.
Whether or not the video has been favorited.
Whether or not the video has completed post-processing.
Whether or not the video's commercials have been manually verified.
The timestamp of the last time the video was watched.
The timestamp of when the video was first added to the library.
The timestamp of when the video was last updated.
List all videos
Returns a list of all videos in the library.
Only return videos with watch status corresponding to the passed in value.
Only return videos with favorited status corresponding to the passed in value.
Only return videos with verified status corresponding to the passed in value.
Sort the response based on the passed in value.
Sort by the date the video was added to the library.
Sort by the date the video originated.
Sort by the date the video was last watched.
Sort by length of the video.
Set the order of the response.
Retrieve a video
This endpoint allows you to retrieve a video by using its unique identifier.