Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2024-10-175745153.1 KB
metrics

Query usage metrics

get/data/usage/query

Query parameters

frominteger

Start millis timestamp for the query range (inclusive)

tointeger

End millis timestamp for the query range (exclusive)

timeStep'hour' | 'day'

The time step to aggregate viewership metrics by

creatorIdstring

The creator ID to filter the query results

breakdownBy[]string[]

The list of fields to break down the query results. Currently the only supported breakdown is by creatorId.

Response

A Usage Metric object

UserIDstring

The user ID associated with the metric

CreatorIDstring

The creator ID associated with the metric

DeliveryUsageMinsnumber

Total minutes of delivery usage.

TotalUsageMinsnumber

Total transcoded minutes.

StorageUsageMinsnumber

Total minutes of storage usage.

Example response

{
  "UserID": "1bde4o2i6xycudoy",
  "CreatorID": "john@doe.com",
  "DeliveryUsageMins": 100,
  "TotalUsageMins": 100,
  "StorageUsageMins": 100
}