[object Object] Icon

Encoding
Learn how to create, start, manage and modify Encodings

[object Object] Icon

Player
Learn how to create, start, manage and modify Players

[object Object] Icon

Analytics
Learn how to create, start, manage and modify Analyticss

Docs Home
User shortcuts for search
Focus by pressing f
Hide results by pressing Esc
Navigate via   keys

Wed Jan 29 2020

Analytics API Dimensions

Wed Jan 29 2020

OverviewLink Icon

All the data you can find in the Analytics Dashboard can be queried using the Bitmovin Analytics API as well. See this list for a complete overview of available player and advertising dimensions.

Player DimensionsLink Icon

DimensionData TypeDescriptionUnit
activePlayerStartuptimemetricImpressions that loaded the player in the foreground
adbooleanIs an ad playing?
analyticsVersionstringVersion of the collector
asnstringASN of the user-based on IP
audioBitrateintCurrent audio bitratebits per second
audioCodecstringAudio codec of currently playing stream
audioLanguagestringAudio track language of the stream
autoplaybooleanIs autoplay activated?
browserstringThe browser of the client
browserIsBotbooleanIs a bot playing the video?
browserVersionMajorstringMajor version of the used browser
browserVersionMinorstringMinor version of the used browser
bufferedintDuration that the player bufferedmilliseconds
cdnProviderstringCDN Provider used to deliver the video
citystringApproximate cIty of the viewer
countrystringApproximate country of the viewer
customData1-5stringOptional free-form data
customUserIdstringUser-ID in the customer system
dayintDate formatUNIX Timestamp in ms
deviceClassstringType of device (desktop, phone, tablet)
deviceTypestringMobile device type used (iPhone/Samsung etc..)
domainstringDomain the player was loaded on
downloadSpeedintSummary of observed download speed measurementsmilliseconds
drmLoadTimeintTime to aquire the DRM licensemilliseconds
drmTypestringType of DRM used
droppedFramesintDropped Frames during playback
durationintDuration of the samplemilliseconds
errorCodestringError code according to player documentation
errorMessagestringError message provided by player
errorRateintTotal number of errors [over] total page loadspercentage
experimentNamestringA/B test experiment name
hourintDate formatUNIX Timestamp
impressionIdstringRandom UUID that is used to identify a play sessionUUID
ipAddressstringIP address of the user (anonymized by stripping out the last byte in all cases)
isCastingbooleanChromecast active?
isLivebooleanIs the stream a live or vod?
isMutedbooleanIs the player currently muted?
ispstringInternet service provider
keystringAnalytics license key
languagestringLanguage set in the browser
licenseKeystringAnalytics license key
m3u8UrlstringURL of the HLS source
minuteintDate formatUNIX Timestamp
monthintDate formatUNIX Timestamp
mpdUrlstringURL of the DASH source
operatingsystemstringOS name (Windows, iOS, Android..)
operatingsystemVersionMajorstringMajor version of the operating system
pageLoadTimeintHow long did the page take to load?milliseconds
pageLoadTypebooleanWas the player loaded in the foreground?
pathstringHTTP path e.g. .../about
pausedintMilliseconds in paused statemilliseconds
platformstringPlatform of the collector (web, ios, android)
playedintMilliseconds in played statemilliseconds
playerstringPlayer name
playerKeystringPlayer license key
playerStartupTimeintDuration it took to start up the playermilliseconds
playerTechstringHTML or native playback
playerVersionstringPlayer version
progUrlstringURL of the progressive MP4 source
regionstringApproximate region or state of the viewer
scaleFactorfloatWas the playback window greater or smaller than the video size?ratio
screenHeightintScreen as reported by the browserpixels
screenWidthintScreen as reported by the browserpixels
seekedintDuration it took the player to seekmilliseconds
sequenceNumberintNumber of data packets sent to the backend (incrementing)
sizeintWindow Size (reserved)pixels
startupTimeintSum of Player + Video Startup Timemilliseconds
statestringInternal state of the analytics state machine
streamFormatstringHLS, DASH or Progressive MP4 Stream
subtitleEnabledstringWhether subtitles were enabled by viewer or not
subtitleLanguagestringSelected subtitle language
supportedVideoCodecsstringVideo codecs supported by platform/browser
timeintCurrent timeUNIX Timestamp in ms
userAgentstringBrowser agent
userIdstringRandom UUID that is persisted across play sessionsUUID
versionstringVersion of the player
videoBitrateintBitrate of the video rendition playedbits per second
videoCodecstringVideo codec of current stream
videoDurationintDuration of the videomilliseconds
videoIdstringID of the video, provided by customer
videoPlaybackHeightintResolution of the video rendition playedpixels
videoPlaybackWidthintResolution of the video rendition playedpixels
videostartFailedbooleanTrue if starting the video failed
videostartFailedReasonstringReason why starting the video failed
videoStartupTimeintHow long did it take to load the first frame?milliseconds
videoTimeEndintEnd time of the sample in the videomilliseconds
videoTimeStartintStart time of the sample in the videomilliseconds
videoTitlestringHuman readable title of the video, provided by customer
videoWindowHeightintSize of the video player on the sitepixels
videoWindowWidthintSize of the video player on the sitepixels

