Viewership
Query creator viewership metrics
Requires a proof of ownership to be sent in the request, which for now is just the assetId or streamId parameters (1 of those must be in the query-string).
GET
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Start timestamp for the query range (inclusive)
End timestamp for the query range (exclusive)
The time step to aggregate viewership metrics by
Available options:
hour
, day
, week
, month
, year
The asset ID to filter metrics for
The stream ID to filter metrics for
The creator ID to filter the query results
The list of fields to break down the query results. Specify this query-string multiple times to break down by multiple fields.
Available options:
deviceType
, device
, cpu
, os
, browser
, browserEngine
, continent
, country
, subdivision
, timezone
, viewerId
Response
200
application/json
A list of Metric objects
The response is of type object[]
.