Retrieves information about a particular public-facing playlist.
Request
Request syntax:
https://content.uplynk.com/api/v4/player/playlists/{playlist_id}
Response
The response for a successful request contains the following parameters:
| Response Parameter | Type | Description |
|---|---|---|
| desc | String | Name of the playlist |
| id | String | The Playlist ID |
| List of assets: | ||
| @id | String | Unique identifier for the item (its .m3u8 URL) |
| @type | String | Always set to "Asset" |
| desc | String | The name of the asset |
| id | String | The Asset ID |
| duration | Float | Duration of the asset in seconds |
| poster_url | String | The URL of the asset’s poster |
| thumb_url | String | The URL for the asset’s thumbnail |
| meta_description | String | An optional long description contained in the asset metadata (set to null if not defined) |
| external_id | String | The External ID (only returned if used for the asset) |
Sample Response
The following sample response contains information about a public-facing playlist.
{
"@id": "/api/v4/player/playlists/516184ef80be442697d0c14abfd87c99",
"@type": "Collection",
"desc": "LVP Test",
"id": "516184ef80be442697d0c14abfd87c99",
"items": [
{
"@id": "https://content-ause1-up-1.uplynk.com/806aeee29a324fb3ac52189a604bc6ec.m3u8",
"@type": "Asset",
"desc": "Squid Game 2 - Mingle Game Song",
"id": "806aeee29a324fb3ac52189a604bc6ec",
"duration": 105.60000000000007,
"poster_url": "http://cf.cdn.uplynk.com/ausw2/slices/806/0933a56ee6f5434c8ffe5e00bee4e178/806aeee29a324fb3ac52189a604bc6ec/00000014.jpg",
"thumb_url": "http://cf.cdn.uplynk.com/ausw2/slices/806/0933a56ee6f5434c8ffe5e00bee4e178/806aeee29a324fb3ac52189a604bc6ec/00000019.jpg",
"meta": {
"description": null
}
},
{
"@id": "https://content-ause1-up-1.uplynk.com/a2c334edd1b54f0ba501ce359a249445.m3u8",
"@type": "Asset",
"desc": "Big Buck Bunny",
"id": "a2c334edd1b54f0ba501ce359a249445",
"duration": 596.4800000000004,
"poster_url": "http://cf.cdn.uplynk.com/ausw/slices/a2c/0933a56ee6f5434c8ffe5e00bee4e178/a2c334edd1b54f0ba501ce359a249445/poster_c9409c7cd66546d99e3d17704df4af80.jpg",
"thumb_url": "http://cf.cdn.uplynk.com/ausw2/slices/a2c/0933a56ee6f5434c8ffe5e00bee4e178/a2c334edd1b54f0ba501ce359a249445/00000091.jpg",
"meta": {
"description": null
},
"external_id": "dolby"
},
{
"@id": "https://content-ause1-up-1.uplynk.com/e6ff51319f14407289cfcbe9264f8662.m3u8",
"@type": "Asset",
"desc": "Candy_Enchiladas",
"id": "e6ff51319f14407289cfcbe9264f8662",
"duration": 844.0320000000006,
"poster_url": "http://cf.cdn.uplynk.com/ause1/slices/e6f/0933a56ee6f5434c8ffe5e00bee4e178/e6ff51319f14407289cfcbe9264f8662/00000014.jpg",
"thumb_url": "http://cf.cdn.uplynk.com/ause1/slices/e6f/0933a56ee6f5434c8ffe5e00bee4e178/e6ff51319f14407289cfcbe9264f8662/000000CE.jpg",
"meta": {
"description": null
},
"external_id": "kenny1"
},
{
"@id": "https://content-ause1-up-1.uplynk.com/856e33d05b23477ebe47d7b850b2e036.m3u8",
"@type": "Asset",
"desc": "Mr. Chuckle Teeth - Short",
"id": "856e33d05b23477ebe47d7b850b2e036",
"duration": 8.32,
"poster_url": "http://cf.cdn.uplynk.com/ausw/slices/856/0933a56ee6f5434c8ffe5e00bee4e178/856e33d05b23477ebe47d7b850b2e036/poster_4039efc865e148379382b89595e813fe.jpg",
"thumb_url": "http://cf.cdn.uplynk.com/ausw2/slices/856/0933a56ee6f5434c8ffe5e00bee4e178/856e33d05b23477ebe47d7b850b2e036/00000002.jpg",
"meta": {
"description": null
}
}
],
"total_duration": 1584,
"timeline_duration": 1554
}