Ad DimensionsLink Icon

DimensionData TypeDescriptionUnit
adClickthroughURLstringThe url the user will be redirected to when clicking the ad
adDescriptionstringThe description of the ad from the VAST response
adDurationintThe duration of the admilliseconds
adFallbackIndexintThe position in the list of fallback tags, if the primary ad tag wasn't available
adIdstringIdentifier for the ad – might be autogenerated.
adIdPlayerstringThe id of the corresponding AdBreakConfig. If the AdBreak was generated out of a VMAP tag, then the ID present in the VMAP tag will be taken – if none is present in the VMAP tag it will be generated
adImpressionsIdstringUnique ID for every ad impressionUUID
adIsPersistentbooleanIf set, the ad tag will be processed and rescheduled automatically when a new source is loaded
adModulestringThe module used to play an ad (Bitmovin Ad Module, IMA Ad Module, etc.)
adOffsetstringThe requested position specified in the ad break config, if it's a mid roll ad
adPlaybackHeightintThe height of the ad assetpixels
adPlaybackWidthintThe width of the ad assetpixels
adPodPositionintThe position of this ad within an ad pod. Will be 1 for standalone ads. Podding provides publishers the ability to return multiple ads from a single ad request
adPositionstringPre, mid or post roll
adPreloadOffsetintSpecifies how many milliseconds the ad tag should start pre-loading before the ad break starts playing (and if possible the media files of the resulting ad response)milliseconds
adReplaceContentDurationintSpecifies for how long the ad break(s) should replace the main video contentmilliseconds
adScheduleTimeintThe time for which the AdBreak is scheduled formilliseconds
adSkippableAfterintTime after which the ad is skippable – if the ad is not skippable, this property is not setmilliseconds
adSkippablebooleanSpecifies whether the ad is skippable or not
adStartupTimeintTime between an ad break start and an actual ad startmilliseconds
adSystemstringThe name of the ad system that returned the ad
adTagPathstringDefines the path part of the ad manifest url
adTagServerstringDefines the server part of the ad manifest url
adTagTypestringSpecifies whether the ad tag is a VAST, VMAP or VPAID tag
adTagUrlstringDefines the url to an ad manifest
adTitlestringA common name for the ad, specified in InLine.AdTitle in the VAST response
adWrapperAdsCountintThe number of the wrapper ads
advertiserNamestringThe name of the advertiser as defined by the ad serving party
analyticsVersionstringVersion of the Analytics collector
apiFrameworkstringIdentifies the API needed to execute an interactive media file or to communicate with the creative
asnstringASN of the user based on IP
audioBitrateintCurrent audio bitratebits per second
audioCodecstringAudio codec of the video
autoplaybooleanIs autoplay activated for the ad?
browserstringThe browser of the client
browserVersionMajorstringMajor version of the used Browser
cdnProviderstringCDN provider used to play out content
citystringApproximate cIty of the user
clickPercentageintPercentage within the ad until a user clicked on it
clickPositionintTime played until the ad was clickedmilliseconds
clickedbooleanDid a viewer click the link in the ad?
clientTimeintTimestamp on the client deviceUNIX timestamp
closePercentageintPercentage within the ad until a user closed it
closePositionintTime played until an ad was closedmilliseconds
closedbooleanDid the viewer close an ad?
completedbooleanDid a viewer complete an ad?
countrystringApproximate country of the user
creativeAdIdstringReturns the ISCI (Industry Standard Commercial Identifier) code for an ad
creativeIDstringReturns the ID of the selected creative for the ad
dayintDate formatUNIX timestamp
dealIdstringReturns the first deal ID present in the wrapper chain for the current ad, starting from the top
deviceClassstringType of device (desktop, phone, tablet)
deviceTypestringWhat mobile device type was used (iPhone/Samsung etc..)
domainstringDomain the player was loaded on
errorCodestringError Code according to ad-SDK documentation
errorPercentageintTime within the ad at which the error occuredmilliseconds
errorPositionintView time until the error occuredmilliseconds
exitPositionintTime played until the user exited the ad (e.g. by closing the browser window)milliseconds
experimentNamestringA/B test experiment name
hourintDate formatUNIX timestamp
ipAddressstringIP address of the user (anonymized by stripping out the last byte in all cases)
isLinearbooleanDetermines whether an ad is linear, i.e. playback of main content needs to be paused for the ad
ispstringInternet service provider
languagestringLanguage set in the browser
licenseKeystringAnalytics license key
manifestDownloadTimeintThe total time it took for the ad manifest to be downloadedmilliseconds
mediaPathstringThe path part of the url of the media file for the ad
mediaServerstringThe server part of the url of the media file for the ad
mediaUrlstringThe url of the corresponding media file for the ad
midpointintWas the midpoint reached?
minSuggestedDurationintThe minimum suggested duration that the creative should be playedmilliseconds
minuteintMinute the ad impression occured inUNIX Timestamp
monthintMonth the ad impression occured inUNIX Timestamp
operatingsystemstringOS name (Windows, iOS, Android..)
operatingsystemVersionMajorstringMajor version of the Operating System
pageLoadTimeintHow long did the page take to load?milliseconds
pageLoadTypebooleanWas the player loaded in the foreground?
pathstringHTTP Path eg /about
percentageInViewportintReports the percentage of the playtime the ad was within the current viewport of the browser and thus potentially visible to the user.
platformstringPlatform of the collector (web, ios, android)
playPercentageintWhat percentage of the ad was actually played?
playerstringPlayer Name
playerKeystringPlayer License Key
playerStartupTimeintHow long did it take to start up the player?milliseconds
playerTechstringHTML or Native Playback
playerVersionstringPlayer Version
quartile1booleanWas the first quartile of the ad reached?
quartile3booleanWas the third quartile of the ad reached?
regionstringApproximate state of the user
scaleFactorintWas the playback window greater or smaller than the video size?
screenHeightintScreen as reported by the Browserpixels
screenWidthintScreen as reported by the Browserpixels
sizeintWindow Sizepixels
skipPercentageintPercentage played when the user skipped the ad
skipPositionintTime played until the ad was skippedmilliseconds
skippedbooleanSpecifies whether the ad was skipped
startedbooleanSpecifies whether the ad was started
streamFormatstringHLS or DASH or Progressive MP4 Stream
surveyUrlstringReturns the URL associated with the survey for a given ad
timeintCurrent TimeUNIX Timestamp
timeFromContentintTime from last frame of the content to first frame of the admilliseconds
timeInViewportintDuration for which the ad was in the viewport of the usermilliseconds
timePlayedintDuration the ad was playedmilliseconds
timeToContentintTime from last frame of the ad to the first frame of the contentmilliseconds
universalAdIdRegistrystringThe registry associated with cataloging the UniversalAdId of the selected creative for the ad
universalAdIdValuestringThe UniversalAdId of the selected creative for the ad
userIdstringRandom UUID that is persisted across play sessionsUUID

Give us feedback