new

Engagement Analytics Visualization and API Improvements

Overview

With this update, builders gain access to more detail from the Viewership Engagement API and receive a quick-start tutorial for how to get started.

To access these features, please follow the guides linked in the Resources section below. Please note that these updates alter behavior for some API requests (see note on playbackId). Existing builders leveraging Engagement Analytics should check that their integration behaves as expected and update it accordingly.

Detail

API improvements

Additional Breakdowns:

viewerId - ID of the viewer. This must be integrated at the application layer and passed into the player at watch time.
creatorId - ID of the creator associated with the video. This value is supplied when the asset is created.
playbackId - ID of video or stream. Previously, the API would return this unprompted. Now it needs to be requested explicitly; otherwise, metrics will be application-wide.
geohash - Geographical encoding of the viewer's location.

Time window defaults:

If the
from
parameter is not supplied, then it will default to either seven days before the
to
parameter or seven days before "now" if
to
is not specified.

Template

We've created a tutorial to help you get started with the API quickly. The tutorial uses Grafana and includes a dashboard template. You can use a free Grafana account and should be able to complete it in about 10 minutes.

Resources

Integrating with the Viewer Engagement API https://docs.livepeer.org/guides/developing/viewer-engagement
Querying Viewership Metrics: https://docs.livepeer.org/reference/api#query-viewership-metrics
Tutorial https://docs.livepeer.org/tutorials/developing/visualize-engagement-metrics-grafana