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