Articles in this section

See more

Supported Data Points - Akamai AMP (tvOS)

Avatar
Bob Carlson
  • Updated
Follow

Want to learn more about how to use these data points? Click here to schedule a demo of Datazoom

Categories

Events
FluxData
Event Attributes
Message Metadata
User Details
Player
Device
Location
Page
Custom

Events

Heartbeat
event
Released in version 1.47
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
to the top
Milestone
event
Released in version 1.47
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, VOD
Node Location: event.type
to the top
Pause
event
Released in version 1.45
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
to the top
Play
event
Released in version 1.45
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
to the top
Playback Complete
event
Released in version 1.45
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
to the top

FluxData

bitrate
fluxdata
Released in version 1.45
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: Ad, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 3127
Unit: kb/s
Max Decimals: 0
to the top
playheadPosition
fluxdata
Released in version 1.45
Returns the current point in the video timeline in seconds.
Applicable for: Ad, Content, Live, VOD
Field Type: numeric
Node Location: event.metrics
Example Value: 10.135
Unit: seconds
Max Decimals: 3
to the top

Event Attributes

milestonePercent
metadata
Released in version 1.47
Number indicating the percentage milestone represented by the event fired. Attribute of Content Milestone & Ad Milestone
Applicable for: Ad, Content, VOD
Field Type: numeric
Node Location: event.attributes
Permitted Values: any
Example Value: 0.75
Unit: percentage
Max Decimals: 2
Scale: 0 .. 1
to the top

Message Metadata

configuration_id
metadata
Released in version 1.45
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: Ad, Content, Live, VOD
Field Type: string
Node Location: root
Permitted Values: UUID
Example Value: 3bba4192-8105-4498-ae34-587154d56fa6
to the top
connector_list
metadata
Released in version 1.45
List of the Connectors configured for this Collector via a Datazoom Data Pipe.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: root
Permitted Values: comma separated list
Example Value: dz-connector-google-analytics,dz-connector-mixpanel
to the top
customer_code
metadata
Released in version 1.45
Unique identifier for the Datazoom customer that generated the event.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: root
Permitted Values: UUID
Example Value: 3bba4192-8105-4498-ae34-587154d56fa6
to the top
event_id
metadata
Released in version 1.45
Unique identifier for each event message fired by a Collector or log file received by Datazoom.
Use Case
Provides a UUID that can be used for de-dupping records in the data platform or Connector.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: root
Permitted Values: any
Example Value: 43DHE-EROILKER-EREOATE
to the top
timestamp
metadata
Released in version 1.45
Epoch UTC time of the event occurrence
Applicable for: Ad, Content, Live, VOD
Field Type: numeric
Node Location: event
Example Value: 1535971954488
Unit: epoch
Max Decimals: 0
to the top
type
metadata
Released in version 1.45
Name of the event that describes the message
Use Case
event.type will be the key way to search for various events generated by the user.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event
Permitted Values: any
to the top

User Details

client_ip
metadata
Released in version 1.48
IP address of the user's device
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details
Permitted Values: IP address
Example Value: 173.19.65.222
to the top
session_id
metadata
Released in version 1.45
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: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details
Permitted Values: any
Example Value: 43DHE-EROILKER-EREOATE
to the top
sessionStartTimestamp
metadata
Released in version 1.45
Start time of the current user session
Applicable for: Ad, Content, Live, VOD
Field Type: numeric
Node Location: user_details
Example Value: 1535971954488
Unit: epoch
Max Decimals: 0
to the top
user_agent
metadata
Released in version 1.45
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: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details
Permitted Values: any
to the top
viewId
metadata
Released in version 1.47
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
to the top

Player

playerName
metadata
Released in version 1.45
States which video player that generated the event
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player
Permitted Values: any
Example Value: JW Player
to the top
playerVersion
metadata
Released in version 1.45
States the version of the video player that generated the event
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: player
Permitted Values: any
Example Value: 8.01
to the top

Device

adTrackingOptOut
metadata
Released in version 1.45
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
to the top
advertisingId
metadata
Released in version 1.45
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
to the top
device_id
metadata
Released in version 1.45
Unique identifier of the user's device.
Use Case
This can be used as a proxy for User if user is anonymous.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: device
Permitted Values: any
to the top
deviceType
metadata
Released in version 1.45
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: 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
to the top

Location

city
metadata
Released in version 1.48
The city or town where the user is located
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: Santa Rosa Beach
to the top
country
metadata
Released in version 1.48
Full name of the user's country
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: United States
to the top
countryCode
metadata
Released in version 1.48
The country from which the browser initiated the event. For a list of country codes, see ISO 3166-1 alpha-2 .
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: 2 letter code
Example Value: US
to the top
latitude
metadata
Released in version 1.48
Location information for the user
Applicable for: Ad, Content, Live, VOD
Field Type: numeric
Node Location: geo_location
Example Value: 30.3659
Unit: degrees
Max Decimals: 4
Scale: -90 .. 90
to the top
longitude
metadata
Released in version 1.48
Location information for the user
Applicable for: Ad, Content, Live, VOD
Field Type: numeric
Node Location: geo_location
Example Value: -86.2458
Unit: degrees
Max Decimals: 4
Scale: -180 .. 180
to the top
region
metadata
Released in version 1.48
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: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: Florida
to the top
regionCode
metadata
Released in version 1.48
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: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: 2 letter code
Example Value: FL
to the top
zipCode
metadata
Released in version 1.48
The specific administrative division within a country where the event occurred. In the United States, zip codes correspond to postal region locator
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location
Permitted Values: any
Example Value: 32459
to the top

Page

dzSdkVersion
metadata
Released in version 1.47
Version number of the Datazoom SDK that generated the event message.
Use Case
Used for troubleshooting data issues or isolating data differences stemming from alternate versions of the SDK used.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: page
Permitted Values: Any
Example Value: 1.40
to the top

Custom

customMetadata
metadata
Released in version 1.55
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: Ad, Content, Live, VOD
Node Location: custom
to the top

Related articles

Comments

0 comments

Article is closed for comments.