API reference overview

You can use Optimizely Web Experimentation API to access resources in your Optimizely projects. This API closely mirrors the functionality of the Optimizely user interface; its endpoints have predictable, resource-oriented URLs.

Product Support

The REST API supports both Optimizely Web Experimentation and Optimizely Feature Experimentation. Both products share many of the same data models, so endpoints like Experiments and Projects can be used for both. Some fields are shared between Optimizely Web Experimentation and Optimizely Feature Experimentation while others are specific to one product. See the field's description for the applicable product or products.

API usage

The Optimizely API endpoints are defined using the OpenAPI Specification. This enables you to create API clients in any programming language using the Swagger Generator, or use any off-the-shelf HTTP client to compose and send requests. See OpenAPI / Swagger for more information.

The API returns JSON in the body of responses. If a value is not set for a field (meaning, the value is null), the field will not appear in the JSON response.

The preferred method of authenticating with the API is using OAuth 2.0. However, to make the API easily explorable, Personal tokens are also available.

Review the API Conventions in the documentation. If you have any questions, you can ask the developer community, or you can submit a ticket to the developer support team.

API endpoint

https://api.optimizely.com