Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
playlists

Get a playlist

get/v2/sites/{site_id}/playlists/{playlist_id}/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

playlist_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the playlist

Response

Resource successfully retrieved

schemastring
idstring

Unique identifier for a resource

createdstring

Date and time at which the resource was created

last_modifiedstring

Date and time at which the resource was most recently modified

typestring

Name of the type of resource.

relationshipsobject

Ancilliary resources associated to the primary resource being read

playlist_type'article_matching' | 'dynamic' | 'manual' | 'search' | 'watchlist'

Type of playlist

Possible values include:

  • article_matching: (Enterprise only) Insert contextually relevant videos into your articles. Filtering rules apply, including tag rules (inclusion and exclusion) and recency filtering. Article Matching playlists are limited to a maximum of 100 videos. Also read about how to Embed videos with Article Matching.

  • dynamic: Automatically sort your videos using PATCH /v2/playlists/{playlist_id}/dynamic_playlist API call to specify what to sort by (publish date for example). Dynamic playlists are limited to a maximum of 500 videos.

  • manual: Manual channels are ordered by the user manually. Manage the playlist's content using POST and PATCH /v2/playlists/{playlist_id}/manual_playlist API calls. Manual playlists are limited to a maximum of 10,000 videos.

  • recommendations: (Enterprise only) Recommendation playlists return a set of recommended videos based on a source video. Recommendations playlists are limited to a maximum of 100 videos.

  • search: (Enterprise only) Search playlists contain videos ordered by similarity to a search term or phrase. Set the rules by which the playlist is filtered by using PATCH /v2/playlists/{playlist_id}/search_playlist API call. Search playlists are limited to a maximum of 100 videos.

  • watchlist: (Apps only) Watch list playlists return a set of videos based on viewer interactions within apps. For more information regarding Watch list playlists, please reach out to your JWX representative.

defaultboolean

(Recommendations) Indicates that the playlist is the default Recommendations playlist

Example response

{
  "schema": "https://schema.jwplayer.com/types/thumbnail.json",
  "id": "Ny05CEfj",
  "created": "2019-09-25T15:29:11.042095+00:00",
  "last_modified": "2019-09-25T15:29:11.042095+00:00",
  "metadata": {
    "custom_params": {
      "param1": "value1"
    }
  }
}