Analytic Events
This page contains deprecated documentation and is no longer actively maintained. A new version of this documentation is now available here.
Mobile | Web | TV Platforms | ||||
---|---|---|---|---|---|---|
DIVA's SDK provides tracking events that are exposed externally to your host application.
- Web
- iOS
- tvOS
- Android
- WebTV
- Roku
const divaParams = {
...,
onAnalyticEvent: (event) => {
console.log(event.type)
}
}
var config = DivaConfiguration(...)
config.onAnalyticEvent = { event in
print(event.description)
}
var config = DivaTVConfiguration(...)
config.onAnalyticEvent = { event in
print(event.description)
}
override fun onAnalyticsCallback(event: AnalyticsEvent) {
val text = StringBuilder()
event.eventArguments.forEach { x -> text.append("\t\t${x.key}: ${x.value}\n") }
Log.d("AnalyticEvent", ".\n${event.type}\n$text")
SessionsContainer.getInstance().currentSession.addEvent(event)
}
React version​
<DivaWebTV
...
onAnalytics={({type, interactive, eventArguments}) => {
logAnalytics('${type}', {interactive, eventArguments})
}}
/>
Vanilla js version​
divaWebtv.createDivaWebTV(el, {
...
onAnalytics:{({type, interactive, eventArguments}) => {
logAnalytics('${type}', {interactive, eventArguments})
}}
})
' Observe Diva Player generic analytics event call
observeDivaPlayerAnalyticsEvent("onAnalyticEvent")
...
' Generic analytics event handler callback
sub onAnalyticEvent(evt as dynamic)
data = evt.getData()
print data["type"]; data["interactive"]; data["eventArguments"]
end sub
All events in DIVA's player are raised through a callback. You can then use your own Analytics plugin to track events.
All DIVA events are identified using the AnalyticsEvent object payload. This structure provides the following parameters:
-
type: String
- type name of event.
-
interactive: boolean
- if true, this specifies when the event is generated as a result of user interaction.
-
eventArguments: Map
- dictionary which contains all the generic arguments (for instance videoMetaData parameters) and the specific event parameter. Arguments list
DIVA Events​
Here, all the available events tracked in DIVA's player are listed. If the platform is not mentioned, the event is available across all supported platforms.
360 player​
These events are available on:
video360_open​
- Description: Every time the 360 overlay appears
- Interactive: False
- EventArguments: N/A
video360_close​
- Description: Every time the 360 overlay disappears
- Interactive: False
- EventArguments: N/A
video360_close_click​
- Description: Every time a user selects the close button
- Interactive: True
- EventArguments: N/A
video360_list_open​
- Description: Every time the 360 list overlay appears
- Interactive: False
- EventArguments: N/A
video360_list_close​
- Description: Every time the 360 list overlay disappears
- Interactive: False
- EventArguments: N/A
video360_list_click​
- Description: Every time a user selects a video from a list
- Interactive: True
- EventArguments: selected_video_id
video360_vr_button_click​
- Description: Every time a user selects the VR/cardboard button
- Interactive: True
- EventArguments: N/A
video360_vr_button_close_click​
- Description: Every time a user selects the close VR/cardboard button
- Interactive: True
- EventArguments: N/A
video360_vr_enable​
- Description: Every time a user enters VR mode from the 360 module
- Interactive: False
- EventArguments: N/A
video360_vr_disable​
- Description: Every time a user exits VR mode from the 360 module
- Interactive: False
- EventArguments: N/A
Advertising​
ad_start​
- Description: When a train of ADs start
- Interactive: False
- EventArguments: ad_type
ad_stop​
- Description: When a train of ADs stop
- Interactive: False
- EventArguments: ad_type
ad_manual_stop
​
- Description: When the AD is stopped by a user via the back button
- Interactive: False
- EventArguments: ad_type
ad_single_click
​
- Description: When a user selects an AD
- Interactive: True
- WventArguments: ad_type
ad_single_mute
​
- Description: When an AD is muted
- Interactive: False
- EventArguments: ad_type
ad_play_click
​
- Description: When a user selects the controls to play a paused AD
- Interactive: True
- EventArguments: ad_type
ad_pause_click
​
- Description: When a user selects the controls to pause an AD
- Interactive: True
- EventArguments: ad_type
ad_single_resume
​
- Description: When an AD resumes playback
- Interactive: False
- EventArguments: ad_type
ad_single_pause
​
- Description: Every time an AD is paused
- Interactive: False
- EventArguments: ad_type
ad_single_fail​
- Description: Every time an AD fails playback
- Interactive: False
- EventArguments: ad_type, error_code
, error_description
ad_single_start​
- Description: Every time an AD starts
- Interactive: False
- EventArguments: ad_type
ad_single_stop​
- Description: When an AD stops
- Interactive: False
- EventArguments: ad_type
ad_single_skip
​
- Description: Every time an AD is skipped by a user
- Interactive: False
- EventArguments: ad_type
Alert​
These events are NOT available for
alert_open​
- Description: Every time an alert is displayed
- Interactive: False
- EventArguments: selected_video_id, alert_type
alert_close​
- Description: Every time an alert is closed (automatically or by user)
- Interactive: False
- EventArguments: selected_video_id, alert_type
alert_click​
- Description: Every time a user selects an alert to open a video
- Interactive: True
- EventArguments: selected_video_id, alert_type
alert_close_click​
- Description: Every time a user selects the close button
- Interactive: True
- EventArguments: selected_video_id, alert_type
multiview_goalalert_open (sidebyside_goalalert_open)
​
- Renamed from version 5.8
- Description: Every time a user selects an alert notification and enters Side-by-Side view
- Interactive: False
- EventArguments: alert_type
multiview_goalalert_close (sidebyside_goalalert_close)
​
- Renamed from version 5.8
- Description: Every time a user exits Side-by-Side view (goal alert)
- Interactive: False
- EventArguments: alert_type, section_time_spent
multiview_open (sidebyside_multiview_open)
​
- Renamed from version 5.8
- Description: Every time a user opens a new video in Side-by-Side view (multi-view)
- Interactive: False
- EventArguments: N/A
multiview_close (sidebyside_multiview_close)
​
- Renamed from version 5.8
- Description: Every time a user exits Side-by-Side view (mult-iview)
- Interactive: False
- EventArguments: section_time_spent
back_notification_open
​
- Description: Every time a back notification alert is displayed
- Interactive: False
- EventArguments: selected_video_id
back_notification_close
​
- Description: Every time a back notification alert is closed (automatically or by user)
- Interactive: False
- EventArguments: selected_video_id
back_notification_click
​
- Description: Every time a user selects a back notification alert to jump back to the original video
- Interactive: True
- EventArguments: selected_video_id
back_notification_close_click
​
- Description: Every time a user selects the close button
- Interactive: True
- EventArguments: selected_video_id
Alternate Timeline​
These events are NOT available for
alternate_timeline_open​
- Description: Every time the Alternate Timeline is displayed
- Interactive: False
- EventArguments: N/A
alternate_timeline_close​
- Description: Every time the Alternate Timeline is closed (automatically or by user)
- Interactive: False
- EventArguments: section_time_spent
alternate_timeline_item_click​
- Description: Every time a user selects an Alternate Timeline item
- Interactive: True
- EventArguments: playbyplay_type
alternate_timeline_swipe_navigation​
- Description: Every time a user swipes to navigate through the Alternate Timeline
- Interactive: True
- EventArguments: N/A
alternate_timeline_arrow_navigation​
- Description: Every time a user selects arrows to navigate through the Alternate Timeline
- Interactive: True
- EventArguments: N/A
alternate_timeline_tooltip_open
​
- Description: Every time a user hovers over a play by play icon (event marker) and the tooltip appears
- Interactive: False
- EventArguments: playbyplay_type, playbyplay_time
alternate_timeline_tooltip_click
​
- Description: Every time a user selects a tooltip in order to seek
- Interactive: True
- EventArguments: playbyplay_type, playbyplay_time
alternate_timeline_tooltip_see_all_click
​
- Description: Every time a user selects a tooltip 'See all highlights' link to open the Alternate Timeline at that specific time
- Interactive: True
- EventArguments: playbyplay_type, playbyplay_time
Enhanced Timeline​
enhanced_timeline_list_open
​
- Description: Every time the event list of the Enhanced Timeline is opened
- Interactive: False
- EventArguments: N/A
enhanced_timeline_list_close
​
- Description: Every time the event list of the Enhanced Timeline is closed
- Interactive: False
- EventArguments: N/A
enhanced_timeline_list_close_click
​
- Description: Every time a user closes the event list of the Enhanced Timeline
- Interactive: True
- EventArguments: N/A
enhanced_timeline_list_item_click
​
- Description: Every time a user selects close on one of the event list items
- Interactive: True
- EventArguments: N/A
enhanced_timeline_item_click
​
- Description: Every time a user selects close on one of the Enhanced Timeline event markers
- Interactive: True
- EventArguments: N/A
enhanced_timeline_arrow_navigation
​
- Description: Every time a user navigates through the Event List (which is done by using left/right directional keys on remote control while Event List is in focus)
- Interactive: True
- EventArguments: N/A
Buttons​
ccat_menu_button_click
​
- Description: Every time the user actions the "Audio and Subtitles" on-screen button, while the "Audio and Subtitles" main menu or any of its submenus are not yet opened/visible
- Interactive: True
- EventArguments: N/A
ccat_menu_open
​
- Description: Every time the "Audio and Subtitles" main menu is opened, as a result of user actioning the "Audio and Subtitles" on-screen button, or otherwise
- Interactive: False
- EventArguments: N/A
ccat_menu_close
​
- Description: Every time the "Audio and Subtitles" main menu closes, no matter if it was a result of user action or not
- Interactive: False
- EventArguments: N/A
audiotrack_list_open​
- Description: Every time the "Audio" submenu is opened/expanded
- Interactive: False
- EventArguments: N/A
audiotrack_list_close​
- Description: Every time the "Audio" submenu is closed/collapsed
- Interactive: False
- EventArguments: N/A
audiotrack_button_click​
- Description:
- ** Small screens **: Every time the user actions the "Audio" menu item inside the consolidated CC/AD menu, intended to expand/open the "Audio" sub-menu.
- ** TV platforms **: Description: Every time a user interacts with the Audio tracks button.
- ** Small screens **: Every time the user actions the "Audio" menu item inside the consolidated CC/AD menu, intended to expand/open the "Audio" sub-menu.
- Interactive: True
- EventArguments: N/A
audiotrack_selection
​
- Description: Every time a user applies a new audio track from the "Audio" submenu
- Interactive: True
- EventArguments: audio_value, audio_display_name
closed_caption_list_open​
- Description: Every time the "Subtitles" submenu is opened/expanded
- Interactive: False
- EventArguments: N/A
closed_caption_list_close​
- Description: Every time the "Subtitles" submenu is closed/collapse
- Interactive: False
- EventArguments: N/A
closed_caption_button_click​
- Description:
- ** Small screens **: Every time the user actions the "Subtitles" menu item inside the consolidated CC/AD menu, intended to expand/open the "Audio" sub-menu
- ** TV platforms **: Description: Every time a user interacts with the Close Captions button.
- ** Small screens **: Every time the user actions the "Subtitles" menu item inside the consolidated CC/AD menu, intended to expand/open the "Audio" sub-menu
- Interactive: True
- EventArguments: N/A
closed_caption_selection
​
- Description: Every time a user applies a new subtitles/CC track from the "Subtitles" submenu
- Interactive: True
- EventArguments: closed_caption_value, closed_caption_display_name
relevant_commentary_button_click
​
- Description: Every time a user selects the Relevant Commentary toggle button
- Interactive: True
- EventArguments: active
custom_button_click
​
- Description: Every time a user selects a custom button defined in a custom template
- Interactive: True
- EventArguments: active, action
pip_button_click
​
- Description: Every time a user selects the native PiP button
- Interactive: True
- EventArguments: N/A
multiview_button_click
​
- Description: Every time a user selects the multiview button
- Interactive: True
- EventArguments: N/A
settings_menu_button_click
​
- Description: Every time the user actions the "Settings" on-screen button, while the "Quality" main menu or any of its submenus are not yet opened/visible
- Interactive: True
- EventArguments: N/A
settings_menu_open
​
- Description: Every time the "Settings" main menu is opened, as a result of user actioning the "Settings" on-screen button, or otherwise
- Interactive: False
- EventArguments: N/A
settings_menu_close
​
- Description: Every time the "Settings" main menu closes, no matter if it was a result of user action or not
- Interactive: False
- EventArguments: N/A
quality_list_open
​
- Description: Every time the "Quality" submenu is opened/expanded
- Interactive: False
- EventArguments: N/A
quality_list_close
​
- Description: Every time the "Quality" submenu is closed/collapsed
- Interactive: False
- EventArguments: N/A
quality_button_click
​
- Description: Every time the user actions the "Quality" menu item inside the consolidated Settings menu, intended to expand/open the "Quality" sub-menu.
- Interactive: True
- EventArguments: N/A
quality_selection
​
- Description: Every time a user applies a new quality level from the "Quality" submenu
- Interactive: True
- EventArguments: quality_value, quality_display_name
Commentary​
These events are NOT available for
commentary_open​
- Description: Every time the Commentary displays
- Interactive: False
- EventArguments: overlay_id, commentary_notification_items
commentary_close​
- Description: Every time Commentary disappears
- Interactive: False
- EventArguments: overlay_id, section_time_spent
commentary_click​
- Description: Every time a user selects playbyplay (event marker)
- Interactive: True
- EventArguments: playbyplay_type, playbyplay_time, overlay_id
Control bar​
controlbar_open
​
- Description: Every time the control bar appears
- Interactive: False
- EventArguments: controlbar_type
controlbar_close
​
- Description: Every time the control bar disappears
- Interactive: False
- EventArguments: controlbar_type
controlbar_play​
- Description: Every time a user selects the play button
- Interactive: True
- EventArguments: controlbar_type
controlbar_pause​
- Description: Every time a user selects the pause button
- Interactive: True
- EventArguments: controlbar_type
controlbar_fullscreen
​
- Description: Every time a user selects the full-screen button
- Interactive: True
- EventArguments: controlbar_type
controlbar_seek_click
​
- Description: Every time a user seeks by selecting the timeline
- Interactive: True
- EventArguments: controlbar_type
controlbar_seek_back
​
- Description: Every time a user selects the seek back button
- Interactive: True
- EventArguments: controlbar_type
controlbar_seek_forward
​
- Description: Every time a user selects the seek forward button
- Interactive: True
- EventArguments: controlbar_type
controlbar_go_live​
- Description: Every time a user selects the Go Live button
- Interactive: True
- EventArguments: controlbar_type
controlbar_mute
​
- Description: Every time a user selects the mute button
- Interactive: True
- EventArguments: controlbar_type
controlbar_unmute
​
- Description: Every time a user selects the unmute button
- Interactive: True
- EventArguments: controlbar_type
controlbar_volume_change
​
- Description: Every time a user changes the volume
- Interactive: True
- EventArguments: controlbar_type
controlbar_commentary
​
- Description: Every time a user selects the Commentary button
- Interactive: True
- EventArguments: controlbar_type
controlbar_alternate_timeline
​
- Description: Every time a user selects the Alternate Commentary button
- Interactive: True
- EventArguments: controlbar_type
controlbar_chapter_list_click
​
- Description: Every time a user selects the Chapter List button
- Interactive: True
- EventArguments: controlbar_type
controlbar_chapter_list_item_click
​
- Description: Every time a user selects a chapter within the chapter list
- Interactive: True
- EventArguments: controlbar_type, chapter_title, chapter_starttime, chapter_endtime
controlbar_chapter_list_open
​
- Description: Every time the chapter list opens
- Interactive: False
- EventArguments: controlbar_type
controlbar_chapter_list_close
​
- Description: Every time the chapter list closes
- Interactive: False
- EventArguments: controlbar_type
controlbar_collapse_click
​
- Dismissed from version 5.8
- Description: Every time a user selects the Collapse button in multiview visualization mode
- Interactive: True
- EventArguments: controlbar_type
Chromecast​
These events are NOT available for
chromecast_click
​
- Description: Every time a user selects the Chromecast icon
- Interactive: True
- EventArguments: N/A
chromecast_open
​
- Description: Every time a user enters Chromecast mode
- Interactive: False
- EventArguments: N/A
chromecast_close
​
- Description: Every time a user exits Chromecast mode
- Interactive: False
- EventArguments: N/A
chromecast_background
​
- Description: Every time the app goes into the background
- Interactive: False
- EventArguments: N/A
chromecast_foreground
​
- Description: Every time the app goes in the foreground
- Interactive: False
- EventArguments: N/A
E-commerce​
These events are NOT available for
ecommerce_notification_open
​
- Description: Every time an E-commerce notification alert is displayed
- Interactive: False
- EventArguments: N/A
ecommerce_notification_close
​
- Description: Every time a an E-commerce notification alert is closed (automatically, by a user or by selecting the E-commerce notification action button)
- Interactive: False
- EventArguments: N/A
ecommerce_notification_click
​
- Description: Every time a user selects an E-commerce notification action button
- Interactive: True
- EventArguments: extId
ecommerce_notification_close_click
​
- Description: Every time a user selects an E-commerce notification alert close button
- Interactive: True
- EventArguments: N/A
ecommerce_icon_click
​
- Description: Every time a user selects an E-commerce shop icon
- Interactive: True
- EventArguments: N/A
Errors​
videometadata_error​
- Description: Every time an error on VideoMetaData is raised
- Interactive: False
- EventArguments: N/A
ssai_error​
- Description: Error generated in case of failure of the DAI manifest request
- Interactive: False
- EventArguments: error_code, error_description
entitlement_error​
- Description: Every time a ENTITLEMENT error is raised by the video component. This is considered a special sub-type of video_error.
- Interactive: False
- EventArguments: error_code, error_description
Highlights​
highlights_mode​
- Description: Every time a user enters Highlights mode
- Interactive: False
- EventArguments: highlights_type
highlights_fullmatch_click​
- Description: Every time a user selects the Full Match button
- Interactive: True
- EventArguments: N/A
highlights_next_click​
- Description: Every time a user selects the next button
- Interactive: True
- EventArguments: N/A
highlights_close_on_pip​
- Description: Every time a user selects the Live PiP to close the Highlights mode and return to the live video
- Interactive: True
- EventArguments: N/A
highlights_notification_open​
- Description: Every time a Highlights notification alert is displayed
- Interactive: False
- EventArguments: N/A
highlights_notification_close​
- Description: Every time a Highlights notification alert is closed (automatically or by a user)
- Interactive: False
- EventArguments: N/A
highlights_notification_click​
- Description: Every time a user selects a Highlights notification alert to enter in Highlights mode
- Interactive: True
- EventArguments: N/A
LiveLike​
This event is NOT available for
influencer_chat_icon_click​
- Description: Every time the icon of Influencer chat is selected
- Interactive: True
- EventArguments: N/A
Menu​
These events are NOT available for
menu_open​
- Description: Every time the menu appears
- Interactive: False
- EventArguments: N/A
menu_close​
- Description: Every time the menu disappears
- Interactive: False
- EventArguments: N/A
menu_close_click​
- Description: Every time a user selects on close menu button
- Interactive: True
- EventArguments: N/A
menu_click​
- Description: Every time a user selects the menu button
- Interactive: True
- EventArguments: N/A
menu_item_click​
- Description: Every time a user selects the menu item button
- Interactive: True
- EventArguments: overlay_id
Overlay​
These events are NOT available for
overlay_open​
- Description: Every time an overlay is opened (automatically or by a user)
- Interactive: False
- EventArguments: overlay_id, overlay_template, overlay_mode
overlay_close​
- Description: When an overlay is closed (automatically or by a user)
- Interactive: False
- EventArguments: overlay_id, overlay_template, overlay_mode
PiP view​
These events are NOT available for
pip_multiview_open​
- Description: Every time a user opens a new video in PiP view
- Interactive: False
- EventArguments: N/A
pip_multiview_close​
- Description: Every time the user exit from PiP view
- Interactive: False
- EventArguments: section_time_spent
pip_show_multiview_click​
- Dismissed from version 5.8
- Description: Every time a user selects to show (Side-by-side view) on relative PiP button
- Interactive: True
- EventArguments: default arguments
pip_swap_videos_click​
- Description: Every time a user selects to swap Side-by-side on relative PiP button
- Interactive: True
- EventArguments: default arguments
pip_close_click​
- Description: Every time a user selects to close PiP on relative PiP button
- Interactive: True
- EventArguments: default arguments
Player​
player_open​
- Description: Every time that a user enters DIVA
- Interactive: False
- EventArguments: hdr_mode
enter_fullscreen
​
- Description: Every time the player enters full-screen mode
- Interactive: False
- EventArguments: default arguments
exit_fullscreen
​
- Description: Every time the player exits full-screen mode
- Interactive: False
- EventArguments: default arguments
enter_zoommode
​
- Description: Every time the player enters zoom mode
- Interactive: True
- EventArguments: default arguments
exit_zoommode
​
- Description: Every time the player exits zoom mode
- Interactive: True
- EventArguments: default arguments
modalvideo_open
​
- Description: Every time a user enters DIVA modal mode
- Interactive: False
- EventArguments: N/A
modalvideo_close
​
- Description: Every time a user closes DIVA modal mode
- Interactive: False
- EventArguments: section_time_spent
modalvideo_close_click
​
- Description: Every time a user selects the close button in DIVA modal mode
- Interactive: True
- EventArguments: N/A
Recommendations​
These events are NOT available for
Recommendation_open​
- Description: Every time the Recommendations panel is open
- Interactive: False
- EventArguments: default arguments
recommendation_close​
- Description: Every time the Recommendations panel is closed
- Interactive: False
- EventArguments: default arguments
Recommendation_autoload​
- Description: Every time DIVA automatically loads the next video
- Interactive: False
- EventArguments: default arguments
recommendation_replay_click​
- Description: Every time a user selects the current video 'Watch again' button in the Recommendations panel
- Interactive: True
- EventArguments: default arguments
recommendation_next_click​
- Description: Every time a user selects the current video 'Watch next' video link (under current video) in the Recommendations panel
- Interactive: True
- EventArguments: default arguments
recommendation_other_click​
- Description: Every time a user selects a video from the videolist in the Recommendations panel
- Interactive: True
- EventArguments: default arguments
Settings​
settings_open​
- Description: Every time a user opens the Settings panel
- Interactive: False
- EventArguments: default arguments
settings_close​
- Description: Every time a user selects the close button in DIVA modal mode
- Interactive: False
- EventArguments: default arguments
settings_wizard_click
​
- Dismissed since DIVA 5
- Description: Every time a user opens the Wizard button via the Settings panel
- Interactive: True
- EventArguments: N/A
settings_audio_selection
​
- Description: Every time a user selects the Audio panel to change Audio track
- Interactive: True
- EventArguments: audio_value
settings_closed_caption_selection
​
- Description: Every time a user selects the Subtitles and Captioning panel to change/disable Subtitles and Captioning track
- Interactive: True
- EventArguments: closed_caption_value
settings_hdr_enable_click
​
- Description: Every time a user enables HDR via the Settings panel
- Interactive: True
- EventArguments: N/A
settings_hdr_disable_click
​
- Description: Every time a user disables HDR via the Settings panel
- Interactive: True
- EventArguments: N/A
settings_button_click
​
- Description: Every time the on-screen "Settings" button is actioned by user
- Interactive: True
- EventArguments: N/A
Start with two videos​
This event is NOT available for
two_video_start​
- Description: Every time the player starts with two videos
- Interactive: False
- EventArguments: videoid2, diva_display_mode
Timeline markers​
marker_open
​
- Description: Every time the tooltip or event marker appears
- Interactive: False
- EventArguments: marker_type, marker_time
marker_click
​
- Description: Every time a user selects an event marker
- Interactive: True
- EventArguments: marker_type, marker_time
Video​
video_open​
- Description: Every time an user opens a new video
- Interactive: False
- EventArguments: video_protection
video_close​
- Description: Every time a user closes a video
- Interactive: False
- EventArguments: video_current_time, video_duration, video_current_bitrate, video_total_time_view, video_total_time_paused, video_total_time_on_video, video_max_time_reach, video_max_percentage_reach, video_current_status, video_protection
video_start​
- Description: Every time a video starts playback after video load
- Interactive: False
- EventArguments: video_current_time, video_duration, video_current_bitrate, video_total_time_view, video_total_time_paused, video_total_time_on_video, video_max_time_reach, video_max_percentage_reach, video_current_status, video_protection
video_end​
- Description: Every time a video playback ends automatically after video load
- Interactive: False
- EventArguments: video_current_time, video_duration, video_current_bitrate, video_total_time_view, video_total_time_paused, video_total_time_on_video, video_max_time_reach, video_max_percentage_reach, video_current_status, video_protection
video_play​
- Description: Every time a play action is called (automatically or by a user)
- Interactive: False
- EventArguments: video_current_time, video_duration, video_current_bitrate, video_total_time_view, video_total_time_paused, video_total_time_on_video, video_max_time_reach, video_max_percentage_reach, video_current_status, video_protection
video_pause​
- Description: Every time a pause action is called (automatically or by a user)
- Interactive: False
- EventArguments: video_current_time, video_duration, video_current_bitrate, video_total_time_view, video_total_time_paused, video_total_time_on_video, video_max_time_reach, video_max_percentage_reach, video_current_status, video_protection
video_error​
- Description: Every time an error is raised by the video component
- Interactive: False
- EventArguments: video_current_time, video_duration, video_current_bitrate, video_total_time_view, video_total_time_paused, video_total_time_on_video, video_max_time_reach, video_max_percentage_reach, video_current_status, video_protection
video_drm_error​
- Description: Every time a DRM error is raised by the video component. This is considered a special sub-type of video_error.
- Interactive: False
- EventArguments: error_code, error_description, video_current_time, video_duration, video_current_bitrate, video_total_time_view, video_total_time_paused, video_total_time_on_video, video_max_time_reach, video_max_percentage_reach, video_current_status, video_protection
video_seek​
- Description: Every time a user seeks through a video. In this case, the video_current_time is the time before the seek action.
- Interactive: False
- EventArguments: video_seek_time, video_current_time, video_duration, video_current_bitrate, video_total_time_view, video_total_time_paused, video_total_time_on_video, video_max_time_reach, video_max_percentage_reach, video_current_status, video_protection
video_playback_info_event​
- Description: Every time that the timer, configured with parameter videoAnalyticsEventFrequency, is raised
- Interactive: False
- EventArguments: video_current_time, video_duration, video_current_bitrate, video_total_time_view, video_total_time_paused, video_total_time_on_video, video_max_time_reach, video_max_percentage_reach, video_current_status, video_protection
video_milestone_25​
- Description: When a VOD first passes 25% total playback
- Interactive: False
- EventArguments: video_current_time, video_duration, video_current_bitrate, video_total_time_view, video_total_time_paused, video_total_time_on_video, video_max_time_reach, video_max_percentage_reach, video_current_status, video_protection
video_milestone_50​
- Description: When a VOD first passes 50% total playback
- Interactive: False
- EventArguments: video_current_time, video_duration, video_current_bitrate, video_total_time_view, video_total_time_paused, video_total_time_on_video, video_max_time_reach, video_max_percentage_reach, video_current_status, video_protection
video_milestone_75​
- Description: When a VOD first passes 75% total playback
- Interactive: False
- EventArguments: video_current_time, video_duration, video_current_bitrate, video_total_time_view, video_total_time_paused, video_total_time_on_video, video_max_time_reach, video_max_percentage_reach, video_current_status, video_protection
video_volume_change​
- Description: When video volume changes
- Interactive: False
- EventArguments: player_volume
video_loopback​
- Description: When player_mode is
chromeless
, loop is enabled and video is automatically restarted after video end - Interactive: False
- EventArguments: default arguments
Video list​
videolist_item_click​
- Description: Every time a user selects a videolist thumbnail
- Interactive: True
- EventArguments: videolist_type, overlay_id, videolist_item_video_id
videolist_item_focus
​
- Description: Every time a user focus a videolist thumbnail
- Interactive: True
- EventArguments: videolist_type, overlay_id
videolist_listmode_exit
​
- Description: Triggered every time user specifically exits the video list mode, returning to the currently loaded video without jumping / switching to another video stream, via one of the video list items. list item. Happens by as user returns to the main player controls, from within the video list mode.
- Interactive: True
- EventArguments: videolist_type, overlay_id
videolist_listmode_open
​
- Description: Triggered every-time video list mode is accessed / entered, regardless on what specific VL is shown first. Happens as user navigates down, from main controls, while at least one video list is available.
- Interactive: True
- EventArguments: videolist_type, overlay_id
multiview_videolist_open​
- Description: Every time the multiview videolist is opened
- Interactive: false
- EventArguments: videolist_type, overlay_id
multiview_videolist_close​
- Description: Every time the multiview videolist is closed
- Interactive: false
- EventArguments: videolist_type, overlay_id
multiview_videolist_close_click​
- Description: Every time the user clicks on multiview videolist close button
- Interactive: true
- EventArguments: videolist_type, overlay_id
videolist_item_add_multiview​
- Description: Every time a user selects a videolist item to add to multiview
- Interactive: True
- EventArguments: videolist_type, overlay_id, videolist_item_video_id
videolist_item_remove_multiview​
- Description: Every time a user selects a videolist item to remove from multiview
- Interactive: True
- EventArguments: videolist_type, overlay_id, videolist_item_video_id
multiview_exit_click​
- Description: Every time a user clicks on the exit button in multiview mode
- Interactive: True
- EventArguments: N/A
multiview_exit_confirm_click​
- Description: Every time a user clicks on confirm exit multiview button
- Interactive: True
- EventArguments: N/A
multiview_exit_cancel_click​
- Description: Every time a user clicks on cancel exit multiview button
- Interactive: True
- EventArguments: N/A
Wizard​
Dismissed since DIVA 5
wizard_open​
- Description: Every time the Wizard is opened (automatically or by a user)
- Interactive: False
- EventArguments: N/A
wizard_close​
- Description: Every time the Wizard is closed
- Interactive: False
- EventArguments: section_time_spent
wizard_auto_open​
- Description: Every time the Wizard is opened automatically
- Interactive: False
- EventArguments: N/A
End Of Play​
endofplay_open​
- Description: Event triggered whenever the current time reaches the max duration (and so the video_end event has been tracked) and so the users get to the end of the playing video and the EoP view is presented.
- Interactive: False
- EventArguments: N/A
endofplay_replay_click​
- Description: Event triggered when the "Replay" button, from within the EoP screen, is manually actioned by the end user. It will be naturally followed up by the EoP close event.
- Interactive: True
- EventArguments: N/A
endofplay_auto_videoplay​
- Description: Event trigger whenever Diva automatically loads the next video from the EoP view. This applies to items in recommended video list or highlights list. It will be naturally followed up by the EoP close event.
- Interactive: False
- EventArguments: videolist_type, overlay_id, videolist_item_video_id
endofplay_close​
- Description: Event triggered whenever the EoP screen closes down (no longer showing on-screen), regardless of reason (e.g. new video initiated, replay used, user is in highlights mode, EoP screen manually closed by user, Diva app exited, etc...). It will be naturally followed up by the EoP close event.
- Interactive: False
- EventArguments: N/A
endofplay_videolist_item_click​
- Description: Every time a user actions a video list item/card, and therefore switching to the new video stream. It will be always followed up by the EoP close event. When a video in a video list is automatically played, then the "endofplay_auto_videoplay" event is applied instead. This is a clone of the "videolist_item_click" event, with just a different name to differentiate the place of origin. It will be naturally followed up by the EoP close event.
- Interactive: True
- EventArguments: videolist_type, overlay_id, videolist_item_video_id
endofplay_videolist_item_focus​
- Description: Every time navigational focus is moved from one video list item to another, by user. Default focus when video list opens is not accounted here. This is a clone of the "videolist_item_focus" event, with just a different name to differentiate the place of origin.
- Interactive: True
- EventArguments: videolist_type, overlay_id, videolist_item_video_id
endofplay_highlights_mode​
- Description: Triggered when Diva enters the Highlights mode, regardless if triggered by user (actioning a HL card in HL list), or automatically as part of EoP screen. It will be always followed up by the EoP close event. This is a clone of the "highlights_mode" event, with just a different name to differentiate the place of origin.
- Interactive: True
- EventArguments: highlights_type
endofplay_recommendation_other_click​
- Description: Triggered when user selects (actions) a video from the recommendations video list. It will be always followed up by the EoP close event. This is a clone of the "recommendation_other_click" event, with just a different name to differentiate the place of origin.
- Interactive: True
- EventArguments: videolist_type, overlay_id, videolist_item_video_id
DIVA Events Arguments​
The mandatory arguments for all the events are videoId, video_display_mode and player_mode for all events and display_orientation for native mobile only
videoId​
- Description: Unique ID of the video
player_mode​
- Description: The mode in which the player is initialized.
Values:
fullscreen
embed
chromeless
video_display_mode​
- Description: Type of video visualization, always in lowercase.
Values for :
single
360
main_side
main_side_360
slave_side
slave_side_360
main_goalalert_side
main_goalalert_side_360
slave_goalalert_side
slave_goalalert_side_360
multiview_pip
multiview_pip_360
Values for
:
single
360
modal
vr
airplay
chromecast
ad_type​
- Description: Type of advertisement: "pre", "mid", "post"
selected_video_id​
- Description: Video id selected to load
section_time_spent​
- Description: How many seconds a view (e.g. goalalert, multiview ecc...) remains open
alert_type​
- Description: The type of alert (if empty 'generic' string is used)
playbyplay_type​
- Description: It contains the type of playbyplay if has a specific timeline icon associated (Goal, Yellow card, ...), 'generic' in other cases
playbyplay_time​
- Description: It contains the time in seconds of the playbyplay relative to the video
overlay_id​
- Description: The analytic identifier of the action, always in lowercase
overlay_template​
- Description: The analytic identifier of the template used for the overlay All available templates for HTML5 player: fullVideo | fullPage | sideBySide | leftSideVideo | rightSideVideo All available templates for mobile platform Android iOS: fullVideo | mobileContextual
Values for :
fullVideo
fullPage
sideBySide
leftSideVideo
rightSideVideo
Values for
:
fullVideo
mobileContextual
All the other platforms have fullVideo
as default value.
overlay_mode​
- Description: The analytics identify the overlay mode Possible values are: default | contextual
Values:
default
contextual
action​
- Description: Defines the action of the button, always in lowercase
Values:
alternate_timeline
audiotracks
chapters
chromecast
closed_captions
commentary
expand
fullscreen
pip
play_pause
relevant_commentary
seek_back
seek_forward
sideview
swap
volume
active​
- Description: State of the button
true
|false
controlbar_type​
- Description: Type of control bar
Values:
full
= Main DIVA control barmultiview
= Controlbar used in multi-view (Side-by-side view)simple
= For small player size
audio_value​
- Description: Value of the audio selected
audio_display_name​
- Description: Label of the audio selected
closed_caption_value​
- Description: Value of the Closed Caption of the audio selected
closed_caption_display_name​
- Description: Label of the Closed Caption of the audio selected
quality_value​
- Description: Value of the quality selected
quality_display_name​
- Description: Label of the quality selected
chapter_title​
- Description: Contains the title of the Chapter selected
chapter_starttime​
- Description: Contains the absolute start time in milliseconds of the Chapter selected (Unix Timestamp)
chapter_endtime​
- Description: Contains the absolute end time in milliseconds of the Chapter selected (Unix Timestamp)
commentary_notification_items​
- Description: Defines the number of Commentary items not viewed by the user. It corresponds to the number of notifications in the badge of the Commentary button
extId​
- Description: The E-commerce item ID
error_code​
- Description: Contains the error code
error_description​
- Description: Contains a brief description of the error
highlights_type​
- Description: Contains the highlights filter (possible values: 'short', 'medium', 'long', 'live')
Values:
short
medium
long
live
hdr_mode​
- Description: HDR mode
Values:
none
hdr10
video_protection​
- Description: Type of video protection
Values:
none
widevine
playready
fairplay
aes
video_current_time​
- Description: Time, in seconds, of the video at the moment of the event dispatch
video_duration​
- Description: Duration, in seconds, of the video at the moment of the event dispatch
player_volume​
- Description: The value of the volume. Values from 0 to 1.
video_current_bitrate​
- Description: Bitrate, in Kbps, of the video at the moment of the event dispatch.
The HTML5 player is not available on iOS devices and on Safari desktop with Native Player. For the iOS player, this value is available only when the AVPlayer plugin exposes it - e.g., not available in the d3_vide_start event
video_total_time_view​
- Description: Total time of video view, in seconds, by user for this video (time of videoPlayback). This could be larger than the duration.
video_total_time_paused​
- Description: Total time of video on pause, in seconds, by user for this video (time of video on pause). This could be larger than the duration.
video_total_time_on_video​
- Description: Total time over the video, in seconds. This could be larger than the duration
video_max_time_reach​
- Description: Maximum time reached by the user, in seconds
video_max_percentage_reach​
- Description: Maximum time reached by the user, as a percentage
video_current_status​
- Description: Current status of video (play, pause, error)
video_seek_time​
- Description: Time of seek request in seconds
marker_type​
- Description: Contains the type of marker if it has a specific associated timeline icon (Goal, Yellow card, ...), generic in other cases
marker_time​
- Description: Contains time in seconds of the event marker relative to the video
videolist_type​
- Description: The type of videolist
Values:
switch
multiview
pipview
multistreamSwitch
multistreamMultiview
multistreamPipview
modal
videolist_item_video_id​
- Description: the vidoeId of the videolist item clicked
videolist_item_video_id​
- Description: The video id of the item in the videolist was clicked
videoid2​
- Description: The videoid of the second video
diva_display_mode​
- Description: Template type of DIVA video visualization, always in lowercase
Values:
multiview
pipview