Video Report
This API call allows you to get detailed viewing information for one or more videos. This report includes individual video viewing sessions, along with information on whether each user completed the video.
NOTES:
- If video GUIDs are not specified in the API call parameters, the response will include data for every video in your Rev account.
- 31 days is the maximum duration for a reporting period.
- As of Rev v7.12, this API is available.
GET
/api/v2/videos/report
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| videoIds | string | GUID for the selected video(s). If no GUIDs are included, the report will returned data for every video in your Rev account. | |
| after | string | url encoded dates in ISO 8601 formatIf after date is used, only video views with a start date after the specified date, up to 31 days, will be included in the response. If both dates are used, video views between the specified dates will be returned, not exceeding 31 days. If no dates are specified, video views between the time of the request and 31 days into the past will be returned. | |
| before | string | url encoded dates in ISO 8601 formatIf before date is used, only video views with a start date before the specified date, up to 31 days, will be included in the response. If both dates are used, video views between the specified dates will be returned, not exceeding 31 days. If no dates are specified, video views between the time of the request and 31 days into the past will be returned. |
Example with encoding:
api/v1/videos/report?videoIds=8fab7499-0da6-4887-a0f0-485cf0c9219e,059d8940-c4f7-4524-a705-609b95c7f05b&after=2016-02-12T12%3A00-05%3A30%0A%0A%0A%0A%0A%0A%0A%0A&before=2017-01-29T12%3A00-05%3A30
Example Response
[
{
"videoId": "8fab7499-0da6-4887-a0f0-485cf0c9219e",
"title": "How-To Training",
"dateViewed": "2016-04-25T05:37:49.329Z",
"username": "john.smith",
"firstName": John,
"lastName": "Smith",
"emailAddress": "john.smith@company.com",
"completed": true,
"zone": "New York",
"device": "null",
"playbackUrl": "http://10.10.6.133:12345/downloads/videos/8fab7499-0da6-4887-a0f0-485cf0c9219e/instances/f670b70e-c5d4-4fd5-8d1e-2a79a8568f25.m3u8",
"browser": "Chrome",
"userDeviceType": "PC",
"viewingTime": "00:01:13.5840000",
"viewingStartTime": "2016-04-25T05:37:49.329Z",
"viewingEndTime": "2016-04-25T05:39:02.913Z"
},
{
"videoId": "8fab7499-0da6-4887-a0f0-485cf0c9219e",
"title": "How-To Training",
"dateViewed": "2016-04-25T05:38:14.856Z",
"username": "jane.jones",
"firstName": "Jane",
"lastName": "Jones",
"emailAddress": "jane.jones@company.com",
"completed": true,
"zone": "Boston",
"device": "null",
"playbackUrl": "http://10.10.6.133:12345/downloads/videos/8fab7499-0da6-4887-a0f0-485cf0c9219e/instances/f670b70e-c5d4-4fd5-8d1e-2a79a8568f25.m3u8",
"browser": "Chrome",
"userDeviceType": "PC",
"viewingTime": "00:01:15.8610000",
"viewingStartTime": "2016-04-25T05:38:14.856Z",
"viewingEndTime": "2016-04-25T05:39:30.717Z"
}
]
Response Codes
| Code | Description |
|---|---|
| 200 | ok |
| 400 | Bad Request |
| 401 | Unauthorized error |
| 500 | Internal server error |