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

When the Buffer Start event is thrown and a value received, it is correlated to a specific playback time by comparing it to the playback length within the manifest. Once the Buffer End event has thrown, the delta between the two can be used to forensically analyze a series of chunks to determine the veracity of the content files. If the issue is corrupt chunks, a new encode can be produced.

Technical Name: buffer_start

Supported Ad Networks: Google IMA

Applicable for: Ad, Content, Live, VOD

Node Location: event.type

Max Decimals: 0

to the top

Buffer End

event

Released in version 1.107

Definition: Event is fired when video starts playing again after a buffer is completed.

Use Case

A buffering event has just completed. The player fires this event which returns a value of 1 to indicate that playback has resumed.

Technical Name: buffer_end

Supported Ad Networks: Google IMA

Applicable for: Content, Live, VOD, Ad

Node Location: event.type

Max Decimals: 0

to the top

Custom Event

event

Released in version 1.77

Definition: 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.

Technical Name: {custom_event_name}

Applicable for: Ad, Content, Live, VOD

Node Location: event.type

Max Decimals: 0

to the top

Datazoom Loaded

event

Released in version 1.76

Definition: Signifies that the Datazoom SDK has been loaded and activated. At this point, the video player can be instantiated or custom events can be sent by the application.

Technical Name: datazoom_loaded

Applicable for:

Node Location: event.type

Max Decimals: 0

to the top

Error

event

Released in version 1.107

Definition: Thrown if an error occurs during content playback or retrieval of the video

Technical Name: error

Supported Ad Networks: Google IMA

Applicable for: Content, Live, VOD, Ad

Node Location: event.type

Max Decimals: 0

to the top

Heartbeat

event

Released in version 1.76

Definition: Periodic event that provides updated insight into all of the selected FluxData metrics fired at the specified Heartbeat interval.

Technical Name: heartbeat

Applicable for: Content, Live, VOD, Ad

Node Location: event.type

Max Decimals: 0

to the top

Media Loaded

event

Released in version 1.102

Definition: Fired when the video is fully loaded into the player & ready to begin playback.

Technical Name: media_loaded

Supported Ad Networks: Google IMA

Applicable for: Content, Live, VOD, Ad

Node Location: event.type

Max Decimals: 0

to the top

Milestone

event

Released in version 1.102

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.

Technical Name: milestone

Supported Ad Networks: Google IMA

Applicable for: Ad, Content, VOD

Node Location: event.type

Max Decimals: 0

to the top

Pause

event

Released in version 1.76

Definition: Pause event is fired when the player enters a paused state. This can be triggered when the user hits the Pause button to temporarily halt video playback or it can occur as part of the player's normal state changes as media is loading, resuming or concluding.

Technical Name: pause

Applicable for: Content, Live, VOD, Ad

Node Location: event.type

Max Decimals: 0

to the top

Playback Start

event

Released in version 1.102

Definition: This event is fired when the video starts playing for the user, also known as First Frame.

Technical Name: playback_start

Supported Ad Networks: Google IMA

Applicable for: Ad, Content, Live, VOD

Node Location: event.type

Max Decimals: 0

to the top

Playback Complete

event

Released in version 1.102

Definition: This event signifies that the video player has reached the end of the currently playing content.

Technical Name: playback_complete

Supported Ad Networks: Google IMA

Applicable for: Content, VOD, Ad

Node Location: event.type

Max Decimals: 0

to the top

Player Ready

event

Released in version 1.76

Definition: Signifies when the player has been initialized and is ready for playback.

Technical Name: player_ready

Applicable for:

Node Location: event.type

Max Decimals: 0

to the top

Playing

event

Released in version 1.102

Definition: The media is no longer blocked from playback, and has started playing. Fired when playback resumes from Stall, Buffering or Seek.

Technical Name: playing

Supported Ad Networks: Google IMA

Applicable for: Content, Live, VOD, Ad

Node Location: event.type

Max Decimals: 0

to the top

Qualified View

event

Released in version 1.100

Definition: This event is fired when the user has watched a specified duration of video playback.

Technical Name: qualified_view

