Viewership
Query usage metrics
GET
/
data
/
usage
/
query
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
from
integer
Start millis timestamp for the query range (inclusive)
to
integer
End millis timestamp for the query range (exclusive)
timeStep
enum<string>
The time step to aggregate viewership metrics by
Available options:
hour
, day
creatorId
string
The creator ID to filter the query results
breakdownBy[]
enum<string>[]
The list of fields to break down the query results. Currently the
only supported breakdown is by creatorId
.
Available options:
creatorId
Response
200 - application/json
An individual metric about usage of a user.
UserID
string
The user ID associated with the metric
CreatorID
string
The creator ID associated with the metric
DeliveryUsageMins
number
Total minutes of delivery usage.
TotalUsageMins
number
Total transcoded minutes.
StorageUsageMins
number
Total minutes of storage usage.
Was this page helpful?