Events
Ad Break Start
event
Released in version 1.86
Definition: Fired at the beginning of an advertising break, signifies that content has been delayed while the advertisements are played.
Technical Name: ad_break_start
Supported Ad Networks: Google IMA
Applicable for: Live, VOD, Ad
Node Location: event.type
Max Decimals: 0
Ad Break End
event
Released in version 1.86
Definition: Fired at the end of an advertising break, signifies that the advertisements have ended and content is ready to resume.
Technical Name: ad_break_end
Supported Ad Networks: Google IMA
Applicable for: Live, VOD, Ad
Node Location: event.type
Max Decimals: 0
Ad Click
event
Released in version 1.86
Definition: Triggered when the user interacts with an advertisement
Technical Name: ad_click
Supported Ad Networks: Google IMA
Applicable for: Live, VOD, Ad
Node Location: event.type
Max Decimals: 0
Ad Impression
event
Released in version 1.86
Definition: Fired when an Ad impression is recorded by the video player.
Technical Name: ad_impression
Supported Ad Networks: Google IMA
Applicable for: Live, VOD, Ad
Node Location: event.type
Max Decimals: 0
Ad Skip
event
Released in version 1.86
Definition: This event is triggered when a user chooses to skip the currently playing ad and go directly to the content..
Technical Name: ad_skip
Supported Ad Networks: Google IMA
Applicable for: Live, VOD, Ad
Node Location: event.type
Max Decimals: 0
Audio Track Changed
event
Released in version 1.90
Definition: This event signifies when the user has chosen to switch to a different audio track during playback.
Technical Name: audio_track_changed
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Buffer Start
event
Released in version 1.86
Definition: 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.
Technical Name: buffer_start
Supported Ad Networks: Google IMA
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Buffer End
event
Released in version 1.86
Definition: 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.
Technical Name: buffer_end
Supported Ad Networks: Google IMA
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Max Decimals: 0
Cast Start
event
Released in version 1.90
Definition: Fired when a user sends a stream from their local device to a remote screen.
Technical Name: cast_start
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Cast End
event
Released in version 1.90
Definition: Fired when a user ends streaming on a remote screen & returns playback to their local device.
Technical Name: cast_end
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Cast Transfer
event
Released in version 1.112
Definition: Signifies that an orchestration event has occurred between casting sender & receiver devices. Upon cast initialization if both the sender and receiver are instrumented with Datazoom SDKs, a cast transfer event will be fired from both devices.
Technical Name: cast_transfer
Applicable for:
Node Location: event.type
Max Decimals: 0
Custom Event
event
Released in version 1.86
Definition: 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.
Technical Name: {custom_event_name}
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Datazoom Loaded
event
Released in version 1.86
Definition: 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.
Technical Name: datazoom_loaded
Applicable for:
Node Location: event.type
Max Decimals: 0
Error
event
Released in version 1.87
Definition: Thrown if an error occurs during content playback or retrieval of the video
Technical Name: error
Supported Ad Networks: Google IMA
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Max Decimals: 0
Exit Fullscreen
event
Released in version 1.90
Definition: Triggered when user exits fullscreen mode during video playback
Technical Name: exit_fullscreen
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Fullscreen
event
Released in version 1.90
Definition: Triggered when user enters fullscreen mode during video playback
Technical Name: fullscreen
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Heartbeat
event
Released in version 1.86
Definition: Periodic event that provides updated insight into all of the selected FluxData metrics fired at the specified Heartbeat interval.
Technical Name: heartbeat
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Max Decimals: 0
Media Loaded
event
Released in version 1.86
Definition: Fired when the video is fully loaded into the player & ready to begin playback.
Technical Name: media_loaded
Supported Ad Networks: Google IMA
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Max Decimals: 0
Milestone
event
Released in version 1.87
Definition: 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.
Technical Name: milestone
Supported Ad Networks: Google IMA
Applicable for: Ad, Content, VOD
Node Location: event.type
Max Decimals: 0
Mute
event
Released in version 1.90
Definition: Triggered when the player volume has been reduced to zero.
Technical Name: mute
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Pause
event
Released in version 1.86
Definition: 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.
Technical Name: pause
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Max Decimals: 0
Playback Start
event
Released in version 1.86
Definition: This event is fired when the video starts playing for the user, also known as First Frame.
Technical Name: playback_start
Supported Ad Networks: Google IMA
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Playback Complete
event
Released in version 1.86
Definition: This event signifies that the video player has reached the end of the currently playing content.
Technical Name: playback_complete
Supported Ad Networks: Google IMA
Applicable for: Content, VOD, Ad
Node Location: event.type
Max Decimals: 0
Player Ready
event
Released in version 1.86
Definition: Signifies when the player has been initialized and is ready for playback.
Technical Name: player_ready
Applicable for:
Node Location: event.type
Max Decimals: 0
Playing
event
Released in version 1.86
Definition: The media is no longer blocked from playback, and has started playing. Fired when playback resumes from Stall, Buffering or Seek.
Technical Name: playing
Supported Ad Networks: Google IMA
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Max Decimals: 0
Qualified View
event
Released in version 1.99
Definition: This event is fired when the user has watched a specified duration of video playback.
Technical Name: qualified_view
Applicable for: Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Rendition Change
event
Released in version 1.87
Definition: 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.
Technical Name: rendition_change
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Max Decimals: 0
Resize
event
Released in version 1.90
Definition: Fired when the player's on-page dimensions have changed. This event is not fired in response to a Fullscreen change.
Technical Name: resize
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Resume
event
Released in version 1.87
Definition: This event is fired when the user begins playing again after pausing the video during playback.
Technical Name: resume
Supported Ad Networks: Google IMA
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Max Decimals: 0
Seek Start
event
Released in version 1.86
Definition: 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.
Technical Name: seek_start
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Seek End
event
Released in version 1.86
Definition: 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.
Technical Name: seek_end
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Stall Start
event
Released in version 1.86
Definition: Stall Start event is triggered when playback of video stops because the buffer has been depleted causing an unexpected interruption for the user.
Technical Name: stall_start
Supported Ad Networks: Google IMA
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Stall End
event
Released in version 1.86
Definition: Event fired when video starts playing again after a stall and the buffer has been replenished and playback resumes.
Technical Name: stall_end
Supported Ad Networks: Google IMA
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Stop
event
Released in version 1.91
Definition: 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.
Technical Name: stop
Applicable for: Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Subtitle Change
event
Released in version 1.90
Definition: Fired when the user enables or disables subtitles or closed captioning.
Technical Name: subtitle_change
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Max Decimals: 0
Unmute
event
Released in version 1.90
Definition: Triggered when the player audio has been reactivated.
Technical Name: unmute
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
Volume Change
event
Released in version 1.90
Definition: Triggered when the player increases or decreases the audio level of the video.
Technical Name: volume_change
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Max Decimals: 0
FluxData
Bandwidth
fluxdata
Released in version 1.86
Definition: Amount of estimated network bandwidth currently available to the end user's device.
Technical Name: bandwidth_kbps
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2152
Unit: kbps
Max Decimals: 0
Buffer Duration
fluxdata
Released in version 1.86
Definition: 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.
Technical Name: buffer_duration_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 124
Unit: milliseconds
Max Decimals: 0
Buffer Duration - Ads
fluxdata
Released in version 1.86
Definition: 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.
Technical Name: buffer_duration_ads_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 124
Unit: milliseconds
Max Decimals: 0
Buffer Duration - Content
fluxdata
Released in version 1.86
Definition: Cumulative time that content has been buffering during content playback in current Content Session.
Technical Name: buffer_duration_content_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 124
Unit: milliseconds
Max Decimals: 0
Buffer Length
fluxdata
Released in version 1.88
Definition: The amount of media currently stored in the player buffer waiting to be played.
Technical Name: buffer_length_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 46100
Unit: milliseconds
Max Decimals: 0
Content Session Start Timestamp
fluxdata
Released in version 1.86
Definition: Start time of a new Content Session for the current user session. Typically a new Content Session begins with a Playback Request.
Technical Name: content_session_start_ts_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1589903189
Unit: milliseconds
Max Decimals: 0
Current Audio Track
fluxdata
Released in version 1.90
Definition: 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.
Technical Name: current_audio_track
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.metrics
Permitted Values: any
Example Value: Japanese - Dubbed
Max Decimals: 0
Current Subtitles
fluxdata
Released in version 1.90
Definition: 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.
Technical Name: current_subtitles
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.metrics
Permitted Values: any
Example Value: Spanish
Max Decimals: 0
Engagement Duration
fluxdata
Released in version 1.87
Definition: Cumulative time that user has been engaged with the app or site, including time spent not viewing video.
Technical Name: engagement_duration_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2468
Unit: milliseconds
Max Decimals: 0
Number of Ad Plays
fluxdata
Released in version 1.87
Definition: Running count of the number of ads played during the user's current session.
Technical Name: num_ad_plays
Applicable for: Ad, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 3
Unit: count
Max Decimals: 0
Number of Content Plays
fluxdata
Released in version 1.87
Definition: The amount of content assets that started playback during the current user app session.
Technical Name: num_content_plays
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2
Unit: count
Max Decimals: 0
Number of Content Requests
fluxdata
Released in version 1.87
Definition: The amount of content assets requested during the current user session.
Technical Name: num_requests_content
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2
Unit: count
Max Decimals: 0
Number of Errors
fluxdata
Released in version 1.87
Definition: Running count of the number of errors that have occurred during the user's current session.
Technical Name: num_errors
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2
Unit: count
Max Decimals: 0
Number of Errors - Ads
fluxdata
Released in version 1.87
Definition: Running count of the number of errors that have occurred while ads are playing during the user's current session.
Technical Name: num_errors_ads
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2
Unit: count
Max Decimals: 0
Number of Errors - Content
fluxdata
Released in version 1.87
Definition: Running count of the number of errors that have occurred while content is playing during the user's current session.
Technical Name: num_errors_content
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2
Unit: count
Max Decimals: 0
Pause Duration
fluxdata
Released in version 1.108
Definition: The cumulative amount of time elapsed where the player was in a paused state during a Content Session.
Technical Name: pause_duration_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2468
Unit: milliseconds
Max Decimals: 0
Pause Duration - Ads
fluxdata
Released in version 1.108
Definition: The cumulative amount of time elapsed where the player was in a paused state during Ad playback of Content Session.
Technical Name: pause_duration_ads_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2468
Unit: milliseconds
Max Decimals: 0
Pause Duration - Content
fluxdata
Released in version 1.108
Definition: The cumulative amount of time elapsed where the player was in a paused state during Content playback of Content Session.
Technical Name: pause_duration_content_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2468
Unit: milliseconds
Max Decimals: 0
Playback Duration
fluxdata
Released in version 1.87
Definition: Cumulative time that content & ads have been playing during the Content Session. Excludes time accrued while user pauses content or buffering.
Technical Name: playback_duration_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2468
Unit: milliseconds
Max Decimals: 0
Playback Duration - Content
fluxdata
Released in version 1.86
Definition: Cumulative time that content has been playing during the current video Content Session. Excludes time accrued while user pauses content or buffering.
Technical Name: playback_duration_content_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
Playback Rate
fluxdata
Released in version 1.89
Definition: 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
Technical Name: playback_rate
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 0.5
Unit: percentage
Max Decimals: 2
Player State
fluxdata
Released in version 1.86
Definition: Returns the player's current playback state. (Idle, buffering, playing, paused)
Technical Name: player_state
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.metrics
Permitted Values: any
Example Value: playing
Max Decimals: 0
Player Viewable
fluxdata
Released in version 1.88
Definition: Is 50% or more of the player visible on the screen at the time of event?
Technical Name: player_viewable
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: event.metrics
Permitted Values: value list
Example Value: false
Value List: true, false
Max Decimals: 0
Player Viewable Percent
fluxdata
Released in version 1.88
Definition: The percentage of the player that is viewable on the screen at the time of the event.
Technical Name: player_viewable_percent
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 75
Unit: percentage
Max Decimals: 3
Scale: 0 .. 100
Playhead Position
fluxdata
Released in version 1.86
Definition: Returns the current point in the video timeline in seconds.
Technical Name: playhead_position_sec
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 10.135
Unit: seconds
Max Decimals: 3
Rendition Height
fluxdata
Released in version 1.87
Definition: 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.
Technical Name: rendition_height
Applicable for: Ad, Content, Live, VOD, Ad
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 720
Unit: pixels
Max Decimals: 0
Rendition Name
fluxdata
Released in version 1.87
Definition: Standardized name to represent the rendition currently being played.
Technical Name: rendition_name
Applicable for: Ad, Content, Live, VOD, Ad
Field Type: string
Node Location: event.metrics
Permitted Values: any
Example Value: 720p
Max Decimals: 0
Rendition Video Bitrate
fluxdata
Released in version 1.86
Definition: 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.
Technical Name: rendition_video_bitrate_kbps
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 3127
Unit: kbps
Max Decimals: 0
Rendition Width
fluxdata
Released in version 1.87
Definition: 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.
Technical Name: rendition_width
Applicable for: Ad, Content, Live, VOD, Ad
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1280
Unit: pixels
Max Decimals: 0
Stall Count
fluxdata
Released in version 1.87
Definition: Number of times the user's playback has been interrupted by an unexpected video stall due to buffer depletion.
Technical Name: stall_count
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 3
Unit: count
Max Decimals: 0
Stall Count - Ads
fluxdata
Released in version 1.87
Definition: Number of times the user's playback of Ads has been interrupted by an unexpected video stall due to buffer depletion.
Technical Name: stall_count_ads
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1
Unit: count
Max Decimals: 0
Stall Count - Content
fluxdata
Released in version 1.87
Definition: Number of times the user's playback of Content has been interrupted by an unexpected video stall due to buffer depletion.
Technical Name: stall_count_content
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2
Unit: count
Max Decimals: 0
Stall Duration
fluxdata
Released in version 1.87
Definition: The cumulative amount of time elapsed where the user's playback has been interrupted by an unexpected video stall due to buffer.
Technical Name: stall_duration_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2468
Unit: milliseconds
Max Decimals: 0
Stall Duration - Ads
fluxdata
Released in version 1.87
Definition: 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.
Technical Name: stall_duration_ads_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
Stall Duration - Content
fluxdata
Released in version 1.86
Definition: 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.
Technical Name: stall_duration_content_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
Time Since Content Started
fluxdata
Released in version 1.88
Definition: Time interval since current content playback began.
Technical Name: time_since_started_content_ms
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 37
Unit: milliseconds
Max Decimals: 0
Time Since Content Request
fluxdata
Released in version 1.88
Definition: Time interval since content playback was requested.
Technical Name: time_since_request_content_ms
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 37
Unit: milliseconds
Max Decimals: 0
Time Since Last Ad Started
fluxdata
Released in version 1.88
Definition: Time interval since advertisement started playing.
Technical Name: time_since_last_started_ad_ms
Applicable for: Ad, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 37
Unit: milliseconds
Max Decimals: 0
Time Since Last Ad Break Start
fluxdata
Released in version 1.88
Definition: Time interval since the current pod of advertisements began.
Technical Name: time_since_last_ad_break_start_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
Time Since Last Ad Completed
fluxdata
Released in version 1.88
Definition: Time interval since the last advertisement completed.
Technical Name: time_since_last_ad_completed_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 37
Unit: milliseconds
Max Decimals: 0
Time Since Last Ad Request
fluxdata
Released in version 1.88
Definition: Time interval since advertisement was requested.
Technical Name: time_since_last_request_ad_ms
Applicable for: Ad, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 37
Unit: milliseconds
Max Decimals: 0
Time Since Last Buffer Start
fluxdata
Released in version 1.86
Definition: Time interval since Buffer Start event began during playback.
Technical Name: time_since_last_buffer_start_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
Time Since Last Buffer Start - Ad
fluxdata
Released in version 1.86
Definition: Time interval since Buffer Start event began during advertisement playback.
Technical Name: time_since_last_buffer_start_ad_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
Time Since Last Buffer Start - Content
fluxdata
Released in version 1.86
Definition: 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.
Technical Name: time_since_last_buffer_start_content_ms
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
Time Since Last Heartbeat
fluxdata
Released in version 1.86
Definition: Time interval since Heartbeat was last sent for the current content session.
Technical Name: time_since_last_heartbeat_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 10000
Unit: milliseconds
Max Decimals: 0
Time Since Last Milestone - Ad
fluxdata
Released in version 1.88
Definition: Time interval since Milestone event was last sent for ad.
Technical Name: time_since_last_milestone_ad_ms
Applicable for: Ad, Content, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 7500
Unit: milliseconds
Max Decimals: 0
Time Since Last Milestone - Content
fluxdata
Released in version 1.88
Definition: Time interval since Milestone event was last sent for content.
Technical Name: time_since_last_milestone_content_ms
Applicable for: Ad, Content, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 7500
Unit: milliseconds
Max Decimals: 0
Time Since Last Pause
fluxdata
Released in version 1.88
Definition: Time interval since content playback was paused., reported in milliseconds
Technical Name: time_since_last_pause_ms
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 37
Unit: milliseconds
Max Decimals: 0
Time Since Last Rendition Change
fluxdata
Released in version 1.87
Definition: Time interval since content playback shifted to a different available quality version from the manifest., reported in milliseconds
Technical Name: time_since_last_rendition_change_ms
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 37
Unit: milliseconds
Max Decimals: 0
Time Since Last Seek Start
fluxdata
Released in version 1.89
Definition: Time interval since the occurrence of a Seek Start event.
Technical Name: time_since_last_seek_start_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
Time Since Last Stall Start
fluxdata
Released in version 1.89
Definition: 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.
Technical Name: time_since_last_stall_start_ms
Applicable for: Content, Ad, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
Time Since Last Stall Start - Ad
fluxdata
Released in version 1.89
Definition: Time interval since Stall Start event began during advertisement playback.
Technical Name: time_since_last_stall_start_ad_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
Time Since Last Stall Start - Content
fluxdata
Released in version 1.89
Definition: Time interval since Stall Start event began during content playback.
Technical Name: time_since_last_stall_start_content_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
Volume Level
fluxdata
Released in version 1.90
Definition: The current playback volume as a whole number percentage.
Technical Name: volume_level_percent
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 85.2
Unit: percentage
Max Decimals: 0
Scale: 0 .. 100
Event Count
fluxdata
Released in version 1.87
Definition: 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.
Technical Name: event_count
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1
Unit: count
Max Decimals: 0
Event Attributes
Startup Duration - Content
metadata
Released in version 1.86
Definition: 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.
Technical Name: startup_duration_content_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.attributes
Permitted Values: any
Example Value: 123
Unit: milliseconds
Max Decimals: 0
Startup Duration - Total
metadata
Released in version 1.87
Definition: This timer represents the total time a user spent waiting for content to begin playback excluding any time spent viewing pre-roll ads.
Technical Name: startup_duration_total_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.attributes
Permitted Values: any
Example Value: 123
Unit: milliseconds
Max Decimals: 0
ABS Shift
metadata
Released in version 1.88
Definition: 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.
Technical Name: abs_shift
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.attributes
Permitted Values: value list
Example Value: up
Value List: up, down
Max Decimals: 0
Error Code
metadata
Released in version 1.87
Definition: Error object representing a code explicitly identified by the player
Technical Name: error_code
Supported Ad Networks: Google IMA
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.attributes
Permitted Values: any
Example Value: 1001
Max Decimals: 0
Error Message
metadata
Released in version 1.87
Definition: Error object representing a message about the error explicitly identified by the player
Technical Name: error_msg
Supported Ad Networks: Google IMA
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.attributes
Permitted Values: any
Example Value: Player failed to launch
Max Decimals: 0
Heartbeat Count
metadata
Released in version 1.105
Definition: Incremental tracker identifying the order of Heartbeat events from the Collector.
Technical Name: heartbeat_count
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.attributes
Permitted Values: any
Example Value: 1
Unit: count
Max Decimals: 0
Inner Error
metadata
Released in version 1.92
Definition: Returns the error that occurred during processing
Technical Name: inner_error
Supported Ad Networks: Google IMA
Applicable for: Ad
Field Type: string
Node Location: event.attributes
Permitted Values: any
Example Value: Error
at new QC (https://imasdk.googleapis.com/js/sdkloader/ima3.js:568:329)
at QC.l.getInnerError (https://imasdk.googleapis.com/js/sdkloader/ima3.js:568:512)
at Ae (https://ssl.p.jwpcdn.com/player/plugins/googima/v/8.9.0/googima.js:1:35485)
Max Decimals: 0
Milestone Percent
metadata
Released in version 1.87
Definition: Number indicating the percentage milestone represented by the event fired. Attribute of Milestone events.
Technical Name: milestone_percent
Supported Ad Networks: Google IMA
Applicable for: Ad, Content, VOD
Field Type: number
Node Location: event.attributes
Permitted Values: any
Example Value: 0.75
Unit: percentage
Max Decimals: 2
Scale: 0 .. 1
Seek Start Point
metadata
Released in version 1.86
Definition: The starting point of a seek event, representing the content timecode in milliseconds. Value will appear as an attribute on Seek End events
Technical Name: seek_start_point_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.attributes
Permitted Values: any
Example Value: 5678
Unit: milliseconds
Max Decimals: 0
Seek End Point
metadata
Released in version 1.86
Definition: The ending point of a seek event, representing the content timecode in milliseconds. Value will appear as an attribute on Seek End events
Technical Name: seek_end_point_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.attributes
Permitted Values: any
Example Value: 8910
Unit: milliseconds
Max Decimals: 0
Qualified View Trigger
metadata
Released in version 1.108
Definition: Number indicating the playback duration triggering the Qualified View event.
Technical Name: qualified_view_sec
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.attributes
Permitted Values: any
Example Value: 30
Unit: seconds
Max Decimals: 0
Message Metadata
Configuration ID
metadata
Released in version 1.86
Definition: 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.
Technical Name: configuration_id
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: root
Permitted Values: UUID
Example Value: 3bba4192-8105-4498-ae34-587154d56fa6
Max Decimals: 0
Event ID
metadata
Released in version 1.86
Definition: 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.
Technical Name: event_id
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: root
Permitted Values: any
Example Value: ddee8570-3dd5-4cfa-aeac-04d694c4c22a_00.00001
Max Decimals: 0
User Details
App Session Start Timestamp
metadata
Released in version 1.86
Definition: Start time of the current user session
Technical Name: app_session_start_ts_ms
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: user_details
Permitted Values: any
Example Value: 1535971954488
Unit: milliseconds
Max Decimals: 0
App Session ID
metadata
Released in version 1.86
Definition: 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.
Technical Name: app_session_id
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details
Permitted Values: any
Example Value: 43DHE-EROILKER-EREOATE
Max Decimals: 0
Cast App Session ID
metadata
Released in version 1.112
Definition: The app session identifier from a related casting device. When collected from the receiver, this value represents the original user app session that was started on the sender device; otherwise the value will represent the app session created on the cast device.
Technical Name: cast_app_session_id
Applicable for:
Field Type: string
Node Location: user_details
Permitted Values: UUID
Example Value: 4ADF2744-B168-4721-B999-CB2B66100E4A
Max Decimals: 0
Cast Content Session ID
metadata
Released in version 1.112
Definition: The content session identifier from a related casting device. When collected from the receiver, this value represents the original user content session that was started on the sender device; otherwise the value will represent the content session created on the cast device.
Technical Name: cast_content_session_id
Applicable for:
Field Type: string
Node Location: user_details
Permitted Values: UUID
Example Value: 32C1B310-E417-499F-B9B9-8C29593D3341
Max Decimals: 0
Client IP Address
metadata
Released in version 1.86
Definition: IP address of the user's device
Technical Name: client_ip
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details
Permitted Values: IP address
Example Value: 173.19.65.222
Max Decimals: 0
Content Session ID
metadata
Released in version 1.86
Definition: A unique id for the current video playback session.
Technical Name: content_session_id
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details
Permitted Values: UUID
Example Value: 3bba4192-8105-4498-ae34-587154d56fa6
Max Decimals: 0
User Agent
metadata
Released in version 1.86
Definition: 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.
Technical Name: user_agent
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details
Permitted Values: any
Example Value: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4606.71 Safari/537.36
Max Decimals: 0
Player
Autostart
metadata
Released in version 1.111
Definition: Returns whether the audio/video should start playing as soon as it is loaded
Technical Name: autostart
Applicable for: Content, Live, VOD
Field Type: bool
Node Location: player
Permitted Values: value list
Example Value: false
Value List: true, false
Max Decimals: 0
Casting
metadata
Released in version 1.90
Definition: Is the player currently in casting mode where the content selected will be played on an external device?
Technical Name: casting
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: player
Permitted Values: value list
Example Value: true
Value List: true, false
Max Decimals: 0
Default Muted
metadata
Released in version 1.115
Definition: Identifies whether the audio/video should be muted by default
Technical Name: default_muted
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: player
Permitted Values: value list
Example Value: true
Value List: true, false
Max Decimals: 0
Fullscreen
metadata
Released in version 1.115
Definition: Is the player in fullscreen mode?
Technical Name: fullscreen
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: player
Permitted Values: value list
Example Value: true
Value List: true, false
Max Decimals: 0
Muted
metadata
Released in version 1.115
Definition: Returns True if player is muted.
Technical Name: muted
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: player
Permitted Values: value list
Example Value: true
Value List: true, false
Max Decimals: 0
Player Name
metadata
Released in version 1.86
Definition: States which video player generated the event
Technical Name: player_name
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player
Permitted Values: any
Example Value: JW Player
Max Decimals: 0
Player Version
metadata
Released in version 1.86
Definition: States the version of the video player that generated the event
Technical Name: player_version
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player
Permitted Values: any
Example Value: 8.01
Max Decimals: 0
Preload
metadata
Released in version 1.113
Definition: 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.
Technical Name: preload
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player
Permitted Values: value list
Example Value: metadata
Value List: none, metadata, auto
Max Decimals: 0
Ready State
metadata
Released in version 1.91
Definition: Identifies the current ready state of the audio/video
Technical Name: ready_state
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: player
Permitted Values: value list
Example Value: 1
Value List: 0,1,2,3,4
Max Decimals: 0
Streaming Protocol
metadata
Released in version 1.88
Definition: What streaming format is being used for the content?
Technical Name: streaming_protocol
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player
Permitted Values: value list
Example Value: HLS
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
Released in version 1.88
Definition: Describes if the content being streamed is Live or On Demand.
Technical Name: streaming_type
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player
Permitted Values: value list
Example Value: Live
Value List: Live, VOD
Max Decimals: 0
Subtitles
metadata
Released in version 1.90
Definition: Describes if subtitles are currently enabled for playback.
Technical Name: subtitles
Applicable for: Ad, Live, Content, VOD
Field Type: bool
Node Location: player
Permitted Values: value list
Example Value: true
Value List: true, false
Max Decimals: 0
Device
Browser Height
metadata
Released in version 1.87
Definition: The height of the end user's browser window at the time when the event occurred.
Technical Name: browser_height
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: device
Permitted Values: any
Example Value: 1250
Unit: pixels
Max Decimals: 0
Browser Name
metadata
Released in version 1.86
Definition: Web browser being used during the session
Technical Name: browser_name
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: Chrome
Max Decimals: 0
Browser Version
metadata
Released in version 1.86
Definition: Version of web browser being used during the session
Technical Name: browser_version
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: 52.01.03
Max Decimals: 0
Browser Width
metadata
Released in version 1.87
Definition: The width of the end user's browser window at the time when the version occurred.
Technical Name: browser_width
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: device
Permitted Values: any
Example Value: 2150
Unit: pixels
Max Decimals: 0
Device ID
metadata
Released in version 1.86
Definition: Unique identifier of the user's device.
Technical Name: device_id
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: 93fb4310be52415e
Max Decimals: 0
Device Type
metadata
Released in version 1.86
Definition: Describes the type of device category being used during the session such as phone, tablet, desktop, connected device, game console, etc.
Technical Name: device_type
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: value list
Example Value: pc
Value List: pc, mobile, tablet, ott device, tv, game console, wearable
Max Decimals: 0
OS Name
metadata
Released in version 1.86
Definition: Operating System of the user's device
Technical Name: os_name
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: OS X
Max Decimals: 0
OS Version
metadata
Released in version 1.86
Definition: Version of Operating System being used during the session
Technical Name: os_version
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: 10.14
Max Decimals: 0
Video
Asset ID
metadata
Released in version 1.99
Definition: Unique identifier of the content shown. This may be produced by the CMS or publishing system.
Technical Name: asset_id
Applicable for: Content, Live, VOD
Field Type: string
Node Location: video
Permitted Values: any
Example Value: 123456
Max Decimals: 0
Description
metadata
Released in version 1.99
Definition: 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.
Technical Name: description
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: video
Permitted Values: any
Example Value: A successful psychotherapist loses his mind after one of his most dependent patients, an obsessive-compulsive neurotic, tracks him down during his family vacation.
Max Decimals: 0
Duration
metadata
Released in version 1.86
Definition: The total length of the media file, reported in decimal seconds
Technical Name: duration_sec
Applicable for: Ad, Content, VOD
Field Type: number
Node Location: video
Permitted Values: any
Example Value: 25.49
Unit: seconds
Max Decimals: 3
Media Type
metadata
Released in version 1.86
Definition: Specifies whether the event relates to an Ad or Content asset.
Technical Name: media_type
Supported Ad Networks: Google IMA
Applicable for: Ad, Content, Live, VOD, Ad
Field Type: string
Node Location: video
Permitted Values: value list
Example Value: Ad
Value List: ad, content
Max Decimals: 0
Player Height
metadata
Released in version 1.89
Definition: Height dimension in pixels of the current playback area.
Technical Name: player_height
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: video
Permitted Values: any
Example Value: 1080
Unit: pixels
Max Decimals: 0
Player Width
metadata
Released in version 1.89
Definition: Width dimension in pixels of the current playback area.
Technical Name: player_width
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: video
Permitted Values: any
Example Value: 1920
Unit: pixels
Max Decimals: 0
Source
metadata
Released in version 1.87
Definition: Returns the URL of the current media file
Technical Name: source
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: video
Permitted Values: URL
Example Value: http://...
Max Decimals: 0
Title
metadata
Released in version 1.99
Definition: Provides the title of current asset being played
Technical Name: title
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: video
Permitted Values: any
Example Value: What About Bob?
Max Decimals: 0
Location
City
metadata
Released in version 1.86
Definition: 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.
Technical Name: city
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: Santa Rosa Beach
Max Decimals: 0
Continent
metadata
Released in version 1.91
Definition: 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.
Technical Name: continent
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: North America
Max Decimals: 0
Continent Code
metadata
Released in version 1.91
Definition: 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.
Technical Name: continent_code
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: 2 letter code
Example Value: NA
Max Decimals: 0
Country
metadata
Released in version 1.86
Definition: 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.
Technical Name: country
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: United States
Max Decimals: 0
Country Code
metadata
Released in version 1.86
Definition: 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.
Technical Name: country_code
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: 2 letter code
Example Value: US
Max Decimals: 0
District
metadata
Released in version 1.91
Definition: 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.
Technical Name: district
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: Old Farm District
Max Decimals: 0
Latitude
metadata
Released in version 1.86
Definition: Location information for the user
Use Case
When used in conjunction with longitude, this can provide an exact location for the viewer.
Technical Name: latitude
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: geo_location
Permitted Values: any
Example Value: 30.3659
Unit: degrees
Max Decimals: 4
Scale: -90 .. 90
Longitude
metadata
Released in version 1.86
Definition: Location information for the user
Use Case
When used in conjunction with latitude, this can provide an exact location for the viewer.
Technical Name: longitude
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: geo_location
Permitted Values: any
Example Value: -86.2458
Unit: degrees
Max Decimals: 4
Scale: -180 .. 180
Postal Code
metadata
Released in version 1.86
Definition: 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.
Technical Name: postal_code
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: 32459
Max Decimals: 0
Region
metadata
Released in version 1.86
Definition: 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.
Technical Name: region
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: Florida
Max Decimals: 0
Region Code
metadata
Released in version 1.86
Definition: 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.
Technical Name: region_code
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: FL
Max Decimals: 0
Timezone Name
metadata
Released in version 1.91
Definition: 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.
Technical Name: timezone_name
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: America/Chicago
Max Decimals: 0
Timezone Offset
metadata
Released in version 1.91
Definition: 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.
Technical Name: timezone_offset
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: geo_location
Permitted Values: any
Example Value: -4.5
Unit: hours
Max Decimals: 2
Scale: -24 .. 24
Network
Mobile Connection
metadata
Released in version 1.91
Definition: 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.
Technical Name: mobile_connection
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: network
Permitted Values: value list
Example Value: True
Value List: true,false
Max Decimals: 0
ASN
metadata
Released in version 1.86
Definition: 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
Technical Name: asn
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network
Permitted Values: any
Example Value: AS30036 Mediacom Communications Corp
Max Decimals: 0
ASN Org
metadata
Released in version 1.86
Definition: The organization that owns the Autonomous System Number. Often an ISP, sometimes a private company or institution.
Technical Name: asn_org
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network
Permitted Values: any
Example Value: MEDIACOM
Max Decimals: 0
ISP
metadata
Released in version 1.86
Definition: Name of the end-user's internet service provider.
Technical Name: isp
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network
Permitted Values: any
Example Value: Mediacom Communications Corp
Max Decimals: 0
Page
DZ SDK Version
metadata
Released in version 1.86
Definition: Version number of the Datazoom SDK that generated the event message.
Technical Name: dz_sdk_version
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: page
Permitted Values: any
Example Value: 1.40
Max Decimals: 0
Page Title
metadata
Released in version 1.89
Definition: The title of the page from which the event originated.
Technical Name: page_title
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: page
Permitted Values: any
Example Value: Week 15 NFL Game Picks, schedule guide, playoff scenarios and more
Max Decimals: 0
Page URL
metadata
Released in version 1.89
Definition: The address of the page from which the event originated.
Technical Name: page_url
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: page
Permitted Values: URL
Example Value: http://...
Max Decimals: 0
Referrer URL
metadata
Released in version 1.91
Definition: The URL of the page the user visited before coming to the active page.
Technical Name: referrer_url
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: page
Permitted Values: URL
Example Value: http://...
Max Decimals: 0
Site Domain
metadata
Released in version 1.91
Definition: URL Domain of the site hosting the video player.
Technical Name: site_domain
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: page
Permitted Values: any
Example Value: espn.com
Max Decimals: 0
Ad Data
Ad Blocker
metadata
Released in version 1.88
Definition: States whether an Ad Blocker was detected or not.
Technical Name: ad_blocker
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: ad
Permitted Values: value list
Example Value: False
Value List: True,False
Max Decimals: 0
Ad Break ID
metadata
Released in version 1.86
Definition: UUID to denote the specific ad break. This can be used to tie events together that occurred during a specific ad break.
Technical Name: ad_break_id
Applicable for: Ad, Live, VOD
Field Type: string
Node Location: ad
Permitted Values: UUID
Example Value: 7A05EA23-E798-47C8-A243-0B8E1D5D7AD7
Max Decimals: 0
Ad Creative ID
metadata
Released in version 1.86
Definition: Creative ID of the ad shown.
Technical Name: ad_creative_id
Supported Ad Networks: Google IMA
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad
Permitted Values: any
Example Value: E1lDoiRb
Max Decimals: 0
Ad Duration
metadata
Released in version 1.86
Definition: The length of the advertisement in seconds.
Technical Name: ad_duration_sec
Applicable for: Ad, Live, VOD
Field Type: number
Node Location: ad
Permitted Values: any
Example Value: 30
Unit: seconds
Max Decimals: 3
Ad ID
metadata
Released in version 1.86
Definition: Identifier of the ad asset shown.
Technical Name: ad_id
Supported Ad Networks: Google IMA
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad
Permitted Values: any
Example Value: 123456
Max Decimals: 0
Ad Position
metadata
Released in version 1.86
Definition: 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.
Technical Name: ad_position
Supported Ad Networks: Google IMA
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad
Permitted Values: value list
Example Value: pre
Value List: pre, mid, post
Max Decimals: 0
Ad Session ID
metadata
Released in version 1.86
Definition: 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.
Technical Name: ad_session_id
Applicable for: Ad
Field Type: string
Node Location: ad
Permitted Values: UUID
Example Value: FFBD8A96-4CA7-4D5E-AF3C-D69345E29BE1
Max Decimals: 0
Ad System
metadata
Released in version 1.86
Definition: The source ad server information included in the ad response.
Technical Name: ad_system
Supported Ad Networks: Google IMA
Applicable for: Ad
Field Type: string
Node Location: ad
Permitted Values: any
Example Value: Innovid Ads
Max Decimals: 0
Ad Time Offset
metadata
Released in version 1.86
Definition: 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.
Technical Name: ad_time_offset_sec
Supported Ad Networks: Google IMA
Applicable for: Ad
Field Type: number
Node Location: ad
Permitted Values: any
Example Value: 30
Unit: seconds
Max Decimals: 3
Advertiser Name
metadata
Released in version 1.86
Definition: The advertiser name as defined by the serving party.
Technical Name: advertiser_name
Supported Ad Networks: Google IMA
Applicable for: Ad
Field Type: string
Node Location: ad
Permitted Values: any
Example Value: Ford
Max Decimals: 0
Deal ID
metadata
Released in version 1.91
Definition: Returns the first deal ID present in the wrapper chain for the current ad, starting from the top.
Technical Name: deal_id
Supported Ad Networks: Google IMA
Applicable for: Ad
Field Type: string
Node Location: ad
Permitted Values: any
Example Value: 123456
Max Decimals: 0
Skip Time Offset
metadata
Released in version 1.86
Definition: The number of seconds of playback before the ad becomes skippable. -1 is returned for non skippable ads or if this is unavailable.
Technical Name: skip_time_offset_sec
Supported Ad Networks: Google IMA
Applicable for: Ad
Field Type: number
Node Location: ad
Permitted Values: any
Example Value: 5
Unit: seconds
Max Decimals: 3
Wrapper Creative IDs
metadata
Released in version 1.91
Definition: Selected creative IDs used for wrapper ads. The creative IDs returned starts at the inline ad and traverses to the outermost wrapper ad.
Technical Name: wrapper_creative_ids
Supported Ad Networks: Google IMA
Applicable for: Ad
Field Type: array of string
Node Location: ad
Permitted Values: any
Example Value: 123456
Max Decimals: 0
Wrapper ID
metadata
Released in version 1.91
Definition: Ad IDs used for wrapper ads. The IDs returned starts at the inline ad (innermost) and traverses to the outermost wrapper ad.
Technical Name: wrapper_id
Supported Ad Networks: Google IMA
Applicable for: Ad
Field Type: array of string
Node Location: ad
Permitted Values: any
Example Value: 123456
Max Decimals: 0
Wrapper Systems
metadata
Released in version 1.91
Definition: Ad systems used for wrapper ads. The ad systems returned starts at the inline ad and traverses to the outermost wrapper ad.
Technical Name: wrapper_systems
Supported Ad Networks: Google IMA
Applicable for: Ad
Field Type: array of string
Node Location: ad
Permitted Values: any
Example Value: 123456
Max Decimals: 0
Custom
Custom Metadata
metadata
Released in version 1.86
Definition: 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.
Technical Name: {custom_metadata_name}
Applicable for: Ad, Content, Live, VOD
Node Location: custom
Permitted Values: any
Max Decimals: 0
Released in version 1.87
Definition:
Applicable for:
|
Comments
0 comments
Article is closed for comments.