Applicable for: Content, Live, VOD

Node Location: event.type

Max Decimals: 0

to the top

Rendition Change

event

Released in version 1.101

Definition: 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.

Technical Name: rendition_change

Applicable for: Content, Live, VOD, Ad

Node Location: event.type

Max Decimals: 0

to the top

Resume

event

Released in version 1.107

Definition: This event is fired when the user begins playing again after pausing the video during playback.

Technical Name: resume

Supported Ad Networks: Google IMA

Applicable for: Content, Live, VOD, Ad

Node Location: event.type

Max Decimals: 0

to the top

Seek Start

event

Released in version 1.93

Definition: This event records when the user interacts with time controls within the player to move forward or backward in the video timeline. It can be triggered by dragging the scrub bar or auto advancing using controls exposed by the app.

Technical Name: seek_start

Applicable for: Ad, Content, Live, VOD

Node Location: event.type

Max Decimals: 0

to the top

Seek End

event

Released in version 1.93

Definition: Event is fired when the player stops moving the playhead position to jump to a specific point on the timeline. This event includes attributes Seek Start Point & Seek End Point to mark the starting & ending points of a seek event.

Technical Name: seek_end

Applicable for: Ad, Content, Live, VOD

Node Location: event.type

Max Decimals: 0

to the top

Stall Start

event

Released in version 1.107

Definition: Stall Start event is triggered when playback of video stops because the buffer has been depleted causing an unexpected interruption for the user.

Technical Name: stall_start

Supported Ad Networks: Google IMA

Applicable for: Ad, Content, Live, VOD

Node Location: event.type

Max Decimals: 0

to the top

Stall End

event

Released in version 1.107

Definition: Event fired when video starts playing again after a stall and the buffer has been replenished and playback resumes.

Technical Name: stall_end

Supported Ad Networks: Google IMA

Applicable for: Ad, Content, Live, VOD

Node Location: event.type

Max Decimals: 0

to the top

Stop

event

Released in version 1.100

Definition: When the player has entered a stopped state due to any reason such as the user hitting a stop button, backgrounding the app, user switches content or the content has ended playback.

Technical Name: stop

Applicable for: Content, Live, VOD

Node Location: event.type

Max Decimals: 0

to the top

FluxData

Bandwidth

fluxdata

Released in version 1.101

Definition: Amount of estimated network bandwidth currently available to the end user's device.

Technical Name: bandwidth_kbps

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 2152

Unit: kbps

Max Decimals: 0

to the top

Buffer Duration - Content

fluxdata

Released in version 1.100

Definition: Cumulative time that content has been buffering during content playback in current Content Session.

Technical Name: buffer_duration_content_ms

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 124

Unit: milliseconds

Max Decimals: 0

to the top

Buffer Length

fluxdata

Released in version 1.101

Definition: The amount of media currently stored in the player buffer waiting to be played.

Technical Name: buffer_length_ms

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 46100

Unit: milliseconds

Max Decimals: 0

to the top

Content Session Start Timestamp

fluxdata

Released in version 1.100

Definition: Start time of a new Content Session for the current user session. Typically a new Content Session begins with a Playback Request.

Technical Name: content_session_start_ts_ms

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 1589903189

Unit: milliseconds

Max Decimals: 0

to the top

Engagement Duration

fluxdata

Released in version 1.101

Definition: Cumulative time that user has been engaged with the app or site, including time spent not viewing video.

Technical Name: engagement_duration_ms

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 2468

Unit: milliseconds

Max Decimals: 0

to the top

Number of Content Plays

fluxdata

Released in version 1.101

Definition: The amount of content assets that started playback during the current user app session.

Technical Name: num_content_plays

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 2

Unit: count

Max Decimals: 0

to the top

Number of Content Requests

fluxdata

Released in version 1.101

Definition: The amount of content assets requested during the current user session.

Technical Name: num_requests_content

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 2

Unit: count

Max Decimals: 0

to the top

Number of Errors - Content

fluxdata

Released in version 1.101

Definition: Running count of the number of errors that have occurred while content is playing during the user's current session.

