Reports

Generate Screen Control Report

Start a job to generate the Screen Control Report

GET

/api/reports/v1/screencontrol

curl --request GET \
  --url 'https://voyager.korbyt.com/api/reports/v1/screencontrol?playerid=15806&playername=sample_player&startdate=2023-02-04&enddate=2023-02-14&email=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

playeridintegerquery

Conditionally required. Player id. If player name is provided, id is optional. If both player id and player name are provided, player id is prioritized

Example: 15806

playernamestringquery

Conditionally required. Player name. If player id is provided, player name is optional. If both player id and player name are provided, player id is prioritized

Example: sample_player

startdatestringqueryrequired

Filter results to only those after a date

Example: 2023-02-04

enddatestringqueryrequired

Filter results to only those before a date

Example: 2023-02-14

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