Want to learn more about how to use these data points? Click here to schedule a demo of Datazoom.
Clappr v.0.3.3
Datazoom Name |
Type |
Description |
Player Method |
Status |
Notes |
|---|---|---|---|---|---|
Ad_Break_End |
Event |
Fired at the end of an advertising pod |
DONE |
||
Ad_Break_Start |
Event |
Fired at the beginning of an advertising pod |
DONE |
||
Ad_Click |
Event |
Triggered when the user interacts with an advertisement |
DONE |
||
Ad_Complete |
Event |
Fired when an ad completes playing back |
DONE |
||
Ad_Error |
Event |
Thrown if an error occurs during ad playback or retrieval of an ad |
DONE |
||
Ad_First_Quartile |
Event |
Ad content passed the first quartile |
DONE |
||
Ad_FluxData |
Event |
Periodic event that contains all of the selected FluxData fired at the specified FluxData interval. |
DONE |
||
Ad_Impression |
Event |
Fired the instant a video ad begins to play |
DONE |
||
Ad_Pause |
Event |
Fired when the ad is paused. |
DONE |
||
Ad_Play |
Event |
Fired whenever an ad starts playing or when an ad is unpaused. |
DONE |
||
Ad_Request |
Event |
When ad is requested to the ad server. |
DONE |
||
Ad_Resume |
Event |
When the ad is resumed. |
DONE |
||
Ad_Second_Quartile |
Event |
Ad content passed the mid point |
DONE |
||
Ad_Third_Quartile |
Event |
Ad content passed the third quartile |
DONE |
||
Bitrate_Change |
Event |
Bitrate value has been updated |
DONE |
||
Buffer_End |
Event |
Video starts playing again after a buffer is completed. |
DONE |
||
Buffering |
Event |
Fired when the player starts playback and when the player enters a buffering state |
DONE |
||
Content_First_Quartile |
Event |
Video playhead passed the first quartile |
DONE |
||
Content_Second_Quartile |
Event |
Video playhead passed the midpoint |
DONE |
||
Content_Third_Quartile |
Event |
Video playhead passes the third quartile |
DONE |
||
Error |
Event |
Fired when the player encounters an error |
DONE |
||
Exit_Fullscreen |
Event |
Triggered when user exits fullscreen mode |
DONE |
||
First_Frame |
Event |
Use this to determine the period of time between a user pressing play and the same user viewing their content |
DONE |
||
FluxData |
Event |
Periodic event that contains all of the selected FluxData fired at the specified FluxData interval. |
DONE |
||
Fullscreen |
Event |
Fired when the player toggles to/from fullscreen |
DONE |
||
Levels_Changed |
Event |
Fired when the user selects a different preferred playback quality. |
DONE |
||
Mute |
Event |
Triggered when the player has gone into a mute state |
DONE |
||
Pause |
Event |
Fired when the player enters the paused state |
DONE |
||
Play |
Event |
Fired when the user initiates video playback. |
DONE |
||
Play_Request |
Event |
User requests the video. 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 |
DONE |
||
Playback_Complete |
Event |
Fired when an item completes playback |
DONE |
||
Player_Ready |
Event |
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 |
DONE |
||
Playing |
Event |
The media is no longer blocked from playback, and has started playing. |
DONE |
||
Rendition_Change |
Event |
When the Player's Adaptive Bitrate Streaming upshifts or downshifts to a different quality level available in the manifest. |
DONE |
||
Resize |
Event |
Fired when the player's on-page dimensions have changed. Is not fired in response to a fullscreen change. |
DONE |
||
Resume |
Event |
When video playback is resumed. |
DONE |
||
Seek |
Event |
Fired after a seek has been requested |
DONE |
||
Seeked |
Event |
Fired after a seek has been completed |
DONE |
||
Unmute |
Event |
Triggered when the player has gone out of a mute state |
DONE |
||
Volume_Change |
Event |
Triggered when the player's volume is changed. |
DONE |
||
bandwidth |
FluxData |
Client bandwidth estimated |
DONE |
||
bitrate |
FluxData |
Current bitrate from the manifest that is being served. |
DONE |
||
bufferFill |
FluxData |
Percent utilization of playback buffer |
DONE |
||
currentCaptions |
FluxData |
The index of the currently active captions track. |
DONE |
||
numberOfVideos |
FluxData |
The amount of unique videos watched during the current viewing session |
DONE |
||
playbackRate |
FluxData |
the speed of the audio/video playback |
DONE |
||
playerState |
FluxData |
Returns the player's current playback state. (Idle, buffering, playing, paused) |
DONE |
||
playheadPosition |
FluxData |
Intended to return the viewer's current position in a media file. |
DONE |
||
renditionBitrate |
FluxData |
Name of the target bandwidth of the rendition being played. In bits. |
DONE |
||
renditionHeight |
FluxData |
Height of the rendition being played. NOT the height of the video element. |
DONE |
||
renditionName |
FluxData |
Name of the rendition being played. |
DONE |
||
renditionWidth |
FluxData |
Width of the rendition being played. NOT the width of the video element. |
DONE |
||
timeSinceAdBreakBegin |
FluxData |
Time interval since the current pod of advertisements began. |
DONE |
||
timeSinceAdPaused |
FluxData |
Time interval since Advertisement was paused |
DONE |
||
timeSinceAdRequested |
FluxData |
Time interval since Advertisement was requested |
DONE |
||
timeSinceAdStarted |
FluxData |
Time interval since Advertisement started playing |
DONE |
||
timeSinceBufferBegin |
FluxData |
Time interval since Buffering event for the current content began |
DONE |
||
timeSinceLastAd |
FluxData |
Time interval since the last Advertisement completed. |
DONE |
||
timeSinceLastAdFluxData |
FluxData |
Time interval since FluxData was last sent for an Advertisement |
DONE |
||
timeSinceLastAdQuartile |
FluxData |
Time interval since the user reached the previous 25%, 50% or 75% mark within the current advertisement. |
DONE |
||
timeSinceLastFluxData |
FluxData |
Time interval since FluxData was last sent for the current content. |
DONE |
||
timeSinceLastRenditionChange |
FluxData |
Time interval since content playback shifted to a different available quality version from the manifest. |
DONE |
||
timeSincePaused |
FluxData |
Time interval since content playback was paused. |
DONE |
||
timeSinceRequested |
FluxData |
Time interval since content playback was requested |
DONE |
||
timeSinceSeekBegin |
FluxData |
Time interval since Seek event during the current content playback began |
DONE |
||
timeSinceStarted |
FluxData |
Time interval since current content playback began. |
DONE |
||
volumeLevel |
FluxData |
The current playback volume |
DONE |
||
absShift |
Metadata |
Contains ‘up’ or ‘down’ in rendition changes depending on the value of the previous rendition. |
DONE |
||
asn |
Metadata |
Autonomous System Number: a unique number identifying a group of IP networks that serves the content to the end-user. |
DONE |
||
asnOrganization |
Metadata |
The organization that owns the Autonomous System Number. Often an ISP, sometimes a private company or institution. |
DONE |
||
autoStart |
Metadata |
Sets or returns whether the audio/video should start playing as soon as it is loaded |
DONE |
||
browser |
Metadata |
Web browser being used during the session |
DONE |
||
browserHeight |
Metadata |
The height of the end user's browser window at the time when the PageAction occurred. |
DONE |
||
browserVersion |
Metadata |
Version of web browser being used during the session |
DONE |
||
browserWidth |
Metadata |
The width of the end user's browser window at the time when the PageAction occurred. |
DONE |
||
city |
Metadata |
The city in which the PageAction occurred; for example, Seattle or Portland. |
DONE |
||
client_ip |
Metadata |
IP address of the user's device |
DONE |
||
configuration_id |
Metadata |
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. |
DONE |
||
controls |
Metadata |
Whether the controls are available for user interaction in the player. (i.e. Play/Pause/Seek) |
DONE |
||
countryCode |
Metadata |
The country from which the browser initiated the PageAction. For a list of country codes, see ISO 3166-1 alpha-2 . |
DONE |
||
customer_code |
Metadata |
Datazoom Customer Code identifier |
DONE |
||
defaultMuted |
Metadata |
Sets or returns whether the audio/video should be muted by default |
DONE |
||
defaultPlaybackRate |
Metadata |
Sets or returns the default speed of the audio/video playback |
DONE |
||
duration |
Metadata |
The total length of the media file. |
DONE |
||
errorCode |
Metadata |
Error object representing a code explicitly identified by the player |
DONE |
||
errorMsg |
Metadata |
Error object representing a message about the error explicitly identified by the player |
DONE |
||
fullscreen |
Metadata |
Is the player in fullscreen mode? |
DONE |
||
isMuted |
Metadata |
True if player is muted. |
DONE |
||
isp |
Metadata |
Name of the end-user's internet service provider. |
DONE |
||
latitude |
Metadata |
Location information for the user |
DONE |
||
longitude |
Metadata |
Location information for the user |
DONE |
||
loop |
Metadata |
Sets or returns whether the audio/video should start over again when finished |
DONE |
||
orientation |
Metadata |
The directional orientation of a mobile device |
DONE |
||
os |
Metadata |
Operating System being used during the session |
DONE |
||
osVersion |
Metadata |
Version of Operating System being used during the session |
DONE |
||
pageUrl |
Metadata |
The page from which the view was originated. |
DONE |
||
playerName |
Metadata |
Static value |
DONE |
||
playerVersion |
Metadata |
Version of the player. |
DONE |
||
readyState |
Metadata |
Returns the current ready state of the audio/video |
DONE |
||
region |
Metadata |
The specific administrative division within a country where the PageView event occurred. In the United States, regions correspond to state names ; for example, Washington or New York. |
DONE |
||
regionCode |
Metadata |
The specific administrative division within a country where the PageView event occurred. In the United States, regions correspond to state codes ; for example, WA or NY. |
DONE |
||
resolutionHeight |
Metadata |
Height dimension in pixels of the current playback area. |
DONE |
||
resolutionWidth |
Metadata |
Width dimension in pixels of the current playback area. |
DONE |
||
session_id |
Metadata |
A unique id for the current view session. |
DONE |
||
sessionViewId |
Metadata |
A unique id for the current video. It is composed of the viewSession and an incremental number (1, 2, 3…). Watching the same video during multiple points in a session will create distinct sessionViewId for each view. |
DONE |
||
socket_session_id |
Metadata |
Internal Datazoom identifier for the user's web socket session. |
DONE |
||
source |
Metadata |
Returns the URL of the current media file |
DONE |
||
streamingProtocol |
Metadata |
What streaming format is being used for the content? MPEG-DASH, HLS, HDS, Smooth, WebRTC, RTMP, RTSP |
DONE |
||
streamingType |
Metadata |
Type of content being streamed - Live or VOD. |
DONE |
||
title |
Metadata |
Provides the title of current item |
DONE |
||
zipCode |
Metadata |
The specific administrative division within a country where the PageView event occurred. In the United States, zip codes correspond to postal region locator |
DONE |
||
totalPlayTime |
FluxData |
Cumulative time that content has been playing during the current session. |
Planned |
||
adCampaignId |
Metadata |
Unique identifier of the advertising campaign that the current ad belongs to. |
Planned |
||
adClickUrl |
Metadata |
Url of the ad opened. |
Planned |
||
adCreativeId |
Metadata |
Creative ID of the ad shown. |
Planned |
||
adPartner |
Metadata |
Name of the partner showing the ad. |
Planned |
||
adPosition |
Metadata |
The position of the ad: pre, mid or post. |
Planned |
||
adSkipped |
Metadata |
Present on AD_END if it was skipped. |
Planned |
Comments
0 comments
Article is closed for comments.