Events
Ad Impression
event
Released in version 1.58
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
Buffer Start
event
Released in version 1.58
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.60
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.58
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
Heartbeat
event
Released in version 1.47
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.47
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
Pause
event
Released in version 1.45
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.45
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.57
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.57
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.45
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.57
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.57
Definition: The media is no longer blocked from playback, and has started playing.
Applicable for: Content, Live, VOD
Node Location: event.type
Resume
event
Released in version 1.58
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
FluxData
bitrate
fluxdata
Released in version 1.45
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
engagementDuration
fluxdata
Released in version 1.60
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
engagementDurationContent
fluxdata
Released in version 1.60
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
playbackDuration
fluxdata
Released in version 1.58
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
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
playerState
fluxdata
Released in version 1.58
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.45
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
timeSinceStarted
fluxdata
Released in version 1.58
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
timeSinceLastHeartbeat
fluxdata
Released in version 1.58
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.58
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
timeSinceRequested
fluxdata
Released in version 1.58
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
Event Attributes
milestonePercent
metadata
Released in version 1.47
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
Message Metadata
configuration_id
metadata
Released in version 1.45
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.45
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.45
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.45
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.48
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.45
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.45
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.45
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.47
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
autoStart
metadata
Released in version 1.58
Definition: Returns whether the audio/video should start playing as soon as it is loaded
Applicable for: Content, Live, VOD
Field Type: bool
Node Location: player
Permitted Values: value list
Example Value: false
Value List: true, false
playerName
metadata
Released in version 1.45
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.45
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
streamingType
metadata
Released in version 1.58
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
adTrackingOptOut
metadata
Released in version 1.45
Definition: States if the user has opted out of advertising tracking on their device. Not applicable to web.
Use Case
This field can be used to omit users who don't send back personal information from certain types of analysis.
Applicable for: Live, VOD, Ad
Field Type: bool
Node Location: device
Permitted Values: value list
Value List: true, false
advertisingId
metadata
Released in version 1.45
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.45
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
deviceType
metadata
Released in version 1.45
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.58
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.58
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
title
metadata
Released in version 1.58
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.58
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.48
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.48
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.48
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.48
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.48
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.48
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
Page
dzSdkVersion
metadata
Released in version 1.47
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.64
Definition: ID of the ad shown.
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad
|
Comments
0 comments
Article is closed for comments.