Beta

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.

Properties

id string

The unique identifier for the Video Group.

name string

The name of the Video Group.

summary string

The summary of the Video Group.

image_url string

The URL of the poster image for the Video Group.

release_year string

The year the Video Group was originated.

release_date string

The date the Video Group was originated.

genres array

An array of strings for the genres of the Video Group.

categories array

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.

labels array

An array of strings for the labels of the Video Group. Labels are self assigned strings used for organizing items in the library.

video_count integer

The number of videos contained in the Video Group.

number_unwatched integer

The number of unwatched videos for the Video Group.

favorited boolean

Whether or not the Video Group has been favorited.

last_watched_at timestamp

The date of the last time a video of the Video Group was watched.

created_at timestamp

The date when the Video Group was first added to the library.

updated_at timestamp

The date when the Video Group was last updated.

GET /api/v1/video_groups

List all video groups

Returns a list of all Video Groups in the library.

Optional Attributes

watched boolean

Only return video groups with their complete watch status corresponding to the passed in value.

favorited boolean

Only return video groups with their favorited status corresponding to the passed in value.

Sorting Attributes

sort string

Sort the response based on the passed in value.

Options

  • alpha default

    Sort by the title of the video group.

  • date_added

    Sort by the date the video group was added to the library.

  • date_released

    Sort by the date the video group originated.

  • date_watched

    Sort by the date the video group was last watched.

  • date_updated

    Sort by date the video group was last updated.

order string

Set the order of the response.

Options

  • asc default

    Ascending order.

  • desc

    Descending order.

Request
GET /api/v1/video_groups
curl http://192.168.1.3:8089/api/v1/video_groups
Response 
[{
  "id": "videos-912b6855d3497def488a22bb41000081c6128dad7bbf71b67b602454960cc92c",
  "name": "Stand Up Specials",
  "summary": "Full Stand-Up specials from Comedy Central.",
  "image_url": "http://192.168.1.3:8089/dvr/uploads/125/content",
  "release_year": 1999,
  "release_date": "1999-02-09",
  "genres": [
    "Stand Up Comedy"
  ],
  "categories": [
    "Internet Video"
  ],
  "video_count": 54,
  "number_unwatched": 54,
  "favorited": false,
  "last_watched_at": 1673044474551,
  "created_at": 1673040687000,
  "updated_at": 1673044474551
},{
  "id": "videos-ce85f4ac0718b2d0b26f85474ff6a9bd615ff423b1b6936a2676082052227744",
   "name": "SNL Clips",
   ...
}]

GET /api/v1/video_groups/:id

Retrieve a video group

This endpoint allows you to retrieve a video group by using its unique identifier.

Required Attributes

id string

The unique identifier of the Video Group.

Request
GET /api/v1/video_groups/183983
curl http://192.168.1.3:8089/api/v1/video_groups/183983
Response 
{
  "id": "videos-912b6855d3497def488a22bb41000081c6128dad7bbf71b67b602454960cc92c",
  "name": "Stand Up Specials",
  "summary": "Full Stand-Up specials from Comedy Central.",
  "image_url": "http://192.168.1.3:8089/dvr/uploads/125/content",
  "release_year": 1999,
  "release_date": "1999-02-09",
  "genres": [
    "Stand Up Comedy"
  ],
  "categories": [
    "Internet Video"
  ],
  "video_count": 54,
  "number_unwatched": 54,
  "favorited": false,
  "last_watched_at": 1673044474551,
  "created_at": 1673040687000,
  "updated_at": 1673044474551
}

GET /api/v1/video_groups/:id/videos

Retrieve a video group's videos

This endpoint allows you to retrieve all the videos contained by a video group.

Required Attributes

id string

The unique identifier of the Video Group.

Optional Attributes

watched boolean

Only return videos with watch status corresponding to the passed in value.

favorited boolean

Only return videos with favorited status corresponding to the passed in value.

verified boolean

Only return videos with verified status corresponding to the passed in value.

Sorting Attributes

sort string

Sort the response based on the passed in value.

Options

  • date_added default

    Sort by the date the video was added to the library.

  • date_released

    Sort by the date the video originated.

  • date_watched

    Sort by the date the video was last watched.

  • duration

    Sort by length of the video.

order string

Set the order of the response.

Options

  • asc

    Ascending order.

  • desc default

    Descending order.

Request
GET /api/v1/video_groups/433445343/videos
curl http://192.168.1.3:8089/api/v1/video_groups/433445343/videos
Response 
[{
  "id": "32074",
  "video_group_id": "videos-912b6855d3497def488a22bb41000081c6128dad7bbf71b67b602454960cc92c",
  "path": "/media/videos/Stand Up Specials/Patton Oswalt - My Inner Child Doesn't Feel Like Chopping Wood Today [IuzCilEFBgo].webm",
  "title": "Stand Up Specials",
  "video_title": "Patton Oswalt - My Inner Child Doesn't Feel Like Chopping Wood Today",
  "summary": "Patton Oswalt gripes about watching old movies in L.A., remembers buying weed at a coffee shop in Amsterdam and reveals why he got thrown out of the Anne Frank House.",
  "image_url": "http://192.168.1.3:8089/dvr/uploads/125/content",
  "thumbnail_url": "https://i3.ytimg.com/vi/IuzCilEFBgo/maxresdefault.jpg",
  "duration": 1240.621,
  "playback_time": 0,
  "original_air_date": "1999-08-14",
  "genres": [
    "Stand Up Comedy"
  ],
  "tags": [
    "HD",
    "Stereo"
  ],
  "categories": [
    "Internet Video"
  ],
  "watched": false,
  "favorited": false,
  "delayed": false,
  "cancelled": false,
  "corrupted": false,
  "completed": false,
  "processed": true,
  "locked": false,
  "verified": false,
  "created_at": 1673040351000,
  "updated_at": 1673042668376
},{
  "id": "31254",
  "video_group_id": "videos-912b6855d3497def488a22bb41000081c6128dad7bbf71b67b602454960cc92c",
  ...
}]