Query viewership metrics
Requires a private (non-CORS) API key to be used.
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
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.
playbackId, deviceType, device, cpu, os, browser, browserEngine, continent, country, subdivision, timezone, geohash, viewerId, creatorId Response
The playback ID associated with the metric.
The ID of the creator associated with the metric.
The ID of the viewer associated with the metric.
The URL of the distributed storage used for the asset
Timestamp (in milliseconds) when the metric was recorded. If the query contains a time step, this timestamp will point to the beginning of the time step period.
The device used by the viewer.
The type of the device used by the viewer.
The CPU used by the viewer's device.
The operating system used by the viewer.
The browser used by the viewer.
The browser engine used by the viewer's browser.
The continent where the viewer is located.
The country where the viewer is located.
The subdivision (e.g., state or province) where the viewer is located.
The timezone where the viewer is located.
Geographic encoding of the viewers location. Accurate to 3 digits.
The number of views for the stream/asset.
The total playtime in minutes for the stream/asset.
The time-to-first-frame (TTFF) in milliseconds.
The rebuffering ratio for the asset.
The error rate for the stream/asset.
The percentage of sessions that existed before the asset started playing.
Was this page helpful?