Links

Playlist

Endpoint URL

https://fireworkapi1.com/embed/v2/playlists/{playlist_id}/feeds?page_size={page_size}

Method

POST

Description

This endpoint retrieves the list of feeds for a specific playlist.

Parameters

Query

  • page_size: The number of feeds to be retrieved on one page

Path

  • playlist_id: The ID of the playlist for which the feeds are to be retrieved.

Response

  • A JSON object containing the following fields:
    • playlist_id: The unique ID of the playlist.
    • feed_items: An array of feed objects, where each feed object contains a video object with the following fields:
      • caption: The title of the video
      • thumbnail_url: The thumbnail URL of the video preview thumbnail
      • id: The video ID
    • next_page: The URL to fetch the next page response. The URL will expire after 5 minutes of inactivity. If you want to cache the feed response, please ensure the TTL is less than 5 minutes or request the next_page URL before it is expired.

HTTP Responses:

  • 200 OK: The request was successful, and the feeds were retrieved.
  • 400 Bad Request: The request was malformed or invalid.
  • 404 Not Found: The specified playlist was not found.

Example

Request

POST https://fireworkapi1.com/embed/v2/playlists/abcdef/feeds?page_size=10

Example Response:

Note: internal only fields are not documented
HTTP/1.1 200 OK
{
"feed_items": [
{
"video": {
"caption": "Hat Gift Guide",
"thumbnail_url": "https://cdn4.fireworktv.com/medias/2022/10/1/1664650827-vkltosfw/transcoded/540/20200423115134.jpg",
"id": "5mKPXa",
}
},
{
"video": {
"caption": "A gift for kids",
"thumbnail_url": "https://cdn4.fireworktv.com/medias/2022/10/1/1664650852-sxauyrgq/transcoded/540/08-1682decomposingshirtturnsintoalgaewhenwornoutrebrand_p1_v3.jpg",
"id": "oAJmM0",
}
}
],
"id": "728a8dbd-e1c7-4cdf-bee4-2ae8cc2c9315",
"next_page": "/embed/v2/playlists/abcdef/feeds/1dc50572-ddd0-4f5b-870d-ebedf374aa28?after=video-gwKXZm"
}
Last modified 9mo ago