GET Vertical Player Config

Overview

---

The following table contains important information about the GET method in regards to receiving the vertical player configuration for a specific video.

GET Vertical Player Config
Method	GET
URL or Endpoint	/vertical-player/playerId/videoId.json
Headers	Not Applicable
Parameters	playerId, videoId
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
playerId	Yes	string	Unique Id of the vertical player.
videoId	Yes	string	Unique Id of the video.

Request Body

The request does not contain a request body

Response

{
  "projectId": "{projectId}",
  "video": {
    "videoId": "{videoId}",
    "file": "{file}",
    "title": "{title}",
    "description": "{description}",
    "publishDate": "2024-05-28T11:44:17.062Z",
    "publishEndDate": "2024-05-28T11:44:17.062Z",
    "private": false,
    "protected": false,
    "passwordProtectedTitle": "{passwordProtectedTitle}",
    "passwordProtectedDescription": "{passwordProtectedDescription}",
    "chapterState": false,
    "chapterPath": "{chapterPath}",
    "assetId": "{assetId}",
    "hasGeoRestriction": false,
    "geoRestrictionLink": "{geoRestrictionLink}",
    "hasDrm": false,
    "drmLicenseUrl": "{drmLicenseUrl}",
    "fpsCertificateUrl": "{fpsCertificateUrl}",
    "widevineLicenseUrl": "{widevineLicenseUrl}",
    "castContentType": "{castContentType}",
    "castVideoSource": "{castVideoSource}",
    "thumbnail": "{thumbnail}",
    "filmstrip": "{filmstrip}",
    "filmstripVtt": "{filmstripVtt}",
    "live": false,
    "liveType": "{liveType}",
    "maxLiveBackDuration": 0,
    "autoRelated": "{autoRelated}",
    "relatedVideos": "{relatedVideos}",
    "shareUrl": "{shareUrl}",
    "source": "{source}",
    "author": "{author}",
    "tracks": [
      {
        "file": "{trackFile}",
        "lang": "{lang}",
        "label": "{label}"
      }
    ],
    "adId": "{adId}",
    "startTime": 0,
    "advertising": false,
    "showEngagementHeatmap": false,
    "ads": {
      "type": "{type}",
      "isVmap": false,
      "enableProgrammability": false,
      "vmap": "{vmap}",
      "skipAllAds": false,
      "VPAIDmode": "{VPAIDmode}",
      "adBreaks": [],
      "bidding": false,
      "bidders": [],
      "functions": [],
      "enableDemandManager": false,
      "demandManager": null,
      "frequency": null,
      "maxCap": 0,
      "initialDelay": null,
      "adCycleDelayMs": 0,
      "adRetryLimit": 0,
      "adCycleRestartMs": 0,
      "banner": null,
      "overrides": {
        "state": false,
        "prerollCount": 0,
        "cuepoints": []
      }
    },
    "playlist": {
      "state": false,
      "playlistId": "{playlistId}",
      "playlistVideoIndex": 0,
      "algorithm": "{algorithm}",
      "shareUrl": "{shareUrl}",
      "displayType": "{displayType}",
      "fromRecommended": false
    },
    "skipIntro": {
      "state": false,
      "skipFrom": 0,
      "skipTo": 0
    },
    "flags": [],
    "tags": [],
    "customOverlays": {
      "state": false,
      "overlays": []
    },
    "videoLocking": {
      "isEnabled": false,
      "value": 0
    },
    "videoProperties": []
  },
  "config": {
    "configId": "{configId}",
    "biskoId": "{biskoId}",
    "recommended": false,
    "recommendedId": "{recommendedId}",
    "muted": false,
    "autoplay": true,
    "loop": false,
    "playlistLoop": false,
    "swipeToSkip": false,
    "autoHideOverlay": false,
    "showAuthor": true,
    "showPublishDate": true,
    "size": {
      "sizeType": "{sizeType}",
      "height": 0
    },
    "lang": {
      "controls": {
        "play": "{play}",
        "pause": "{pause}",
        "mute": "{mute}",
        "unmute": "{unmute}",
        "fullscreen": "{fullscreen}",
        "minimize": "{minimize}",
        "settings": "{settings}",
        "more": "{more}",
        "less": "{less}",
        "previous": "{previous}",
        "next": "{next}",
        "live": "{live}"
      },
      "settings": {
        "share": "{share}",
        "copy": "{copy}",
        "copyLink": "{copyLink}",
        "off": "{off}",
        "playbackRate": "{playbackRate}",
        "normal": "{normal}",
        "quality": "{quality}",
        "auto": "{auto}"
      }
    },
    "controls": {
      "play": false,
      "seekbar": false,
      "text": false,
      "fullscreen": true,
      "share": true,
      "settings": true
    },
    "skin": {
      "text": "{text}",
      "buttons": {
        "icon": "{icon}",
        "background": "{background}"
      },
      "seekbar": {
        "rail": "{rail}",
        "buffer": "{buffer}",
        "progress": "{progress}",
        "dragger": "{dragger}"
      }
    },
    "autostartOnViewable": {
      "state": false,
      "onMobile": false,
      "onData": false,
      "percentageViewable": 0.5
    },
    "autopauseOnViewable": {
      "state": false,
      "percentageViewable": 0.5
    },
    "soundSubtitleInversion": false,
    "socialMedia": []
  }
}

