Integrate Optimizely with the web trackers

The web tracker supports Optimizely X (Next Generation Platform) for campaign and A/B test management.

The Optimizely entity is automatically tracked once configured.

Install plugin

JavaScript (tag)

Tracker Distribution	Included
sp.js	❌
sp.lite.js	❌

Download:

Download from GitHub Releases (Recommended)	Github Releases (plugins.umd.zip)
Available on jsDelivr	jsDelivr
Available on unpkg	unpkg

Note: The links to the CDNs above are pinned to a specific version at the time of writing. Check the plugin's GitHub releases for newer versions, and update the pinned version when you upgrade.

javascript

window.snowplow('addPlugin',
  "https://cdn.jsdelivr.net/npm/@snowplow/browser-plugin-optimizely-x@4.10.2/dist/index.umd.min.js",
  ["snowplowOptimizelyX", "OptimizelyXPlugin"]
);

Browser (npm)

• npm install @snowplow/browser-plugin-optimizely-x
• yarn add @snowplow/browser-plugin-optimizely-x
• pnpm add @snowplow/browser-plugin-optimizely-x

javascript

import { newTracker, trackPageView } from '@snowplow/browser-tracker';
import { OptimizelyXPlugin } from '@snowplow/browser-plugin-optimizely-x';

newTracker('sp1', '{{collector_url}}', {
   appId: 'my-app-id',
   plugins: [ OptimizelyXPlugin() ],
});

Check out the third-party sources overview page to see the entity schema.

If you're planning on leveraging the entity's variationName, you'll have to untick "Mask descriptive names in project code and third-party integrations" in the OptimizelyX menu > Settings > Privacy. Otherwise, all variation names will be null.

Legacy plugin

The browser-plugin-optimizely-x plugin supersedes the earlier browser-plugin-optimizely plugin that was added in version 3.0. We deprecated and fully removed it in version 4.0.