Analytics API Glossary
Note: For a description of the values that are displayed in the Analytics module UI, see the Analytics Module UI Glossary.
- The Video Cloud account ID.
- The number of videos in the account that currently active (playable). Note that data for
active_mediais accurate only if the data is
- The number of times the Brightcove Player or SDK switched into ad mode in order to begin playing ad content. This event would occur before the
video_viewevent in a pre-roll scenario or after the
video_viewevent in a mid or post roll configuration. This metric does not directly correspond to the number of ads actually delivered, since the number of ads shown can vary depending on the ad server configuration.
- The number times the Brightcove Player or SDK returned from playing ad content.
- A measure of bytes delivered, including video data and metadata as well as the player code. Note that data for
bytes_deliveredif the data is
- This is the estimated number of unique viewers that an account had on a given day. This data is only available for videos watched 1-2 days ago and only at the account level. You can improve the accuracy of this metric by following these directions
- Day of the month the video was viewed. The value of this dimension is an ISO 8601 date in the format YYYY-MM-DD
date_hourdimension is similar to the
datedimension, but can be used to access hourly data for videos within the last 32 days. See The date_hour Dimension for further details.
- The domain where a
video_impressionoccurred (for web views). This is called "Display Domain" in the UI.
- The path for the page where a video view impression occurred (for web views). This is called "Display URL" in the UI.
- Device operating system. Possible values are:
other(for User Agents which are not mapped to any of the above)
- Device type used to view a video. Possible values are:
desktop- includes desktop and laptop computers
tablet- includes iPads, Android tablets, etc.
mobile- mobile phones
tv- includes Smart TVs, set-top boxes and game consoles
other- for user-agents which are not mapped to any of the above
- Dimensions are analytics data categories that you can specify for reports. Current dimensions available are:
- DMA (Designated Market Area) regions are the geographic areas in the United States in which local television viewing is measured by The Nielsen Company.
- The average percent watched per video view (calculated by adding all the percentage watched divided by the number of Video Views). For more information on how this is calculated, see Calculating Video Engagement Score.
- A parameter used to specify which metric fields should be returned - see the Analytics API Overview for more details.
- Number of items that match the criteria of the API request.
- The number of data items to be returned - a positive integer or "all".
- If you are using limit to return only a portion of the data items,
offsetspecifies the item number to start with.
- Play rate is a ratio of the number of times a video was played back (video_view), over the number of opportunities for playback (video_impression).
- The number of times playback was requested either by a user pressing the play button or an auto-play event. This typically occurs between the
video_viewevent. However, a
play_requestis also sent if a user pauses and presses play to resume watching a video.
- Video Cloud player ID.
- Number of times a player was loaded.
- Name of the Video Cloud player.
- Analytics data is derived from multiple sources: some is sent by the player, but other data is collected from CDNs and the Video Cloud system. In order to deliver analytics as quickly as possible, we start delivering "real-time" data as soon as it is available, and then adjust the analytics later when data from all sources has been collected and processed. The fully processed data is called
- Referring domain reported by the client (browser or other).
- Referring domain reported by the client (browser or other).
- Two letter province or state code where a video was viewed. Follows the ISO 3166 standard.
- Province or state name where a video was viewed. Follows the ISO 3166 standard.
- Detailed analytics data for one or more dimensions.
- If a viewer found a video by searching, these are the search terms that were used.
- A parameter to specify a metric to sort analytics data on - see the Analytics API Overview for more details.
- An indication of how the viewer reached the player page; possible values are:
referral(direct link from some other page)
direct(bookmark, typed in URL, or link from email)
organic_search(ordinary search using some search engine)
paid_search(clicking a sponsored link in search results)
secure_search(search by a logged-in viewer)
- Traffic Sources
- Unique Viewers
- See daily_unique_viewers
- Video Cloud ID of the video.
- Length of the video in seconds.
- A measure of the average percent watched per video view (calculated by adding all the percentage watched divided by the number of Video Views). For more information on how this is calculated, see Calculating Video Engagement Score.
- The number of views recorded at the 1% point of the video.
- The number of views recorded at the 25% point of the video.
- The number of views recorded at the 50% point of the video.
- The number of views recorded at the 75% point of the video.
- The number of views recorded at the 100% point of the video.
- The number of times a video was loaded into a player and ready for interaction.
- Name of the video (at the time the
- This is a sum of the percent watched by each viewer. For example, if viewer A watched 0.50 and viewer B watched 0.75 then the total value would be 1.25. This metric is not useful on its own. This metric is used with video_view to calculate engagement score. Engagement score is video_percent_viewed divided by video_view. The video_percent_viewed is useful for calculating the engagement score across multiple videos.
- The total number of seconds a video was viewed.
- The number of times the video started playing, recorded when the stream is started (does not include rewind or replay). Video views are not counted with a video is viewed in Studio.
- A parameter used to filter a report on specific dimension values - see the Analytics API Overview for details.