[object Object] Icon

Learn how to create, start, manage and modify Encodings

[object Object] Icon

Learn how to create, start, manage and modify Players

[object Object] Icon

Learn how to create, start, manage and modify Analyticss

Docs Home
User shortcuts for search
Focus by pressing f
Hide results by pressing Esc
Navigate via   keys

Wed Jan 29 2020

Analytics Configuration Overview

Wed Jan 29 2020

OverviewLink Icon

Bitmovin Analytics allows for extensive customization of your data architecture. This means data can be easily extended and enriched with information that is not collected through the player integration. Here’s a list of all fields that can be set in the Analytics configuration.

Configuration OptionsLink Icon

Field NameCategoryUse-CasePre-requisite for
videoTitleRequiredConfiguring the videoTitle will allow you to efficiently compare the performance of different content pieces in the Bitmovin Analytics Dashboard. You will see names and titles instead of just numbers and IDs.Video Title Filter
Video Title Breakdown
Bitrate Heatmap
videoIdRequiredConfiguring the videoId is important to ensure consistency within your data framework. We use the videoId to enable filtering and breaking down by videoTitle, hence setting the videoId is a pre-requisite to enable this feature. If no videoId is set the videoTitle filter cannot be applied to the data.
In case there are multiple videoTitles with the same videoId, we assign the data to each of the different videoTitles.
Video Title Filter
Video Title Breakdown
Bitrate Heatmap
cdnProviderOptionalSetting the CDN provider in the configuration allows you to use CDN as a breakdown or global filter in the Bitmovin Analytics Dashboard and API. This will enable you to compare the performance of the different CDN providers that you’re using.CDN Filter
CDN Breakdown
isLiveOptionalDifferentiating between Live and VOD content is important, as both are often distributed through different workflows. Auto-detection is only possible once stream metadata is received so explicitly providing this information is helpful in certain cases and improves the accuracy of your data.Live Filter
Live Breakdown
ExperimentOptionalFor testing purposes, Bitmovin Analytics provides an Experiment field to differentiate between testing groups.
A popular application for this data field is to use it for testing a new player version, before rolling it out to all your viewers.
Experiment Filter
Experiment Breakdown
customUserIdOptionalThe customUserId field can be used to integrate a subscriber or user ID into Bitmovin Analytics.
Features such as Session Tracking will only work if a customUserId is configured. Otherwise, all impressions will be assigned to a single null user.

A consistent ID for a specific user is important to enable use-cases such as cross-device tracking.

For privacy reasons we advise you to send customUserIds not as emails or otherwise personally identifiable form but either as IDs or in a hashed form

In case you want to tie your video Analytics data with other data sets, it is important to pass customUserIds in a format that is consisten across your different data sources.
Session Tracking
OptionalThe five customData fields can be freely configured. The data sent through these fields can be used as a filter or as a breakdown to segment the data according to your needs.
Common use-cases for customData are sending the app version used, a cross-domain or profile ID, to track viewers across different platforms, or assigning a high-level content category to order content assets. But the options are more or less unlimited.

In the dashboard, under the license settings, customData fields can be labeled according to your liking.

Note: For customData field queries we allow a cardinality of maximum of 15,000 distinct values per customData field within the selected time-frame.
Each customData field has a limit of 160 characters.
Custom Filters
Custom Breakdowns

Give us feedback