Skip to main content

GET Playlist

URL

GET https://api.smartzer.com/embedding/api/v1/playlist/{playlist_id}

Parameters

FieldType \ Value(s)RequiredDescription
regionstringfalseThe region of the user (used for the region plugin)
langstringfalseThe language of the user (used for the language plugin)
distributionstringfalseAny distribution flag you would like passed through to the player for analytics purposes
utm_*stringfalseAll utm_ prefixed variables are passed through to the player, and then added to the end of every cta that has a url

Response

{
projects: {
items: {
id: number, // The project Id
projectType: "VIDEO" | "LIVESTREAM" | "SHORTFORM" | "LIVESTREAM_RECORDING", // The type of the project
config: {
title: string[], // An array of strings that can be used to display the title of the project
thumbnail: string, // A url that can be used to display a thumbnail for the project
},
project: {
projectName: string, // The name of the project
duration: number, // The duration of the project in seconds (if known)
countdown: number, // The go-live time of the livestream project in milliseconds (if known)
},
url: string, // The url to play the video (this should be used to embed the video - it can play in an iframe, a webview or directly in the browser)
}[],
playlist: {} // this is an internal object that is used for the Smartzer SDK only
}
}