GET Video Config

Overview

---

The following table contains important information about the GET method in regards to receiving the video config.

GET Video Config
Method	GET
URL or Endpoint	/video/videoId/playerId
Headers	Authorization
Parameters	playerId, videoId, api-version
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 player.
videoId	Yes	string	Unique Id of the video.
api-version	No	string	Correct api-version.

Request Body

The request does not contain a request body

Response

{
  "videoId": "{videoId}",
  "file": "{file}",
  "title": "{title}",
  "description": "{description}",
  "publishDate": "{publishDate}",
  "publishEndDate": "{publishEndDate}",
  "thumbnail": "{thumbnail}",
  "filmstrip": "{filmstrip}",
  "filmstripVtt": "{filmstripVtt}",
  "private": false,
  "passwordProtected": false,
  "passwordProtectedTitle": null,
  "passwordProtectedDescription": null,
  "chapterState": false,
  "chapterPath": null,
  "assetId": "{assetId}",
  "hasGeoRestriction": false,
  "geoRestrictionLink": null,
  "hasDrm": false,
  "drmLicenseUrl": null,
  "fpsCertificateUrl": null,
  "widevineLicenseUrl": null,
  "castContentType": null,
  "castVideoSource": null,
  "live": false,
  "liveType": null,
  "maxLiveBackDuration": 0,
  "autoRelated": null,
  "relatedVideos": null,
  "shareUrl": "{shareUrl}",
  "source": null,
  "author": null,
  "advertising": false,
  "showEngagementHeatmap": false,
  "adId": null,
  "startTime": 0,
  "tracks": [
    {
      "file": "{trackFile}",
      "lang": "{lang}",
      "label": "{label}"
    }
  ],
  "flags": [],
  "tags": [],
  "ads": {
    "type": null,
    "isVmap": false,
    "enableProgrammability": false,
    "vmap": null,
    "skipAllAds": false,
    "vpAIDmode": null,
    "adBreaks": [],
    "bidding": false,
    "bidders": [],
    "adFunctions": [],
    "enableDemandManager": false,
    "demandManager": null,
    "frequency": null,
    "maxCap": 0,
    "initialDelay": null,
    "adCycleDelayMs": null,
    "adRetryLimit": null,
    "adCycleRestartMs": null,
    "banner": null
  },
  "playlist": {
    "state": false,
    "playlistId": null,
    "playlistVideoIndex": 0,
    "algorithm": null,
    "shareUrl": null,
    "displayType": null,
    "fromRecommended": false
  },
  "skipIntro": {
    "state": false,
    "skipFrom": null,
    "skipTo": null
  },
  "customOverlay": {
    "state": false,
    "customOverlays": []
  },
  "videoLocking": {
    "isEnabled": null,
    "value": null
  },
  "videoProperties": []
}

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

The description of the response fields is as follows:

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 and time when the video was published.
publishEndDate	string	Date and time when the video publish period ends.
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.
private	bool	Whether the video is private.
passwordProtected	bool	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	bool	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	bool	Whether the video has geographic restrictions.
geoRestrictionLink	string	Redirect URL shown to geo-blocked users.
hasDrm	bool	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.
live	bool	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.
advertising	bool	Whether advertising is enabled for the video.
showEngagementHeatmap	bool	Whether the engagement heatmap is displayed on the seek bar.
adId	string	Identifier of the ad schedule associated with the video.
startTime	integer	Start time offset in seconds for video playback.
tracks	array	List of subtitle/caption tracks for the video.
flags	array	List of flags associated with the video.
tags	array	List of tags associated with the video.
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.
customOverlay	object	Custom overlay configuration for the video.
videoLocking	object	Video locking configuration.
videoProperties	array	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	bool	Whether the ad schedule uses VMAP format.
enableProgrammability	bool	Whether ad programmability is enabled.
vmap	string	URL of the VMAP ad schedule.
skipAllAds	bool	Whether all ads can be skipped.
vpAIDmode	string	VPAID rendering mode.
adBreaks	array	List of ad break configurations.
bidding	bool	Whether header bidding is enabled.
bidders	array	List of header bidding bidder configurations.
adFunctions	array	List of ad macro function configurations.
enableDemandManager	bool	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	Delay in milliseconds between ad cycles.
adRetryLimit	integer	Maximum number of ad request retries on failure.
adCycleRestartMs	integer	Time in milliseconds before an ad cycle restarts.
banner	object	Banner ad configuration.

playlist Properties

Field Name	Type	Description
state	bool	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	bool	Whether the playlist is generated from recommendations.

skipIntro Properties

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

customOverlay Properties

Field Name	Type	Description
state	bool	Whether custom overlays are enabled.
customOverlays	array	List of custom overlay configurations.

videoLocking Properties

Field Name	Type	Description
isEnabled	bool	Whether video locking is enabled.
value	integer	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.

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