Web SDK

In standard Bitmovin Player package Bitmovin Analytics already comes pre-packaged with the Player, you just have to enable it via the Player configuration. This is only available from player version 8.

If you are using the Modular Bitmovin Player packages, you need to manually add the Bitmovin Analytics Collector to your website

Copy<script type="text/javascript" src="https://cdn.bitmovin.com/analytics/web/2/bitmovinanalytics.min.js"></script>

To activate analytics, add the analytics configuration to the player configuration, with the analytics property and then instantiate the player.

Standard

Modular

Copyconst configWithAnalytics = { key: '<PLAYER_LICENSE_KEY>', analytics: { key: '<ANALYTICS_LICENSE_KEY>', videoId: 'my-video-id', title: 'A descriptive video title', userId: '<USER_ID>', cdnProvider: 'CDN provider', customData1: 'custom data', customData2: 'custom data', customData3: 'custom data', customData4: 'custom data', customData5: 'custom data' } }; const container = document.getElementById('my-player'); const player = bitmovin.player.Player(container, configWithAnalytics);

For all configuration options, please see the Analytics Configuration Overview

When you are loading a new video, you can pass its metadata with the source config. Analytics will then automatically pick up the new metadata and use it for the following events.

Copyplayer.load({ dash: 'path/to/video.mpd', analytics: { title: 'New Video Name', videoId: 'your-video-id' } });

If you are using multiple CDNs or plan to test with different CDNs in the future it's very helpful to set the cdnProvider parameter to be able to compare performance between the CDNs. You can specify any string, but we have built in some constan ts that are available on bitmovin.analytics.CdnProviders:

• BITMOVIN
• AKAMAI
• FASTLY
• MAXCDN
• CLOUDFRONT
• CHINACACHE
• BITGRAVITY

It is possible to supply custom data to Bitmovin Analytics. We support 5 fields for custom data as well as experimentName which can be used to A/B Test your setup.

• customData1
• customData2
• customData3
• customData4
• customData5

In order to use the Analytics on your website(s), you have to white-list the domain(s) of your website(s) for which you want to use it. This is a security mechanism and protects your license from being used elsewhere.

It can be done in our dashboard under Analytics -> Licenses

The domain localhost is allowlisted by default to ease the development process, so you don't have to deal with license denials while working on your integration locally.