Video Reporting API

Introduction

The Video Reporting API can be used to pull any data available through the Console UI.

By querying the following endpoints, you can automate reporting processes for your Browsi Video activity.

Authentication

For access to any report via the API you will need

Endpoint - https://video-console-server.browsiprod.com/api/v1/oauth/token

METHOD: POST

RESPONSE:

The token provided this way needs to be added to any other request to the API, as part of the header 'authorization' with the value: "Bearer <TOKEN>".

The Video Reporting API supports the following endpoints

Available metrics and dimensions  

https://video-console-server.browsiprod.com/api/v1/reports/fields

1. Method: GET
2. Response: 
   

Run Report

https://video-console-server.browsiprod.com/api/v1/reports

1. Method: POST
2. Body: 
   
   

• Defaults if not provided:
  • Timezone: UTC
• Params
  • Dimensions - mandatory
  • Metrics - mandatory
  • Limit - optional (if not provided, no limit)
  • Type - mandatory (csv or json)
  • Filters - optional
  • timeRange - mandatory - startDate and endDate yyyy-mm-dd
• Response:
  • If type is "csv", put the report data in s3 and return the URL (same as in the Console UI, with
    1-hour expiration)
  • If type is "json", return the data of the report
    Use this endpoint to retrieve reports on one or multiple Video players.