Engagement via 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:

1. Integrated the necessary components to capture viewership data. Details here.
2. Viewed videos via (1) to collect data.
3. Created an CORS-enabled API Key. The key must allow CORS access from your Grafana origin, or from all (*)
4. 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
5. Install the JSON API plugin for grafana.

With that we are ready to set up our dashboard!

​

Setting up the Engagement Dashboard

• Login to Grafana
• Click “Connections” > “Connect Data”

• Set up your JSON API:
  1. Name: e.g. “Livepeer Engagement Data”
  2. URL: https://livepeer.studio/api/data/views/query
  3. Authentication methods: Forward OAuth Identity
  4. TLS Settings: Skip TLS certificate validation
  5. Custom HTTP Headers
     1. Header: “Authorization”
     2. 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