Skip to main content
POST
Run a custom report

Authorizations

X-Auth-Token
string
header
required

API key created in the dashboard or via POST /v1/api/api-keys. Keys are prefixed pn_ and do not expire until revoked.

Query Parameters

download
enum<string>

Return a CSV of the table rows or the dateWise series instead of JSON

Available options:
table,
dateWise

Body

application/json

Report definition. Additional fields are forwarded to the analytics engine as-is.

from
string<date>
to
string<date>
videoIds
string[]

Restrict to these videos

tags
integer[]

Restrict to videos carrying any of these tag IDs

Response

Report result

summary
object
dateWise
object[]
data
object[]
totalRows
integer