Analytics API Fields

Suggest Edits

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 fields.

Overview

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 fields.

Player API Fields

These fields are being collected when monitoring a normal video (not an Ad).

Dimension	Data Type	Description	Unit
activePlayerStartuptime	metric	Impressions that loaded the player in the foreground
ad	boolean	Is an ad playing?
analyticsVersion	string	Version of the collector
audioBitrate	int	Current audio bitrate	bits per second
audioCodec	string	Audio codec of currently playing stream
audioLanguage	string	Audio track language of the stream
autoplay	boolean	Is autoplay activated?
browser	string	The browser of the client
browserIsBot	boolean	Is a bot playing the video?
browserVersionMajor	string	Major version of the used browser
browserVersionMinor	string	Minor version of the used browser
buffered	int	Duration that the player buffered	milliseconds
cdnProvider	string	CDN Provider used to deliver the video
city	string	Approximate cIty of the viewer
country	string	Approximate country of the viewer
customData1-5	string	Optional free-form data
customUserId	string	User-ID in the customer system
day	int	Date format	UNIX Timestamp in ms
deviceClass	string	Type of device (desktop, phone, tablet)
deviceType	string	Mobile device type used (iPhone/Samsung etc..)
domain	string	Domain the player was loaded on
downloadSpeed	int	Summary of observed download speed measurements	bits/s
drmLoadTime	int	Time to aquire the DRM license	milliseconds
drmType	string	Type of DRM used
droppedFrames	int	Dropped Frames during playback
duration	int	Duration of the sample	milliseconds
errorCode	string	Error code according to player documentation
errorMessage	string	Error message provided by player
errorRate	int	Total number of errors [over] total page loads	percentage
errorData	string	Additional errorData from stack trace
experimentName	string	A/B test experiment name
hour	int	Date format	UNIX Timestamp
impressionId	string	Random UUID that is used to identify a play session	UUID
ipAddress	string	IP address of the user (anonymized by stripping out the last byte in all cases)
isCasting	boolean	Chromecast active?
isLive	boolean	Is the stream a live or vod?
isMuted	boolean	Is the player currently muted?
isp	string	Internet service provider
key	string	Analytics license key
language	string	Language set in the browser
licenseKey	string	Analytics license key
m3u8Url	string	URL of the HLS source
minute	int	Date format	UNIX Timestamp
month	int	Date format	UNIX Timestamp
mpdUrl	string	URL of the DASH source
operatingsystem	string	OS name (Windows, iOS, Android..)
operatingsystemVersionMajor	string	Major version of the operating system
pageLoadTime	int	How long did the page take to load?	milliseconds
pageLoadType	boolean	Was the player loaded in the foreground?
path	string	HTTP path e.g. .../about
paused	int	Milliseconds in paused state	milliseconds
platform	string	Platform of the collector (web, ios, android)
played	int	Milliseconds in played state	milliseconds
player	string	Player name
playerKey	string	Player license key
playerStartupTime	int	Duration it took to start up the player	milliseconds
playerTech	string	HTML or native playback
playerVersion	string	Player version
progUrl	string	URL of the progressive MP4 source
region	string	Approximate region or state of the viewer
scaleFactor	float	Was the playback window greater or smaller than the video size?	ratio
screenHeight	int	Screen as reported by the browser	pixels
screenWidth	int	Screen as reported by the browser	pixels
seeked	int	Duration it took the player to seek	milliseconds
segmentName	string	Name of the downloaded segment
segmentDownloadCount	int	Total number of downloaded segments
segmentDownloadSize	int	Total download size in bytes	bytes
segmentDownloadTime	int	Total time spent downloading segments	milliseconds
sequenceNumber	int	Number of data packets sent to the backend (incrementing)
size	int	Window Size (reserved)	pixels
startupTime	int	Sum of Player + Video Startup Time	milliseconds
state	string	Internal state of the analytics state machine
streamFormat	string	HLS, DASH or Progressive MP4 Stream
subtitleEnabled	string	Whether subtitles were enabled by viewer or not
subtitleLanguage	string	Selected subtitle language
supportedVideoCodecs	string	Video codecs supported by platform/browser
time	int	Current time	UNIX Timestamp in ms
userAgent	string	Browser agent
userId	string	Random UUID that is persisted across play sessions	UUID
version	string	Version of the player
videoBitrate	int	Bitrate of the video rendition played	bits per second
videoCodec	string	Video codec of current stream
videoDuration	int	Duration of the video	milliseconds
videoId	string	ID of the video, provided by customer
videoPlaybackHeight	int	Resolution of the video rendition played	pixels
videoPlaybackWidth	int	Resolution of the video rendition played	pixels
videostartFailed	boolean	True if starting the video failed
videostartFailedReason	string	Reason why starting the video failed
videoStartupTime	int	How long did it take to load the first frame?	milliseconds
videoTimeEnd	int	End time of the sample in the video	milliseconds
videoTimeStart	int	Start time of the sample in the video	milliseconds
videoTitle	string	Human readable title of the video, provided by customer
videoWindowHeight	int	Size of the video player on the site	pixels
videoWindowWidth	int	Size of the video player on the site	pixels

