Events
Custom Event
event
Released in version 1.26
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
Pause
event
Released in version 1.22
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.22
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
Playback Complete
event
Released in version 1.22
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
FluxData
bitrate
fluxdata
Released in version 1.22
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?
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 3127
Unit: kb/s
Max Decimals: 0
bufferFill
fluxdata
Released in version 1.22
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
playheadPosition
fluxdata
Released in version 1.22
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
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.22
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.22
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
session_id
metadata
Released in version 1.22
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: Ads, Content, Live, VOD
Field Type: string
Node Location: user_details
Permitted Values: any
Example Value: 43DHE-EROILKER-EREOATE
user_agent
metadata
Released in version 1.22
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
playerName
metadata
Released in version 1.22
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
playerVersion
metadata
Released in version 1.22
States the version of the video player that generated the event
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: player
Permitted Values: any
Example Value: 8.01
Device
device_id
metadata
Released in version 1.22
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.22
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
Video
duration
metadata
Released in version 1.22
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.22
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://...
Custom
customMetadata
metadata
Released in version 1.26
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.