Product Updates | Contact Support | System Status
Page Contents

    Brightcove Interactivity Video Tracking Events

    In this topic you will learn about the video tracking events.

    Brightcove Interactivity tracks how your viewers are interacting with your video in detail. More than just play and pause, we track a whole set of specific events associated with your video that give you deep-level insights into viewer choices, behavior and engagement.

    There are three event1 types:

    1. Player Action details how a viewer played, paused, and progressed through the video.
    2. Annotation View and Annotation Ended details which annotations were seen by the viewer and for how long.
    3. Annotation Action details how the user interacted with the annotation.

    Each event has a set of properties associated with it. For example, the event of a click on an annotation call-to-action could have the following properties:

    • The viewer’s UserID2 was “kyle_morton”
    • The annotation’s duration was 8.35 seconds
    • 5 seconds elapsed before the viewer clicked the link
    • The annotation’s link target was http://www.rei.com/product/763713

    ---------------

    1 Attribute name is "event"

    2 Available when the viewer user is logged into the Portal

    Common event properties

    These properties are present on all events.

    Identifiers

    • Project ID - Present if the track was loaded from a project
    • Video ID - Brightcove Interactivity internal video ID
    • Video Source - Origin source of video asset (e.g. HTML5, provider)
    • Video Source ID - The original video URL or provider ID for the asset
    • Track ID - Brightcove Interactivity internal ID for group of annotations being shown
    • Host - The page the video is being served from

    Object information

    • Video Duration - The duration of the video (in seconds)
    • Project Title - If known, title of the project
    • Video Title - If known, title of the video
    • Num Annotations - The total number of annotations on the video
    • Tags - Author-provided tags associated with the Track or Project objects

    Optional information

    You can pass in optional properties to track like UserIDs and other custom user details that will help you make sense of the data later on. When present, these data will become properties of every event.

    • Partner User ID - hashed userID from an external system
    • Partner Username - human-readable username to be displayed in reports
    • Partner / *custom - arbitrary name=value pairs can be passed for custom tracking

    Annotation Event Generic Properties

    These properties are present on Annotation View, Annotation End and Annotation Action events.

    Identifiers

    • Annotation ID - Brightcove Interactivity internal ID for the annotation

    Timing information

    • Annotation Start Time - The timestamp when the annotation is shown or activated
    • Annotation Duration - The length of time the annotation is active
    • Elapsed - The length of time the annotation was viewed for. Since some annotations can pause the video, this property accounts for the total time it was on-screen.
    • Remaining - How much time left until the end of the video
    • Paused - Boolean for whether video is paused or not, when the event is logged
    • Play Time Accrued - The total amount of time spent playing the video, when the event is logged
    • Video Offset - The current time in the video, when the event is logged
    • Video Percent Complete - The total percentage of video watched, when the event is logged. This is the position of the playhead expressed as a percentage of total video duration.

    Interaction information

    • Action - Present for “Player Action” and "Annotation Action" event types. Refer to the specific annotation type to see a list of possible values.

    Annotation Specific Event Properties

    Linked annotation types: Pop, Image, HotLink

    • Action - "Click" or "External Click"
    • Target - The URL of the link
    • Target Annotation - The target annotation ID if used for in-video navigation
    • Target Time - The target timestamp if used for in-video navigation
    • Target Track - The track ID if the click caused another track to load
    • Target Expression - The optional javascript expression evaluated
    • Text - If present, the text displayed in the annotation

    Quiz annotation

    • Action - "Answer", "Submit", "Prev", "Next", "Skipped"
    • Answer - For "Answer": The text of the answer provided by the viewer
    • Question - For "Answer": The text of the question answered by the viewer
    • Num Questions - For "Submit" - the total number of questions in the quiz annotation. This is useful for a quiz with multiple questions in it.
    • Num Answered - For "Submit" - the total number of answers provided by the viewer. This is useful for a quiz with multiple questions in it.
    • Num Correct - For "Submit" - the total number of correct answers provided by the viewer. This is useful for a quiz with multiple questions in it.
    • Correct - For "Answer" - true or false
    • Pass - For "Submit" - true or false
    • Target/Target Time/Target Track/Target Expression - For "Submit" - present if an automatic pass/fail follow-up action is configured for the quiz.

    Table of Contents annotation

    • Action - "Click", "Prev", "Next", "Expand", "Collapse"
    • Type - “contents”
    • Target - Annotation ID of the clicked Chapter
    • Target Time - Time offset of the clicked Chapter
    • Text - Text (name) of the target chapter

    Player Event Generic Properties

    These properties are present on all Player Action events.

    Timing information

    • Play Time Accrued - The total amount of time spent playing the video
    • Video Offset - The current time in the video when the event is logged
    • Video Percent Complete - The total percentage of video watched, when the event is logged. This is the position of the playhead expressed as a percentage of total video duration.

    Player interaction information

    • Action - values listed below
      • Load - This means that the Brightcove Interactivity-enabled video loaded on the page
      • Play, Pause, Seek, Volume, Fullscreen - Standard video player functionality
      • Progress - This fires every 5 seconds.
      • End - Complete - This fires once when the video reaches the end if the view time is equal to the video duration
      • End - Over - This fires once when the video reaches the end if the view time is greater than the video duration. Typically this means the viewer re-watched certain segments of the video.
      • End - Under - This fires once when the video reaches the end if the view time is less than the video duration. Typically this means that the viewer skipped over a section of the video.

    Standard Properties for all Events

    This is general information about the viewer and environment, similar to most web analytics systems. These values are not available to client-side analytics.

    • browser
    • ip
    • os
    • referrer
    • referring_domain

    Analytics API

    All events and properties are exposed as a JSON object made available via the "onTrackingEvent" callback function on the Brightcove Interactivity Viewer Object.

            
    hapyak.viewer({
        onTrackingEvent: function(data) {
            console.log('Brightcove Interactivity / ' + data.event, data.properties);
        }
    });
    
    

    Documentation on the Brightcove Interactivity Viewer Object can be found here: http://www.hapyak.com/docs/#AdvancedOptions12.


    Page last updated on 07 Dec 2021