Technical Name: num_errors_content

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 2

Unit: count

Max Decimals: 0

to the top

Playback Duration - Content

fluxdata

Released in version 1.100

Definition: Cumulative time that content has been playing during the current video Content Session. Excludes time accrued while user pauses content or buffering.

Technical Name: playback_duration_content_ms

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 1234

Unit: milliseconds

Max Decimals: 0

to the top

Player Viewable

fluxdata

Released in version 1.101

Definition: Is 50% or more of the player visible on the screen at the time of event?

Technical Name: player_viewable

Applicable for: Ad, Content, Live, VOD

Field Type: bool

Node Location: event.metrics

Permitted Values: value list

Example Value: false

Value List: true, false

Max Decimals: 0

to the top

Player Viewable Percent

fluxdata

Released in version 1.101

Definition: The percentage of the player that is viewable on the screen at the time of the event.

Technical Name: player_viewable_percent

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 75

Unit: percentage

Max Decimals: 3

Scale: 0 .. 100

to the top

Playhead Position

fluxdata

Released in version 1.76

Definition: Returns the current point in the video timeline in seconds.

Technical Name: playhead_position_sec

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 10.135

Unit: seconds

Max Decimals: 3

to the top

Rendition Video Bitrate

fluxdata

Released in version 1.101

Definition: Target bitrate of the currently selected video rendition from the manifest. The manifest may contain multiple versions (i.e. renditions) of the video encoded at varying qualities to support varying network conditions.

Technical Name: rendition_video_bitrate_kbps

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 3127

Unit: kbps

Max Decimals: 0

to the top

Stall Count - Content

fluxdata

Released in version 1.101

Definition: Number of times the user's playback of Content has been interrupted by an unexpected video stall due to buffer depletion.

Technical Name: stall_count_content

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 2

Unit: count

Max Decimals: 0

to the top

Stall Duration - Content

fluxdata

Released in version 1.101

Definition: The cumulative amount of time elapsed where the user's playback of Content has been interrupted by an unexpected video stall due to buffer depletion.

Technical Name: stall_duration_content_ms

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 1234

Unit: milliseconds

Max Decimals: 0

to the top

Time Since Content Started

fluxdata

Released in version 1.102

Definition: Time interval since current content playback began.

Technical Name: time_since_started_content_ms

Applicable for: Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 37

Unit: milliseconds

Max Decimals: 0

to the top

Time Since Content Request

fluxdata

Released in version 1.102

Definition: Time interval since content playback was requested.

Technical Name: time_since_request_content_ms

Applicable for: Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 37

Unit: milliseconds

Max Decimals: 0

to the top

Time Since Last Ad Break Start

fluxdata

Released in version 1.107

Definition: Time interval since the current pod of advertisements began.

Technical Name: time_since_last_ad_break_start_ms

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 1234

Unit: milliseconds

Max Decimals: 0

to the top

Time Since Last Buffer Start - Content

fluxdata

Released in version 1.102

Definition: Time interval since Buffer Start event began during content playback, reported in milliseconds. Value is reset to zero at the start of a new video View or when another Buffer Start event occurs.

Technical Name: time_since_last_buffer_start_content_ms

Applicable for: Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 1234

Unit: milliseconds

Max Decimals: 0

to the top

Time Since Last Heartbeat

fluxdata

Released in version 1.102

Definition: Time interval since Heartbeat was last sent for the current content session.

Technical Name: time_since_last_heartbeat_ms

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 10000

Unit: milliseconds

Max Decimals: 0

to the top

Time Since Last Milestone - Ad

fluxdata

Released in version 1.102

Definition: Time interval since Milestone event was last sent for ad.

Technical Name: time_since_last_milestone_ad_ms

Applicable for: Ad, Content, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 7500

Unit: milliseconds

Max Decimals: 0

to the top

Time Since Last Milestone - Content

fluxdata

Released in version 1.102

Definition: Time interval since Milestone event was last sent for content.

Technical Name: time_since_last_milestone_content_ms

Applicable for: Ad, Content, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 7500

Unit: milliseconds

Max Decimals: 0

to the top

Event Count

