Migrating from Optimizely Classic Web

If you have any questions about migrating to Optimizely Web Experimentation, you can submit a ticket to the developer support team. We'll be happy to assist you.

We're excited to release Optimizely API (2.0), providing read-and-write access to your Optimizely Web Experimentation data and read-only access to your Classic Web data. This version of our REST API has been completely re-built from the ground up. This API has been written to support the new data models in Optimizely Web Experimentation causing the endpoints to vary from Optimizely API (1.0). We have also incorporated many new features requested by developers like pagination, enhanced error handling and improved input validation. This guide will walk you through the key differences between versions.

First, we've added the Campaign model, which is a collection of Experiments that share the same objective. Campaigns should now be leveraged when creating a personalization campaign that shares the same focus. With this addition, Projects will now consist of Experiments and/or Campaigns.

In Optimizely API (2.0), variations are the property of experiments. Variations cannot be queried outside of the experiment context, so there is no /variations endpoint like there was in the Optimizely API (1.0). We have also introduced the concept of a Page that controls where experiments can run. Previously, this was defined in url_conditions in an experiment.

The notion of Goals has transformed into Metrics and Events. Events most closely resemble goals, as they are specific actions you can track. For example, an Event could be button clicks within a page or page views. Metrics define how to add up the data we receive from Events. Audiences remain the same between versions.

In Optimizely API (1.0), you could authenticate with tokens that you could generate on http://app.optimizely.com/tokens. Those "Classic Tokens" are replaced by "Personal Tokens" in the v2 API.

Migration Checklist

• Read about the Optimizely Web Experimentation data model concepts in the Optimizely API (1.0) to Optimizely API (2.0) table below
• Read about authentication with Personal Tokens and OAuth 2.0
• Familiarize yourself with Optimizely API (2.0).
• Make your first request. See Get started with REST API.
• Update your application to use Optimizely API (2.0) routes and handle Optimizely API (2.0) errors.

If you have any questions, you can submit a ticket to the developer support team. We'll be happy to assist you.

Mapping Optimizely API (1.0) to Optimizely API (2.0)