Events
Ad Break Start
event
Released in version 1.59
Definition: Fired at the beginning of an advertising pod, signifies that content has been delayed while the advertisements are played.
Applicable for: Live, VOD, Ad
Node Location: event.type
Ad Break End
event
Released in version 1.59
Definition: Fired at the end of an advertising pod, signifies that the advertisements have ended and content is ready to resume.
Applicable for: Live, VOD, Ad
Node Location: event.type
Ad Complete
event
Released in version 1.50
Definition: Fired when an ad completes playing back
Use Case
What percentage of users watched the entire ad?
Applicable for: Live, VOD, Ad
Node Location: event.type
Ad Error
event
Released in version 1.58
Definition: Thrown if an error occurs during ad playback or retrieval of an ad
Use Case
How many errors occurred in the video player during ad playback?
Applicable for: Live, VOD, Ad
Node Location: event.type
Ad Impression
event
Released in version 1.50
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.
Applicable for: Live, VOD, Ad
Node Location: event.type
Ad Loaded
event
Released in version 1.57
Definition: Fired when the ad is fully loaded into the player & ready to begin playback.
Applicable for: Ad
Node Location: event.type
Ad Pause
event
Released in version 1.59
Definition: Fired when the ad is paused. Depending on your implementation pausing an ad may not be allowed.
Use Case
Track the number of times a user decided to pause an ad during playback.
Applicable for: Live, VOD, Ad
Node Location: event.type
Ad Play
event
Released in version 1.57
Definition: Fired whenever an ad starts playing for the first time.
Applicable for: Live, VOD, Ad
Node Location: event.type
Ad Request
event
Released in version 1.50
Definition: When ad is requested from the ad server.
Use Case
Compare how many ads were requested versus how many were actually played to get a delivery percentage.
Applicable for: Live, VOD, Ad
Node Location: event.type
Ad Resume
event
Released in version 1.59
Definition: When playback of the ad is resumed after being paused.
Use Case
What percentage of users continued watching the ad after initially pausing playback?
Applicable for: Live, VOD, Ad
Node Location: event.type
Buffer Start
event
Released in version 1.54
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.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Buffer End
event
Released in version 1.58
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.
Applicable for: Content, Live, VOD
Node Location: event.type
Content Loaded
event
Released in version 1.53.1
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.
Applicable for: Content, Live, VOD
Node Location: event.type
Datazoom Loaded
event
Released in version 1.51.2
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.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Error
event
Released in version 1.57
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?
Applicable for: Content, Live, VOD
Node Location: event.type
Heartbeat
event
Released in version 1.51.2
Definition: Periodic event that contains 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.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Milestone
event
Released in version 1.53.1
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.
Applicable for: Ad, Content, VOD
Node Location: event.type
Mute
event
Released in version 1.23
Definition: Triggered when the player volume has been reduced to zero.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Pause
event
Released in version 1.17
Definition: Event is fired when user hits the Pause button and chooses to temporarily halt video playback.
Applicable for: Content, Live, VOD
Node Location: event.type
Play
event
Released in version 1.17
Definition: Event is fired when a user initiates video playback by clicking on the play button.
Use Case
Count the number of playback attempts within the app & compare against successful video starts.
Applicable for: Content, Live, VOD
Node Location: event.type
Play Request
event
Released in version 1.20
Definition: Event signifies the video player requests the video from the server. The trigger could be the user clicking on a play button of a thumbnail. If the video is played automatically, this may be fired when the player starts loading.
Use Case
Identify problems that may be occurring in the video player which prevent successful playback after a user requests a video
Applicable for: Content, Live, VOD
Node Location: event.type
Playback Start
event
Released in version 1.48
Definition: This event is fired when the video starts playing & is viewable by the user.
Use Case
Use this to determine the period of time between a user pressing play and the same user viewing their content
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Playback Complete
event
Released in version 1.48
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.
Applicable for: Content, VOD
Node Location: event.type
Player Ready
event
Released in version 1.20
Definition: Signifies when the player has been initialized and is ready for playback. This is the earliest point at which any API calls should be made
Applicable for: Content, Live, VOD
Node Location: event.type
Playing
event
Released in version 1.20
Definition: The media is no longer blocked from playback, and has started playing.
Applicable for: Content, Live, VOD
Node Location: event.type
Rendition Change
event
Released in version 1.53.2
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?
Applicable for: Content, Live, VOD
Node Location: event.type
Resume
event
Released in version 1.20
Definition: This event is fired when the user hits the play button after pausing video during playback.
Use Case
Compare the amount of time elapsed between user hitting the Pause event and then resuming playback.
Applicable for: Content, Live, VOD
Node Location: event.type
Seek Start
event
Released in version 1.54
Definition: Event records when the user interacts with content timeline by moving the playhead position forward or backwards to jump to a specific point on the timeline.
Use Case
Count the number of times users choose to seek to another part of the video.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Seek End
event
Released in version 1.54
Definition: Event is fired when the user stops moving the playhead position forward or backwards to jump to a specific point on the timeline. This event includes attributes seekStartPoint & seekEndPoint to mark the starting & ending points of a seek event, representing the content timecode in milliseconds
Use Case
Determine what parts of a video were skipped over or re-watched frequently.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Stall Start
event
Released in version 1.54
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.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Stall End
event
Released in version 1.54
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.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
Unmute
event
Released in version 1.23
Definition: Triggered the player audio has been reactivated.
Applicable for: Ad, Content, Live, VOD
Node Location: event.type
FluxData
bitrate
fluxdata
Released in version 1.51.2
Definition: The bits per second of the currently selected asset from the video manifest. This is a proxy for quality and a good determinant of overall delivery costs/network consumption.
Use Case
What is the average bitrate of all videos delivered to my users?
Technical Name: bitrate
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Example Value: 3127
Unit: kb/s
Max Decimals: 0
bufferDuration
fluxdata
Released in version 1.58
Definition: Cumulative time that content has been buffering during the current Video View.
Technical Name: bufferDuration
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Example Value: 124
Unit: milliseconds
Max Decimals: 0
bufferFill
fluxdata
Released in version 1.17
Definition: Percent utilization of playback buffer for storing video segments before they are shown by the video player. A bufferFill near 100% indicates that the video segments are downloading quickly enough to keep pace with the video playback of the user & should produce minimal buffering interruptions.
Use Case
Are buffering events directly related to low and frequent bufferFill levels?
Technical Name: bufferFill
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Example Value: 80.26
Unit: percentage
Max Decimals: 3
Scale: 0 .. 100
engagementDuration
fluxdata
Released in version 1.58
Definition: Cumulative time that user has been engaged with the page, including time spent not viewing video.
Technical Name: engagementDuration
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2468
Unit: milliseconds
Max Decimals: 0
engagementDurationAds
fluxdata
Released in version 1.60
Definition: Cumulative time the player has spent playing and buffering Ads.
Technical Name: engagementDurationAds
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
engagementDurationContent
fluxdata
Released in version 1.58
Definition: Cumulative time the player has spent playing and buffering Content.
Technical Name: engagementDurationContent
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
numberOfAdsPlayed
fluxdata
Released in version 1.62
Definition: Running count of the number of ads played during the user's current session.
Use Case
Analyze if the number of ads shown directly affects the length of a viewer's session.
Technical Name: numberOfAdsPlayed
Applicable for: Ad, Live, VOD
Field Type: number
Node Location: event.metrics
Example Value: 3
Unit: ads
Max Decimals: 0
numberOfErrors
fluxdata
Released in version 1.57
Definition: Running count of the number of errors that have occurred during the user's current session.
Technical Name: numberOfErrors
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Example Value: 2
Unit: errors
Max Decimals: 0
playbackDuration
fluxdata
Released in version 1.48
Definition: Cumulative time that content & ads have been playing during the current video View. Excludes time accrued while user pauses content or buffering. Value is reset to zero at the start of a new video View.
Technical Name: playbackDuration
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2468
Unit: milliseconds
Max Decimals: 0
playbackDurationAds
fluxdata
Released in version 1.60
Definition: Cumulative time that ads have been playing during the current video View. Excludes time accrued while user pauses content or buffering.
Technical Name: playbackDurationAds
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
playbackDurationContent
fluxdata
Released in version 1.58
Definition: Cumulative time that content has been playing during the current video Session View. Excludes time accrued while user pauses content or buffering.
Technical Name: playbackDurationContent
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
playbackStallCount
fluxdata
Released in version 1.58
Definition: Number of times the user's playback has been interrupted by an unexpected video stall due to buffer depletion during a View.
Technical Name: playbackStallCount
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 3
Unit: count
Max Decimals: 0
playbackStallCountAds
fluxdata
Released in version 1.59
Definition: Number of times the user's playback of Ads has been interrupted by an unexpected video stall due to buffer depletion during a View.
Technical Name: playbackStallCountAds
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1
Unit: count
Max Decimals: 0
playbackStallCountContent
fluxdata
Released in version 1.58
Definition: Number of times the user's playback of Content has been interrupted by an unexpected video stall due to buffer depletion during a View.
Technical Name: playbackStallCountContent
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2
Unit: count
Max Decimals: 0
playbackStallDuration
fluxdata
Released in version 1.58
Definition: The cumulative amount of time elapsed where the user's playback has been interrupted by an unexpected video stall due to buffer depletion during a View.
Technical Name: playbackStallDuration
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 2468
Unit: milliseconds
Max Decimals: 0
playbackStallDurationAds
fluxdata
Released in version 1.59
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 during a View.
Technical Name: playbackStallDurationAds
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
playbackStallDurationContent
fluxdata
Released in version 1.58
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 during a View.
Technical Name: playbackStallDurationContent
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
playerState
fluxdata
Released in version 1.20
Definition: Returns the player's current playback state. (idle, buffering, playing, paused, seeking)
Use Case
Correlate the current state of the video player with other activities or actions that are occurring with the user during a session.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.metrics
Permitted Values: any
Example Value: Ready
playheadPosition
fluxdata
Released in version 1.48
Definition: Returns the current point in the video timeline in seconds.
Technical Name: playheadPosition
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Example Value: 10.135
Unit: seconds
Max Decimals: 3
renditionAudioBitrate
fluxdata
Released in version 1.55
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.
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: renditionAudioBitrate
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 300
Unit: kb/s
Max Decimals: 0
renditionHeight
fluxdata
Released in version 1.55
Definition: Height in pixels of the rendition being played. The manifest may contain multiple versions (i.e. renditions) of the video encoded at varying qualities to support varying network conditions.
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: renditionHeight
Applicable for: Ad, Content, Live, VOD, Ad
Field Type: number
Node Location: event.metrics
Example Value: 720
Unit: pixels
Max Decimals: 0
renditionName
fluxdata
Released in version 1.55
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.
Applicable for: Ad, Content, Live, VOD, Ad
Field Type: string
Node Location: event.metrics
Permitted Values: any
Example Value: 720p
renditionVideoBitrate
fluxdata
Released in version 1.55
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
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: renditionVideoBitrate
Applicable for: Ad, Content, Live, VOD, Ad
Field Type: number
Node Location: event.metrics
Example Value: 3000
Unit: kb/s
Max Decimals: 0
renditionWidth
fluxdata
Released in version 1.55
Definition: Width of the rendition being played. The manifest may contain multiple versions (i.e. renditions) of the video encoded at varying qualities to support varying network conditions.
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: renditionWidth
Applicable for: Ad, Content, Live, VOD, Ad
Field Type: number
Node Location: event.metrics
Example Value: 1280
Unit: pixels
Max Decimals: 0
timeSinceStarted
fluxdata
Released in version 1.24
Definition: Time interval since current content playback began., reported in milliseconds
Technical Name: timeSinceStarted
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.metrics
Example Value: 37
Unit: milliseconds
Max Decimals: 0
timeSinceAdStarted
fluxdata
Released in version 1.62
Definition: Time interval since advertisement started playing, reported in milliseconds
Technical Name: timeSinceAdStarted
Applicable for: Ad, Live, VOD
Field Type: number
Node Location: event.metrics
Example Value: 37
Unit: milliseconds
Max Decimals: 0
timeSinceAdBreakStart
fluxdata
Released in version 1.62
Definition: Time interval since the current pod of advertisements began., reported in milliseconds. Value is reset to zero at the start of a new video View or when Ad Break Start event occurs.
Technical Name: timeSinceAdBreakStart
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
timeSinceAdRequested
fluxdata
Released in version 1.62
Definition: Time interval since advertisement was requested, reported in milliseconds
Technical Name: timeSinceAdRequested
Applicable for: Ad, Live, VOD
Field Type: number
Node Location: event.metrics
Example Value: 37
Unit: milliseconds
Max Decimals: 0
timeSinceAdSeekStart
fluxdata
Released in version 1.62
Definition: Time interval since the occurrence of an Ad Seek Start event, reported in milliseconds. Value is reset to zero at the start of a new video View or when Ad Seek Start event occurs.
Technical Name: timeSinceAdSeekStart
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
timeSinceAdStallStart
fluxdata
Released in version 1.59
Definition: Time interval since Stall Start event began during advertisement playback, 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: timeSinceAdStallStart
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
timeSinceBufferStart
fluxdata
Released in version 1.56
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: timeSinceBufferStart
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
timeSinceLastAd
fluxdata
Released in version 1.61
Definition: Time interval since the last advertisement completed., reported in milliseconds
Technical Name: timeSinceLastAd
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Example Value: 37
Unit: milliseconds
Max Decimals: 0
timeSinceLastAdHeartbeat
fluxdata
Released in version 1.58
Definition: Time interval since Heartbeat event was last sent for an advertisement, reported in milliseconds. Value is reset to zero at the start of a new video View or when another Ad Heartbeat event occurs.
Technical Name: timeSinceLastAdHeartbeat
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 10000
Unit: milliseconds
Max Decimals: 0
timeSinceLastAdMilestone
fluxdata
Released in version 1.58
Definition: Time interval since Milestone event was last sent for ad, reported in milliseconds. Value is reset to zero at the start of a new video View or when another Milestone event occurs.
Technical Name: timeSinceLastAdMilestone
Applicable for: Ad, Content, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 7500
Unit: milliseconds
Max Decimals: 0
timeSinceLastHeartbeat
fluxdata
Released in version 1.56
Definition: Time interval since Heartbeat was last sent for the current content, reported in milliseconds
Technical Name: timeSinceLastHeartbeat
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 10000
Unit: milliseconds
Max Decimals: 0
timeSinceLastMilestone
fluxdata
Released in version 1.56
Definition: Time interval since Milestone event was last sent for content, reported in milliseconds. Value is reset to zero at the start of a new video View or when another Milestone event occurs.
Technical Name: timeSinceLastMilestone
Applicable for: Ad, Content, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 7500
Unit: milliseconds
Max Decimals: 0
timeSinceLastRenditionChange
fluxdata
Released in version 1.56
Definition: Time interval since content playback shifted to a different available quality version from the manifest., reported in milliseconds
Technical Name: timeSinceLastRenditionChange
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.metrics
Example Value: 37
Unit: milliseconds
Max Decimals: 0
timeSincePaused
fluxdata
Released in version 1.24
Definition: Time interval since content playback was paused., reported in milliseconds
Technical Name: timeSincePaused
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.metrics
Example Value: 37
Unit: milliseconds
Max Decimals: 0
timeSinceRequested
fluxdata
Released in version 1.24
Definition: Time interval since content playback was requested, reported in milliseconds
Technical Name: timeSinceRequested
Applicable for: Content, Live, VOD
Field Type: number
Node Location: event.metrics
Example Value: 37
Unit: milliseconds
Max Decimals: 0
timeSinceSeekStart
fluxdata
Released in version 1.62
Definition: Time interval since the occurrence of a Seek Start event, reported in milliseconds. Value is reset to zero at the start of a new video View or when Seek Start event occurs.
Technical Name: timeSinceSeekStart
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
timeSinceStallStart
fluxdata
Released in version 1.56
Definition: Time interval since Stall 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 Stall Start event occurs.
Technical Name: timeSinceStallStart
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
viewStartTimestamp
fluxdata
Released in version 1.51.2
Definition: Start time of a new video view for the current user session. (Epoch UTC). Typically a new View begins with a Playback Request.
Technical Name: viewStartTimestamp
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics
Permitted Values: any
Example Value: 1589903189
Unit: milliseconds
Max Decimals: 0
Event Attributes
absShift
metadata
Released in version 1.53.2
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.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.attributes
Permitted Values: value list
Example Value: up
Value List: up, down
errorCode
metadata
Released in version 1.57
Definition: Error object representing a code explicitly identified by the player
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.attributes
Permitted Values: any
Example Value: 1001
errorMsg
metadata
Released in version 1.57
Definition: Error object representing a message about the error explicitly identified by the player
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.attributes
Permitted Values: any
Example Value: Player failed to launch
milestonePercent
metadata
Released in version 1.53.1
Definition: Number indicating the percentage milestone represented by the event fired. Attribute of Content Milestone & Ad Milestone
Technical Name: milestonePercent
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
seekStartPoint
metadata
Released in version 1.54
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: seekStartPoint
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.attributes
Permitted Values: any
Example Value: 5678
Unit: milliseconds
Max Decimals: 0
seekEndPoint
metadata
Released in version 1.54
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: seekEndPoint
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.attributes
Permitted Values: any
Example Value: 8910
Unit: milliseconds
Max Decimals: 0
totalStartupDuration
metadata
Released in version 1.59
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: totalStartupDuration
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.attributes
Permitted Values: any
Example Value: 123
Unit: milliseconds
Max Decimals: 0
Message Metadata
configuration_id
metadata
Released in version 1.37
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.
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.48
Definition: Unique identifier for each event message fired by a Collector or log file received by Datazoom.
Use Case
Provides a UUID that can be used for de-dupping records in the data platform or Connector.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: root
Permitted Values: any
Example Value: 43DHE-EROILKER-EREOATE
timestamp
metadata
Released in version 1.48
Definition: Epoch UTC time of the event occurrence
Technical Name: timestamp
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event
Example Value: 1535971954488
Unit: epoch
Max Decimals: 0
type
metadata
Released in version 1.48
Definition: Name of the event that describes the message
Use Case
event.type will be the key way to search for various events generated by the user.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event
Permitted Values: any
User Details
client_ip
metadata
Released in version 1.19
Definition: IP address of the user's device
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details
Permitted Values: IP address
Example Value: 173.19.65.222
session_id
metadata
Released in version 1.48
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.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details
Permitted Values: any
Example Value: 43DHE-EROILKER-EREOATE
sessionStartTimestamp
metadata
Released in version 1.55
Definition: Start time of the current user session
Technical Name: sessionStartTimestamp
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: user_details
Example Value: 1535971954488
Unit: epoch
Max Decimals: 0
user_agent
metadata
Released in version 1.58
Definition: Contains a number of tokens that refer to various aspects of the request, including the user's browser name and version, rendering engine, device’s model number, operating system and its version, etc.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details
Permitted Values: any
viewId
metadata
Released in version 1.48
Definition: A unique id for the current video. It is composed of the session_id and an incremental number (1, 2, 3…). Watching the same video during multiple points in a session will create distinct viewId for each view.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details
Permitted Values: UUID incremented
Example Value: 3bba4192-8105-4498-ae34-587154d56fa6-4
Player
controls
metadata
Released in version 1.20
Definition: Whether the controls are available for user interaction in the player. (i.e. Play/Pause/Seek)
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: player
Permitted Values: value list
Example Value: false
Value List: true, false
defaultMuted
metadata
Released in version 1.23
Definition: Sets or returns whether the audio/video should be muted by default
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: player
Permitted Values: value list
Example Value: true
Value List: true, false
defaultPlaybackRate
metadata
Released in version 1.53.1
Definition: Sets or returns the default speed of the audio/video playback. Describes the speed that the video is played back to the user in relation to normal playback time. .5x, 1x, 1.5x, 2x
Technical Name: defaultPlaybackRate
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: player
Example Value: 0.5
Unit: percentage
Max Decimals: 2
isMuted
metadata
Released in version 1.23
Definition: True if player is muted.
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: player
Permitted Values: value list
Example Value: true
Value List: true, false
loop
metadata
Released in version 1.20
Definition: Returns whether the audio/video is programmed to start over again when finished
Applicable for: Content, Live, VOD
Field Type: bool
Node Location: player
Permitted Values: value list
Example Value: false
Value List: true, false
playerName
metadata
Released in version 1.48
Definition: States which video player that generated the event
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player
Permitted Values: any
Example Value: JW Player
playerVersion
metadata
Released in version 1.58
Definition: States the version of the video player that generated the event
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player
Permitted Values: any
Example Value: 8.01
readyState
metadata
Released in version 1.20
Definition: Returns the current ready state of the audio/video
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player
Permitted Values: value list
Example Value: HAVE_METADATA
Value List: HAVE_NOTHING, HAVE_METADATA, HAVE_CURRENT_DATA, HAVE_FUTURE_DATA, HAVE_ENOUGH_DATA
streamingProtocol
metadata
Released in version 1.59
Definition: What streaming format is being used for the content?
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
streamingType
metadata
Released in version 1.59
Definition: Describes if the content being streamed is Live or on demand.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player
Permitted Values: value list
Example Value: Live
Value List: Live, VOD
Device
advertisingId
metadata
Released in version 1.57
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.
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: device
Permitted Values: any
device_id
metadata
Released in version 1.54
Definition: Unique identifier of the user's device.
Use Case
This can be used as a proxy for User if user is anonymous.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
deviceMfg
metadata
Released in version 1.54
Definition: Manufacturer of the user's device. Not always available.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: Apple
deviceName
metadata
Released in version 1.54
Definition: Name of the device model used by the viewer
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: iPad Mini 4
deviceType
metadata
Released in version 1.48
Definition: Describes the type of device being used during the session. phone, tablet, desktop, connected device, game console
Use Case
Can be used to group attributes by device platform type for better understanding of app performance on different platforms.
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
metadata
Released in version 1.19
Definition: Operating System of the user's device
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: OS X
osVersion
metadata
Released in version 1.19
Definition: Version of Operating System being used during the session
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: 10.14
Video
description
metadata
Released in version 1.23
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.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: video
Permitted Values: any
duration
metadata
Released in version 1.48
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
frameRate
metadata
Released in version 1.57
Definition: The frames per second of the current video encoding.
Technical Name: frameRate
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: video
Example Value: 29.97
Unit: frames per second
Max Decimals: 2
playerHeight
metadata
Released in version 1.55
Definition: Height dimension in pixels of the current playback area.
Technical Name: playerHeight
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: video
Permitted Values: any
Example Value: 1080
Unit: pixels
Max Decimals: 0
playerWidth
metadata
Released in version 1.55
Definition: Width dimension in pixels of the current playback area.
Technical Name: playerWidth
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.51.2
Definition: Returns the URL of the current media file
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: video
Permitted Values: URL
Example Value: http://...
title
metadata
Released in version 1.23
Definition: Provides the title of current asset being played
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: video
Permitted Values: any
Example Value: What About Bob?
videoType
metadata
Released in version 1.48
Definition: Is this Ad or Content?
Technical Name: videotype
Applicable for: Ad, Content, Live, VOD, Ad
Field Type: string
Node Location: video
Permitted Values: value list
Example Value: Ad
Value List: Ad, Content
Location
city
metadata
Released in version 1.19
Definition: The city or town where the user is located
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: Santa Rosa Beach
country
metadata
Released in version 1.55
Definition: Full name of the user's country
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: United States
countryCode
metadata
Released in version 1.19
Definition: The country from which the browser initiated the event. For a list of country codes, see ISO 3166-1 alpha-2 .
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: 2 letter code
Example Value: US
latitude
metadata
Released in version 1.48
Definition: Location information for the user
Technical Name: latitude
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: geo_location
Example Value: 30.3659
Unit: degrees
Max Decimals: 4
Scale: -90 .. 90
longitude
metadata
Released in version 1.48
Definition: Location information for the user
Technical Name: longitude
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: geo_location
Example Value: -86.2458
Unit: degrees
Max Decimals: 4
Scale: -180 .. 180
region
metadata
Released in version 1.55
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.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: Florida
regionCode
metadata
Released in version 1.19
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.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: 2 letter code
Example Value: FL
zipCode
metadata
Released in version 1.55
Definition: The specific administrative division within a country where the event occurred. In the United States, zip codes correspond to postal region locator
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: 32459
Network
asn
metadata
Released in version 1.19
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.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network
Permitted Values: any
Example Value: AS30036 Mediacom Communications Corp
asnOrganization
metadata
Released in version 1.19
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
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network
Permitted Values: any
Example Value: MEDIACOM
connectionType
metadata
Released in version 1.59
Definition: The type of network connection currently being used to access the content
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network
Permitted Values: value list
Example Value: WiFi
Value List: WiFi, Mobile, LAN
isp
metadata
Released in version 1.55
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
eventCount
metadata
Released in version 1.59
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.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: page
Permitted Values: any
Example Value: 1
dzSdkVersion
metadata
Released in version 1.58
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.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: page
Permitted Values: Any
Example Value: 1.40
Ad Data
adId
metadata
Released in version 1.58
Definition: ID of the ad shown.
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad
adPosition
metadata
Released in version 1.57
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.
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad
Permitted Values: value list
Example Value: pre
Value List: pre, mid, post
|
Comments
0 comments
Article is closed for comments.