Events
Audio Track Changed
event
Released in version 1.29
This event signifies when the user has chosen to switch to a different audio track during playback.
Use Case
Count the number of times that users choose an alternate language audio track instead of the default language.
Applicable for: Ads, Content, Live, VOD
Node Location: event.type
Buffer End
event
Released in version 1.18
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
Custom Event
event
Released in version 1.25
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.
Applicable for: Ads, Content, Live, VOD
Node Location: event.type
Error
event
Released in version 1.07
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
Exit Fullscreen
event
Released in version 1.29
Triggered when user exits fullscreen mode during video playback
Use Case
Used to determine how often users are switching from in-page playback to a full screen experience.
Applicable for: Ads, Content, Live, VOD
Node Location: event.type
Fullscreen
event
Released in version 1.29
Triggered when user enters fullscreen mode during video playback
Use Case
Used to determine how often users are switching from in-page playback to a full screen experience.
Applicable for: Ads, Content, Live, VOD
Node Location: event.type
Idle
event
Released in version 1.38
This event signifies that the video player has reached an state where there is no present activity. The user has stopped playback or the video player is loaded and waiting for the next piece of content to be selected.
Use Case
Use this event to track activities a user may be performing on other parts of the app while the video player is inactive.
Applicable for: Ads, Content, Live, VOD
Node Location: event.type
Mute
event
Released in version 1.29
Triggered when the player volume has been reduced to zero.
Applicable for: Ads, Content, Live, VOD
Node Location: event.type
Pause
event
Released in version 1.07
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.07
Event is fired when a user initiates video playback.
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.18
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 Complete
event
Released in version 1.07
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.38
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.25
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.18
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
Session End
event
Released in version 1.29
Event is fired after a user session is considered closed. This would happen after playback & user interactions have ceased for 20 mins.
Applicable for: Ads, Content, Live, VOD
Node Location: event.type
Unmute
event
Released in version 1.29
Triggered the player audio has been reactivated.
Applicable for: Ads, Content, Live, VOD
Node Location: event.type
Volume Change
event
Released in version 1.29
Triggered when the player increases or decreases the audio level of the video.
Applicable for: Ads, Content, Live, VOD
Node Location: event.type
FluxData
bandwidth
fluxdata
Released in version 1.07
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?
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 2152
Unit: bits per second
Max Decimals: 0
bufferFill
fluxdata
Released in version 1.07
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?
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 80.26
Unit: percentage
Max Decimals: 3
Scale: 0 .. 100
currentAudioTrack
fluxdata
Released in version 1.29
Identifies which audio track available for the content has been selected by the user. Multiple audio tracks are usually used for alternate languages. Values returned may vary by content publisher & player.
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: event.metrics
Permitted Values: any
Example Value: Japanese - Dubbed
currentCaptions
fluxdata
Released in version 1.29
Identifies which subtitle or closed captioning track available for the content has been selected by the user. Multiple captioning tracks are usually used for alternate languages. Values returned may vary by content publisher & player.
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: event.metrics
Permitted Values: any
Example Value: Spanish
numberOfVideos
fluxdata
Released in version 1.28
The amount of unique videos watched during the current viewing session
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 2
Unit: videos
Max Decimals: 0
playbackRate
fluxdata
Released in version 1.28
The speed of the audio/video playback. Describes the speed that the video is played back to the user in relation to normal playback time. .5x, 1x, 1.5x, 2x
Use Case
If users prefer to watch your content at a sped up rate, does this mean you should alter the type of content you produce?
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 0.5
Unit: percentage
Max Decimals: 2
playerState
fluxdata
Released in version 1.28
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.
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: event.metrics
Permitted Values: any
Example Value: Ready
playheadPosition
fluxdata
Released in version 1.07
Returns the current point in the video timeline in seconds.
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 10.135
Unit: seconds
Max Decimals: 3
timeSinceStarted
fluxdata
Released in version 1.27
Time interval since current content playback began., reported in milliseconds
Applicable for: Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 37
Unit: milliseconds
Max Decimals: 0
timeSincePaused
fluxdata
Released in version 1.27
Time interval since content playback was paused., reported in milliseconds
Applicable for: Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 37
Unit: milliseconds
Max Decimals: 0
timeSinceRequested
fluxdata
Released in version 1.27
Time interval since content playback was requested, reported in milliseconds
Applicable for: Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 37
Unit: milliseconds
Max Decimals: 0
totalBufferTime
fluxdata
Released in version 1.38
Cumulative time that content has been buffering during the current Session View. Reset the totalBufferTime when a new video starts during the session.
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 124
Unit: milliseconds
Max Decimals: 0
volumeLevel
fluxdata
Released in version 1.07
The current playback volume as a whole number percentage.
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 85.2
Unit: percentage
Max Decimals: 0
Scale: 0 .. 100
Event Attributes
errorCode
metadata
Released in version 1.29
Error object representing a code explicitly identified by the player
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: event.attributes
Permitted Values: any
Example Value: 1001
errorMsg
metadata
Released in version 1.29
Error object representing a message about the error explicitly identified by the player
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: event.attributes
Permitted Values: any
Example Value: Player failed to launch
Message Metadata
timestamp
metadata
Released in version 1.37
Epoch UTC time of the event occurrence
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: root
Example Value: 1535971954488
Unit: epoch
Max Decimals: 0
configuration_id
metadata
Released in version 1.37
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: Ads, Content, Live, VOD
Field Type: string
Node Location: root
Permitted Values: UUID
Example Value: 3bba4192-8105-4498-ae34-587154d56fa6
connector_list
metadata
Released in version 1.37
List of the Connectors configured for this Collector via a Datazoom Data Pipe.
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: root
Permitted Values: comma separated list
Example Value: dz-connector-google-analytics,dz-connector-mixpanel
customer_code
metadata
Released in version 1.37
Unique identifier for the Datazoom customer that generated the event.
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: root
Permitted Values: UUID
Example Value: 3bba4192-8105-4498-ae34-587154d56fa6
User Details
client_ip
metadata
Released in version 1.12
IP address of the user's device
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: user_details
Permitted Values: IP address
Example Value: 173.19.65.222
user_agent
metadata
Released in version 1.12
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: Ads, Content, Live, VOD
Field Type: string
Node Location: user_details
Permitted Values: any
Player
autoStart
metadata
Released in version 1.29
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
controls
metadata
Released in version 1.29
Whether the controls are available for user interaction in the player. (i.e. Play/Pause/Seek)
Applicable for: Ads, 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.29
Sets or returns whether the audio/video should be muted by default
Applicable for: Ads, 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.29
Sets or returns the default speed of the audio/video playback. Describes the speed that the video is played back to the user in relation to normal playback time. .5x, 1x, 1.5x, 2x
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: player
Example Value: 0.5
Unit: percentage
Max Decimals: 2
fullscreen
metadata
Released in version 1.29
Is the player in fullscreen mode?
Applicable for: Ads, Content, Live, VOD
Field Type: bool
Node Location: player
Permitted Values: value list
Example Value: true
Value List: true, false
isMuted
metadata
Released in version 1.29
True if player is muted.
Applicable for: Ads, 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.29
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.09.01
States which video player that generated the event
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: player
Permitted Values: any
Example Value: JW Player
readyState
metadata
Released in version 1.29
Returns the current ready state of the audio/video
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: player
Permitted Values: any
Example Value: 1
streamingProtocol
metadata
Released in version 1.29
What streaming format is being used for the content?
Applicable for: Ads, 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.29
Describes if the content being streamed is Live or on demand.
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: player
Permitted Values: value list
Example Value: Live
Value List: Live, VOD
Device
browser
metadata
Released in version 1.12
Web browser being used during the session
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: Chrome
browserHeight
metadata
Released in version 1.28
The height of the end user's browser window at the time when the event occurred.
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: device
Example Value: 1250
Unit: pixels
Max Decimals: 0
browserVersion
metadata
Released in version 1.12
Version of web browser being used during the session
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: 52.01.03
browserWidth
metadata
Released in version 1.28
The width of the end user's browser window at the time when the version occurred.
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: device
Example Value: 2150
Unit: pixels
Max Decimals: 0
device_id
metadata
Released in version 1.12
Unique identifier of the user's device.
Use Case
This can be used as a proxy for User if user is anonymous.
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
deviceType
metadata
Released in version 1.12
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: Ads, 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.12
Operating System of the user's device
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: OS X
osVersion
metadata
Released in version 1.12
Version of Operating System being used during the session
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
Example Value: 10.14
Video
duration
metadata
Released in version 1.07
The total length of the media file, reported in decimal seconds
Applicable for: Ads, Content, VOD
Field Type: numeric
Node Location: video
Example Value: 25.49
Unit: seconds
Max Decimals: 3
source
metadata
Released in version 1.07
Returns the URL of the current media file
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: video
Permitted Values: URL
Example Value: http://...
Location
city
metadata
Released in version 1.28
The city or town where the user is located
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: Santa Rosa Beach
countryCode
metadata
Released in version 1.28
The country from which the browser initiated the event. For a list of country codes, see ISO 3166-1 alpha-2 .
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: 2 letter code
Example Value: US
latitude
metadata
Released in version 1.28
Location information for the user
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: geo_location
Example Value: 30.3659
Unit: degrees
Max Decimals: 4
Scale: -90 .. 90
longitude
metadata
Released in version 1.28
Location information for the user
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: geo_location
Example Value: -86.2458
Unit: degrees
Max Decimals: 4
Scale: -180 .. 180
region
metadata
Released in version 1.28
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: Ads, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: Florida
regionCode
metadata
Released in version 1.28
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: Ads, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: 2 letter code
Example Value: FL
zipCode
metadata
Released in version 1.28
The specific administrative division within a country where the event occurred. In the United States, zip codes correspond to postal region locator
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: 32459
Network
asn
metadata
Released in version 1.28
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: Ads, Content, Live, VOD
Field Type: string
Node Location: network
Permitted Values: any
Example Value: AS30036 Mediacom Communications Corp
asnOrganization
metadata
Released in version 1.28
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: Ads, Content, Live, VOD
Field Type: string
Node Location: network
Permitted Values: any
Example Value: MEDIACOM
isp
metadata
Released in version 1.22
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: Ads, Content, Live, VOD
Field Type: string
Node Location: network
Permitted Values: any
Example Value: Mediacom Communications Corp
Page
pageUrl
metadata
Released in version 1.28
The address of the page from which the view originated.
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: page
Permitted Values: URL
Example Value: http://...
Custom
customMetadata
metadata
Released in version 1.25
Customers can add any user or system data to the Datazoom data stream. Requires custom coding on the page or in the app by customer developer.
Applicable for: Ads, Content, Live, VOD
Node Location: custom
|
Comments
0 comments
Article is closed for comments.