Page Contents

Dimension: `date`

In this topic, you will learn about the Analytics API date dimension. The date dimension returns analytics for a single day. The user can specify the from and to parameters in yyyy-mm-dd format. This enables a user to query the analytics system to generate a report by days within the from and to date range. Any date range specified by the user will be interpreted to the current timezone for the account. The date ranges for the request are inclusive, exclusive i.e. if the user makes a request from=2013-09-24&to=2013-09-27, the response will include results from 2013-09-24 00:00:00 to 2013-09-27 00:00:00.

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.

ad_mode_begin - the number of times the player entered ad mode
ad_mode_complete - the number of times the player completed ad mode
active_media - the number of active videos in the account
bytes_delivered - total bytes delivered to client machines for the player and associated media
daily_unique_viewers - average daily unique users
date - the date in ISO 8601 date (YYYY-MM-DD) format
drm_bytes_packaged - the number of DRM bytes packaged
engagement_score - the average engagement score for videos
licenses_served - the number of DRM licenses served
live_seconds_streamed - the total number of live streaming seconds delivered
play_request - total number of times video playback was requested
play_rate - the average play rate (video views divided by impressions) for videos
player_load - the total number of player loads
video_engagement_1 - the total number of views at the 1 percent point of video duration
video_engagement_100 - the total number of views at the 100 percent point of video duration
video_engagement_25 - the total number of views at the 25 percent point of video duration
video_engagement_50 - the total number of views at the 50 percent point of video duration
video_engagement_75 - the total number of views at the 75 percent point of video duration
video_impression - the total number of times videos were loaded into players
video_percent_viewed - total percent viewed for all video views (a sum, not an average)
video_seconds_viewed - the total seconds viewed for all videos
video_view - the total number of times video playback began

Filter values

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

Filter values: The date dimension is not used as a filter.

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=date

Filter request

    Not applicable

Sample Response

{
  "item_count": 31,
  "items": [
    {
      "date": "2022-04-30",
      "video_view": 160
    },
    {
      "date": "2022-05-07",
      "video_view": 220
    },
    {
      "date": "2022-05-21",
      "video_view": 226
    },
    {
      "date": "2022-05-08",
      "video_view": 236
    },
    {
      "date": "2022-05-28",
      "video_view": 261
    },
    {
      "date": "2022-05-29",
      "video_view": 280
    },
    {
      "date": "2022-05-01",
      "video_view": 307
    },
    {
      "date": "2022-05-03",
      "video_view": 431
    },
    {
      "date": "2022-05-02",
      "video_view": 512
    },
    {
      "date": "2022-05-30",
      "video_view": 518
    }
  ],
  "summary": {
    "video_view": 45117
  }
}

Page last updated on 04 Aug 2022