Events
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
Idle
event
Released in version 1.16
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
Pause
event
Released in version 1.16
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.16
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
Player Ready
event
Released in version 1.16
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.16
The media is no longer blocked from playback, and has started playing.
Applicable for: Content, Live, VOD
Node Location: event.type
Volume Change
event
Released in version 1.16
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.16
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
bitrate
fluxdata
Released in version 1.16
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
playerState
fluxdata
Released in version 1.16
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.16
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
volumeLevel
fluxdata
Released in version 1.16
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
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.16
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.16
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.16
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.16
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
fullscreen
metadata
Released in version 1.16
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
playerName
metadata
Released in version 1.16
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
Device
adTrackingOptOut
metadata
Released in version 1.27
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.27
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.16
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.16
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.16
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.16
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
source
metadata
Released in version 1.16
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.24
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
country
metadata
Released in version 1.24
Full name of the user's country
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: United States
countryCode
metadata
Released in version 1.24
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.16
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.16
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.24
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.24
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.24
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
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
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.