Viewership
Query viewership metrics
Requires a private (non-CORS) API key to be used.
GET
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
The playback ID to filter the query results. This can be a canonical playback ID from Livepeer assets or streams, or dStorage identifiers for assets
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:
playbackId
, deviceType
, device
, cpu
, os
, browser
, browserEngine
, continent
, country
, subdivision
, timezone
, geohash
, viewerId
, creatorId
Response
200
application/json
A list of Metric objects
The response is of type object[]
.