Analytics API Glossary

Product(s)
Video Cloud
Role(s)
API Developer
Topic(s)
Analytics
General Info
API(s)
Analytics API

This topic provides a glossary of terms used for the Analytics API.

Index

| -A- | -B- | -C- | -D- | -E- | -F- | -G- | -I- | -L- | -M-| -N- | -O- | -P- | -R- | -S- | -T- | -U- | -V- | -W- |

Note: For a description of the values that are displayed in the Analytics module UI, see the Analytics Module UI Glossary.

A

account
The Video Cloud account ID.
active_media
The number of videos in the account that currently active (playable). Note that data for active_media is accurate only if the data is reconciled.
ad_mode_begin
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_view event in a pre-roll scenario or after the video_view event 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.
ad_mode_complete
The number times the Brightcove Player or SDK returned from playing ad content.

B

bytes_delivered
A measure of bytes delivered, including video data and metadata as well as the player code. Note that data for bytes_delivered if the data is reconciled.

C

city
City where a video was viewed.
country
Two letter country code where the video was viewed. Follows the ISO 3166 standard.
English short name of the country where the video was viewed. Follows the ISO 3166 standard.

D

daily_unique_viewers
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
date
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_hour
The date_hour dimension is similar to the date dimension, but can be used to access hourly data for videos within the last 32 days. See The date_hour Dimension for further details.
destination_domain
The domain where a video_impression occurred (for web views). This is called "Display Domain" in the UI.
destination_path
The path for the page where a video view impression occurred (for web views). This is called "Display URL" in the UI.
device_os
Device operating system. Possible values are:
  • android
  • bada
  • ios
  • linux
  • mac_os
  • os_x
  • rim (Blackberry)
  • symbian
  • web_os
  • windows
  • other (for User Agents which are not mapped to any of the above)
device_type
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
Dimensions are analytics data categories that you can specify for reports. Current dimensions available are:

    See dimensions and fields and use the interactive tool to see what fields are returned for various dimensions, and select multiple dimensions to see what dimensions you can combine in a report.

    DMA
    DMA (Designated Market Area) regions are the geographic areas in the United States in which local television viewing is measured by The Nielsen Company.

    E

    engagement_score
    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.

    F

    fields
    A parameter used to specify which metric fields should be returned - see the Analytics API Overview for more details.

    G

    Geographical dimensions
    Dimensions available regarding the geographical location where a video_impression occurred. The geographic dimensions tracked are:

    I

    item_count
    Number of items that match the criteria of the API request.

    L

    limit
    The number of data items to be returned - a positive integer or "all".

    M

    Metrics
    Data items that are tracked for the different dimensions. Also see fields

    O

    offset
    If you are using limit to return only a portion of the data items, offset specifies the item number to start with.

    P

    play_rate
    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).
    play_request
    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_impression and video_view event. However, a play_request is also sent if a user pauses and presses play to resume watching a video.
    player
    Video Cloud player ID.
    player_load
    Number of times a player was loaded.
    player_name
    Name of the Video Cloud player.

    R

    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 reconciled
    Referring domain reported by the client (browser or other).
    referrer_domain
    Referring domain reported by the client (browser or other).
    region
    Two letter province or state code where a video was viewed. Follows the ISO 3166 standard.
    region_name
    Province or state name where a video was viewed. Follows the ISO 3166 standard.
    Report
    Detailed analytics data for one or more dimensions.

    S

    search_terms
    If a viewer found a video by searching, these are the search terms that were used.
    sort
    A parameter to specify a metric to sort analytics data on - see the Analytics API Overview for more details.
    source_type
    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)

    T

    Traffic Sources
    See source_type

    U

    Unique Viewers
    See daily_unique_viewers

    V

    video
    Video Cloud ID of the video.
    video_duration
    Length of the video in seconds.
    video_engagement
    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.
    video_engagement_1
    The number of views recorded at the 1% point of the video.
    video_engagement_25
    The number of views recorded at the 25% point of the video.
    video_engagement_50
    The number of views recorded at the 50% point of the video.
    video_engagement_75
    The number of views recorded at the 75% point of the video.
    video_engagement_100
    The number of views recorded at the 100% point of the video.
    video_impression
    The number of times a video was loaded into a player and ready for interaction.
    video_name
    Name of the video (at the time the video_impression occurred).
    video_percent_viewed
    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.
    video_seconds_viewed
    The total number of seconds a video was viewed.
    video_view
    The number of times the video started playing, recorded when the stream is started (does not include rewind or replay).

    W

    where
    A parameter used to filter a report on specific dimension values - see the Analytics API Overview for details.