Events
Ad Break Start
event
Fired at the beginning of an advertising break, signifies that content has been delayed while the advertisements are played.
Applicable for: Live, VOD, Ad
Node Location: event.type : ad_break_start
Max Decimals: 0
Ad Break End
event
Fired at the end of an advertising break, signifies that the advertisements have ended and content is ready to resume.
Applicable for: Live, VOD, Ad
Node Location: event.type : ad_break_end
Max Decimals: 0
Ad Click
event
Triggered when the user interacts with an advertisement
Applicable for: Live, VOD, Ad
Node Location: event.type : ad_click
Max Decimals: 0
Ad Impression
event
Fired when an Ad impression is recorded by the video player.
Applicable for: Live, VOD, Ad
Node Location: event.type : ad_impression
Max Decimals: 0
Ad Skip
event
This event is triggered when a user chooses to skip the currently playing ad and go directly to the content..
Applicable for: Live, VOD, Ad
Node Location: event.type : ad_skip
Max Decimals: 0
Audio Track Changed
event
This event signifies when the user has chosen to switch to a different audio track during playback.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : audio_track_changed
Max Decimals: 0
Buffer Start
event
Buffer Start identifies anytime the player has to wait for the video buffer to fill with video segments . This event includes all visible buffering activity including during playback startup, connectivity issues or buffering that may occur when resuming after seek or pause.
Use Case
When the Buffer Start event is thrown and a value received, it is correlated to a specific playback time by comparing it to the playback length within the manifest. Once the Buffer End event has thrown, the delta between the two can be used to forensically analyze a series of chunks to determine the veracity of the content files. If the issue is corrupt chunks, a new encode can be produced.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : buffer_start
Max Decimals: 0
Buffer End
event
Event is fired when video starts playing again after a buffer is completed.
Use Case
A buffering event has just completed. The player fires this event which returns a value of 1 to indicate that playback has resumed.
Applicable for: Content, Live, VOD, Ad
Node Location: event.type : buffer_end
Max Decimals: 0
Cast Start
event
Fired when a user sends a stream from their local device to a remote screen.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : cast_start
Max Decimals: 0
Cast End
event
Fired when a user ends streaming on a remote screen & returns playback to their local device.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : cast_end
Max Decimals: 0
Custom Event
event
Add any user or system behavioral event to the Datazoom data stream. Requires custom coding on the page or in the app by customer developer.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : {custom_event_name}
Max Decimals: 0
Datazoom Loaded
event
Signifies that the Datazoom SDK has been loaded and activated. At this point, the video player can be instantiated or custom events can be sent by the application.
Applicable for:
Node Location: event.type : datazoom_loaded
Max Decimals: 0
Error
event
Thrown if an error occurs during content playback or retrieval of the video
Applicable for: Content, Live, VOD, Ad
Node Location: event.type : error
Max Decimals: 0
Exit Fullscreen
event
Triggered when user exits fullscreen mode during video playback
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : exit_fullscreen
Max Decimals: 0
Fullscreen
event
Triggered when user enters fullscreen mode during video playback
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : fullscreen
Max Decimals: 0
Heartbeat
event
Periodic event that provides updated insight into all of the selected FluxData metrics fired at the specified Heartbeat interval.
Applicable for: Content, Live, VOD, Ad
Node Location: event.type : heartbeat
Max Decimals: 0
Media Loaded
event
Fired when the video is fully loaded into the player & ready to begin playback.
Applicable for: Content, Live, VOD, Ad
Node Location: event.type : media_loaded
Max Decimals: 0
Media Object Request
event
Fired after the player has requested an object related to video playback. This object may be a manifest, audio/ video segment or subtitle file. The player will fire this event after the full roundtrip of request and response has completed.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : media_object_request
Max Decimals: 0
Media Request
event
Event signifies the video player requests the video from the server. The could be triggered by 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.
Use Case
Identify problems that may be occurring in the video player which prevent successful playback after a user requests playback.
Applicable for: Content, Live, VOD, Ad
Node Location: event.type : media_request
Max Decimals: 0
Milestone
event
Fired when the playheadPosition passes a predetermined percentile milestone of the video's duration. This event is used for both Ads & Content. Current milestones are fired at the 10, 25, 50, 75, 90 & 95 percentiles.
Applicable for: Ad, Content, VOD
Node Location: event.type : milestone
Max Decimals: 0
Mute
event
Triggered when the player volume has been reduced to zero.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : mute
Max Decimals: 0
Network Type Change
event
This event fires when the users connection changes to a different network type such as moving from WiFi to Cellular. The values correspond to data returned in the connection_type field.
Applicable for: Ad, Live, Content, VOD
Node Location: event.type : network_type_change
Max Decimals: 0
Pause
event
Pause event is fired when the player enters a paused state. This can be triggered when the user hits the Pause button to temporarily halt video playback or it can occur as part of the player's normal state changes as media is loading, resuming or concluding.
Applicable for: Content, Live, VOD, Ad
Node Location: event.type : pause
Max Decimals: 0
Play Button
event
Event is fired when a user initiates video playback by clicking on the play button. This event can fire to start new content or to resume paused content or an ad. Actual implementation of this event may vary by video player.
Applicable for: Content, Live, VOD, Ad
Node Location: event.type : play_btn
Max Decimals: 0
Playback Start
event
This event is fired when the video starts playing for the user, also known as First Frame.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : playback_start
Max Decimals: 0
Playback Complete
event
This event signifies that the video player has reached the end of the currently playing content.
Applicable for: Content, VOD, Ad
Node Location: event.type : playback_complete
Max Decimals: 0
Player Ready
event
Signifies when the player has been initialized and is ready for playback.
Applicable for:
Node Location: event.type : player_ready
Max Decimals: 0
Playing
event
The media is no longer blocked from playback, and has started playing. Fired when playback resumes from Stall, Buffering or Seek.
Applicable for: Content, Live, VOD, Ad
Node Location: event.type : playing
Max Decimals: 0
Qualified View
event
This event is fired when the user has watched a specified duration of video playback.
Default settings are:
- 30 sec, 60 sec for Content
- 5 sec for Ads
Applicable for: Content, Ads
Node Location: event.type : qualified_view
Max Decimals: 0
Quality Change Request
event
This 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.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : quality_change_request
Max Decimals: 0
Rendition Change
event
When 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.
Applicable for: Content, Live, VOD, Ad
Node Location: event.type : rendition_change
Max Decimals: 0
Resize
event
Fired when the player's on-page dimensions have changed. This event is not fired in response to a Fullscreen change.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : resize
Max Decimals: 0
Resume
event
This event is fired when the user begins playing again after pausing the video during playback.
Applicable for: Content, Live, VOD, Ad
Node Location: event.type : resume
Max Decimals: 0
Seek Start
event
This event records when the user interacts with time controls within the player to move forward or backward in the video timeline. It can be triggered by dragging the scrub bar or auto advancing using controls exposed by the app.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : seek_start
Max Decimals: 0
Seek End
event
Event is fired when the player stops moving the playhead position to jump to a specific point on the timeline. This event includes attributes Seek Start Point & Seek End Point to mark the starting & ending points of a seek event.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : seek_end
Max Decimals: 0
Stall Start
event
Stall Start event is triggered when playback of video stops because the buffer has been depleted causing an unexpected interruption for the user.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : stall_start
Max Decimals: 0
Stall End
event
Event fired when video starts playing again after a stall and the buffer has been replenished and playback resumes.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : stall_end
Max Decimals: 0
Stop
event
When the player has entered a stopped state due to any reason such as the user hitting a stop button, backgrounding the app, user switches content or the content has ended playback.
Applicable for: Content, Live, VOD
Node Location: event.type : stop
Max Decimals: 0
Subtitle Change
event
Fired when the user enables or disables subtitles or closed captioning.
Applicable for: Content, Live, VOD, Ad
Node Location: event.type : subtitle_change
Max Decimals: 0
Unmute
event
Triggered when the player audio has been reactivated.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : unmute
Max Decimals: 0
Volume Change
event
Triggered when the player increases or decreases the audio level of the video.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type : volume_change
Max Decimals: 0
FluxData
Bandwidth
fluxdata
Amount of estimated network bandwidth currently available to the end user's device.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.bandwidth_kbps
Permitted Values: any
Unit: kbps
Max Decimals: 0
Buffer Duration
fluxdata
Cumulative time that content has been buffering during the current Content Session.
Use Case
This is a value that is communicated at the termination of each title viewed during a playback session. These can then be aggregated by title and region, providing insight into potential content or delivery issues.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.buffer_duration_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Buffer Duration - Ads
fluxdata
Cumulative time that content has been buffering during ad playback in current Content Session.
Use Case
When used in conjunction with Buffer Start and Buffer End, this value can be helpful in determining how much of an ad pod was played which can affect the reporting of impressions and/or playback time to advertisers.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.buffer_duration_ads_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Buffer Duration - Content
fluxdata
Cumulative time that content has been buffering during content playback in current Content Session.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.buffer_duration_content_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Buffer Length
fluxdata
The amount of media currently stored in the player buffer waiting to be played.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.buffer_length_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Content Session Start Timestamp
fluxdata
Start time of a new Content Session for the current user session. Typically a new Content Session begins with a Playback Request.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.content_session_start_ts_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Current Audio Track
fluxdata
Identifies which available audio track has been selected by the user. Multiple audio tracks are usually used for alternate languages. Values returned may vary by content publisher & player.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.metrics.current_audio_track
Permitted Values: any
Max Decimals: 0
Current Subtitles
fluxdata
Identifies which available subtitle or closed captioning track has been selected by the user. Multiple captioning tracks are usually used for alternate languages. Values returned may vary by content publisher & player.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.metrics.current_subtitles
Permitted Values: any
Max Decimals: 0
Engagement Duration
fluxdata
Cumulative time that user has been engaged with the app or site, including time spent not viewing video.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.engagement_duration_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Number of Ad Plays
fluxdata
Running count of the number of ads played during the user's current session.
Applicable for: Ad, Live, VOD
Field Type: number
Node Location: event.metrics.num_ad_plays
Permitted Values: any
Unit: count
Max Decimals: 0
Number of Content Plays
fluxdata
The amount of content assets that started playback during the current user app session.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.num_content_plays
Permitted Values: any
Unit: count
Max Decimals: 0
Number of Content Requests
fluxdata
The amount of content assets requested during the current user session.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.num_requests_content
Permitted Values: any
Unit: count
Max Decimals: 0
Number of Errors
fluxdata
Running count of the number of errors that have occurred during the user's current session.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.num_errors
Permitted Values: any
Unit: count
Max Decimals: 0
Number of Errors - Ads
fluxdata
Running count of the number of errors that have occurred while ads are playing during the user's current session.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.num_errors_ads
Permitted Values: any
Unit: count
Max Decimals: 0
Number of Errors - Content
fluxdata
Running count of the number of errors that have occurred while content is playing during the user's current session.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.num_errors_content
Permitted Values: any
Unit: count
Max Decimals: 0
Pause Duration
fluxdata
The cumulative amount of time elapsed where the player was in a paused state during a Content Session.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.pause_duration_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Pause Duration - Ads
fluxdata
The cumulative amount of time elapsed where the player was in a paused state during Ad playback of Content Session.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.pause_duration_ads_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Pause Duration - Content
fluxdata
The cumulative amount of time elapsed where the player was in a paused state during Content playback of Content Session.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.pause_duration_content_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Playback Duration
fluxdata
Cumulative time that content & ads have been playing during the Content Session. Excludes time accrued while user pauses content or buffering.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.playback_duration_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Playback Duration - Ads
fluxdata
Cumulative time that ads have been playing during the current Content Session. Excludes time accrued while user pauses content or buffering.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.playback_duration_ads_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Playback Duration - Content
fluxdata
Cumulative time that content has been playing during the current video Content Session. Excludes time accrued while user pauses content or buffering.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.playback_duration_content_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Playback Duration - Promo
fluxdata
Cumulative time that inline promo content has been playing during the current video Content Session. Excludes time accrued while user pauses content or buffering. Requires application to annotate content session with promo timing information.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.playback_duration_promo_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Playback Rate
fluxdata
The speed of the audio/video playback. Describes the speed that the video is played back to the user in relation to normal playback time. .5x, 1x, 1.5x, 2x
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.playback_rate
Permitted Values: any
Unit: percentage
Max Decimals: 2
Player State
fluxdata
Returns the player's current playback state. (Idle, buffering, playing, paused)
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.metrics.player_state
Permitted Values: any
Max Decimals: 0
Player Viewable
fluxdata
Is 50% or more of the player visible on the screen at the time of event?
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: event.metrics.player_viewable
Permitted Values: value list
Value List: true, false
Max Decimals: 0
Player Viewable Percent
fluxdata
The percentage of the player that is viewable on the screen at the time of the event.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.player_viewable_percent
Permitted Values: any
Unit: percentage
Max Decimals: 3
Scale: 0 .. 100
Playhead Position
fluxdata
Returns the current point in the video timeline in seconds.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.playhead_position_sec
Permitted Values: any
Unit: seconds
Max Decimals: 3
Rendition Audio Bitrate
fluxdata
Target audio encoding bitrate of the currently selected rendition from the manifest. The manifest may contain multiple versions (i.e. renditions) of the asset encoded at varying qualities to support varying network conditions. This data point returns the audio bitrate value stated in the manifest for the currently playing rendition. Only available if the manifest contains discrete ad & video tracks.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.rendition_audio_bitrate_kbps
Permitted Values: any
Unit: kbps
Max Decimals: 0
Rendition Height
fluxdata
Height in pixels of the video rendition being played. The manifest may contain multiple versions (i.e. renditions) of the video encoded at varying qualities to support varying network conditions.
Applicable for: Ad, Content, Live, VOD, Ad
Field Type: number
Node Location: event.metrics.rendition_height
Permitted Values: any
Unit: pixels
Max Decimals: 0
Rendition Name
fluxdata
Standardized name to represent the rendition currently being played.
Applicable for: Ad, Content, Live, VOD, Ad
Field Type: string
Node Location: event.metrics.rendition_name
Permitted Values: any
Max Decimals: 0
Rendition Video Bitrate
fluxdata
Target 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.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.rendition_video_bitrate_kbps
Permitted Values: any
Unit: kbps
Max Decimals: 0
Rendition Width
fluxdata
Width in pixels of the video rendition being played. The manifest may contain multiple versions (i.e. renditions) of the video encoded at varying qualities to support varying network conditions.
Applicable for: Ad, Content, Live, VOD, Ad
Field Type: number
Node Location: event.metrics.rendition_width
Permitted Values: any
Unit: pixels
Max Decimals: 0
Stall Count
fluxdata
Number of times the user's playback has been interrupted by an unexpected video stall due to buffer depletion.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.stall_count
Permitted Values: any
Unit: count
Max Decimals: 0
Stall Count - Ads
fluxdata
Number of times the user's playback of Ads has been interrupted by an unexpected video stall due to buffer depletion.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.stall_count_ads
Permitted Values: any
Unit: count
Max Decimals: 0
Stall Count - Content
fluxdata
Number of times the user's playback of Content has been interrupted by an unexpected video stall due to buffer depletion.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.stall_count_content
Permitted Values: any
Unit: count
Max Decimals: 0
Stall Duration
fluxdata
The cumulative amount of time elapsed where the user's playback has been interrupted by an unexpected video stall due to buffer.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.stall_duration_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Stall Duration - Ads
fluxdata
The cumulative amount of time elapsed where the user's playback of Ads has been interrupted by an unexpected video stall due to buffer depletion.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.stall_duration_ads_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Stall Duration - Content
fluxdata
The cumulative amount of time elapsed where the user's playback of Content has been interrupted by an unexpected video stall due to buffer depletion.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.stall_duration_content_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Content Started
fluxdata
Time interval since current content playback began.
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_started_content_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Content Request
fluxdata
Time interval since content playback was requested.
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_request_content_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Ad Started
fluxdata
Time interval since advertisement started playing.
Applicable for: Ad, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_last_started_ad_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Ad Break Start
fluxdata
Time interval since the current pod of advertisements began.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_last_ad_break_start_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Ad Completed
fluxdata
Time interval since the last advertisement completed.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_last_ad_completed_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Ad Request
fluxdata
Time interval since advertisement was requested.
Applicable for: Ad, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_last_request_ad_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Buffer Start
fluxdata
Time interval since Buffer Start event began during playback.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_last_buffer_start_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Buffer Start - Ad
fluxdata
Time interval since Buffer Start event began during advertisement playback.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_last_buffer_start_ad_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Buffer Start - Content
fluxdata
Time interval since Buffer Start event began during content playback, reported in milliseconds. Value is reset to zero at the start of a new video View or when another Buffer Start event occurs.
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_last_buffer_start_content_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Heartbeat
fluxdata
Time interval since Heartbeat was last sent for the current content session.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_last_heartbeat_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Milestone - Ad
fluxdata
Time interval since Milestone event was last sent for ad.
Applicable for: Ad, Content, VOD
Field Type: number
Node Location: event.metrics.time_since_last_milestone_ad_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Milestone - Content
fluxdata
Time interval since Milestone event was last sent for content.
Applicable for: Ad, Content, VOD
Field Type: number
Node Location: event.metrics.time_since_last_milestone_content_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Pause
fluxdata
Time interval since content playback was paused., reported in milliseconds
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_last_pause_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Rendition Change
fluxdata
Time interval since content playback shifted to a different available quality version from the manifest., reported in milliseconds
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_last_rendition_change_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Seek Start
fluxdata
Time interval since the occurrence of a Seek Start event.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_last_seek_start_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Stall Start
fluxdata
Time interval since Stall Start event began, reported in milliseconds. Value is reset to zero at the start of a new video View or when another Stall Start event occurs.
Applicable for: Content, Ad, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_last_stall_start_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Stall Start - Ad
fluxdata
Time interval since Stall Start event began during advertisement playback.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_last_stall_start_ad_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time Since Last Stall Start - Content
fluxdata
Time interval since Stall Start event began during content playback.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.time_since_last_stall_start_content_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Volume Level
fluxdata
The current playback volume as a whole number percentage.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.volume_level_percent
Permitted Values: any
Unit: percentage
Max Decimals: 0
Scale: 0 .. 100
Event Count
fluxdata
Incremental counter of the events generated during a user session. This field is valuable for ensuring proper sequencing of events and detecting any potential data loss.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.event_count
Permitted Values: any
Unit: count
Max Decimals: 0
Event Attributes
Startup Duration - Content
metadata
This timer represents the total time a user spent waiting for content to begin playback excluding any time related to requesting, loading or playing pre-roll ads.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.attributes.startup_duration_content_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Startup Duration - Total
metadata
This timer represents the total time a user spent waiting for content to begin playback excluding any time spent viewing pre-roll ads.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.attributes.startup_duration_total_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
ABS Shift
metadata
Describes 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.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.attributes.abs_shift
Permitted Values: value list
Value List: up, down
Max Decimals: 0
Error Code
metadata
Error object representing a code explicitly identified by the player
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.attributes.error_code
Permitted Values: any
Max Decimals: 0
Error Message
metadata
Error object representing a message about the error explicitly identified by the player
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.attributes.error_msg
Permitted Values: any
Max Decimals: 0
Heartbeat Count
metadata
Incremental tracker identifying the order of Heartbeat events from the Collector.
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.attributes.heartbeat_count
Permitted Values: any
Unit: count
Max Decimals: 0
Inner Error
metadata
Returns the error that occurred during processing
Applicable for: Ad
Field Type: string
Node Location: event.attributes.inner_error
Permitted Values: any
Max Decimals: 0
Milestone Percent
metadata
Number indicating the percentage milestone represented by the event fired. Attribute of Milestone events.
Applicable for: Ad, Content, VOD
Field Type: number
Node Location: event.attributes.milestone_percent
Permitted Values: any
Unit: percentage
Max Decimals: 2
Scale: 0 .. 1
Seek Start Point
metadata
The starting point of a seek event, representing the content timecode in milliseconds. Value will appear as an attribute on Seek End events
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.attributes.seek_start_point_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Seek End Point
metadata
The ending point of a seek event, representing the content timecode in milliseconds. Value will appear as an attribute on Seek End events
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.attributes.seek_end_point_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Qualified View Trigger
metadata
Number indicating the playback duration triggering the Qualified View event.
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.attributes.qualified_view_sec
Permitted Values: any
Unit: seconds
Max Decimals: 0
Message Metadata
Configuration ID
metadata
Datazoom 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.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: root.configuration_id
Permitted Values: UUID
Max Decimals: 0
Event ID
metadata
Unique identifier for each event message fired by a Collector or log file received by Datazoom. The string includes an incremental counter at the end to allow for sequencing the events from a user session.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: root.event_id
Permitted Values: any
Max Decimals: 0
CDN Data
CDN
metadata
Content Distribution Network name
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cdn.cdn
Permitted Values: any
Max Decimals: 0
User Details
App Session Start Timestamp
metadata
Start time of the current user session
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: user_details.app_session_start_ts_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
App Session End Timestamp
metadata
End time of the current user session.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: user_details.app_session_end_ts_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
App Session ID
metadata
Unique 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.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details.app_session_id
Permitted Values: any
Max Decimals: 0
Client IP Address
metadata
IP address of the user's device
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details.client_ip
Permitted Values: IP address
Max Decimals: 0
Content Session ID
metadata
A unique id for the current video playback session.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details.content_session_id
Permitted Values: UUID
Max Decimals: 0
User Agent
metadata
Contains a number of tokens that refer to aspects of the user device, including the user's browser name and version, rendering engine, device’s model number, operating system and its version, etc.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details.user_agent
Permitted Values: any
Max Decimals: 0
Player
Autostart
metadata
Returns whether the audio/video should start playing as soon as it is loaded
Applicable for: Content, Live, VOD
Field Type: bool
Node Location: player.autostart
Permitted Values: value list
Value List: true, false
Max Decimals: 0
Casting
metadata
Is the player currently in casting mode where the content selected will be played on an external device?
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: player.casting
Permitted Values: value list
Value List: true, false
Max Decimals: 0
Controls
metadata
Whether the controls are available for user interaction in the player. (i.e. Play/Pause/Seek)
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: player.controls
Permitted Values: value list
Value List: true, false
Max Decimals: 0
Default Muted
metadata
Identifies whether the audio/video should be muted by default
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: player.default_muted
Permitted Values: value list
Value List: true, false
Max Decimals: 0
Default Playback Rate
metadata
Sets or returns the default speed of the audio/video playback. Describes the speed that the video is played back to the user in relation to normal playback time. .5x, 1x, 1.5x, 2x
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: player.default_playback_rate
Permitted Values: any
Unit: percentage
Max Decimals: 2
Fullscreen
metadata
Is the player in fullscreen mode?
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: player.fullscreen
Permitted Values: value list
Value List: true, false
Max Decimals: 0
Loop
metadata
Identifies whether the audio/video is programmed to start over again when finished
Applicable for: Content, Live, VOD
Field Type: bool
Node Location: player.loop
Permitted Values: value list
Value List: true, false
Max Decimals: 0
Muted
metadata
Returns True if player is muted.
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: player.muted
Permitted Values: value list
Value List: true, false
Max Decimals: 0
Player Name
metadata
States which video player generated the event
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player.player_name
Permitted Values: any
Max Decimals: 0
Player Version
metadata
States the version of the video player that generated the event
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player.player_version
Permitted Values: any
Max Decimals: 0
Preload
metadata
Identifies whether the audio/video should be loaded when the page loads. It may have one of the following values: none: Indicates that the video should not be preloaded; metadata: Indicates that only video metadata (e.g. length) is fetched; auto: Indicates that the whole video file can be downloaded, even if the user is not expected to use it.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player.preload
Permitted Values: value list
Value List: none, metadata, auto
Max Decimals: 0
Ready State
metadata
Identifies the current ready state of the audio/video
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: player.ready_state
Permitted Values: value list
Value List: 0,1,2,3,4
Max Decimals: 0
Streaming Protocol
metadata
What streaming format is being used for the content?
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player.streaming_protocol
Permitted Values: value list
Value List: MPEG-DASH, HLS, HDS, Smooth, WebRTC, RTMP, RTSP, Flash, MP4, MPEG2-TS, 3GPP, Quicktime, AVI, Windows Media
Max Decimals: 0
Streaming Type
metadata
Describes if the content being streamed is Live or On Demand.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player.streaming_type
Permitted Values: value list
Value List: Live, VOD
Max Decimals: 0
Subtitles
metadata
Describes if subtitles are currently enabled for playback.
Applicable for: Ad, Live, Content, VOD
Field Type: bool
Node Location: player.subtitles
Permitted Values: value list
Value List: true, false
Max Decimals: 0
Device
Ad Tracking Opt Out
metadata
States if the user has opted out of advertising tracking on their device.
Applicable for: Live, VOD, Ad
Field Type: bool
Node Location: device.ad_tracking_opt_out
Permitted Values: value list
Value List: true, false
Max Decimals: 0
Advertising ID
metadata
Advertising ID is a user resettable ID assigned by the device or operating environment for advertising purposes (e.g. targeting, frequency capping). The key difference between a Device ID and an Advertising ID is that advertising IDs can be reset by the user at any time. Examples include Apple's IDFA and Android's AAID.
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: device.advertising_id
Permitted Values: any
Max Decimals: 0
Browser Height
metadata
The height of the end user's browser window at the time when the event occurred.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: device.browser_height
Permitted Values: any
Unit: pixels
Max Decimals: 0
Browser Name
metadata
Web browser being used during the session
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device.browser_name
Permitted Values: any
Max Decimals: 0
Browser Version
metadata
Version of web browser being used during the session
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device.browser_version
Permitted Values: any
Max Decimals: 0
Browser Width
metadata
The width of the end user's browser window at the time when the version occurred.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: device.browser_width
Permitted Values: any
Unit: pixels
Max Decimals: 0
Cookies Enabled
metadata
Does the user's browser have cookies enabled?
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: device.cookies_enabled
Permitted Values: value list
Value List: true, false
Max Decimals: 0
Device ID
metadata
Unique identifier of the user's device.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device.device_id
Permitted Values: any
Max Decimals: 0
Device Manufacturer
metadata
Manufacturer of the users device.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device.device_mfg
Permitted Values: any
Max Decimals: 0
Device Name
metadata
Name of the device model used by the viewer.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device.device_name
Permitted Values: any
Max Decimals: 0
Device Type
metadata
Describes the type of device category being used during the session such as phone, tablet, desktop, connected device, game console, etc.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device.device_type
Permitted Values: value list
Value List: pc, mobile, tablet, ott device, tv, game console, wearable
Max Decimals: 0
Orientation
metadata
The directional orientation that the user is holding their mobile device.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device.orientation
Permitted Values: value list
Value List: landscape, portrait
Max Decimals: 0
OS Name
metadata
Operating System of the user's device
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device.os_name
Permitted Values: any
Max Decimals: 0
OS Version
metadata
Version of Operating System being used during the session
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device.os_version
Permitted Values: any
Max Decimals: 0
Video
Asset ID
metadata
Unique identifier of the content shown. This may be produced by the CMS or publishing system.
Applicable for: Content, Live, VOD
Field Type: string
Node Location: video.asset_id
Permitted Values: any
Max Decimals: 0
Description
metadata
A brief description of the content being played, this description may be internal to the CMS or may be displayed to the end user as part of their effort to select content to view.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: video.description
Permitted Values: any
Max Decimals: 0
Duration
metadata
The total length of the media file, reported in decimal seconds
Applicable for: Ad, Content, VOD
Field Type: number
Node Location: video.duration_sec
Permitted Values: any
Unit: seconds
Max Decimals: 3
Frame Rate
metadata
The frames per second of the current video encoding.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: video.frame_rate
Permitted Values: any
Unit: fps
Max Decimals: 2
Media Type
metadata
Specifies whether the event relates to an Ad or Content asset.
Applicable for: Ad, Content, Live, VOD, Ad
Field Type: string
Node Location: video.media_type
Permitted Values: value list
Value List: ad, content
Max Decimals: 0
Player Height
metadata
Height dimension in pixels of the current playback area.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: video.player_height
Permitted Values: any
Unit: pixels
Max Decimals: 0
Player Width
metadata
Width dimension in pixels of the current playback area.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: video.player_width
Permitted Values: any
Unit: pixels
Max Decimals: 0
Source
metadata
Returns the URL of the current media file
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: video.source
Permitted Values: URL
Max Decimals: 0
Title
metadata
Provides the title of current asset being played
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: video.title
Permitted Values: any
Max Decimals: 0
Location
City
metadata
The city or town where the user is located
Use Case
When aggregated with other player sessions, this can provide a definitive number of viewers within a city. This can be helpful when targeting local advertising.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location.city
Permitted Values: any
Max Decimals: 0
Continent
metadata
The name of the continent from which the event originated based on the user's IP address.
Use Case
This value is ideal to utilize when enforcing content rights: any player identified within a specific country can be blocked from accessing the content. Note that proxy servers can be used by viewers to make their request appear to be originating from an approved country. Matching the countryCode received during a request to the country specified in the subscriber's profile information can help mitigate proxy use.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location.continent
Permitted Values: any
Max Decimals: 0
Continent Code
metadata
The continent from which the event originated based on the user's IP address.
Use Case
This value is ideal to utilize when enforcing content rights: any player identified within a specific country can be blocked from accessing the content. Note that proxy servers can be used by viewers to make their request appear to be originating from an approved country. Matching the countryCode received during a request to the country specified in the subscriber's profile information can help mitigate proxy use.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location.continent_code
Permitted Values: 2 letter code
Max Decimals: 0
Country
metadata
Full name of the user's country
Use Case
For content rights that have global distribution, country is often the value most used to enforce access making it relatively easy to blacklist and/or whitelist certain countries.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location.country
Permitted Values: any
Max Decimals: 0
Country Code
metadata
The country from which the browser initiated the event. For a list of country codes, see ISO 3166-1 alpha-2 .
Use Case
This value is ideal to utilize when enforcing content rights: any player identified within a specific country can be blocked from accessing the content. Note that proxy servers can be used by viewers to make their request appear to be originating from an approved country. Matching the countryCode received during a request to the country specified in the subscriber's profile information can help mitigate proxy use.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location.country_code
Permitted Values: 2 letter code
Max Decimals: 0
District
metadata
The district, subdivision of city from where the event originated as determined by the user's IP address.
Use Case
This value is ideal to utilize when enforcing content rights: any player identified within a specific country can be blocked from accessing the content. Note that proxy servers can be used by viewers to make their request appear to be originating from an approved country. Matching the countryCode received during a request to the country specified in the subscriber's profile information can help mitigate proxy use.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location.district
Permitted Values: any
Max Decimals: 0
Latitude
metadata
Location information for the user
Use Case
When used in conjunction with longitude, this can provide an exact location for the viewer.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: geo_location.latitude
Permitted Values: any
Unit: degrees
Max Decimals: 4
Scale: -90 .. 90
Longitude
metadata
Location information for the user
Use Case
When used in conjunction with latitude, this can provide an exact location for the viewer.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: geo_location.longitude
Permitted Values: any
Unit: degrees
Max Decimals: 4
Scale: -180 .. 180
Postal Code
metadata
The specific administrative division within a country where the event occurred. In the United States, zip codes correspond to postal region locator
Use Case
When aggregated with other player sessions, this can provide a definitive number of viewers within a specific area of a city. This can be helpful when targeting local advertising.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location.postal_code
Permitted Values: any
Max Decimals: 0
Region
metadata
The 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.
Use Case
This is the full form of the regionCode (i.e., Florida instead of FL). As a result, this value is often used for display purposes, rather than programmatically. If the fullname of a country region is needed, pulling this field is more efficient than employing memory or CPU to programmatically match the regionCode to a region name.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location.region
Permitted Values: any
Max Decimals: 0
Region Code
metadata
The specific administrative division within a country where the event occurred. In the United States, regions correspond to state abbreviations; for example, WA or NY but in other countries the region code may be represented by numbers or some other identifier.
Use Case
Like the countryCode, this value can be used to enforce content rights, especially when those rights are tied to only certain regions within a country. For example, a sporting event on the West Coast of the U.S. may not be available on the East Coast of the U.S., therefore all states on the East Coast (NY, FL, NH, etc.) would be blocked from content access.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location.region_code
Permitted Values: any
Max Decimals: 0
Timezone Name
metadata
The name of the user's timezone where the event originated based on their IP address.
Use Case
This value is ideal to utilize when enforcing content rights: any player identified within a specific country can be blocked from accessing the content. Note that proxy servers can be used by viewers to make their request appear to be originating from an approved country. Matching the countryCode received during a request to the country specified in the subscriber's profile information can help mitigate proxy use.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location.timezone_name
Permitted Values: any
Max Decimals: 0
Timezone Offset
metadata
The difference in hours, relative to UTC, of the user's timezone.
Use Case
This value is ideal to utilize when enforcing content rights: any player identified within a specific country can be blocked from accessing the content. Note that proxy servers can be used by viewers to make their request appear to be originating from an approved country. Matching the countryCode received during a request to the country specified in the subscriber's profile information can help mitigate proxy use.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: geo_location.timezone_offset
Permitted Values: any
Unit: hours
Max Decimals: 2
Scale: -24 .. 24
Network
Mobile Connection
metadata
Specifies if a user is on a mobile connection as determined by their IP address.
Use Case
This value is ideal to utilize when enforcing content rights: any player identified within a specific country can be blocked from accessing the content. Note that proxy servers can be used by viewers to make their request appear to be originating from an approved country. Matching the countryCode received during a request to the country specified in the subscriber's profile information can help mitigate proxy use.
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: network.mobile_connection
Permitted Values: value list
Value List: true,false
Max Decimals: 0
ASN
metadata
Autonomous 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
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network.asn
Permitted Values: any
Max Decimals: 0
ASN Org
metadata
The organization that owns the Autonomous System Number. Often an ISP, sometimes a private company or institution.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network.asn_org
Permitted Values: any
Max Decimals: 0
ISP
metadata
Name of the end-user's internet service provider.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network.isp
Permitted Values: any
Max Decimals: 0
Network Type
metadata
The type of network connection currently being used to access the content.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network.network_type
Permitted Values: value list
Value List: WiFi, Mobile, LAN
Max Decimals: 0
Page
DZ SDK Version
metadata
Version number of the Datazoom SDK that generated the event message.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: page.dz_sdk_version
Permitted Values: any
Max Decimals: 0
Page Title
metadata
The title of the page from which the event originated.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: page.page_title
Permitted Values: any
Max Decimals: 0
Page URL
metadata
The address of the page from which the event originated.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: page.page_url
Permitted Values: URL
Max Decimals: 0
Referrer URL
metadata
The URL of the page the user visited before coming to the active page.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: page.referrer_url
Permitted Values: URL
Max Decimals: 0
Site Domain
metadata
URL Domain of the site hosting the video player.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: page.site_domain
Permitted Values: any
Max Decimals: 0
Ad Data
Ad Blocker
metadata
States whether an Ad Blocker was detected or not.
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: ad.ad_blocker
Permitted Values: value list
Value List: True,False
Max Decimals: 0
Ad Break ID
metadata
UUID to denote the specific ad break. This can be used to tie events together that occurred during a specific ad break.
Applicable for: Ad, Live, VOD
Field Type: string
Node Location: ad.ad_break_id
Permitted Values: UUID
Max Decimals: 0
Ad Click Url
metadata
URL opened when the user interacts with an ad during playback.
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad.ad_click_url
Permitted Values: URL
Max Decimals: 0
Ad Creative ID
metadata
Creative ID of the ad shown.
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad.ad_creative_id
Permitted Values: any
Max Decimals: 0
Ad Duration
metadata
The length of the advertisement in seconds.
Applicable for: Ad, Live, VOD
Field Type: number
Node Location: ad.ad_duration_sec
Permitted Values: any
Unit: seconds
Max Decimals: 3
Ad ID
metadata
Identifier of the ad asset shown.
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad.ad_id
Permitted Values: any
Max Decimals: 0
Ad Partner
metadata
Name of the partner showing the ad.
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad.ad_partner
Permitted Values: any
Max Decimals: 0
Ad Position
metadata
Where the ad appears in relation to the video content. Pre-roll ads run before the content, mid-roll ads run during the middle of the content & post-roll ads run after the content has completed streaming.
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad.ad_position
Permitted Values: value list
Value List: pre, mid, post
Max Decimals: 0
Ad Session ID
metadata
A Datazoom generated UUID to denote the specific ad asset playback. This can be used to tie events together that occurred during a specific ad item.
Applicable for: Ad
Field Type: string
Node Location: ad.ad_session_id
Permitted Values: UUID
Max Decimals: 0
Ad System
metadata
The source ad server information included in the ad response.
Applicable for: Ad
Field Type: string
Node Location: ad.ad_system
Permitted Values: any
Max Decimals: 0
Ad Time Offset
metadata
Returns the point in time during the content playback at which the current ad pod was scheduled to appear. For pods in VOD streams with dynamically inserted ads, stream time is returned.
Applicable for: Ad
Field Type: number
Node Location: ad.ad_time_offset_sec
Permitted Values: any
Unit: seconds
Max Decimals: 3
Advertiser Name
metadata
The advertiser name as defined by the serving party.
Applicable for: Ad
Field Type: string
Node Location: ad.advertiser_name
Permitted Values: any
Max Decimals: 0
Deal ID
metadata
Returns the first deal ID present in the wrapper chain for the current ad, starting from the top.
Applicable for: Ad
Field Type: string
Node Location: ad.deal_id
Permitted Values: any
Max Decimals: 0
Skip Time Offset
metadata
The number of seconds of playback before the ad becomes skippable. -1 is returned for non skippable ads or if this is unavailable.
Applicable for: Ad
Field Type: number
Node Location: ad.skip_time_offset_sec
Permitted Values: any
Unit: seconds
Max Decimals: 3
Wrapper Creative IDs
metadata
Selected creative IDs used for wrapper ads. The creative IDs returned starts at the inline ad and traverses to the outermost wrapper ad.
Applicable for: Ad
Field Type: array of string
Node Location: ad.wrapper_creative_ids
Permitted Values: any
Max Decimals: 0
Wrapper ID
metadata
Ad IDs used for wrapper ads. The IDs returned starts at the inline ad (innermost) and traverses to the outermost wrapper ad.
Applicable for: Ad
Field Type: array of string
Node Location: ad.wrapper_id
Permitted Values: any
Max Decimals: 0
Wrapper Systems
metadata
Ad systems used for wrapper ads. The ad systems returned starts at the inline ad and traverses to the outermost wrapper ad.
Applicable for: Ad
Field Type: array of string
Node Location: ad.wrapper_systems
Permitted Values: any
Max Decimals: 0
Custom
Custom Metadata
metadata
Customers 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.
Applicable for: Ad, Content, Live, VOD
Node Location: custom.{custom_metadata_name}
Permitted Values: any
Max Decimals: 0
cmcd
Startup (CMCD)
metadata
Key is included without a value if the object is needed urgently due to startup, seeking or recovery after a buffer-empty event. The media SHOULD not be rendering when this request is made. This key MUST not be sent if it is FALSE.
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: cmcd.su
Permitted Values: value list
Value List: true, false
Max Decimals: 0
Buffer Length (CMCD)
metadata
The buffer length associated with the media object being requested.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.bl
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Buffer Starvation (CMCD)
metadata
Key is included without a value if the buffer was starved at some point between the prior request and this object request, resulting in the player being in a rebuffering state and the video or audio playback being stalled. This key MUST NOT be sent if the buffer was not starved since the prior request. If the object type ‘ot’ key is sent along with this key, then the ‘bs’ key refers to the buffer associated with the particular object type. If no object type is communicated, then the buffer state applies to the current session.
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: cmcd.bs
Permitted Values: value list
Value List: true, false
Max Decimals: 0
Content ID (CMCD)
metadata
A unique string identifying the current content.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.cid
Permitted Values: any
Max Decimals: 0
Deadline (CMCD)
metadata
Deadline from the request time until the first sample of this Segment/Object needs to be available in order to not create a buffer underrun or any other playback problems.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.dl
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Encoded Bitrate (CMCD)
metadata
The encoded bitrate of the audio or video object being requested. This may not be known precisely by the player; however, it MAY be estimated based upon playlist/manifest declarations. If the playlist declares both peak and average bitrate values, the peak value should be transmitted.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.br
Permitted Values: any
Unit: kbps
Max Decimals: 0
Measured throughput (CMCD)
metadata
The throughput between client and server, as measured by the client and MUST be rounded to the nearest 100 kbps. This value, however derived, SHOULD be the value that the client is using to make its next Adaptive Bitrate switching decision. If the client is connected to multiple servers concurrently, it must take care to report only the throughput measured against the receiving server. If the client has multiple concurrent connections to the server, then the intent is that this value communicates the aggregate throughput the client sees across all those connections.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.mtp
Permitted Values: any
Unit: kbps
Max Decimals: 0
Next Object Request (CMCD)
metadata
Relative path of the next object to be requested. This can be used to trigger pre-fetching by the CDN. This MUST be a path relative to the current request. This string MUST be URLEncoded [5]. The client SHOULD NOT depend upon any pre-fetch action being taken - it is merely a request for such a pre-fetch to take place.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.nor
Permitted Values: any
Max Decimals: 0
Next Range Request (CMCD)
metadata
If the next request will be a partial object request, then this string denotes the byte range to be requested. If the ‘nor’ field is not set, then the object is assumed to match the object currently being requested. The client SHOULD NOT depend upon any pre-fetch action being taken – it is merely a request for such a pre-fetch to take place. Formatting is similar to the HTTP Range header, except that the unit MUST be ‘byte’, the ‘Range:’ prefix is NOT required and specifying multiple ranges is NOT allowed. Valid combinations are: "<range-start>-" "<range-start>-<range-end>" "-<suffix-length>"
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.nrr
Permitted Values: any
Max Decimals: 0
Object Duration (CMCD)
metadata
The playback duration in milliseconds of the object being requested. If a partial segment is being requested, then this value MUST indicate the playback duration of that part and not that of its parent segment. This value can be an approximation of the estimated duration if the explicit value is not known.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.d
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Object Type (CMCD)
metadata
The media type of the current object being requested: m = text file, such as a manifest or playlist a = audio only v = video only av = muxed audio and video i = init segment c = caption or subtitle tt = ISOBMFF timed text track k = cryptographic key, license or certificate. o = other If the object type being requested is unknown, then this key MUST NOT be used.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.ot
Permitted Values: value list
Value List: m, a, v, av, i, c, tt, k, o
Max Decimals: 0
Playback Rate (CMCD)
metadata
1 if real-time, 2 if double speed, 0 if not playing. SHOULD only be sent if not equal to 1.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.pr
Permitted Values: any
Max Decimals: 2
Request ID (CMCD)
metadata
A unique identifier that is established to track an individual media object request made from the client to a CDN.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.rid
Permitted Values: any
Max Decimals: 0
Requested Maximum Throughput (CMCD)
metadata
The requested maximum throughput that the client considers sufficient for delivery of the asset. Values MUST be rounded to the nearest 100kbps. For example, a client would indicate that the current segment, encoded at 2Mbps, is to be delivered at no more than 10Mbps, by using rtp=10000. Note: This can benefit clients by preventing buffer saturation through over-delivery and can also deliver a community benefit through fair-share delivery. The concept is that each client receives the throughput necessary for great performance, but no more. The CDN may not support the rtp feature.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.rtp
Permitted Values: any
Unit: kbps
Max Decimals: 0
Session ID (CMCD)
metadata
A GUID identifying the current playback session. A playback session typically ties together segments belonging to a single media asset. Maximum length is 64 characters. It is RECOMMENDED to conform to the UUID specification [7].
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.sid
Permitted Values: any
Max Decimals: 0
Stream Type (CMCD)
metadata
Describes if the content being streamed is Live or On Demand.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.st
Permitted Values: value list
Value List: v, l
Max Decimals: 0
Streaming Format (CMCD)
metadata
The streaming format that defines the current request. d = MPEG DASH h = HTTP Live Streaming (HLS) s = Smooth Streaming o = other If the streaming format being requested is unknown, then this key MUST NOT be used.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.sf
Permitted Values: value list
Value List: d, h, s, o
Max Decimals: 0
Top Bitrate (CMCD)
metadata
The highest bitrate rendition in the manifest or playlist that the client is allowed to play, given current codec, licensing and sizing constraints.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.tb
Permitted Values: any
Unit: kbps
Max Decimals: 0
Version (CMCD)
metadata
The version of the CMCD specification used for interpreting the defined key names and values.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.v
Permitted Values: any
Max Decimals: 0
|
Comments
0 comments
Please sign in to leave a comment.