Retrieve DRM Playlist

Returns all media metadata and assets (images, tracks, conversions, manifests), formatted as JSON, needed to play media of a DRM playlist in the JW Player

byJW Player API (Video Platform)

12calls

N/Alatency

Discover -> Inspect -> Call

Call setup

Tool IDjwplayer_api.drm_playlists.retrieve.v2.89496024

Request parametersJSON

Before this Call

1 credit / call

The final charge is settled from actual provider usage and will appear in Usage.

Field reference

playlist_idstringRequired

Eight-character, alphanumeric ID (ex: WXu7kuaW) that uniquely identifies the playlist. You can find it in the playlist details page in the dashboard OR in the JW Platform Management API in /channels.

policy_idstringRequired

Eight-character, alphanumeric ID that uniquely identifies the DRM policy

backfillbooleanOptional

Ensures that a video result is always returned for dynamic playlists with a trending sort order, Article Matching playlists, or search playlists. If no video results are explicitly returned for the given query, a Trending playlist is returned as the result. For Article Matching playlists and dynamic playlist with a trending sort order, true is the default. For search playlists, false is the default.

default_source_fallbackbooleanOptional

Whether to provide a fallback if the requested source qualities do not exist. Default behavior is false. When this parameter is true, the playlist will be populated with the next valid rendition, if one exists. Use of this parameter is not recommended, but it is available to provide similar behavior to legacy feed generation logic.

exclude_media_filtering_modestringOptional

Filtering behavior for exclude_media_filtering. Possible values: all (default): Excludes assets with every custom parameter; any: Excludes assets with at least one custom parameter. Works with all playlists (channels) except manual.

exclude_tags_modestringOptional

Filtering behavior for exclude_tags. Possible values: all (default): Excludes assets with every tag; any: Excludes assets with at least one tag. Works with all playlists (channels) except manual.

media_filtering_modestringOptional

Filtering behavior for media_filtering. Possible values: all (default): Includes assets with every custom parameter; any: Includes assets with at least one custom parameter. Works with all playlists (channels) except manual.

page_limitintegerOptional

The maximum number of items per page. For Similar Video, Search, and Article Matching playlists, the maximum value is 100. For Manual and Dynamic playlists, the maximum value is 500. This overrides dashboard or management API settings when included with a request.

page_offsetintegerOptional

The number of items to offset for paginated requests. Values can be from 1 to N where N is the last possible item of a given playlist.

poster_widthintegerOptional

The width of poster images to include with the playlist. By default, the playlist will include 720-pixel-wide images which is a good balance between quality and page speed for most playlist thumbnail applications.

recencystringOptional

Filter for playlists based on the number of days or years passed since the publish date of a given media asset. Use the format of _D or _YR. Examples: 9D will only serve media assets published less than 9 days ago; 2YR will only serve media assets published less than 2 years ago. When appended to an API request, this query parameter only applies when the playlist recency value is left unpopulated.

recommendations_playlist_idstringOptional

Eight-character, alphanumeric ID (ex: wZuMVmMk) that uniquely identifies the recommendations playlist to use. If no recommendations_playlist_id is included, the playlist will use the default recommendations 'similar video' playlist for the property.

related_media_idstringOptional

(Required for Similar Video playlists) Eight-character, alphanumeric ID for the media asset JW Recommendations uses to create a similar video playlist. Recommendations are based on the related_media_id, viewer engagement and network data.

searchstringOptional

(Required for Search and Article Matching playlists) URL-encoded search phrase of one or more words separated by spaces, phrases contained by double quotes, or both. JWP indexes and searches media metadata, such as titles and descriptions, and returns the most relevant results. By default, tags are included in Article Matching playlist searches. Tags are not included in Search playlist searches by default, and only when "use_tags": true is set. Input text is broken into terms by whitespace and commas. For Article Matching playlists, set the search query to __CONTEXTUAL__.

tags_modestringOptional

Filtering behavior for tags. Possible values: all (default): Includes assets with every tag; any: Includes assets with at least one tag. Works with all playlists (channels) except manual.

tokenstringOptional

Signature for requests to the Content API for protected content. It consists of a JSON Web Token (JWT) containing the parameters of the request. When requested with no signature to prevent unauthorized access to videos, unsigned video URLs are returned. More information is available in the developer guide.

use_tagsbooleanOptional

(Search playlists only) Includes tags in the considered metadata. Default: false.