Learn how to check out viewer engagement on Livepeer
Livepeer offers 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.
Please note that in order to use Realtime Viewership metrics, you need to use Player SDK
@livepeer/react
version 4.2.0 or higher.
This API includes real-time metrics about the ongoing livestream or VOD engagement:
This API includes usage metrics to help you understand how viewers are engaging with your platform:
Please note that data is refreshed every 5 minutes and newly uploaded videos may take up to an hour before viewership data is available
This API offers several key performance metrics to help you understand your platforms performance:
Please note that data is refreshed every 5 minutes and newly uploaded videos may take up to an hour before viewership data is available
To provide a comprehensive view of viewer behavior, our data product includes several dimensions to help you segment your data and identify patterns:
To collect and register viewership metrics, you first need to configure your player. We recommend that you use the Livepeer player to get viewership metrics, as it comes fully configured. You can follow the Player guide to get started.
To collect and register viewership metrics, you first need to configure your player. We recommend that you use the Livepeer player to get viewership metrics, as it comes fully configured. You can follow the Player guide to get started.
We also support viewership metrics for applications using custom players. In
order for metrics to be tracked by Livepeer, you will need to configure your
player using addMediaMetrics
.
Here’s how to configure your player:
Make sure you have initialized your player before calling addMediaMetrics
.
Make sure you have initialized your player before calling addMediaMetrics
.
Make sure you have initialized your player before calling addMediaMetrics
.
The Livepeer Studio Dashboard is a frontend interface for publishing live or on-demand video streams with no code. In this guide, we’ll show you how to use the dashboard to retrieve viewership metrics.
Click on an existing asset and you’ll be brought to that asset’s specific details page. If you haven’t created an asset yet, you can follow the upload a video asset guide.
In the asset’s specific detail page you can view its total number of views.
playbackId
of an existing stream/assetGet the playbackId
of an existing asset. A playbackId
can be found in the
stream/asset page on the dashboard or from any Asset API call. If you haven’t created
a stream/asset yet, you can follow the
upload a video asset guide.
The playbackId
can be a canonical playback ID from a specific Livepeer asset
or stream objects, or dStorage identifiers for assets. Queries by dStorage ID
are universal/cross-account, as explained below, so check what makes the most
sense for your app.
When querying by dStorage ID (e.g. ipfs://
or ar://
URLs, or CID/txID), you
will get views for all assets with that dStorage ID across any Livepeer account.
This is useful to display global metrics from a video. To display the viewership
metrics only from the videos in your account, use the API objects playbackId
.
Once you have the playbackId
, you can make a request to get the viewership
data.
For more information on the API and SDK methods, refer to the API reference.
If you’re happy with the above metrics you can stop here. If you want to build more advanced analytics, you can use the following API endpoints to get more detailed data.
This API can be called from the frontend to retrieve realtime engagement metrics (current view count and error rate). You can break down the results by playback id, browser, device, and country.
For more information on the API and SDK methods, refer to the API reference.
This API can be called from the frontend to retrieve detailed engagement metrics
for a specific resource. The only restriction it has is that it has to be called
with an assetId
or streamId
values, which are private values today that only
the asset creator should have access. Soon this creator ownership will be
validated using wallet signatures instead.
The idea for this API is to build creator analytics dashboards. It can be called from the frontend and can provide detailed insights to creators about their assets and streams.
For more information on the API and SDK methods, refer to the API reference.
This API can be called from the backend to retrieve detailed engagement metrics for a specific resource. It requires a non-CORS API key to be used, meaning that it cannot be called from the frontend. This is for security reasons since this API provides full access to all metrics in the account, meaning it provides the most flexibility in queries.
The idea is that developers should build their own abstraction and access control logics on top of this API and abstract it as higher level API in their apps.
For more information on the API and SDK methods, refer to the API reference.
If you are ready to take a deep dive into your data, then visualizations are the next step. We have put together a tutorial complete with templates to get you started.
If you are interested in visualizing your engagement metrics with Grafana, feel free to check out our tutorial, Visualize Engagement Metrics with Grafana, to learn more.
Learn how to check out viewer engagement on Livepeer
Livepeer offers 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.
Please note that in order to use Realtime Viewership metrics, you need to use Player SDK
@livepeer/react
version 4.2.0 or higher.
This API includes real-time metrics about the ongoing livestream or VOD engagement:
This API includes usage metrics to help you understand how viewers are engaging with your platform:
Please note that data is refreshed every 5 minutes and newly uploaded videos may take up to an hour before viewership data is available
This API offers several key performance metrics to help you understand your platforms performance:
Please note that data is refreshed every 5 minutes and newly uploaded videos may take up to an hour before viewership data is available
To provide a comprehensive view of viewer behavior, our data product includes several dimensions to help you segment your data and identify patterns:
To collect and register viewership metrics, you first need to configure your player. We recommend that you use the Livepeer player to get viewership metrics, as it comes fully configured. You can follow the Player guide to get started.
To collect and register viewership metrics, you first need to configure your player. We recommend that you use the Livepeer player to get viewership metrics, as it comes fully configured. You can follow the Player guide to get started.
We also support viewership metrics for applications using custom players. In
order for metrics to be tracked by Livepeer, you will need to configure your
player using addMediaMetrics
.
Here’s how to configure your player:
Make sure you have initialized your player before calling addMediaMetrics
.
Make sure you have initialized your player before calling addMediaMetrics
.
Make sure you have initialized your player before calling addMediaMetrics
.
The Livepeer Studio Dashboard is a frontend interface for publishing live or on-demand video streams with no code. In this guide, we’ll show you how to use the dashboard to retrieve viewership metrics.
Click on an existing asset and you’ll be brought to that asset’s specific details page. If you haven’t created an asset yet, you can follow the upload a video asset guide.
In the asset’s specific detail page you can view its total number of views.
playbackId
of an existing stream/assetGet the playbackId
of an existing asset. A playbackId
can be found in the
stream/asset page on the dashboard or from any Asset API call. If you haven’t created
a stream/asset yet, you can follow the
upload a video asset guide.
The playbackId
can be a canonical playback ID from a specific Livepeer asset
or stream objects, or dStorage identifiers for assets. Queries by dStorage ID
are universal/cross-account, as explained below, so check what makes the most
sense for your app.
When querying by dStorage ID (e.g. ipfs://
or ar://
URLs, or CID/txID), you
will get views for all assets with that dStorage ID across any Livepeer account.
This is useful to display global metrics from a video. To display the viewership
metrics only from the videos in your account, use the API objects playbackId
.
Once you have the playbackId
, you can make a request to get the viewership
data.
For more information on the API and SDK methods, refer to the API reference.
If you’re happy with the above metrics you can stop here. If you want to build more advanced analytics, you can use the following API endpoints to get more detailed data.
This API can be called from the frontend to retrieve realtime engagement metrics (current view count and error rate). You can break down the results by playback id, browser, device, and country.
For more information on the API and SDK methods, refer to the API reference.
This API can be called from the frontend to retrieve detailed engagement metrics
for a specific resource. The only restriction it has is that it has to be called
with an assetId
or streamId
values, which are private values today that only
the asset creator should have access. Soon this creator ownership will be
validated using wallet signatures instead.
The idea for this API is to build creator analytics dashboards. It can be called from the frontend and can provide detailed insights to creators about their assets and streams.
For more information on the API and SDK methods, refer to the API reference.
This API can be called from the backend to retrieve detailed engagement metrics for a specific resource. It requires a non-CORS API key to be used, meaning that it cannot be called from the frontend. This is for security reasons since this API provides full access to all metrics in the account, meaning it provides the most flexibility in queries.
The idea is that developers should build their own abstraction and access control logics on top of this API and abstract it as higher level API in their apps.
For more information on the API and SDK methods, refer to the API reference.
If you are ready to take a deep dive into your data, then visualizations are the next step. We have put together a tutorial complete with templates to get you started.
If you are interested in visualizing your engagement metrics with Grafana, feel free to check out our tutorial, Visualize Engagement Metrics with Grafana, to learn more.