fluxdata

Released in version 1.77

Definition: Incremental counter of the events generated during a user session. This field is valuable for ensuring proper sequencing of events and detecting any potential data loss.

Technical Name: event_count

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.metrics

Permitted Values: any

Example Value: 1

Unit: count

Max Decimals: 0

to the top

Event Attributes

Startup Duration - Content

metadata

Released in version 1.102

Definition: This timer represents the total time a user spent waiting for content to begin playback excluding any time related to requesting, loading or playing pre-roll ads.

Technical Name: startup_duration_content_ms

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.attributes

Permitted Values: any

Example Value: 123

Unit: milliseconds

Max Decimals: 0

to the top

Startup Duration - Total

metadata

Released in version 1.102

Definition: This timer represents the total time a user spent waiting for content to begin playback excluding any time spent viewing pre-roll ads.

Technical Name: startup_duration_total_ms

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.attributes

Permitted Values: any

Example Value: 123

Unit: milliseconds

Max Decimals: 0

to the top

Error Code

metadata

Released in version 1.107

Definition: Error object representing a code explicitly identified by the player

Technical Name: error_code

Supported Ad Networks: Google IMA

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: event.attributes

Permitted Values: any

Example Value: 1001

Max Decimals: 0

to the top

Error Message

metadata

Released in version 1.107

Definition: Error object representing a message about the error explicitly identified by the player

Technical Name: error_msg

Supported Ad Networks: Google IMA

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: event.attributes

Permitted Values: any

Example Value: Player failed to launch

Max Decimals: 0

to the top

Heartbeat Count

metadata

Released in version 1.105

Definition: Incremental tracker identifying the order of Heartbeat events from the Collector.

Technical Name: heartbeat_count

Applicable for: Content, Live, VOD

Field Type: number

Node Location: event.attributes

Permitted Values: any

Example Value: 1

Unit: count

Max Decimals: 0

to the top

Milestone Percent

metadata

Released in version 1.102

Definition: Number indicating the percentage milestone represented by the event fired. Attribute of Milestone events.

Technical Name: milestone_percent

Supported Ad Networks: Google IMA

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

to the top

Seek Start Point

metadata

Released in version 1.93

Definition: The starting point of a seek event, representing the content timecode in milliseconds. Value will appear as an attribute on Seek End events

Technical Name: seek_start_point_ms

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.attributes

Permitted Values: any

Example Value: 5678

Unit: milliseconds

Max Decimals: 0

to the top

Seek End Point

metadata

Released in version 1.93

Definition: The ending point of a seek event, representing the content timecode in milliseconds. Value will appear as an attribute on Seek End events

Technical Name: seek_end_point_ms

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: event.attributes

Permitted Values: any

Example Value: 8910

Unit: milliseconds

Max Decimals: 0

to the top

Qualified View Trigger

metadata

Released in version 1.100

Definition: Number indicating the playback duration triggering the Qualified View event.

Technical Name: qualified_view_sec

Applicable for: Content, Live, VOD

Field Type: number

Node Location: event.attributes

Permitted Values: any

Example Value: 30

Unit: seconds

Max Decimals: 0

to the top

Message Metadata

Configuration ID

metadata

Released in version 1.76

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.

Technical Name: configuration_id

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: root

Permitted Values: UUID

Example Value: 3bba4192-8105-4498-ae34-587154d56fa6

Max Decimals: 0

to the top

Event ID

metadata

Released in version 1.76

Definition: Unique identifier for each event message fired by a Collector or log file received by Datazoom. The string includes an incremental counter at the end to allow for sequencing the events from a user session.

Technical Name: event_id

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: root

Permitted Values: any

Example Value: ddee8570-3dd5-4cfa-aeac-04d694c4c22a_00.00001

Max Decimals: 0

to the top

User Details

App Session Start Timestamp

metadata

Released in version 1.76

Definition: Start time of the current user session

Technical Name: app_session_start_ts_ms

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: user_details

Permitted Values: any

Example Value: 1535971954488

Unit: milliseconds

Max Decimals: 0

to the top

App Session ID

metadata

