Video Groups are the titled items that group your imported Videos. They are very similar to Shows, but they group together imported Videos. Video Groups are full of their own metadata. On this page, we’ll dive into the different endpoints you can use to read video group information programmatically from the Channels library.
The video groups model
The video group model contains all the information about your Video Groups in your library, such as their name, poster art, last watched date, etc. Additionally, you can fetch all of the videos of a video group using the nested endpoint.
Note: Properties with null values will be ommited from the response.
The unique identifier for the Video Group.
The name of the Video Group.
The summary of the Video Group.
The URL of the poster image for the Video Group.
The year the Video Group was originated.
The date the Video Group was originated.
An array of strings for the genres of the Video Group.
An array of strings for the categories of the Video Group. Categories describe the type of content the Video Group is such as Intenet Videos, Concert, etc.
An array of strings for the labels of the Video Group. Labels are self assigned strings used for organizing items in the library.
The number of videos contained in the Video Group.
The number of unwatched videos for the Video Group.
Whether or not the Video Group has been favorited.
The date of the last time a video of the Video Group was watched.
The date when the Video Group was first added to the library.
The date when the Video Group was last updated.
List all video groups
Returns a list of all Video Groups in the library.
Only return video groups with their complete watch status corresponding to the passed in value.
Only return video groups with their favorited status corresponding to the passed in value.
Sort the response based on the passed in value.
Sort by the title of the video group.
Sort by the date the video group was added to the library.
Sort by the date the video group originated.
Sort by the date the video group was last watched.
Sort by date the video group was last updated.
Set the order of the response.
Retrieve a video group
This endpoint allows you to retrieve a video group by using its unique identifier.