Articles in this section

See more

Supported Data Points - iOS Media Player

Avatar
Tony Gentile
  • Updated
Follow

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

Categories

Events
FluxData
Message Metadata
User Details
Player
Device
Video
Location
Network

Events

Ad Complete
event
Released in version 1.47.1
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
to the top
Ad Impression
event
Released in version 1.47.1
Fired when an Ad impression is recorded by the video player.
Use Case
Count how many times a single ad was presented to a user.
Applicable for: Live, VOD, Ad
Node Location: event.type
to the top
Ad Request
event
Released in version 1.47.1
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
to the top
Error
event
Released in version 1.22
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
to the top
Pause
event
Released in version 1.10.01
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.10.01
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
Play Request
event
Released in version 1.19
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
to the top
Playback Complete
event
Released in version 1.47.1
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
Player Ready
event
Released in version 1.10.01
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
to the top
Playing
event
Released in version 1.10.01
The media is no longer blocked from playback, and has started playing.
Applicable for: Content, Live, VOD
Node Location: event.type
to the top
Resume
event
Released in version 1.19
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
to the top

FluxData

bitrate
fluxdata
Released in version 1.10.01
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
to the top
numberOfVideos
fluxdata
Released in version 1.21
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
to the top
playbackRate
fluxdata
Released in version 1.10.01
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
to the top
playerState
fluxdata
Released in version 1.10.01
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
to the top
playheadPosition
fluxdata
Released in version 1.47.1
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
to the top
volumeLevel
fluxdata
Released in version 1.10.01
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
to the top

Message Metadata

timestamp
metadata
Released in version 1.47.1
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
to the top
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
to the top
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
to the top
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
to the top
event_id
metadata
Released in version 1.47.1
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
to the top

User Details

client_ip
metadata
Released in version 1.10.01
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
to the top
user_agent
metadata
Released in version 1.10.01
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
to the top

Player

autoStart
metadata
Released in version 1.22
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
to the top
controls
metadata
Released in version 1.22
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
to the top
defaultPlaybackRate
metadata
Released in version 1.22
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
to the top
fullscreen
metadata
Released in version 1.22
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
to the top
loop
metadata
Released in version 1.22
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
to the top
playerName
metadata
Released in version 1.10.01
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
to the top
streamingProtocol
metadata
Released in version 1.22
What streaming format is being used for the content?
Applicable for: Ads, 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
to the top
streamingType
metadata
Released in version 1.22
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
to the top

Device

device_id
metadata
Released in version 1.10.01
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
to the top
os
metadata
Released in version 1.10.01
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
to the top
osVersion
metadata
Released in version 1.21
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
to the top

Video

duration
metadata
Released in version 1.47.1
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
to the top
source
metadata
Released in version 1.10.01
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://...
to the top
videoType
metadata
Released in version 1.47.1
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
to the top

Location

city
metadata
Released in version 1.21
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
to the top
countryCode
metadata
Released in version 1.21
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
to the top
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
to the top
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
to the top
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
to the top
regionCode
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 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
to the top
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
to the top

Network

asn
metadata
Released in version 1.21
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
to the top
asnOrganization
metadata
Released in version 1.21
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
to the top
isp
metadata
Released in version 1.17
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
to the top

Related articles

Comments

0 comments

Article is closed for comments.