Dimension: live

Live Analytics Endpoints

In addition to the live_stream dimension covered in this topic, There are also special endpoints for retrieving additional analytics data for Brightcove Live streaming jobs. See the Analytics API Reference for details.

URL parameters

Analytics API reports support the following URL parameters.

URL Parameters
Parameter	Description	Required	Values	Default
`account`	The accounts you want to report on	yes	one or more account ids as a comma-delimited list	none
`dimensions`	The dimension(s) to report on	yes	one or more dimensions as a comma-delimited list (some combinations are not valid - use the interactive tool here to determine if a combination is valie)	none
`where`	Used to specify filters for reports	no	{dimension}=={value} - one or more as a semi-colon-delimited list. The value will be one or more values for the primary metric of that dimension. For example: `video==video_id`, `country=country-code`, or `viewer=viewer_id` (in the last case, the form of the viewer_id will vary depending on whether you are capturing and sending some kind of viewer_id yourself or depending on the value generated by the analytics system).	none
`limit`	Number of items to return	no	positive integer	10
`offset`	Number of items to skip	no	positive integer	0
`sort`	Field to sort items on	no	any field that is being returned by the request	video_view
`fields`	Fields to return	no	varies according to the dimension you are reporting on	video,video_view
`format`	Format to return results in	no	json (default) \| csv \| xlxs	json
`reconciled`	If included, will limit results to either historical or realtime data. 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	no	true \| false	true
`from`	The beginning of the date range for the request	no	One of the following: An ISO 8601 date (YYYY-MM-DD) Epoch time in milliseconds (example: 1659641316719 [= Thursday, August 4, 2022 7:28:36.719 PM GMT]). See the Epoch time converter. A string: `from=alltime` +/- relative dates in days (d), weeks (w), or months (m) - example: `from=-6m&to=%2B2w` (the period from 6 months ago to 2 weeks after that -- note that the + sign needs to be URI encoded as `%2B`) Only dates within the past 32 days are allowed for engagement endpoints or if reconciled=false.	-30d
`to`	The end of the date range for the request	no	One of the following: An ISO 8601 date (YYYY-MM-DD) Epoch time in milliseconds (example: 1659641316719 [= Thursday, August 4, 2022 7:28:36.719 PM GMT]). See the Epoch time converter. A string: `to=now` +/- relative dates in days (d), weeks (w), or months (m) - example: `from=-6m&to=%2B2w` (the period from 6 months ago to 2 weeks after that -- note that the + sign needs to be URI encoded as `%2B`) Only dates within the past 32 days are allowed for engagement endpoints or if reconciled=false.	now

Fields available

The following fields can be returned for the dimension.

bytes_delivered - total bytes delivered for live streams, including the player and all associated media
origin_bytes_delivered - bytes delivered for the live streams themselves
live_stream - id of the live stream, if available

Filter values

Used as a filter, a dimension allows you to narrow the results.

Filter values:

Combining dimensions

To see what dimensions this on can be combined with, and what fields are available for the combination, see Dimension and Fields.

Request Examples

Dimension request

    https://analytics.api.brightcove.com/v1/data?accounts=1752604059001&dimensions=live_stream

Filter request

    Not applicable

Sample Response

{
  "item_count": 1,
  "items": [
    {
      "live_stream": null
    }
  ],
  "summary": {}
}

Dimension: live_stream