Reports

Generate HDMI CEC Report

Start a job to generate the HDMI CEC Report.

GET

/api/reports/v1/hdmicecreport

curl --request GET \
  --url 'https://voyager.korbyt.com/api/reports/v1/hdmicecreport?playername=sample_player&startdate=01%2F21%2F2014&enddate=02%2F12%2F2023&playerid=1&email=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

Authorizations

Authorizationstringheaderrequired

Access token from POST /api/v1/auth/login

Query Parameters

playernamestringquery

Conditionally required. The name of the player you want the report for. Either name or id will suffice, both are not required

Example: sample_player

startdatestringquery

Defines the start date for the entries in the report

Example: 01/21/2014

enddatestringquery

Defines the end date for the entries in the report

Example: 02/12/2023

playeridintegerquery

Conditionally required. The Id of the player you want the report for

Example: 1

emailstringquery

Email to notify when the report is ready

Response

Success. Response body is not documented in the source collection.

Still need help? Share an idea