Released in version 1.76

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.

Technical Name: app_session_id

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: user_details

Permitted Values: any

Example Value: 43DHE-EROILKER-EREOATE

Max Decimals: 0

to the top

Client IP Address

metadata

Released in version 1.76

Definition: IP address of the user's device

Technical Name: client_ip

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: user_details

Permitted Values: IP address

Example Value: 173.19.65.222

Max Decimals: 0

to the top

Content Session ID

metadata

Released in version 1.76

Definition: A unique id for the current video playback session.

Technical Name: content_session_id

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: user_details

Permitted Values: UUID

Example Value: 3bba4192-8105-4498-ae34-587154d56fa6

Max Decimals: 0

to the top

User Agent

metadata

Released in version 1.100

Definition: Contains a number of tokens that refer to aspects of the user device, including the user's browser name and version, rendering engine, device’s model number, operating system and its version, etc.

Technical Name: user_agent

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: user_details

Permitted Values: any

Example Value: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4606.71 Safari/537.36

Max Decimals: 0

to the top

Player

Player Name

metadata

Released in version 1.76

Definition: States which video player generated the event

Technical Name: player_name

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: player

Permitted Values: any

Example Value: JW Player

Max Decimals: 0

to the top

Player Version

metadata

Released in version 1.76

Definition: States the version of the video player that generated the event

Technical Name: player_version

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: player

Permitted Values: any

Example Value: 8.01

Max Decimals: 0

to the top

Streaming Protocol

metadata

Released in version 1.101

Definition: What streaming format is being used for the content?

Technical Name: streaming_protocol

Applicable for: Ad, 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

Max Decimals: 0

to the top

Streaming Type

metadata

Released in version 1.101

Definition: Describes if the content being streamed is Live or On Demand.

Technical Name: streaming_type

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: player

Permitted Values: value list

Example Value: Live

Value List: Live, VOD

Max Decimals: 0

to the top

Device

Browser Height

metadata

Released in version 1.76

Definition: The height of the end user's browser window at the time when the event occurred.

Technical Name: browser_height

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: device

Permitted Values: any

Example Value: 1250

Unit: pixels

Max Decimals: 0

to the top

Browser Name

metadata

Released in version 1.76

Definition: Web browser being used during the session

Technical Name: browser_name

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: device

Permitted Values: any

Example Value: Chrome

Max Decimals: 0

to the top

Browser Version

metadata

Released in version 1.76

Definition: Version of web browser being used during the session

Technical Name: browser_version

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: device

Permitted Values: any

Example Value: 52.01.03

Max Decimals: 0

to the top

Browser Width

metadata

Released in version 1.76

Definition: The width of the end user's browser window at the time when the version occurred.

Technical Name: browser_width

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: device

Permitted Values: any

Example Value: 2150

Unit: pixels

Max Decimals: 0

to the top

Device ID

metadata

Released in version 1.77

Definition: Unique identifier of the user's device.

Technical Name: device_id

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: device

Permitted Values: any

Example Value: 93fb4310be52415e

Max Decimals: 0

to the top

Device Type

metadata

Released in version 1.77

Definition: Describes the type of device category being used during the session such as phone, tablet, desktop, connected device, game console, etc.

Technical Name: device_type

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

Max Decimals: 0

to the top

OS Name

metadata

Released in version 1.100

Definition: Operating System of the user's device

Technical Name: os_name

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: device

Permitted Values: any

Example Value: OS X

Max Decimals: 0

to the top

OS Version

metadata

Released in version 1.100

Definition: Version of Operating System being used during the session

Technical Name: os_version

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: device

Permitted Values: any

Example Value: 10.14

Max Decimals: 0

to the top

Video

Duration

metadata

Released in version 1.76

Definition: The total length of the media file, reported in decimal seconds

Technical Name: duration_sec

Applicable for: Ad, Content, VOD

Field Type: number

Node Location: video

Permitted Values: any

Example Value: 25.49

Unit: seconds

Max Decimals: 3

to the top

Media Type

metadata

Released in version 1.102

Definition: Specifies whether the event relates to an Ad or Content asset.

