Reports

Generate Proof of Play Report

Start a job to generate the Proof of Play Report.

GET

/api/reports/v1/pop

curl --request GET \
  --url 'https://voyager.korbyt.com/api/reports/v1/pop?contentname=%3Cstring%3E&contenttype=image&playlistname=%3Cstring%3E&playername=%3Cstring%3E&startdate=01%2F20%2F2023&enddate=02%2F20%2F2023&email=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

contentnamestringquery

Filter results by media item name.

contenttypestringquery

Filter results by content type - Allowed types are All, Audio, Image, Layout, Message, or Video.

Example: image

playlistnamestringquery

Filter results by playlist name.

playernamestringquery

Filter results by player name.

startdatestringquery

Defines the start date for the entries in the report.

Example: 01/20/2023

enddatestringquery

Defines the end date for the entries in the report.

Example: 02/20/2023

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