Want to learn more about how to use these data points? Click here to schedule a demo of Datazoom.
Akamai AMP (Android) v.1
root
configuration_id
Released in version 1.23Datazoom Collector configuration ID. Allows customers to differentiate data on the Connector from different Collectors. This could be useful for separating test content from production data.
| Data point type | Metadata |
|---|---|
| Data location | root.configuration_id |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | UUID |
| Example value | DOIKLER-DOIF2353 |
connector_list
Released in version 1.37List of the Connectors configured for this Collector via a Datazoom Data Pipe.
| Data point type | Metadata |
|---|---|
| Data location | root.connector_list |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | comma separated list |
| Example value | dz-connector-google-analytics,dz-connector-mixpanel |
customer_code
Released in version 1.23Unique identifier for the Datazoom customer that generated the event.
| Data point type | Metadata |
|---|---|
| Data location | root.customer_code |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | UUID |
| Example value | a573aecc-03c6-472a-b2b9-4704ec9f3a92 |
event_id
Released in version 1.38Unique identifier for each event message fired by a Collector.
| Data point type | Metadata |
|---|---|
| Data location | root.event_id |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | 43DHE-EROILKER-EREOATE |
Provides a UUID that can be used for de-dupping records in the data platform or Connector.
timestamp
Released in version 1.37Epoch UTC time of the event occurrence
| Data point type | Metadata |
|---|---|
| Data location | root.timestamp |
| Data type | numeric |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Minimum value | 1579102499300 |
| Unit | epoch |
| Example value | 1535971954488 |
event.type
Ad Click
Released in version 1.38.1Triggered when the user interacts with an advertisement
| Data point type | Event |
|---|---|
| Data location | event.type.Ad_Click |
| PII handling | None |
| Applicable for | Live VOD Ad |
How many users clicked on a call-to-action link for a given ad?
Ad Complete
Released in version 1.38.1Fired when an ad completes playing back
| Data point type | Event |
|---|---|
| Data location | event.type.Ad_Complete |
| PII handling | None |
| Applicable for | Live VOD Ad |
What percentage of users watched the entire ad?
Ad Error
Released in version 1.38.1Thrown if an error occurs during ad playback or retrieval of an ad
| Data point type | Event |
|---|---|
| Data location | event.type.Ad_Error |
| PII handling | None |
| Applicable for | Live VOD Ad |
How many errors occurred in the video player during ad playback?
Ad First Quartile
Released in version 1.38.1Fired when an advertisement has been played for at least 25% of the total ad duration.
| Data point type | Event |
|---|---|
| Data location | event.type.Ad_First_Quartile |
| PII handling | None |
| Applicable for | Live VOD Ad |
How many users stop watching the ad before it's 25% complete?
Ad FluxData
Released in version 1.38.1Periodic event that contains all of the selected FluxData metrics fired at the specified FluxData interval.
| Data point type | Event |
|---|---|
| Data location | event.type.Ad_FluxData |
| PII handling | None |
| Applicable for | Live VOD Ad |
This heartbeat event can be used for creating time-series charts tracking a user's quality of experience during their playback session.
Ad Impression
Released in version 1.38.1Fired the instant a video ad begins to play
| Data point type | Event |
|---|---|
| Data location | event.type.Ad_Impression |
| PII handling | None |
| Applicable for | Live VOD Ad |
Count how many times a single ad was presented to a user.
Ad Pause
Released in version 1.38.1Fired when the ad is paused. Depending on your implementation pausing an ad may not be allowed.
| Data point type | Event |
|---|---|
| Data location | event.type.Ad_Pause |
| PII handling | None |
| Applicable for | Live VOD Ad |
Track the number of times a user decided to pause an ad during playback.
Ad Play
Released in version 1.38.1Fired whenever an ad starts playing or when an ad is unpaused.
| Data point type | Event |
|---|---|
| Data location | event.type.Ad_Play |
| PII handling | None |
| Applicable for | Live VOD Ad |
Ad Request
Released in version 1.38.1When ad is requested from the ad server.
| Data point type | Event |
|---|---|
| Data location | event.type.Ad_Request |
| PII handling | None |
| Applicable for | Live VOD Ad |
Compare how many ads were requested versus how many were actually played to get a delivery percentage.
Ad Resume
Released in version 1.38.1When playback of the ad is resumed after being paused.
| Data point type | Event |
|---|---|
| Data location | event.type.Ad_Resume |
| PII handling | None |
| Applicable for | Live VOD Ad |
What percentage of users continued watching the ad after initially pausing playback?
Ad Second Quartile
Released in version 1.38.1Fired when an advertisement has been played for at least 50% of the total ad duration.
| Data point type | Event |
|---|---|
| Data location | event.type.Ad_Second_Quartile |
| PII handling | None |
| Applicable for | Live VOD Ad |
How many users stop watching the ad before it's 50% complete?
Ad Seek End
Released in version 1.38.1Event is fired when the ad starts playing again after a seek is completed. Includes attributes from_millis & to_millis to indicate where the user was in the video before the seek & where they ended up after seeking. Depending on your player implementation, user may not be able to seek during ad playback.
| Data point type | Event |
|---|---|
| Data location | event.type.Ad_Seek_End |
| PII handling | None |
| Applicable for | Live VOD Ad |
Examine what parts of the video are re-watched or skipped. Calculate how much of the video was actually watched excluding any time where the user seeked past a portion of the video.
Ad Seek Start
Released in version 1.38.1Fired when user seeks to another part of the ad (jumps to another point of the video). Depending on your player implementation, user may not be able to seek during ad playback.
| Data point type | Event |
|---|---|
| Data location | event.type.Ad_Seek_Start |
| PII handling | None |
| Applicable for | Live VOD Ad |
Count how many times users choose to skip to a different part of the video.
Ad Third Quartile
Released in version 1.38.1Fired when an advertisement has been played for at least 75% of the total ad duration.
| Data point type | Event |
|---|---|
| Data location | event.type.Ad_Third_Quartile |
| PII handling | None |
| Applicable for | Live VOD Ad |
How many users stop watching the ad before it's 75% complete?
Buffer End
Released in version 1.24Event is fired when video starts playing again after a buffer is completed.
| Data point type | Event |
|---|---|
| Data location | event.type.Buffer_End |
| PII handling | None |
| Applicable for | Content Live VOD |
Compare the number of times video successfully resumed playing after buffering with the total number of Buffering events to see what percentage of buffers were irrecoverable.
Buffering
Released in version 1.24Fired when the player starts playback and when the player enters a buffering state
| Data point type | Event |
|---|---|
| Data location | event.type.Buffering |
| PII handling | None |
| Applicable for | Content Live VOD |
Monitor the number of delays of user playback caused by waiting for video to load.
Content First Quartile
Released in version 1.25Fired when a video has been played for at least 25% of the video duration.
| Data point type | Event |
|---|---|
| Data location | event.type.Content_First_Quartile |
| PII handling | None |
| Applicable for | Content VOD |
How many users stop watching the content before it reached 25% complete?
Content Second Quartile
Released in version 1.25Fired when a video has been played for at least 50% of the video duration.
| Data point type | Event |
|---|---|
| Data location | event.type.Content_Second_Quartile |
| PII handling | None |
| Applicable for | Content VOD |
How many users stop watching the content before it reached 50% complete?
Content Third Quartile
Released in version 1.25Fired when a video has been played for at least 75% of the video duration.
| Data point type | Event |
|---|---|
| Data location | event.type.Content_Third_Quartile |
| PII handling | None |
| Applicable for | Content VOD |
How many users stop watching the content before it reached 75% complete?
Custom Event
Released in version 1.34.1Add any user or system behavioral event to the Datazoom data stream. Requires custom coding on the page or in the app by customer developer.
| Data point type | Event |
|---|---|
| Data location | event.type.Custom_Event |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
Record that a user entered a comment on the video during playback. Capture a button from outside the player that was pressed by the user during video playback.
Error
Released in version 1.24Thrown if an error occurs during content playback or retrieval of the video
| Data point type | Event |
|---|---|
| Data location | event.type.Error |
| PII handling | None |
| Applicable for | Content Live VOD |
How many errors occurred in the video player during content playback?
Exit Fullscreen
Released in version 1.24Triggered when user exits fullscreen mode during video playback
| Data point type | Event |
|---|---|
| Data location | event.type.Exit_Fullscreen |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
Used to determine how often users are switching from in-page playback to a full screen experience.
First Frame
Released in version 1.24This event is fired when the video starts playing & is viewable by the user.
| Data point type | Event |
|---|---|
| Data location | event.type.First_Frame |
| PII handling | None |
| Applicable for | Content Live VOD |
Use this to determine the period of time between a user pressing play and the same user viewing their content
FluxData
Released in version 1.23Periodic event that contains all of the selected FluxData metrics fired at the specified FluxData interval.
| Data point type | Event |
|---|---|
| Data location | event.type.FluxData |
| PII handling | None |
| Applicable for | Content Live VOD |
This heartbeat event can be used for creating time-series charts tracking a user's quality of experience during their playback session.
Fullscreen
Released in version 1.24Triggered when user enters fullscreen mode during video playback
| Data point type | Event |
|---|---|
| Data location | event.type.Fullscreen |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
Used to determine how often users are switching from in-page playback to a full screen experience.
Idle
Released in version 1.24This event signifies that the video player has reached an state where there is no present activity. The user has stopped playback or the video player is loaded and waiting for the next piece of content to be selected.
| Data point type | Event |
|---|---|
| Data location | event.type.Idle |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
Use this event to track activities a user may be performing on other parts of the app while the video player is inactive.
Levels Changed
Released in version 1.24This event signifies when the user selects a different preferred playback quality. This is usually represented as a High, Med, Low setting that the user can select depending on their network capability. This event is different than Rendition Change which is fired automatically as video quality is adjusted dynamically as a response to actual network conditions.
| Data point type | Event |
|---|---|
| Data location | event.type.Levels_Changed |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
How many users proactively decide to select a lower quality level to presumably improve playback performance.
Mute
Released in version 1.25Triggered when the player volume has been reduced to zero.
| Data point type | Event |
|---|---|
| Data location | event.type.Mute |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
Pause
Released in version 1.23Event is fired when user hits the Pause button and chooses to temporarily halt video playback.
| Data point type | Event |
|---|---|
| Data location | event.type.Pause |
| PII handling | None |
| Applicable for | Content Live VOD |
Play
Released in version 1.23Event is fired when a user initiates video playback.
| Data point type | Event |
|---|---|
| Data location | event.type.Play |
| PII handling | None |
| Applicable for | Content Live VOD |
Count the number of playback attempts within the app & compare against successful video starts.
Play Request
Released in version 1.24Event signifies the video player requests the video from the server. The trigger could be the user clicking on a play button of a thumbnail. If the video is played automatically, this may be fired when the player starts loading
| Data point type | Event |
|---|---|
| Data location | event.type.Play_Request |
| PII handling | None |
| Applicable for | Content Live VOD |
Identify problems that may be occurring in the video player which prevent successful playback after a user requests a video
Playback Complete
Released in version 1.23This event signifies that the video player has reached the end of the currently playing content.
| Data point type | Event |
|---|---|
| Data location | event.type.Playback_Complete |
| PII handling | None |
| Applicable for | Content VOD |
Compare the number of Play Requests with the number of Playback Complete events to get a percentage of users who watched the entire video.
Player Ready
Released in version 1.24Signifies when the player has been initialized and is ready for playback. This is the earliest point at which any API calls should be made
| Data point type | Event |
|---|---|
| Data location | event.type.Player_Ready |
| PII handling | None |
| Applicable for | Content Live VOD |
Playing
Released in version 1.24The media is no longer blocked from playback, and has started playing.
| Data point type | Event |
|---|---|
| Data location | event.type.Playing |
| PII handling | None |
| Applicable for | Content Live VOD |
Rendition Change
Released in version 1.25When the Player's Adaptive Bitrate Streaming upshifts or downshifts during Content Playback to a different quality level available in the manifest. This event includes absShift attribute identifying the direction of the change.
| Data point type | Event |
|---|---|
| Data location | event.type.Rendition_Change |
| PII handling | None |
| Applicable for | Content Live VOD |
How often does an video change quality during playback due to network bandwidth conditions?
Resize
Released in version 1.24Fired when the player's on-page dimensions have changed. Is not fired in response to a fullscreen change.
| Data point type | Event |
|---|---|
| Data location | event.type.Resize |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
Understand how many users are changing the video player dimensions during video playback.
Resume
Released in version 1.24This event is fired when the user hits the play button after pausing video during playback.
| Data point type | Event |
|---|---|
| Data location | event.type.Resume |
| PII handling | None |
| Applicable for | Content Live VOD |
Compare the amount of time elapsed between user hitting the Pause event and then resuming playback.
Seek
Released in version 1.23Event records when the user interacts with content timeline by moving the playhead position forward or backwards to jump to a specific point on the timeline.
| Data point type | Event |
|---|---|
| Data location | event.type.Seek |
| PII handling | None |
| Applicable for | Content Live VOD |
Count the number of times users choose to seek to another part of the video.
Seeked
Released in version 1.23Event is fired when the user stops moving the playhead position forward or backwards to jump to a specific point on the timeline. This event includes attributes from_millis & to_millis to mark the starting & ending points of a seek event, representing the content timecode in milliseconds
| Data point type | Event |
|---|---|
| Data location | event.type.Seeked |
| PII handling | None |
| Applicable for | Content Live VOD |
Determine what parts of a video were skipped over or re-watched frequently.
Unmute
Released in version 1.25Triggered the player audio has been reactivated.
| Data point type | Event |
|---|---|
| Data location | event.type.Unmute |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
Volume Change
Released in version 1.25Triggered when the player increases or decreases the audio level of the video.
| Data point type | Event |
|---|---|
| Data location | event.type.Volume_Change |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
event.attributes
absShift
Released in version 1.25Describes the direction of the rendition change that occurred during Adaptive Bitrate Streaming. Values ‘up’ or ‘down’ depends on the value of the previous rendition. 'absShift' is an attribute of the Rendition Change event.
| Data point type | Metadata |
|---|---|
| Data location | event.attributes.absShift |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | value list |
| Value list | up, down |
| Example value | up |
Monitor how often the video player is downshifting video quality to account for network conditions.
errorCode
Released in version 1.24Error object representing a code explicitly identified by the player
| Data point type | Metadata |
|---|---|
| Data location | event.attributes.errorCode |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | 1001 |
errorMsg
Released in version 1.24Error object representing a message about the error explicitly identified by the player
| Data point type | Metadata |
|---|---|
| Data location | event.attributes.errorMsg |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | Player failed to launch |
event.metrics
bandwidth
Released in version 1.25Amount of estimated network bandwidth currently available to the end user's device.
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.bandwidth |
| Data type | numeric |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Minimum value | 0 |
| Unit | bits per second |
| Example value | 2152 |
Am I delivering a higher quality video asset to the user than their network connection can handle?
bitrate
Released in version 1.23The bits per second of the currently selected asset from the video manifest. This is a proxy for quality and a good determinant of overall delivery costs/network consumption.
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.bitrate |
| Data type | numeric |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Minimum value | 0 |
| Unit | bits per second |
| Example value | 3127 |
What is the average bitrate of all videos delivered to my users?
bufferFill
Released in version 1.23Percent utilization of playback buffer for storing video segments before they are shown by the video player. A bufferFill near 100% indicates that the video segments are downloading quickly enough to keep pace with the video playback of the user & should produce minimal buffering interruptions.
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.bufferFill |
| Data type | numeric |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Minimum value | 0 |
| Maximum value | 100 |
| Unit | percentage |
| Example value | 80.26 |
Are buffering events directly related to low and frequent bufferFill levels?
currentCaptions
Released in version 1.24Identifies which subtitle or closed captioning track available for the content has been selected by the user. Multiple captioning tracks are usually used for alternate languages. Values returned may vary by content publisher & player.
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.currentCaptions |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | Spanish |
numberOfErrors
Released in version 1.24Running count of the number of errors that have occurred during the user's current session.
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.numberOfErrors |
| Data type | numeric |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Minimum value | 0 |
| Unit | errors |
| Example value | 2 |
numberOfVideos
Released in version 1.24The amount of unique videos watched during the current viewing session
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.numberOfVideos |
| Data type | numeric |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Minimum value | 0 |
| Unit | videos |
| Example value | 2 |
playerState
Released in version 1.24Returns the player's current playback state. (Idle, buffering, playing, paused)
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.playerState |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | Ready |
Correlate the current state of the video player with other activities or actions that are occurring with the user during a session.
playheadPosition
Released in version 1.23Returns the current point in the video timeline in seconds.
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.playheadPosition |
| Data type | numeric |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Minimum value | 0 |
| Unit | seconds |
| Example value | 10.135 |
renditionBitrate
Released in version 1.25Target bitrate of the currently selected video rendition from the manifest. The manifest may contain multiple versions (i.e. renditions) of the video encoded at varying qualities to support varying network conditions.
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.renditionBitrate |
| Data type | numeric |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Minimum value | 0 |
| Unit | k/bits per second |
| Example value | 3000 |
Use rendition attributes to determine if the correct version of the video is being delivered to the client to match the users bandwidth, device & resolution.
renditionHeight
Released in version 1.25Height in pixels of the rendition being played. The manifest may contain multiple versions (i.e. renditions) of the video encoded at varying qualities to support varying network conditions.
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.renditionHeight |
| Data type | numeric |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Minimum value | 0 |
| Unit | pixels |
| Example value | 720 |
Use rendition attributes to determine if the correct version of the video is being delivered to the client to match the users bandwidth, device & resolution.
renditionName
Released in version 1.25Standardized name to represent the rendition currently being played.
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.renditionName |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | 720p |
Use rendition attributes to determine if the correct version of the video is being delivered to the client to match the users bandwidth, device & resolution.
renditionWidth
Released in version 1.25Width of the rendition being played. The manifest may contain multiple versions (i.e. renditions) of the video encoded at varying qualities to support varying network conditions.
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.renditionWidth |
| Data type | numeric |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Minimum value | 0 |
| Unit | pixels |
| Example value | 1280 |
Use rendition attributes to determine if the correct version of the video is being delivered to the client to match the users bandwidth, device & resolution.
timeSinceBufferBegin
Released in version 1.24Time interval since Buffering event for the current content began, reported in milliseconds
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.timeSinceBufferBegin |
| Data type | numeric |
| PII handling | None |
| Applicable for | Content Live VOD |
| Minimum value | 0 |
| Unit | milliseconds |
| Example value | 37 |
timeSinceLastFluxData
Released in version 1.24Time interval since FluxData was last sent for the current content., reported in milliseconds
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.timeSinceLastFluxData |
| Data type | numeric |
| PII handling | None |
| Applicable for | Content Live VOD |
| Minimum value | 0 |
| Unit | milliseconds |
| Example value | 37 |
timeSinceLastRenditionChange
Released in version 1.24Time interval since content playback shifted to a different available quality version from the manifest., reported in milliseconds
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.timeSinceLastRenditionChange |
| Data type | numeric |
| PII handling | None |
| Applicable for | Content Live VOD |
| Minimum value | 0 |
| Unit | milliseconds |
| Example value | 37 |
timeSincePaused
Released in version 1.24Time interval since content playback was paused., reported in milliseconds
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.timeSincePaused |
| Data type | numeric |
| PII handling | None |
| Applicable for | Content Live VOD |
| Minimum value | 0 |
| Unit | milliseconds |
| Example value | 37 |
timeSinceRequested
Released in version 1.24Time interval since content playback was requested, reported in milliseconds
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.timeSinceRequested |
| Data type | numeric |
| PII handling | None |
| Applicable for | Content Live VOD |
| Minimum value | 0 |
| Unit | milliseconds |
| Example value | 37 |
timeSinceSeekBegin
Released in version 1.24Time interval since Seek event during the current content playback began, reported in milliseconds
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.timeSinceSeekBegin |
| Data type | numeric |
| PII handling | None |
| Applicable for | Content Live VOD |
| Minimum value | 0 |
| Unit | milliseconds |
| Example value | 37 |
timeSinceStarted
Released in version 1.24Time interval since current content playback began., reported in milliseconds
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.timeSinceStarted |
| Data type | numeric |
| PII handling | None |
| Applicable for | Content Live VOD |
| Minimum value | 0 |
| Unit | milliseconds |
| Example value | 37 |
totalPlayTime
Released in version 1.24Cumulative time that content & ads have been playing during the current video Session View. Excludes time accrued while user pauses content.
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.totalPlayTime |
| Data type | numeric |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Minimum value | 0 |
| Unit | milliseconds |
| Example value | 124 |
volumeLevel
Released in version 1.25The current playback volume
| Data point type | FluxData |
|---|---|
| Data location | event.metrics.volumeLevel |
| Data type | numeric |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Minimum value | 0 |
| Maximum value | 100 |
| Unit | percentage |
| Example value | 85.2 |
user_details
client_ip
Released in version 1.24IP address of the user's device
| Data point type | Metadata |
|---|---|
| Data location | user_details.client_ip |
| Data type | string |
| PII handling | Reduce Precision |
| Applicable for | Ads Content Live VOD |
| Permitted values | IP address |
| Example value | 173.19.65.222 |
session_id
Released in version 1.23Unique identifier for the user's current Datazoom session. Session will persist as long as the user is viewing content uninterrupted. A 20 minute pause in activity will close the session.
| Data point type | Metadata |
|---|---|
| Data location | user_details.session_id |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | 43DHE-EROILKER-EREOATE |
This is the primary identifier for grouping events generated by Datazoom for analysis and unique user counts.
sessionViewId
Released in version 1.24A unique id for the current video. It is composed of the session_id and an incremental number (1, 2, 3…). Watching the same video during multiple points in a session will create distinct sessionViewId for each view.
| Data point type | Metadata |
|---|---|
| Data location | user_details.sessionViewId |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | UUID incremented |
| Example value | 43DHE-EROILKER-EREOATE-4 |
socket_session_id
Released in version 1.23Internal identifier for Datazoom to manage a user's connection with the Datazoom platform.
| Data point type | Metadata |
|---|---|
| Data location | user_details.socket_session_id |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | 68793-daio7-faoid-d34sa |
user_agent
Released in version 1.23Contains a number of tokens that refer to various aspects of the request, including the browser’s name and version, rendering engine, device’s model number, operating system and its version, etc.
| Data point type | Metadata |
|---|---|
| Data location | user_details.user_agent |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
user_agent is a proxy for uniquely identifying a user.
player
defaultMuted
Released in version 1.25Sets or returns whether the audio/video should be muted by default
| Data point type | Metadata |
|---|---|
| Data location | player.defaultMuted |
| Data type | bool |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | value list |
| Value list | true, false |
| Example value | true |
fullscreen
Released in version 1.24Is the player in fullscreen mode?
| Data point type | Metadata |
|---|---|
| Data location | player.fullscreen |
| Data type | bool |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | value list |
| Value list | true, false |
| Example value | true |
isMuted
Released in version 1.25True if player is muted.
| Data point type | Metadata |
|---|---|
| Data location | player.isMuted |
| Data type | bool |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | value list |
| Value list | true, false |
| Example value | true |
playerName
Released in version 1.23States which video player that generated the event
| Data point type | Metadata |
|---|---|
| Data location | player.playerName |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | JW Player |
playerVersion
Released in version 1.23States the version of the video player that generated the event
| Data point type | Metadata |
|---|---|
| Data location | player.playerVersion |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | 8.01 |
readyState
Released in version 1.24Returns the current ready state of the audio/video
| Data point type | Metadata |
|---|---|
| Data location | player.readyState |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | 1 |
streamingProtocol
Released in version 1.24What streaming format is being used for the content?
| Data point type | Metadata |
|---|---|
| Data location | player.streamingProtocol |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | value list |
| Value list | MPEG-DASH, HLS, HDS, Smooth, WebRTC, RTMP, RTSP, Flash, MP4, MPEG2-TS, 3GPP, Quicktime, AVI, Windows Media |
| Example value | HLS |
streamingType
Released in version 1.24Describes if the content being streamed is Live or on demand.
| Data point type | Metadata |
|---|---|
| Data location | player.streamingType |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | value list |
| Value list | Live, VOD |
| Example value | Live |
device
device_id
Released in version 1.23Unique identifier of the user's device.
| Data point type | Metadata |
|---|---|
| Data location | device.device_id |
| Data type | string |
| PII handling | Anonymize |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
This can be used as a proxy for User if user is anonymous.
deviceName
Released in version 1.24Name of the device model used by the viewer
| Data point type | Metadata |
|---|---|
| Data location | device.deviceName |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | iPad Mini 4 |
deviceType
Released in version 1.23Describes the type of device being used during the session. phone, tablet, desktop, connected device, game console
| Data point type | Metadata |
|---|---|
| Data location | device.deviceType |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | value list |
| Value list | pc, mobile, tablet, ott device, tv, game console, wearable |
| Example value | pc |
Can be used to group attributes by device platform type for better understanding of app performance on different platforms.
orientation
Released in version 1.24The directional orientation that the user is holding their mobile device
| Data point type | Metadata |
|---|---|
| Data location | device.orientation |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | value list |
| Value list | landscape, portrait |
| Example value | portrait |
os
Released in version 1.24Operating System of the user's device
| Data point type | Metadata |
|---|---|
| Data location | device.os |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | OS X |
osVersion
Released in version 1.24Version of Operating System being used during the session
| Data point type | Metadata |
|---|---|
| Data location | device.osVersion |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | 10.14 |
video
duration
Released in version 1.23The total length of the media file, reported in decimal seconds
| Data point type | Metadata |
|---|---|
| Data location | video.duration |
| Data type | numeric |
| PII handling | None |
| Applicable for | Ads Content VOD |
| Minimum value | 0 |
| Unit | seconds |
| Example value | 25.49 |
resolutionHeight
Released in version 1.24Height dimension in pixels of the current playback area.
| Data point type | Metadata |
|---|---|
| Data location | video.resolutionHeight |
| Data type | numeric |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Minimum value | 1 |
| Unit | pixels |
| Example value | 720 |
Use this in conjunction with renditionHeight to determine if the user is watching the video in a shrunken or expanded state.
resolutionWidth
Released in version 1.24Width dimension in pixels of the current playback area.
| Data point type | Metadata |
|---|---|
| Data location | video.resolutionWidth |
| Data type | numeric |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Minimum value | 1 |
| Unit | pixels |
| Example value | 1280 |
Use this in conjunction with renditionWidth to determine if the user is watching the video in a shrunken or expanded state.
source
Released in version 1.23Returns the URL of the current media file
| Data point type | Metadata |
|---|---|
| Data location | video.source |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | URL |
| Example value | http://... |
title
Released in version 1.37Provides the title of current asset being played
| Data point type | Metadata |
|---|---|
| Data location | video.title |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | What About Bob? |
videoType
Released in version 1.24Is this Ad or Content?
| Data point type | Metadata |
|---|---|
| Data location | video.videoType |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | value list |
| Value list | Ad, Content |
| Example value | Ad |
geo_location
city
Released in version 1.24The city or town where the user is located
| Data point type | Metadata |
|---|---|
| Data location | geo_location.city |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | Santa Rosa Beach |
countryCode
Released in version 1.24The country from which the browser initiated the event. For a list of country codes, see ISO 3166-1 alpha-2 .
| Data point type | Metadata |
|---|---|
| Data location | geo_location.countryCode |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | 2 letter code |
| Example value | US |
latitude
Released in version 1.24Location information for the user
| Data point type | Metadata |
|---|---|
| Data location | geo_location.latitude |
| Data type | numeric |
| PII handling | Reduce Precision |
| Applicable for | Ads Content Live VOD |
| Minimum value | -90 |
| Maximum value | 90 |
| Unit | degrees |
| Example value | 30.3659 |
longitude
Released in version 1.24Location information for the user
| Data point type | Metadata |
|---|---|
| Data location | geo_location.longitude |
| Data type | numeric |
| PII handling | Reduce Precision |
| Applicable for | Ads Content Live VOD |
| Minimum value | -180 |
| Maximum value | 180 |
| Unit | degrees |
| Example value | -86.2458 |
region
Released in version 1.24The specific administrative division within a country where the event occurred. In the United States, regions correspond to state names ; for example, Washington or New York.
| Data point type | Metadata |
|---|---|
| Data location | geo_location.region |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | Florida |
regionCode
Released in version 1.24The specific administrative division within a country where the event occurred. In the United States, regions correspond to state codes ; for example, WA or NY.
| Data point type | Metadata |
|---|---|
| Data location | geo_location.regionCode |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | 2 letter code |
| Example value | FL |
zipCode
Released in version 1.24The specific administrative division within a country where the event occurred. In the United States, zip codes correspond to postal region locator
| Data point type | Metadata |
|---|---|
| Data location | geo_location.zipCode |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | 32459 |
network
asn
Released in version 1.24Autonomous System Number: a unique number identifying a group of IP networks that serves the content to the end-user. Client ASN as determined from a lookup of the client IP
| Data point type | Metadata |
|---|---|
| Data location | network.asn |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | AS30036 Mediacom Communications Corp |
ASN is a proxy for the customer's ISP which can be used for analyzing usage by ISP to identify problems that might be related to the ISP
asnOrganization
Released in version 1.24The organization that owns the Autonomous System Number. Often an ISP, sometimes a private company or institution.
| Data point type | Metadata |
|---|---|
| Data location | network.asnOrganization |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | MEDIACOM |
ASN is a proxy for the customer's ISP which can be used for analyzing usage by ISP to identify problems that might be related to the ISP
connectionType
Released in version 1.24The type of network connection currently being used to access the content
| Data point type | Metadata |
|---|---|
| Data location | network.connectionType |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | value list |
| Value list | WiFi, Mobile, LAN |
| Example value | WiFi |
isp
Released in version 1.24Name of the end-user's internet service provider.
| Data point type | Metadata |
|---|---|
| Data location | network.isp |
| Data type | string |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
| Permitted values | any |
| Example value | Mediacom Communications Corp |
Can be used for analyzing usage by ISP to identify problems that might be related to the ISP
custom
customMetadata
Released in version 1.34.1Customers can add any user or system data to the Datazoom data stream. Requires custom coding on the page or in the app by customer developer.
| Data point type | Metadata |
|---|---|
| Data location | custom.customMetadata |
| PII handling | None |
| Applicable for | Ads Content Live VOD |
Comments
0 comments
Article is closed for comments.