Technical Name: media_type

Supported Ad Networks: Google IMA

Applicable for: Ad, Content, Live, VOD, Ad

Field Type: string

Node Location: video

Permitted Values: value list

Example Value: Ad

Value List: ad, content

Max Decimals: 0

to the top

Source

metadata

Released in version 1.101

Definition: Returns the URL of the current media file

Technical Name: source

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: video

Permitted Values: URL

Example Value: http://...

Max Decimals: 0

to the top

Location

City

metadata

Released in version 1.76

Definition: The city or town where the user is located

Use Case

When aggregated with other player sessions, this can provide a definitive number of viewers within a city. This can be helpful when targeting local advertising.

Technical Name: city

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: geo_location

Permitted Values: any

Example Value: Santa Rosa Beach

Max Decimals: 0

to the top

Continent

metadata

Released in version 1.100

Definition: The name of the continent from which the event originated based on the user's IP address.

Use Case

This value is ideal to utilize when enforcing content rights: any player identified within a specific country can be blocked from accessing the content. Note that proxy servers can be used by viewers to make their request appear to be originating from an approved country. Matching the countryCode received during a request to the country specified in the subscriber's profile information can help mitigate proxy use.

Technical Name: continent

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: geo_location

Permitted Values: any

Example Value: North America

Max Decimals: 0

to the top

Continent Code

metadata

Released in version 1.100

Definition: The continent from which the event originated based on the user's IP address.

Use Case

Technical Name: continent_code

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: geo_location

Permitted Values: 2 letter code

Example Value: NA

Max Decimals: 0

to the top

Country

metadata

Released in version 1.77

Definition: Full name of the user's country

Use Case

For content rights that have global distribution, country is often the value most used to enforce access making it relatively easy to blacklist and/or whitelist certain countries.

Technical Name: country

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: geo_location

Permitted Values: any

Example Value: United States

Max Decimals: 0

to the top

Country Code

metadata

Released in version 1.77

Definition: The country from which the browser initiated the event. For a list of country codes, see ISO 3166-1 alpha-2 .

Use Case

Technical Name: country_code

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: geo_location

Permitted Values: 2 letter code

Example Value: US

Max Decimals: 0

to the top

District

metadata

Released in version 1.100

Definition: The district, subdivision of city from where the event originated as determined by the user's IP address.

Use Case

Technical Name: district

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: geo_location

Permitted Values: any

Example Value: Old Farm District

Max Decimals: 0

to the top

Latitude

metadata

Released in version 1.100

Definition: Location information for the user

Use Case

When used in conjunction with longitude, this can provide an exact location for the viewer.

Technical Name: latitude

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: geo_location

Permitted Values: any

Example Value: 30.3659

Unit: degrees

Max Decimals: 4

Scale: -90 .. 90

to the top

Longitude

metadata

Released in version 1.100

Definition: Location information for the user

Use Case

When used in conjunction with latitude, this can provide an exact location for the viewer.

Technical Name: longitude

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: geo_location

Permitted Values: any

Example Value: -86.2458

Unit: degrees

Max Decimals: 4

Scale: -180 .. 180

to the top

Postal Code

metadata

Released in version 1.100

Definition: The specific administrative division within a country where the event occurred. In the United States, zip codes correspond to postal region locator

Use Case

When aggregated with other player sessions, this can provide a definitive number of viewers within a specific area of a city. This can be helpful when targeting local advertising.

Technical Name: postal_code

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: geo_location

Permitted Values: any

Example Value: 32459

Max Decimals: 0

to the top

Region

metadata

Released in version 1.100

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.

Use Case

This is the full form of the regionCode (i.e., Florida instead of FL). As a result, this value is often used for display purposes, rather than programmatically. If the fullname of a country region is needed, pulling this field is more efficient than employing memory or CPU to programmatically match the regionCode to a region name.

Technical Name: region

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: geo_location

Permitted Values: any

Example Value: Florida

Max Decimals: 0

to the top

Region Code

metadata

Released in version 1.100

Definition: The specific administrative division within a country where the event occurred. In the United States, regions correspond to state abbreviations; for example, WA or NY but in other countries the region code may be represented by numbers or some other identifier.

