Events
Ad Break Start
event
Released in version 1.81
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: Roku
Applicable for: Live, VOD, Ad
Node Location: event.type
Ad Break End
event
Released in version 1.80
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: Roku
Applicable for: Live, VOD, Ad
Node Location: event.type
Ad Impression
event
Released in version 1.80
Definition: Fired when an Ad impression is recorded by the video player.
Use Case
Count how many times a single ad was presented to a user.
Technical Name: ad_impression
Supported Ad Networks: Roku
Applicable for: Live, VOD, Ad
Node Location: event.type
Buffer Start
event
Released in version 1.80
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
Monitor the number of delays of user playback caused by waiting for video to load.
Technical Name: buffer_start
Supported Ad Networks: Roku
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Buffer End
event
Released in version 1.80
Definition: Event is fired when video starts playing again after a buffer is completed.
Use Case
Compare the number of times video successfully resumed playing after buffering with the total number of Buffering events to see what percentage of buffers were irrecoverable.
Technical Name: buffer_end
Supported Ad Networks: Roku
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Custom Event
event
Released in version 1.82
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.
Use Case
Record that a user entered a comment on the video during playback. Capture a button from outside the player that was pressed by the user during video playback.
Technical Name: {custom_event_name}
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Datazoom Loaded
event
Released in version 1.79
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
Error
event
Released in version 1.79
Definition: Thrown if an error occurs during content playback or retrieval of the video
Use Case
How many errors occurred in the video player during content playback?
Technical Name: error
Supported Ad Networks: Roku
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Heartbeat
event
Released in version 1.79
Definition: Periodic event that provides updated insight into all of the selected FluxData metrics fired at the specified Heartbeat interval.
Use Case
This heartbeat event can be used for creating time-series charts tracking a user's quality of experience during their playback session.
Technical Name: heartbeat
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Media Loaded
event
Released in version 1.80
Definition: Fired when the video is fully loaded into the player & ready to begin playback.
Use Case
Part of the startup sequence of video playback so you can identify time taken to complete each step.
Technical Name: media_loaded
Supported Ad Networks: Roku
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Media Request
event
Released in version 1.80
Definition: 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 a video
Technical Name: media_request
Supported Ad Networks: Roku
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Milestone
event
Released in version 1.81
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.
Use Case
What percentage of users made it to various checkpoints in the video timeline.
Technical Name: milestone
Supported Ad Networks: Roku
Applicable for: Ad, Content, VOD
Node Location: event.type
Pause
event
Released in version 1.79
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
Play Button
event
Released in version 1.82
Definition: 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.
Use Case
Count the number of playback attempts within the app & compare against successful video starts.
Technical Name: play_btn
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Playback Start
event
Released in version 1.80
Definition: This event is fired when the video starts playing for the user, also known as First Frame.
Use Case
Use this to determine the period of time between a user pressing play and the same user viewing their content
Technical Name: playback_start
Supported Ad Networks: Roku
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Playback Complete
event
Released in version 1.80
Definition: This event signifies that the video player has reached the end of the currently playing content.
Use Case
Compare the number of Play Requests with the number of Playback Complete events to get a percentage of users who watched the entire video.
Technical Name: playback_complete
Supported Ad Networks: Roku
Applicable for: Content, VOD, Ad
Node Location: event.type
Player Ready
event
Released in version 1.79
Definition: Signifies when the player has been initialized and is ready for playback.
Technical Name: player_ready
Applicable for:
Node Location: event.type
Playing
event
Released in version 1.82
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: Roku
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
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
Rendition Change
event
Released in version 1.86
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.
Use Case
How often does an video change quality during playback due to network bandwidth conditions?
Technical Name: rendition_change
Supported Ad Networks: Roku
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Resume
event
Released in version 1.79
Definition: This event is fired when the user begins playing again after pausing the video during playback.
Use Case
Compare the amount of time elapsed between user hitting the Pause event and then resuming playback.
Technical Name: resume
Supported Ad Networks: Roku
Applicable for: Content, Live, VOD, Ad
Node Location: event.type
Seek Start
event
Released in version 1.79
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.
Use Case
Count the number of times users choose to seek to another part of the video.
Technical Name: seek_start
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Seek End
event
Released in version 1.79
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.
Use Case
Determine what parts of a video were skipped over or re-watched frequently.
Technical Name: seek_end
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Stall Start
event
Released in version 1.80
Definition: Stall Start event is triggered when playback of video stops because the buffer has been depleted causing an unexpected interruption for the user.
Use Case
Monitor the number of interruptions of user playback caused by waiting for video to load.
Technical Name: stall_start
Supported Ad Networks: Roku
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Stall End
event
Released in version 1.85
Definition: Event fired when video starts playing again after a stall and the buffer has been replenished and playback resumes.
Use Case
Compare the number of times video successfully resumed playing after an interruption with the total number of Stall events to see what percentage of interruptions were irrecoverable.
Technical Name: stall_end
Supported Ad Networks: Roku
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Stop
event
Released in version 1.95
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
FluxData
Bandwidth
fluxdata
Released in version 1.95
Definition: Amount of estimated network bandwidth currently available to the end user's device.
Use Case
Am I delivering a higher quality video asset to the user than their network connection can handle?
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.80
Definition: Cumulative time that content has been buffering during the current Content Session.
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 - Content
fluxdata
Released in version 1.82
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
Content Session Start Timestamp
fluxdata
Released in version 1.83
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.93
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
Current Subtitles
fluxdata
Released in version 1.97
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
Engagement Duration
fluxdata
Released in version 1.82
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 Content Plays
fluxdata
Released in version 1.82
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.85
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.80
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 - Content
fluxdata
Released in version 1.85
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.95
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.97
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.95
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.80
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 - Ads
fluxdata
Released in version 1.93
Definition: Cumulative time that ads have been playing during the current Content Session. Excludes time accrued while user pauses content or buffering.
Technical Name: playback_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
Playback Duration - Content
fluxdata
Released in version 1.82
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
Player State
fluxdata
Released in version 1.93
Definition: Returns the player's current playback state. (Idle, buffering, playing, paused)
Use Case
Correlate the current state of the video player with other activities or actions that are occurring with the user during a session.
Technical Name: player_state
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.metrics
Permitted Values: any
Example Value: playing
Playhead Position
fluxdata
Released in version 1.79
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 Audio Bitrate
fluxdata
Released in version 1.95
Definition: 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.
Use Case
Use rendition attributes to determine if the correct version of the video is being delivered to the client to match the users bandwidth, device & resolution.
Technical Name: rendition_audio_bitrate_kbps
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 300
Unit: kbps
Max Decimals: 0
Rendition Height
fluxdata
Released in version 1.95
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.
Use Case
Use rendition attributes to determine if the correct version of the video is being delivered to the client to match the users bandwidth, device & resolution.
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.95
Definition: Standardized name to represent the rendition currently being played.
Use Case
Use rendition attributes to determine if the correct version of the video is being delivered to the client to match the users bandwidth, device & resolution.
Technical Name: rendition_name
Applicable for: Ad, Content, Live, VOD, Ad
Field Type: string
Node Location: event.metrics
Permitted Values: any
Example Value: 720p
Rendition Video Bitrate
fluxdata
Released in version 1.89
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.
Use Case
What is the average bitrate of all videos delivered to my users?
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.95
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.
Use Case
Use rendition attributes to determine if the correct version of the video is being delivered to the client to match the users bandwidth, device & resolution.
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.79
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 - Content
fluxdata
Released in version 1.79
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.80
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 - Content
fluxdata
Released in version 1.80
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.82
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.82
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 Buffer Start - Content
fluxdata
Released in version 1.83
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.82
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.86
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.86
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.82
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.92
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.82
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 - Content
fluxdata
Released in version 1.82
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
Event Count
fluxdata
Released in version 1.80
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
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.81
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.93
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.
Use Case
Monitor how often the video player is downshifting video quality to account for network conditions.
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
Error Code
metadata
Released in version 1.79
Definition: Error object representing a code explicitly identified by the player
Technical Name: error_code
Supported Ad Networks: Roku
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.attributes
Permitted Values: any
Example Value: 1001
Error Message
metadata
Released in version 1.85
Definition: Error object representing a message about the error explicitly identified by the player
Technical Name: error_msg
Supported Ad Networks: Roku
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.attributes
Permitted Values: any
Example Value: Player failed to launch
Milestone Percent
metadata
Released in version 1.81
Definition: Number indicating the percentage milestone represented by the event fired. Attribute of Milestone events.
Technical Name: milestone_percent
Supported Ad Networks: Roku
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.82
Definition: The starting point of a seek event, representing the content timecode in milliseconds. Value will appear as an attribute on Seek End events
Use Case
Determine where in the video timeline a user began a seek.
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.79
Definition: The ending point of a seek event, representing the content timecode in milliseconds. Value will appear as an attribute on Seek End events
Use Case
Determine how much video time was covered during a user's seek event or if the seek was forward or backwards.
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.99
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.79
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
Event ID
metadata
Released in version 1.79
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.
Use Case
Provides a UUID that can be used for de-dupping records in the data platform or Connector.
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
User Details
App Session Start Timestamp
metadata
Released in version 1.81
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.81
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.
Use Case
This is the primary identifier for grouping events generated by Datazoom for analysis and unique user counts.
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
Client IP Address
metadata
Released in version 1.79
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
Content Session ID
metadata
Released in version 1.79
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
User Agent
metadata
Released in version 1.79
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
Player
Player Name
metadata
Released in version 1.79
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
Player Version
metadata
Released in version 1.79
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
Streaming Protocol
metadata
Released in version 1.79
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
Streaming Type
metadata
Released in version 1.79
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
Subtitles
metadata
Released in version 1.95
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
Device
Advertising ID
metadata
Released in version 1.82
Definition: 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.
Technical Name: advertising_id
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: device
Permitted Values: any
Example Value: 75ee75da-9aa3-4a40-a6b8-6d2aa64c90d6
Device ID
metadata
Released in version 1.79
Definition: Unique identifier of the user's device.
Use Case
This can be used as a proxy for User if user is anonymous.
Technical Name: device_id
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: 93fb4310be52415e
Device Manufacturer
metadata
Released in version 1.79
Definition: Manufacturer of the user's device.
Technical Name: device_mfg
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: Apple
Device Name
metadata
Released in version 1.79
Definition: Name of the device model used by the viewer.
Technical Name: device_name
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: iPad Mini 4
Device Type
metadata
Released in version 1.79
Definition: Describes the type of device category being used during the session such as phone, tablet, desktop, connected device, game console, etc.
Use Case
Can be used to group attributes by device platform type for better understanding of app performance on different platforms.
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
OS Name
metadata
Released in version 1.79
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
OS Version
metadata
Released in version 1.79
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
Video
Asset ID
metadata
Released in version 1.82
Definition: Unique identifier of the content shown. This may be produced by the CMS or publishing system.
Use Case
This identifier will allow an analyst to group events from various users & various sessions that are all viewing the same content or ad asset.
Technical Name: asset_id
Applicable for: Content, Live, VOD
Field Type: string
Node Location: video
Permitted Values: any
Example Value: 123456
duration
metadata
Released in version 1.79
Definition: The total length of the media file, reported in decimal seconds
Technical Name: duration
Applicable for: Ad, Content, VOD
Field Type: number
Node Location: video
Example Value: 25.49
Unit: seconds
Max Decimals: 3
Duration
metadata
Released in version 1.80
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.80
Definition: Specifies whether the event relates to an Ad or Content asset.
Technical Name: media_type
Supported Ad Networks: Roku
Applicable for: Ad, Content, Live, VOD, Ad
Field Type: string
Node Location: video
Permitted Values: value list
Example Value: Ad
Value List: ad, content
Player Height
metadata
Released in version 1.95
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.95
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.79
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://...
Title
metadata
Released in version 1.79
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?
Location
City
metadata
Released in version 1.79
Definition: The city or town where the user is located
Technical Name: city
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: Santa Rosa Beach
Continent
metadata
Released in version 1.97
Definition: The name of the continent from which the event originated based on the user's IP address.
Technical Name: continent
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: North America
Continent Code
metadata
Released in version 1.97
Definition: The continent from which the event originated based on the user's IP address.
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
Country
metadata
Released in version 1.79
Definition: Full name of the user's country
Technical Name: country
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: United States
Country Code
metadata
Released in version 1.79
Definition: The country from which the browser initiated the event. For a list of country codes, see ISO 3166-1 alpha-2 .
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
District
metadata
Released in version 1.97
Definition: The district, subdivision of city from where the event originated as determined by the user's IP address.
Technical Name: district
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: Old Farm District
Latitude
metadata
Released in version 1.79
Definition: Location information for the user
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.79
Definition: Location information for the user
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.79
Definition: The specific administrative division within a country where the event occurred. In the United States, zip codes correspond to postal region locator
Technical Name: postal_code
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: 32459
Region
metadata
Released in version 1.79
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.
Technical Name: region
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: Florida
Region Code
metadata
Released in version 1.79
Definition: The specific administrative division within a country where the event occurred. In the United States, regions correspond to state codes ; for example, WA or NY.
Technical Name: region_code
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: 2 letter code
Example Value: FL
Timezone Name
metadata
Released in version 1.95
Definition: The name of the user's timezone where the event originated based on their IP address.
Technical Name: timezone_name
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: America/Chicago
Timezone Offset
metadata
Released in version 1.95
Definition: The difference in hours, relative to UTC, of the user's timezone.
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
ASN
metadata
Released in version 1.79
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
Use Case
ASN is a proxy for the customer's ISP which can be used for analyzing usage by ISP to identify problems that might be related a specific part of the ISP infrastructure.
Technical Name: asn
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network
Permitted Values: any
Example Value: AS30036 Mediacom Communications Corp
ASN Org
metadata
Released in version 1.79
Definition: The organization that owns the Autonomous System Number. Often an ISP, sometimes a private company or institution.
Use Case
ASN is a proxy for the customer's ISP which can be used for analyzing usage by ISP to identify problems that might be related to the ISP
Technical Name: asn_org
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network
Permitted Values: any
Example Value: MEDIACOM
ISP
metadata
Released in version 1.80
Definition: Name of the end-user's internet service provider.
Use Case
Can be used for analyzing usage by ISP to identify problems that might be related to the ISP
Technical Name: isp
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network
Permitted Values: any
Example Value: Mediacom Communications Corp
isp
metadata
Released in version 1.79
Definition: Name of the end-user's internet service provider.
Use Case
Can be used for analyzing usage by ISP to identify problems that might be related to the ISP
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network
Permitted Values: any
Example Value: Mediacom Communications Corp
Page
DZ SDK Version
metadata
Released in version 1.79
Definition: Version number of the Datazoom SDK that generated the event message.
Use Case
Used for troubleshooting data issues or isolating data differences stemming from alternate versions of the SDK used.
Technical Name: dz_sdk_version
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: page
Permitted Values: any
Example Value: 1.40
Site Domain
metadata
Released in version 1.92
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
Ad Data
Ad Break ID
metadata
Released in version 1.80
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
Ad Creative ID
metadata
Released in version 1.92
Definition: Creative ID of the ad shown.
Use Case
Creative ID is used to identify the same ad displayed across different sites.
Technical Name: ad_creative_id
Supported Ad Networks: Roku
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad
Permitted Values: any
Example Value: E1lDoiRb
Ad Duration
metadata
Released in version 1.81
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: 0
Ad ID
metadata
Released in version 1.92
Definition: Identifier of the ad asset shown.
Technical Name: ad_id
Supported Ad Networks: Roku
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad
Permitted Values: any
Example Value: 123456
Ad Partner
metadata
Released in version 1.93
Definition: Name of the partner showing the ad.
Use Case
Understand the source, publisher or advertiser who is responsible for displaying the ad on the service.
Technical Name: ad_partner
Supported Ad Networks: Roku
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad
Permitted Values: any
Example Value: Pepsi
Ad Position
metadata
Released in version 1.80
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: Roku
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad
Permitted Values: value list
Example Value: pre
Value List: pre, mid, post
Ad Session ID
metadata
Released in version 1.80
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
Ad System
metadata
Released in version 1.92
Definition: The source ad server information included in the ad response.
Technical Name: ad_system
Supported Ad Networks: Roku
Applicable for: Ad
Field Type: string
Node Location: ad
Permitted Values: any
Example Value: Innovid Ads
Wrapper Creative IDs
metadata
Released in version 1.95
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: Roku
Applicable for: Ad
Field Type: array of string
Node Location: ad
Permitted Values: any
Example Value: 123456
Wrapper ID
metadata
Released in version 1.93
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: Roku
Applicable for: Ad
Field Type: array of string
Node Location: ad
Permitted Values: any
Example Value: 123456
Wrapper Systems
metadata
Released in version 1.93
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: Roku
Applicable for: Ad
Field Type: array of string
Node Location: ad
Permitted Values: any
Example Value: 123456
Custom
Custom Metadata
metadata
Released in version 1.83
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
|
Comments
0 comments
Article is closed for comments.