Ad Fields

Dimension	Data Type	Description	Unit
adClickthroughURL	string	The url the user will be redirected to when clicking the ad
adDescription	string	The description of the ad from the VAST response
adDuration	int	The duration of the ad	milliseconds
adFallbackIndex	int	The position in the list of fallback tags, if the primary ad tag wasn't available
adId	string	Identifier for the ad – might be autogenerated.
adIdPlayer	string	The 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
adImpressionsId	string	Unique ID for every ad impression	UUID
adIsPersistent	boolean	If set, the ad tag will be processed and rescheduled automatically when a new source is loaded
adModule	string	The module used to play an ad (Bitmovin Ad Module, IMA Ad Module, etc.)
adOffset	string	The requested position specified in the ad break config, if it's a mid roll ad
adPlaybackHeight	int	The height of the ad asset	pixels
adPlaybackWidth	int	The width of the ad asset	pixels
adPodPosition	int	The 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
adPosition	string	Pre, mid or post roll
adPreloadOffset	int	Specifies 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
adReplaceContentDuration	int	Specifies for how long the ad break(s) should replace the main video content	milliseconds
adScheduleTime	int	The time for which the AdBreak is scheduled for	milliseconds
adSkippableAfter	int	Time after which the ad is skippable – if the ad is not skippable, this property is not set	milliseconds
adSkippable	boolean	Specifies whether the ad is skippable or not
adStartupTime	int	Time between an ad break start and an actual ad start	milliseconds
adSystem	string	The name of the ad system that returned the ad
adTagPath	string	Defines the path part of the ad manifest url
adTagServer	string	Defines the server part of the ad manifest url
adTagType	string	Specifies whether the ad tag is a VAST, VMAP or VPAID tag
adTagUrl	string	Defines the url to an ad manifest
adTitle	string	A common name for the ad, specified in InLine.AdTitle in the VAST response
adWrapperAdsCount	int	The number of the wrapper ads
advertiserName	string	The name of the advertiser as defined by the ad serving party
analyticsVersion	string	Version of the Analytics collector
apiFramework	string	Identifies the API needed to execute an interactive media file or to communicate with the creative
asn	string	ASN of the user based on IP
audioBitrate	int	Current audio bitrate	bits per second
audioCodec	string	Audio codec of the video
autoplay	boolean	Is autoplay activated for the ad?
browser	string	The browser of the client
browserVersionMajor	string	Major version of the used Browser
cdnProvider	string	CDN provider used to play out content
city	string	Approximate cIty of the user
clickPercentage	int	Percentage within the ad until a user clicked on it
clickPosition	int	Time played until the ad was clicked	milliseconds
clicked	boolean	Did a viewer click the link in the ad?
clientTime	int	Timestamp on the client device	UNIX timestamp
closePercentage	int	Percentage within the ad until a user closed it
closePosition	int	Time played until an ad was closed	milliseconds
closed	boolean	Did the viewer close an ad?
completed	boolean	Did a viewer complete an ad?
country	string	Approximate country of the user
creativeAdId	string	Returns the ISCI (Industry Standard Commercial Identifier) code for an ad
creativeID	string	Returns the ID of the selected creative for the ad
day	int	Date format	UNIX timestamp
dealId	string	Returns the first deal ID present in the wrapper chain for the current ad, starting from the top
deviceClass	string	Type of device (desktop, phone, tablet)
deviceType	string	What mobile device type was used (iPhone/Samsung etc..)
domain	string	Domain the player was loaded on
errorCode	string	Error Code according to ad-SDK documentation
errorPercentage	int	Time within the ad at which the error occured	milliseconds
errorPosition	int	View time until the error occured	milliseconds
exitPosition	int	Time played until the user exited the ad (e.g. by closing the browser window)	milliseconds
experimentName	string	A/B test experiment name
hour	int	Date format	UNIX timestamp
ipAddress	string	IP address of the user (anonymized by stripping out the last byte in all cases)
isLinear	boolean	Determines whether an ad is linear, i.e. playback of main content needs to be paused for the ad
isp	string	Internet service provider
language	string	Language set in the browser
licenseKey	string	Analytics license key
manifestDownloadTime	int	The total time it took for the ad manifest to be downloaded	milliseconds
mediaPath	string	The path part of the url of the media file for the ad
mediaServer	string	The server part of the url of the media file for the ad
mediaUrl	string	The url of the corresponding media file for the ad
midpoint	int	Was the midpoint reached?
minSuggestedDuration	int	The minimum suggested duration that the creative should be played	milliseconds
minute	int	Minute the ad impression occured in	UNIX Timestamp
month	int	Month the ad impression occured in	UNIX Timestamp
operatingsystem	string	OS name (Windows, iOS, Android..)
operatingsystemVersionMajor	string	Major version of the Operating System
pageLoadTime	int	How long did the page take to load?	milliseconds
pageLoadType	boolean	Was the player loaded in the foreground?
path	string	HTTP Path eg /about
percentageInViewport	int	Reports the percentage of the playtime the ad was within the current viewport of the browser and thus potentially visible to the user.
platform	string	Platform of the collector (web, ios, android)
playPercentage	int	What percentage of the ad was actually played?
player	string	Player Name
playerKey	string	Player License Key
playerStartupTime	int	How long did it take to start up the player?	milliseconds
playerTech	string	HTML or Native Playback
playerVersion	string	Player Version
quartile1	boolean	Was the first quartile of the ad reached?
quartile3	boolean	Was the third quartile of the ad reached?
region	string	Approximate state of the user
scaleFactor	int	Was the playback window greater or smaller than the video size?
screenHeight	int	Screen as reported by the Browser	pixels
screenWidth	int	Screen as reported by the Browser	pixels
size	int	Window Size	pixels
skipPercentage	int	Percentage played when the user skipped the ad
skipPosition	int	Time played until the ad was skipped	milliseconds
skipped	boolean	Specifies whether the ad was skipped
started	boolean	Specifies whether the ad was started
streamFormat	string	HLS or DASH or Progressive MP4 Stream
surveyUrl	string	Returns the URL associated with the survey for a given ad
time	int	Current Time	UNIX Timestamp
timeInViewport	int	Duration for which the ad was in the viewport of the user	milliseconds
timePlayed	int	Duration the ad was played	milliseconds
universalAdIdRegistry	string	The registry associated with cataloging the UniversalAdId of the selected creative for the ad
universalAdIdValue	string	The UniversalAdId of the selected creative for the ad
userId	string	Random UUID that is persisted across play sessions	UUID

Updated 5 months ago