The description of the response fields is as follows:

Top-Level Properties

Field Name	Type	Description
projectId	string	Unique identifier of the project.
video	object	Video configuration object.
config	object	Player configuration object.

video Properties

Field Name	Type	Description
videoId	string	Unique identifier of the video.
file	string	URL of the video file.
title	string	Title of the video.
description	string	Description of the video.
publishDate	string($date-time)	Date and time when the video was published.
publishEndDate	string($date-time)	Date and time when the video publish period ends.
private	boolean	Whether the video is private.
protected	boolean	Whether the video is password protected.
passwordProtectedTitle	string	Title displayed on the password protection prompt.
passwordProtectedDescription	string	Description displayed on the password protection prompt.
chapterState	boolean	Whether chapters are enabled for the video.
chapterPath	string	URL of the chapter definitions file.
assetId	string	The content/asset identifier used for DRM.
hasGeoRestriction	boolean	Whether the video has geographic restrictions.
geoRestrictionLink	string	Redirect URL shown to geo-blocked users.
hasDrm	boolean	Whether DRM protection is enabled.
drmLicenseUrl	string	URL of the DRM license server.
fpsCertificateUrl	string	URL of the FairPlay Streaming certificate.
widevineLicenseUrl	string	URL of the Widevine DRM license server.
castContentType	string	MIME type used when casting the video.
castVideoSource	string	Video source URL used for casting.
thumbnail	string	URL of the video thumbnail image.
filmstrip	string	URL of the filmstrip image used for seek preview.
filmstripVtt	string	URL of the VTT file for filmstrip seek preview timing.
live	boolean	Whether the video is a live stream.
liveType	string	Type of live stream.
maxLiveBackDuration	integer	Maximum duration in seconds for live DVR rewind.
autoRelated	string	Identifier for auto-generated related videos.
relatedVideos	string	Identifier for manually configured related videos.
shareUrl	string	URL used when sharing the video.
source	string	Source attribution for the video.
author	string	Author of the video.
tracks	array[object]	List of subtitle/caption tracks for the video.
adId	string	Identifier of the ad schedule associated with the video.
startTime	integer	Start time offset in seconds for video playback.
advertising	boolean	Whether advertising is enabled for the video.
showEngagementHeatmap	boolean	Whether the engagement heatmap is displayed on the seek bar.
ads	object	Ad configuration object for the video.
playlist	object	Playlist configuration if the video belongs to a playlist.
skipIntro	object	Skip intro configuration for the video.
flags	array[string]	List of flags associated with the video.
tags	array[string]	List of tags associated with the video.
customOverlays	object	Custom overlay configuration for the video.
videoLocking	object	Video locking configuration.
videoProperties	array[object]	List of additional video properties.

tracks Properties

Field Name	Type	Description
file	string	URL of the subtitle/caption file.
lang	string	Language code of the track (e.g., "en", "de").
label	string	Display label of the track (e.g., "English").

ads Properties

Field Name	Type	Description
type	string	Type of ad configuration (e.g., "DYNAMIC", "STATIC").
isVmap	boolean	Whether the ad schedule uses VMAP format.
enableProgrammability	boolean	Whether ad programmability is enabled.
vmap	string	URL of the VMAP ad schedule.
skipAllAds	boolean	Whether all ads can be skipped.
VPAIDmode	string	VPAID rendering mode.
adBreaks	array[object]	List of ad break configurations.
bidding	boolean	Whether header bidding is enabled.
bidders	array[object]	List of header bidding bidder configurations.
functions	array[object]	List of ad macro function configurations.
enableDemandManager	boolean	Whether the demand manager (prebid) is enabled.
demandManager	object	Demand manager (prebid) configuration.
frequency	object	Ad frequency capping configuration.
maxCap	integer	Maximum number of ad impressions per frequency period.
initialDelay	object	Initial delay configuration before the first ad plays.
adCycleDelayMs	integer or null	Delay in milliseconds between ad cycles.
adRetryLimit	integer or null	Maximum number of ad request retries on failure.
adCycleRestartMs	integer or null	Time in milliseconds before an ad cycle restarts.
banner	object	Banner ad configuration.
overrides	object	Per-video ad overrides configuration.

ads.overrides Properties

Field Name	Type	Description
state	boolean	Whether video-level ad overrides are active.
prerollCount	integer	The number of preroll ads to play, overriding the ad schedule default.
cuepoints	array[integer]	List of custom midroll ad cue point times in seconds.

playlist Properties

