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.
| 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) | 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 | a valid field for the request | video_view |
fields |
Fields to return | no | varies according to the dimension you are reporting on | video_view |
format |
Format to return results in | no | json | csv | xlxs | json |
reconciled |
If included, will limit results to either historical or realtime data | no | true | false | true |
from |
The beginning of the date range for the request | no | An ISO 8601 date (YYYY-MM-DD), epoch time in milliseconds, the string alltime, or relative date (-1m); only dates within the past 32 days are allowed for engagement endpoints or if reconciled=false. | 30 days prior to now |
to |
The end of the date range for the request | no | An ISO 8601 date (YYYY-MM-DD), epoch time in milliseconds, the string now, or relative data (+7d); 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 modead_mode_complete- the number of times the player completed ad modeactive_media- the number of active videos in the accountbytes_delivered- total bytes delivered to client machines for the player and associated mediadaily_unique_viewers- average daily unique usersdate- the date in ISO 8601 date (YYYY-MM-DD) formatdrm_bytes_packaged- the number of DRM bytes packagedengagement_score- the average engagement score for videoslicenses_served- the number of DRM licenses servedlive_seconds_streamed- the total number of live streaming seconds deliveredplay_request- total number of times video playback was requestedplay_rate- the average play rate (video views divided by impressions) for videosplayer_load- the total number of player loadsvideo_engagement_1- the total number of views at the 1 percent point of video durationvideo_engagement_100- the total number of views at the 100 percent point of video durationvideo_engagement_25- the total number of views at the 25 percent point of video durationvideo_engagement_50- the total number of views at the 50 percent point of video durationvideo_engagement_75- the total number of views at the 75 percent point of video durationvideo_impression- the total number of times videos were loaded into playersvideo_percent_viewed- total percent viewed for all video views (a sum, not an average)video_seconds_viewed- the total seconds viewed for all videosvideo_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
Response
Response will appear here when you test a request