Use Case

Like the countryCode, this value can be used to enforce content rights, especially when those rights are tied to only certain regions within a country. For example, a sporting event on the West Coast of the U.S. may not be available on the East Coast of the U.S., therefore all states on the East Coast (NY, FL, NH, etc.) would be blocked from content access.

Technical Name: region_code

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: geo_location

Permitted Values: any

Example Value: FL

Max Decimals: 0

to the top

Timezone Name

metadata

Released in version 1.100

Definition: The name of the user's timezone where the event originated based on their IP address.

Use Case

Technical Name: timezone_name

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: geo_location

Permitted Values: any

Example Value: America/Chicago

Max Decimals: 0

to the top

Timezone Offset

metadata

Released in version 1.100

Definition: The difference in hours, relative to UTC, of the user's timezone.

Use Case

Technical Name: timezone_offset

Applicable for: Ad, Content, Live, VOD

Field Type: number

Node Location: geo_location

Permitted Values: any

Example Value: -4.5

Unit: hours

Max Decimals: 2

Scale: -24 .. 24

to the top

Network

Mobile Connection

metadata

Released in version 1.100

Definition: Specifies if a user is on a mobile connection as determined by their IP address.

Use Case

Technical Name: mobile_connection

Applicable for: Ad, Content, Live, VOD

Field Type: bool

Node Location: network

Permitted Values: value list

Example Value: True

Value List: true,false

Max Decimals: 0

to the top

ASN

metadata

Released in version 1.76

Definition: 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

Technical Name: asn

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: network

Permitted Values: any

Example Value: AS30036 Mediacom Communications Corp

Max Decimals: 0

to the top

ASN Org

metadata

Released in version 1.76

Definition: The organization that owns the Autonomous System Number. Often an ISP, sometimes a private company or institution.

Technical Name: asn_org

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: network

Permitted Values: any

Example Value: MEDIACOM

Max Decimals: 0

to the top

ISP

metadata

Released in version 1.100

Definition: Name of the end-user's internet service provider.

Technical Name: isp

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: network

Permitted Values: any

Example Value: Mediacom Communications Corp

Max Decimals: 0

to the top

Page

DZ SDK Version

metadata

Released in version 1.76

Definition: Version number of the Datazoom SDK that generated the event message.

Technical Name: dz_sdk_version

Applicable for: Ad, Content, Live, VOD

Field Type: string

Node Location: page

Permitted Values: any

Example Value: 1.40

Max Decimals: 0

to the top

Ad Data

Ad Break ID

metadata

Released in version 1.107

Definition: UUID to denote the specific ad break. This can be used to tie events together that occurred during a specific ad break.

Technical Name: ad_break_id

Applicable for: Ad, Live, VOD

Field Type: string

Node Location: ad

Permitted Values: UUID

Example Value: 7A05EA23-E798-47C8-A243-0B8E1D5D7AD7

Max Decimals: 0

to the top

Ad Session ID

metadata

Released in version 1.107

Definition: A Datazoom generated UUID to denote the specific ad asset playback. This can be used to tie events together that occurred during a specific ad item.

Technical Name: ad_session_id

Applicable for: Ad

Field Type: string

Node Location: ad

Permitted Values: UUID

Example Value: FFBD8A96-4CA7-4D5E-AF3C-D69345E29BE1

Max Decimals: 0

to the top

Custom

Custom Metadata

metadata

Released in version 1.77

Definition: 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.

Technical Name: {custom_metadata_name}

Applicable for: Ad, Content, Live, VOD

Node Location: custom

Permitted Values: any

Max Decimals: 0

to the top

Articles in this section

Supported Data Points - Amazon IVS

Categories

Data Points

Events

FluxData

Event Attributes

Message Metadata

User Details

Player

Device

Video

Location

Network

Page

Ad Data

Custom

Comments

Articles in this section

Categories

Data Points

Events

FluxData

Event Attributes

Message Metadata

User Details

Player

Device

Video

Location

Network

Page

Ad Data

Custom

Related articles