Getting started with Optimizely's JS API

Follow the steps below to get started using Optimizely's JavaScript API. If you're already an Optimizely customer and have active experiments running on your website, jump straight to 4. Read from the Optimizely Data Object.

1. Create an Optimizely account

If you don't have an Optimizely account already, just sign up for a free developer account. This account will give you access to core Optimizely features and API access, but with limited traffic allocation. No credit card is required, but you can always upgrade your account to a paid plan later.

2. Implement the Optimizely Snippet

If you are not already running Optimizely, you'll need to add the Optimizely Snippet to the head section of your web page. See Implement the one-line snippet for Optimizely X for detailed instructions on how to add the Optimizely snippet for your project.

3. Start an experiment

To see the Optimizely JavaScript API in action, you should have at least one experiment running on your web page. The article Get started with Optimizely X Web Experimentation contains detailed instructions on how to setup and run an experiment.

4. Read from the Data Object

The API has a window["optimizely"].get() function that gives you access to the data that you have saved in your project (Campaigns, Experiments, Pages, Events, Audiences). With this function you can also get information about the current state of Optimizely in the browser.

To access data you have saved, open your browser console and type window["optimizely"].get('data'):

You can also access data about the current visitor by typing window["optimizely"].get('visitor') or get to the current state of the campaigns and experiments that are running by typing window["optimizely"].get('state').

5. Make an API call

In addition to reading data, you can also Track common user interactions and use API functions to develop experiences and influence the execution of Optimizely on a page.

The API function calls expose many of Optimizely's decisions and actions so you can take control.

One example is starting experiments manually rather than upon page load, which is useful for testing dynamic web pages. Your application can tell Optimizely when to activate these "manual activation mode" experiments with the activate API function. Another example is using the bucketVisitor API function to assign visitors to a specific variation if you wanted to incorporate inputs that Optimizely's traffic allocation algorithm does not.

If you have any questions about using the JavaScript API, you can ask the developer community, or you can submit a ticket to the developer support team. We'll be happy to assist you.