OpenTV Analytics
OpenTV Analytics
Breadcrumbs

Bitmovin Analytics Customer Onboarding Guide

Overview 

This guide helps customers onboard to the Bitmovin Analytics platform and start monitoring playback performance, error trends, and user experience KPIs. It outlines the steps required to access the analytics dashboard, configure device-level tracking, and interpret critical KPIs used by integration partners integrating BitMovin Player.

Scope

The scope of this test plan covers the integration of the Bitmovin Player with an application to validate its functionality and compatibility. The objective is to ensure that application integrators can successfully implement the Player and achieve seamless interaction with its APIs and features.

Audience

This document is intended for the following audiences:

  • Application integrators: individuals responsible for integrating the Player into their applications

  • Operators: entities that are responsible for deploying the application and Player into a production environment

  • Product manager: individuals overseeing the development and lifecycle of the product

  • Engineering team: personnel who will verify that the integration and Player usage meet the required standards and work as expected

Prerequisites 

The following account-level details and configurations are required to start using Bitmovin Analytics: 

  • Customer account ID and workspace creation 

  • Role assignment: Admin, Viewer, Developer 

  • Single Sign-On (SSO) configuration (if enabled) 

  • Customer-specific analytics key 

Steps

  1. Contact the NAGRAVISION Operations/DevOps team to request account setup. 

  2. Provide organisation details (company name and email domain). 

  3. Once the account is created, assign roles: 

    1. Admin: full dashboard and alert access 

    2. Viewer: read-only analytics access

  4. Log in to the Bitmovin Analytics dashboard here: https://dashboard.bitmovin.com/. 

For SSO integration (optional): customers using Azure AD or Okta can integrate Bitmovin Dashboard via SAML-based SSO. Contact the NAGRAVISION DevOps team for configuration. 

For billing, access, or role-related queries, contact [email protected].

Observability and documentation 

The Bitmovin Dashboard provides observability into performance, playback, and audience insights. Customers can refer to the official documentation: 

Filtering based on data fields 

The following table lists the suggested data fields that can be used for filtering for effective analysis and classification. This list also includes the standard and custom fields currently being used in the deployment. It is recommended to verify that these bare minimum fields are available for a deployment in the respective Player integration.

Data field

Description

Values & usage guidance

Auto-populated

Supplied by app integration

browser

The web browser used for playback

Available browsers (common): Chrome, Safari, Microsoft Edge, Firefox

yes


country

The geographical country where the user is located (usually derived from IP address)

Used to analyse performance or content availability by region

yes


device_type

The general category of device used for playback

Examples: Phone, Tablet, Desktop, SmartTV, Game Console, Set Top Box (STB)

yes


platform

The specific operating system or app environment hosting the player

Examples: Web (HTML5/browser), iOS (Native App), Android (Native App), tvOS (Apple TV), Android TV, Tizen (Samsung), webOS (LG)

yes


user_id

A persistent, non-personal, high-privacy user (accountId) identifier linking the session to a specific user account in your system

Essential for linking analytics data to specific user reports or accounts (e.g., VIP user, test user)


yes

video_title

The human-readable name of the content being played

Examples: "Avengers: Endgame," "Season 3 – Episode 5: The Escape." Used for filtering content performance insights.

This helps the team to filter playback sessions by content name.

Video title (asset.title)


yes

video_id

A unique identifier assigned to the video asset that is editorialId.

Examples: VID_987654, asset_f3c2d91e. Recommended for accurate, system-level filtering and asset-specific troubleshooting.

Supports debugging and troubleshooting issues related to specific video assets.

Recommended for filtering KPIs and analytics at the asset level.


yes

device_class

Class of device

Filter based on device class , e.g., TV, browser

yes


ip_address

Public IP of the client

Analyse specific events originating from an IP.

yes


isp

ISP name

ISP name

yes


city

Client city

Filter the events based on city.

yes


player_version

Bitmovin Player version

Filter based on Player version. eg. bitmovin-3.150.0

yes


mpd_url

Content manifest URL

Filter based on URL.


yes

Custom Fields

Data field

Description

Values & usage guidance

custom_data_1

Device identifier

Tracks the identifier of the client device

Device ID to be sent always

custom_data_2

Channel ID

Identifier of the channel

custom_data_3

Content type

Type of content watched example: live-event, vod-ed, SO, CU

custom_data_4

Application-specific data can be provided.

Useful supporting data can be provided (example: user agent or something else)

custom_data_5

Playback session identifier

Individual playout session – a unique ID provided by the client or Player SDK for the specific piece of content playback activity

These values need to be set in the SDK for licensing:

  • key – analytics API key

  • origin – domain/app identifier