Viewership
Query usage metrics
GET
/
data
/
usage
/
query
Authorization
Query
curl --request GET \
--url https://livepeer.studio/api/data/usage/query \
--header 'Authorization: <authorization>'
{
"CreatorID": "3e02c844-d364-4d48-b401-24b2773b5d6c",
"DeliveryUsageMins": 10,
"StorageUsageMins": 10,
"TotalUsageMins": 10,
"UserID": "3e02c844-d364-4d48-b401-24b2773b5d6c"
}
Authorizations
Authorization
string
headerrequiredBearer api-key
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
Response
200 - application/json
CreatorID
string
requiredThe creator ID associated with the metric
DeliveryUsageMins
number
requiredThe number of minutes of delivery usage
StorageUsageMins
number
requiredThe number of minutes of storage usage
TotalUsageMins
number
requiredThe number of minutes of total usage
UserID
string
requiredThe user ID associated with the metric
Was this page helpful?
curl --request GET \
--url https://livepeer.studio/api/data/usage/query \
--header 'Authorization: <authorization>'
{
"CreatorID": "3e02c844-d364-4d48-b401-24b2773b5d6c",
"DeliveryUsageMins": 10,
"StorageUsageMins": 10,
"TotalUsageMins": 10,
"UserID": "3e02c844-d364-4d48-b401-24b2773b5d6c"
}