Describes the available REST APIs to Optimizely Feature Experimentation.
Optimizely Feature Experimentation has multiple REST APIs you can use to do administrative tasks on your Feature Experimentation project. The following describes the functionality of the available REST APIs and what endpoints are available for Optimizely Feature Experimentation.
For the most common operations in an experiment's lifecycle using the Optimizely APIs, see the Feature Experimentation REST API Cookbook hosted on GitHub.
Authentication and finding IDs
For information on generating API keys, see the developer documentation onUse the Feature Experimentation REST API. For information on finding IDs for the API keys, see Find IDs for API calls.
Optimizely Feature Experimentation API
The Optimizely Feature Experimentation API has a rate limit of two requests per second, 120 requests per minute.
You can use the Optimizely Feature Experimentation API to manage the following items:
- flags
- rules and rulesets
- reports (results)
- variable definitions
- variations
- environments
- groups
Note
The Optimizely Feature Experimentation API expands upon the functionality of the Optimizely API to include functionality specific to Feature Experimentation projects.
Optimizely API
Use the Optimizely API for additional management that the Optimizely Feature Experimentation API does not cover. You can use the Optimizely API for other types of Experimentation projects, such as Web Experimentation and Full Stack (Legacy).
The Optimizely API has a rate limit of 100 requests per minute. The Get Campaign results and Get Experiment results endpoints have a rate limit of 20 requests per minute.
Note
Not all Optimizely API endpoints are available in Feature Experimentation.
The following Optimizely API endpoints are available in Optimizely Feature Experimentation:
- Attributes
- Audiences
- Impressions Usage
- Campaigns
- Change History
- Events
- Experiments – Only the Get Experiment results endpoint is available for Feature Experimentation.
- Reports
- Export Credentials
- Subject Access Request
- User
- Metrics
- Plan
- Projects
- Search
Optimizely Feature Experimentation Scheduling API
Use the Scheduling API to list, create, update, or delete scheduled changes for your flags and rules.
Permission service
Use the Permission Service API to get and update user permissions.
Optimizely Agent API
The Optimizely Agent API manages your Optimizely Feature Experimentation Agent instance.