Events
Ad Break Start
event
Released in version 1.11
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.11
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 Click
event
Released in version 1.11
Triggered when the user interacts with an advertisement
Use Case
How many users clicked on a call-to-action link for a given ad?
Applicable for: Live, VOD, Ad
Node Location: event.type
Ad Complete
event
Released in version 1.11
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.11
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 Pause
event
Released in version 1.11
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.11
Fired whenever an ad starts playing or when an ad is unpaused.
Applicable for: Live, VOD, Ad
Node Location: event.type
Ad Rendition Change
event
Released in version 1.11
When the Player's Adaptive Bitrate Streaming upshifts or downshifts during Content Playback to a different quality level available in the manifest.
Use Case
How often does an ad change quality during playback due to network bandwidth conditions?
Applicable for: Live, VOD, Ad
Node Location: event.type
Ad Request
event
Released in version 1.11
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.11
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.48
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.09
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
Error
event
Released in version 1.06
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.48
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
Idle
event
Released in version 1.44
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
Milestone
event
Released in version 1.48
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, Live, VOD
Node Location: event.type
Pause
event
Released in version 1.06
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.06
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.09
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
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.06
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.06
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
Rendition Change
event
Released in version 1.11
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.09
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.49
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.49
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
Volume Change
event
Released in version 1.06
Triggered when the player increases or decreases the audio level of the video.
Applicable for: Ads, Content, Live, VOD
Node Location: event.type
FluxData
bufferFill
fluxdata
Released in version 1.06
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
engagementDuration
fluxdata
Released in version 1.49
Cumulative time that user has been engaged with the page, including time spent not viewing video.
Applicable for: Ad, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Permitted Values: any
Example Value: 2468
Unit: milliseconds
Max Decimals: 0
numberOfErrors
fluxdata
Released in version 1.10
Running count of the number of errors that have occurred during the user's current session.
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 2
Unit: errors
Max Decimals: 0
numberOfVideos
fluxdata
Released in version 1.10
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.06
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
playheadPosition
fluxdata
Released in version 1.06
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
renditionHeight
fluxdata
Released in version 1.11
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.
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 720
Unit: pixels
Max Decimals: 0
renditionName
fluxdata
Released in version 1.11
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: Ads, Content, Live, VOD
Field Type: string
Node Location: event.metrics
Permitted Values: any
Example Value: 720p
renditionWidth
fluxdata
Released in version 1.11
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.
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 1280
Unit: pixels
Max Decimals: 0
timeSinceStarted
fluxdata
Released in version 1.09
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
timeSinceAdStarted
fluxdata
Released in version 1.11
Time interval since advertisement started playing, reported in milliseconds
Applicable for: Ad, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 37
Unit: milliseconds
Max Decimals: 0
timeSinceAdPaused
fluxdata
Released in version 1.11
Time interval since advertisement was paused, reported in milliseconds
Applicable for: Ad, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 37
Unit: milliseconds
Max Decimals: 0
timeSinceAdRequested
fluxdata
Released in version 1.11
Time interval since advertisement was requested, reported in milliseconds
Applicable for: Ad, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 37
Unit: milliseconds
Max Decimals: 0
timeSinceLastAd
fluxdata
Released in version 1.11
Time interval since the last advertisement completed., reported in milliseconds
Applicable for: Ads, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 37
Unit: milliseconds
Max Decimals: 0
timeSinceLastRenditionChange
fluxdata
Released in version 1.11
Time interval since content playback shifted to a different available quality version from the manifest., 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.09
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.09
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
timeSinceSeekStart
fluxdata
Released in version 1.49
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.
Applicable for: Ad, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Permitted Values: any
Example Value: 1234
Unit: milliseconds
Max Decimals: 0
totalBufferTime
fluxdata
Released in version 1.48
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
viewStartTimestamp
fluxdata
Released in version 1.48
Start time of a new video view for the current user session. (Epoch UTC). Typically a new View begins with a Playback Request.
Applicable for: Ad, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Permitted Values: any
Example Value: 1589903189
Unit: milliseconds
Max Decimals: 0
volumeLevel
fluxdata
Released in version 1.06
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
absShift
metadata
Released in version 1.11
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: Ads, Content, Live, VOD
Field Type: string
Node Location: event.attributes
Permitted Values: value list
Example Value: up
Value List: up, down
milestonePercent
metadata
Released in version 1.48
Number indicating the percentage milestone represented by the event fired. Attribute of Content Milestone & Ad Milestone
Applicable for: Ad, Content, Live, VOD
Field Type: numeric
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.49
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.
Applicable for: Ad, Content, Live, VOD
Field Type: numeric
Node Location: event.attributes
Permitted Values: any
Example Value: 5678
Unit: milliseconds
Max Decimals: 0
seekEndPoint
metadata
Released in version 1.49
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.
Applicable for: Ad, Content, Live, VOD
Field Type: numeric
Node Location: event.attributes
Permitted Values: any
Example Value: 8910
Unit: milliseconds
Max Decimals: 0
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: event
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
event_id
metadata
Released in version 1.43
Unique identifier for each event message fired by a Collector.
Use Case
Provides a UUID that can be used for de-dupping records in the data platform or Connector.
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: root
Permitted Values: any
Example Value: 43DHE-EROILKER-EREOATE
User Details
client_ip
metadata
Released in version 1.09
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
session_id
metadata
Released in version 1.09
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
session_id
metadata
Released in version 1.09
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.09
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
viewId
metadata
Released in version 1.49
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.06
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.06
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.06
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.06
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.09
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.09
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.06
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.06
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.09
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
preload
metadata
Released in version 1.06
Sets or returns whether the audio/video should be loaded when the page loads
Applicable for: Ads, Content, Live, VOD
Field Type: bool
Node Location: player
Permitted Values: value list
Example Value: true
Value List: true, false
readyState
metadata
Released in version 1.06
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
streamingType
metadata
Released in version 1.06
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.09
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.09
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.09
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.09
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.09
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.09
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.09
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.09
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.06
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.06
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://...
title
metadata
Released in version 1.09
Provides the title of current asset being played
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: video
Permitted Values: any
Example Value: What About Bob?
videoType
metadata
Released in version 1.43
Is this Ad or Content?
Applicable for: Ads, 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.09
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.21
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.09
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.21
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.21
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.21
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.09
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.21
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.09
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.09
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.09
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://...
referrerUrl
metadata
Released in version 1.09
The URL of the page that loaded before the event occurred.
Applicable for: Ads, Content, Live, VOD
Field Type: string
Node Location: page
Permitted Values: URL
Example Value: http://...
Ad Data
adBlocker
metadata
Released in version 1.44
Whether an Ad Blocker was detected or not.
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: ad
Permitted Values: value list
Example Value: False
Value List: True,False
adClickUrl
metadata
Released in version 1.11
URL opened when the user interacts with an ad during playback.
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad
Permitted Values: URL
Example Value: http://...
adCreativeId
metadata
Released in version 1.11
Creative ID of the ad shown.
Use Case
Creative ID is used to identify the same ad displayed across different sites.
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad
Permitted Values: any
Example Value: E1lDoiRb
adPartner
metadata
Released in version 1.11
Name of the partner showing the ad.
Use Case
Understand the source, publisher or advertiser who is responsible for displaying the ad on the service.
Applicable for: Live, VOD, Ad
Field Type: string
Node Location: ad
Permitted Values: any
Example Value: Pepsi
adPosition
metadata
Released in version 1.11
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
adSkipped
metadata
Released in version 1.11
Shows if user chose to skip the ad during playback
Applicable for: Live, VOD, Ad
Field Type: bool
Node Location: ad
Permitted Values: value list
Example Value: true
Value List: true, false
|
Comments
0 comments
Article is closed for comments.