Data Collection API Reference (2.0.0)
Download OpenAPI specification:Download
Reference for the Brightcove Data Collection API, used to send analytics data to the Brightcove analytics system.
For additional in-depth guides to features of the API, see the general documentation.
Base URL: http://metrics.brightcove.com/v2
Send Event
Send event information to the data collector for Brightcove Analytics
query Parameters
account required | string Account ID for all requests |
domain required | string Value: "videocloud" Example: domain=videocloud domain for all requests |
event required | string (event) Enum: "catalog_request" "catalog_response" "error" "video_impression" "video_view" "video_engagement" Example: event=catalog_request The event type for all requests |
session required | string (session) Example: session=733b52a5-b139-4718-ad21-aec5bd8d2604 A unique session identifier for all requests - see the Data Collection API Overview for more information |
device_os | string 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 or if the value submitted is not in the list of values shown here. Not typically included) for all requests |
device_manufacturer | string Override to specify the manufacturer of the device that originated the event in cases where the User Agent is unreliable. Not typically included) for all requests |
device_os_version | string 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. Not typically included) for all requests |
device_type | string Enum: "mobile" "tablet" "tv" "desktop" "other" 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 or if the value submitted is not in the list of values shown here. Not typically included) for all requests |
catalog_url | string The destination url associated with the |
response_time_ms | integer <int32> The time, in milliseconds, between the catalog_request event and the catalog_response event for |
error_code | integer <int32> A platform specific error code associated with the event for |
video | string The video id for |
video_name | string The video name for |
start_time_ms | number 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 for |
range | string The range of the video video viewed for video_engagement events in the format StartSecond..EndSecond - range can be left out of an engagement event to show that during the period covered by the event, there was no viewing activity. (for example, when there is only re-buffering activity) for |
rendition_url | string 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 for |
rendition_indicated_bps | string The indicated bitrate, in bits per second, of the most recently selected rendition for |
rendition_mime_type | string The mime type of the most recently selected rendition for |
rendition_height | string The encoded height of the video rendition in pixels for |
rendition_width | string The encoded width of the video rendition in pixels for |
rebuffering_seconds | number The number of seconds the user spent waiting for video to playback due to un-requested delay during the engagement period for |
rebuffering_count | integer <int32> The number of times playback stopped due to re-buffering during the represented engagement period delay during the engagement period for |
forward_buffer_seconds | number The number of seconds of video currently residing in the forward buffer for |
measured_bps | number 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 for |
player_width | number The current pixel width of the player at the end of the engagement range for |
player_height | number The current pixel height of the player at the end of the engagement range for |
dropped_frames | integer <int32> The number of dropped frames duriung the engagement range for |
video_duration | integer <int32> The duration of the video in seconds for |
video_seconds_viewed | number The count of watched seconds since the last update for video_engagement events for |