LIlivepeer
metrics

Query usage metrics

Changed on
get/data/usage/query

Request

  • Base URL
    https://livepeer.studio/api
  • URL
    https://livepeer.studio/api/data/usage/query
  • Auth
    HTTP bearer

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
}

Changes

  • fc477586b24cRevision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • info

      added the new optional query request parameter breakdownBy[]

  • d0909f9b9414Revision changes
    • info

      api operation id getUsageMetrics was added

    • info

      api tag metrics added