Contact Support | System Status
Page Contents

    Data Sent to Analytics by the Brightcove Player

    This topic provides a list of all data sent by the Brightcove Player to the Analytics system.

    Introduction

    This topic details the information fields that are sent by the Brightcove Player to the data collector for use by the Analytics system. Note that the players sends multiple batches of data to the collector, and each batch is associated with an event. Not all data fields are sent in every batch, some may not be sent at all if tha associated data is not available for some reason.

    Also note that the player can be configured to send additional information - see Overview: The Data Collection API for more details. This topic covers the data that is sent by default.

    Events

    The following events prompt the player to send data to the collector, and the event itself is included in the data.

    Events
    event Intent/Meaning
    player_load A player session has been initiated by an end-user. This marks the beginning of the analytics session, and should be sent before any other events.
    video_impression A video has loaded in the player and is ready for playback.
    video_view A video has started playing back (either auto-play after loading, or due to user interaction).
    load_time_ms The time, in milliseconds, between initiating data load for the video and the video becoming playable, collected on a video view.
    start_time_ms The time, in milliseconds, between initiation of playback and the first frame of the video being rendered, collected on a video view. This can be different depending on the experience, for instance, if there are no pre-roll ads configured, this measurement is the time between the 'play_request' and video_view events. If there is a preroll ad, the time between ad_mode_begin and ad_mode_complete should not be included.
    video_engagement A user watched a range of seconds of a video's timeline. This event is a heartbeat for tracking video engagement and will likely be sent many times during playback, depending on the user interaction and the length of the video. The AS3/HTML5 player instrumentation sends this event every 10 seconds, if playback is not interrupted. Events describing ranges over 20 seconds are discarded by the Analytics system.
    play_request Sent when the playback is initiated either by the user expressly clicking the play button, or automatically when the platform triggers playback in an auto-play scenario.
    ad_mode_begin Sent when control is handed over to an advertising agent by the playback platform.
    ad_mode_complete Sent when control is handed back from the advertising agent to the playback platform.
    error Sent when fatal errors which disrupt the playback experience are encountered.
    video_download_request Offline DRM video download request.
    video_download_complete Offline DRM video download complete.
    video_download_cancellation Offline DRM video download cancellation.
    video_download_error Offline DRM video download error.

    Event Parameters

    Below are data items sent on various events. Note that some items may not be sent if there is no data available.

    Parameter Value Events
    event The name of the event all, required
    domain videocloud all, required
    time End-user timestamp (ms since epoch) all
    account Brightcove account ID all, required
    player Brightcove player ID that originated the event all
    player_name Name of the player specified by the player parameter all
    browser Full name and version of the browser used all
    browser_type Common name of browser used (i.e. chrome, edge, firefox) all
    video Brightcove video ID that originated the event, if there was one video_impression, video_view, video_engagement
    video_name Name of the video specified by the video parameter video_impression, video_view, video_engagement
    video_duration+range; video_seconds_viewed The duration of the video (in seconds) and the range (in the format <start_second>..<end_second>) of seconds viewed; or a count of watched seconds since the last update. See more information about video_engagement Events below. video_engagement
    destination
    (formerly embed)
    The URI that originated the event all
    source The URI that sent the end-user to the destination URI; if not provided, the Analytics system will treat events as direct traffic for traffic source data. all
    device_type Override to specify the type of the device that originated the event in cases where the User-Agent is unreliable; ignored unless both device_os and device_type are included. Not typically included. all
    device_os Override to specify the OS of the device that originated the event in cases where the User-Agent is unreliable; ignored unless both device_os and device_type are included. Not typically included. all
    session The session identifier. The session value should be constant for the lifecycle of an experience and sent for all events from that experience. It should be as close as is possible to a universally unique identifier. If there are collisions, the two sessions may be discarded as invalid if they cannot be disentangled. all
    user Viewer's User ID, if available, or persistent device unique ID. all
    application Application ID, if applicable (enables viewer tracking) all
    device_os_version The version of os being used by the device. When not specified, this will be calculated by parsing the user agent string for the tracking request. all
    platform_version Used to indicate that a new release of the specified platform is being used to send the events. all
    catalog_url The destination url associated with the catalog_request event. catalog_request,catalog_response
    response_time_ms The time, in milliseconds, between the catalog_request event and the catalog_response event. catalog_response
    error_code A platform specific error code associated with the event. error
    load_time_ms The time, in milliseconds, between initiating data load for the video and the video becoming playable. video_view
    start_time_ms The time, in milliseconds, between initiation of playback and the first frame of the video being rendered. This can be different depending on the experience, for instance, if there are no pre-roll ads configured, this measurement is the time between the 'play_request' and video_view events. If there is a preroll ad, the time between ad_mode_begin and ad_mode_complete should not be included. video_view
    rendition_url The url to the most recently selected rendition. For example, for an HLS stream this would be the url to the most recently selected variant. video_engagement, video_download_start
    rendition_indicated_bps The indicated bitrate, in bits per second, of the most recently selected rendition. video_engagement, video_download_start
    rendition_mime_type The mime type of the most recently selected rendition. video_engagement, video_download_start
    rendition_height The encoded height of the video rendition in pixels video_engagement, video_download_start
    rendition_width The encoded width of the video rendition in pixels video_engagement, video_download_start
    rebuffering_seconds The number of seconds the user spent waiting for video to playback due to un-requested delay during the engagement period. video_engagement
    rebuffering_count The number of times playback stopped due to re-buffering during the represented engagement period. video_engagement
    forward_buffer_seconds The number of seconds of video currently residing in the forward buffer. video_engagement
    measured_bps The ratio of the number of bits included in the most recently downloaded segment to the time spend downloading that segment, in bits per second. video_engagement
    player_width The current pixel width of the player at the end of the engagement range. video_engagement
    player_height The current pixel height of the player at the end of the engagement range. video_engagement
    dropped_frames The number of frames that were dropped from video playback during this engagement period video_engagement
    file_size_bytes The size of the download offline DRM file. video_download_complete

    Video engagement fields

    The data fields listed below are specific to video_engagement events.


    Page last updated on 27 Aug 2021