Viewership Metrics
Engagement via Grafana
Learn how to visualize your engagement metrics with Grafana
In May 2023, we released powerful engagement metrics offering detailed
information on viewer behavior and playback quality on your platform. The API
includes engagement metrics such as view counts and watch time, as well as
performance metrics such as error rate, time to first frame, rebuffer ratio, and
exit-before-starts across a variety of dimensions. For more details, check out
the docs here.
In this tutorial we will introduce a simple, free, and customizable method to
quickly visualize the core metrics and dimensions of the API.
Prerequisites
Before you begin this tutorial, make sure you have:- Integrated the necessary components to capture viewership data. Details here.
- Viewed videos via (1) to collect data.
- Created an CORS-enabled API Key.
The key must allow CORS access from your Grafana origin, or from all (
*) - Set up a Grafana account and workspace with permissions to add new dashboard (and datasource/connection, if necessary). A free account is sufficient and available at grafana.com
- Install the
JSON APIplugin for grafana.
Setting up the Engagement Dashboard
- Login to Grafana
- Click “Connections” > “Connect Data”
- Set up your JSON API:
- Name: e.g. “Livepeer Engagement Data”
- URL:
https://livepeer.studio/api/data/views/query - Authentication methods: Forward OAuth Identity
- TLS Settings: Skip TLS certificate validation
- Custom HTTP Headers
- Header: “Authorization”
- Value: Full Access
Bearer <your api key>
- Save and Test
- “Import” the dashboard from the official Livepeer Studio Viewership Engagement dashboard and using the JSON API datasource created above.
- Rename the dashboard if you’d prefer