analytics.js Vimeo Plugin

With the analytics.js Vimeo Plugin you can collect Vimeo player events into the Segment ecosystem.

Getting Started

To use the Vimeo plugin:

  1. Generate an access token in Vimeo. The plugin uses this token to access metadata about the playing video content. Vimeo provides documentation to generate the access token.
    • Note: Make sure to select the access scopes you need as the plugin only needs to read information about your video(s).
  2. Enable a new plugin by navigating to the settings for your Source and clicking Plugins. You can enable the Vimeo plugin from this menu:

    the plugins setting screen

  3. Initialize the plugin by entering your Vimeo access token and granting it access to the Vimeo video player instance(s) running on the page. Use this initialize method:
<iframe src="" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
<script src=""></script>
    var iframe = document.querySelector('iframe');
    var player = new Vimeo.Player(iframe);
    analytics.ready(function () {
      var VimeoAnalytics =
      var vimeoAnalytics = new VimeoAnalytics(player, 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX0365')

That’s it! The plugin listens to the Vimeo player for events, and responds by firing the corresponding Segment Video Spec events on Analytics.js.

Supported Events

The plugin tracks the following Segment Video Spec events:

  • Video Playback Started
  • Video Playback Completed
  • Video Playback Paused/Resumed
  • Video Content Started/Completed

Supported Properties

The plugin automatically attaches the following Segment Video Spec properties to the above events:

‘Playback’ Events

  • Total Length
  • Position
  • Video Player
  • Sound

‘Content’ Events

  • Title
  • Description
  • Publisher

This page was last modified: 09 Jun 2021

Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
Create free account