View Relationsips

Returns a list of playlists and its relationships


Managing Playlist Relationships

Playlist Relationships allow you to create a parent / child relationship between two playlists. This is useful for nesting playlist content within OTT apps. For example, you could create a parent playlist called "Comedy" and nest child playlists underneath called "Romantic Comedies" and "Slapstick Comedies" to provide a better user experience for your audience. To manage Playlist Relationships, we use the parent_id and priority fields of a playlist.

Parameter

Function

Type

playlist[parent_id]

The parent playlist id. If this value is null, the playlist is a root playlist and can be used as the primary playlist within an app where all your other playlists and videos are nested under

String

playlist[priority]

The priority of the playlist related with its siblings. Playlists are ordered ascending by priority value

Integer

When creating or updating a Playlist:

  • If the parent_id and priority are not set, the playlist will be set as a root playlist with the highest priority value set.
  • If the parent_id is not set, but the priority is, then, the playlist will be set as a root playlist, and will be ordered by the priority value set. If there is another root playlist with the same priority, then it will be added after this playlist.
  • If the parent_id and priority are set, the playlist will be added as a child of the playlist with id parent_id, and will be ordered by the priority value set. If there is another sibling playlist with the same priority, then it will be added after the sibling.

To nest a playlist under a new parent, you need to change its parent_id field to the id of the playlist you want to nest it under. If you want it to be a root playlist, then you have to set the parent_id field as null or empty

Also, take into account that 0 (zero) is the highest priority.

Language
Authentication
Query
URL
Click Try It! to start a request and see the response here!