Field Name	Type	Description
state	boolean	Whether playlist mode is enabled.
playlistId	string	Unique identifier of the playlist.
playlistVideoIndex	integer	Index of the current video within the playlist.
algorithm	string	Algorithm used for playlist ordering.
shareUrl	string	URL used when sharing the playlist.
displayType	string	Display type of the playlist in the player UI.
fromRecommended	boolean	Whether the playlist is generated from recommendations.

skipIntro Properties

Field Name	Type	Description
state	boolean	Whether skip intro is enabled.
skipFrom	integer or null	Time in seconds when the skip intro button appears.
skipTo	integer or null	Time in seconds to skip to when the button is clicked.

customOverlays Properties

Field Name	Type	Description
state	boolean	Whether custom overlays are enabled.
overlays	array[object]	List of custom overlay configurations.

videoLocking Properties

Field Name	Type	Description
isEnabled	boolean or null	Whether video locking is enabled.
value	integer or null	Time in seconds after which the video is locked.

videoProperties Properties

Field Name	Type	Description
type	string	Type of the video property.
name	string	Name of the video property.

config Properties

Field Name	Type	Description
configId	string	Unique identifier of the player configuration.
biskoId	string	Bisko analytics identifier.
recommended	boolean	Whether recommendations are enabled.
recommendedId	string	Identifier of the recommended playlist.
muted	boolean or null	Whether the player starts muted.
autoplay	boolean	Whether autoplay is enabled.
loop	boolean	Whether content loops after finishing.
playlistLoop	boolean	Whether the playlist loops after the last video.
swipeToSkip	boolean	Whether swipe to skip is enabled.
autoHideOverlay	boolean	Whether the player overlay (title, description, author, publish date, and other metadata) is automatically hidden during playback.
showAuthor	boolean	Whether the video author is displayed in the player overlay.
showPublishDate	boolean	Whether the video publish date is displayed in the player overlay.
size	object	Player size configuration.
lang	object	Player localization strings.
controls	object	Player controls visibility configuration.
skin	object	Player skin and color configuration.
autostartOnViewable	object	Autostart on viewable configuration.
autopauseOnViewable	object	Auto-pause on viewable configuration.
soundSubtitleInversion	boolean	Whether sound and subtitle controls are inverted.
socialMedia	array[string]	List of social media sharing options.

size Properties

Field Name	Type	Description
sizeType	string	Size mode of the player (e.g., "RESPONSIVE").
height	integer	Height of the player in pixels.

lang Properties

Field Name	Type	Description
controls	object	Localization strings for player controls.
settings	object	Localization strings for player settings.

lang.controls Properties

Field Name	Type	Description
play	string	Localized text for the play button.
pause	string	Localized text for the pause button.
mute	string	Localized text for the mute button.
unmute	string	Localized text for the unmute button.
fullscreen	string	Localized text for the fullscreen button.
minimize	string	Localized text for the minimize button.
settings	string	Localized text for the settings button.
more	string	Localized text for the more button.
less	string	Localized text for the less button.
previous	string	Localized text for the previous button.
next	string	Localized text for the next button.
live	string	Localized text for the live indicator.

lang.settings Properties

Field Name	Type	Description
share	string	Localized text for the share option.
copy	string	Localized text for the copy option.
copyLink	string	Localized text for the copy link option.
off	string	Localized text for the off option.
playbackRate	string	Localized text for the playback rate option.
normal	string	Localized text for the normal speed option.
quality	string	Localized text for the quality option.
auto	string	Localized text for the auto quality option.

controls Properties

Field Name	Type	Description
play	boolean	Whether the play button is visible.
seekbar	boolean	Whether the seek bar is visible.
text	boolean	Whether text overlays are visible.
fullscreen	boolean	Whether the fullscreen button is visible.
share	boolean	Whether the share button is visible.
settings	boolean	Whether the settings button is visible.

skin Properties

Field Name	Type	Description
text	string	Text color for player skin elements.
buttons	object	Button color configuration.
seekbar	object	Seek bar color configuration.

skin.buttons Properties

Field Name	Type	Description
icon	string	Color of button icons.
background	string	Background color of buttons.

skin.seekbar Properties

Field Name	Type	Description
rail	string	Color of the seek bar rail.
buffer	string	Color of the seek bar buffer indicator.
progress	string	Color of the seek bar progress indicator.
dragger	string	Color of the seek bar dragger handle.

autostartOnViewable Properties

Field Name	Type	Description
state	boolean	Whether autostart on viewable is enabled.
onMobile	boolean	Whether autostart on viewable is enabled on mobile.
onData	boolean	Whether autostart on viewable is enabled on mobile data.
percentageViewable	float	Percentage of the player that must be visible to trigger autostart (0.0 to 1.0).

autopauseOnViewable Properties

Field Name	Type	Description
state	boolean	Whether auto-pause on viewable is enabled.
percentageViewable	float	Percentage of the player that must be hidden to trigger pause (0.0 to 1.0).

If the action is successful, the service sends back an HTTP 200 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed