Playlist¶
An individual playlist represented in the Graph API.
Test this object with the API Explorer
To read a playlist, perform an HTTP GET request on https://api.dailymotion.com/playlist/PLAYLIST_ID. By default, only a small number of fields are returned. To request specific fields, pass the list of wanted fields in the fields query-string parameter (ex: https://api.dailymotion.com/playlist/PLAYLIST_ID?fields=field1,field2,...).
Global API Parameters¶
The following parameters are valid globally on the API:
- localization – Change the default localization of the user. This will affect results language and content selection.
Note that changing the localization won’t give access to geoblocked content of the defined localization. The IP of the API consumer is always used for this kind of restriction. You can use a standard locale like fr_FR, en_US or simply en, it.
- family_filter – Enable/disable the family filter. By default, the family filter is on. Changing this parameter will filter-out
explit content from searches and global contexts. You should always check the explicit field when applicable as some contexts may return those contents. You should then flag those content in your UI to warn the user about the nature of the content.
Fields¶
| Name | Description | Permissions | Format |
|---|---|---|---|
| created_time | The date when the playlist has been created | No access_token required for reading. | Returns date. |
| description | The playlist’s description | No access_token required for reading. This field is writable. | Returns string, min size: 1, max size: 2000. |
| id | The playlist object ID | No access_token required for reading. | Returns the object id. |
| name | The playlist’s name | No access_token required for reading. This field is writable. | Returns string, min size: 1, max size: 50. |
| owner | The user who created the playlist | No access_token required for reading. | Return a user. You can request sub-fields by using owner.<sub-field> notation. |
| search | Full text search | This field can be used as filter but can’t be read nor written. | Returns string, min size: 1, max size: 150. |
| sort | Change result ordering | This field can be used as filter but can’t be read nor written. | Returns string, allowed values: recent, relevance, alpha. |
| thumbnail_large_url | The URL of the first video thumbnail (320px by 240px). | No access_token required for reading. | Returns url. |
| thumbnail_medium_url | The URL of the first video thumbnail (160px by 120px). | No access_token required for reading. | Returns url. |
| thumbnail_small_url | The URL of the first video thumbnail (80px by 60px). | No access_token required for reading. | Returns url. |
| thumbnail_url | The URL of the first video raw thumbnail (full size respecting ratio). | No access_token required for reading. | Returns url. |
| videos_total | The total number of videos in the playlist. | No access_token required for reading. | Returns number, min value: 0. |
Connections¶
| Name | Description | Permissions | Returns |
|---|---|---|---|
| videos | Playlist’s videos in the order defined by its owner. | No access_token required for reading. This connection is writable. | A list of Video. |
The videos connection¶
Read¶
You can read the list of a playlist‘s videos by issuing an HTTP GET to /playlist/PLAYLIST_ID/videos. You can requests the list of video‘s fields to be returned using the fields parameter.
Test with the API Explorer
You can also see if a playlist has a video by issuing an HTTP GET to /playlist/PLAYLIST_ID/videos/VIDEO_ID. This will return a list containing only the video if connected or an empty list otherwise.
Create¶
You can add a video by issuing an HTTP POST request to /playlist/PLAYLIST_ID/videos/VIDEO_ID. You can set videos by issuing an HTTP POST request to /playlist/PLAYLIST_ID/videos?ids=VIDEO_ID_1,VIDEO_ID_2,VIDEO_ID_N. Note that the order of ids matters. You can clear videos by issuing a POST request with an empty ids paramter.
Test with the API Explorer
Delete¶
You can remove a video by issuing an HTTP DELETE request to /playlist/PLAYLIST_ID/videos/VIDEO_ID.
Test with the API Explorer