LIlivepeer
metrics

Query public total views metrics

Changed on

Allows querying for the public metrics for viewership about a video. This can be called from the frontend with a CORS key, or even unauthenticated.

get/data/views/query/total/{playbackId}

Request

  • Base URL
    https://livepeer.studio/api
  • URL
    https://livepeer.studio/api/data/views/query/total/{playbackId}
  • Auth
    HTTP bearer

Path parameters

playbackIdstring required

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

Response

A single Metric object with the viewCount and playtimeMins metrics.

playbackIdPlaybackId (unresolved $ref)
dStorageUrlDStorageUrl (unresolved $ref)
viewCountViewCount (unresolved $ref)
playtimeMinsPlaytimeMins (unresolved $ref)

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

  • d0909f9b9414Revision changes
    • info

      api operation id getPublicViewershipMetrics was added

    • info

      api tag metrics added