Using the REST API

📘

Note

This page describes an API to control flags in the Optimizely Full Stack app.
If you are looking for a REST API that delivers the same functionality as the Full Stack SDKs, see instead Optimizely Agent.

The Full Stack REST API allows you to interface with Optimizely programmatically to build customized integrations and workflows. For example, you can create feature flags from an automated script, build custom dashboards of feature test results, or connect your experiments to other project management tools.

To explore the REST API, we recommend an API client called Postman. Using Postman, you can import an API collection with example requests for each Full Stack API method. See below for instructions on setting up Postman to explore the API.

To integrate the API into your application, you'll need to generate an API token and use it to call the API directly from your code. For an overview of using the REST API, see the Integrate the REST API section below.

Explore with Postman

To explore the Full Stack REST API collection:

1. Install Postman if you have not already installed it on your machine.
2. Click the Import button.
3. Choose Import From Link.
4. Enter the URL https://api.optimizely.com/collections/fullstack.json.
5. Click Collections in the left pane, then click a folder to see the available methods.

By default, this collection links to a sample read-only project. To instead use your own account:

1. Right-click Optimizely Full Stack API in the left pane.
2. Click Edit to launch the Edit Collection window, then click the Variables tab.
3. Replace the default project ID and API token with your own settings.
4. Add other variables as needed for various endpoints, for example, {{flag_key}}, {{audience_id}}, {{variation_id}}, etc. You can get the values for these variables by using GET endpoints (for example, for a {{flag_key}}, use the List Flags endpoint).
5. Click Update.

See the Integrate the REST API section below for more information on generating an API token.

Integrate the REST API

For production use cases, you will want to integrate these API calls directly into your own application. See Getting Started with the REST API to generate an API token and make your first API call.

We recommend authenticating using OAuth 2.0. However, to make our API easily explorable, we have also implemented Personal Tokens. See API Conventions for more information on conventions like authentication and rate limiting.

For a full guide to all our REST API endpoints, see the Optimizely v2 REST API reference. This reference describes each endpoint's methods and fields.

📘

Note

Because our REST API is used for both Optimizely Web and Full Stack, some resources may not be applicable for your use cases.