About the Feature Experimentation APIs
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, which is hosted on GitHub.
Authentication and finding IDs
For information on generating API keys, see Generate tokens and use the REST APIsGenerate tokens and use the REST APIs. See Find IDs for API callsFind IDs for API calls for specific IDs required for certain API endpoints.
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 APIOptimizely 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 APIOptimizely 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 ExperimentationWeb Experimentation and Full Stack (Legacy)Full Stack (Legacy).
The Optimizely API has a rate limit of 100 requests per minute. The Get Campaign resultsGet Campaign results and Get Experiment resultsGet 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:
- AttributesAttributes
- AudiencesAudiences
- Impressions UsageImpressions Usage
- CampaignsCampaigns
- Change HistoryChange History
- EventsEvents
- ExperimentsExperiments – Only the Get Experiment resultsGet Experiment results and Get Experiment results as a CSVGet Experiment results as a CSV endpoints are available for Feature Experimentation.
- ReportsReports
- Export CredentialsExport Credentials
- Subject Access RequestSubject Access Request
- EnvironmentsEnvironments
- UserUser
- PlanPlan
- ProjectsProjects
- SearchSearch
Optimizely Feature Experimentation Scheduling API
Use the Scheduling API to list, create, update, or delete scheduled changesscheduled changes for your flags and rules.
Permission service
Use the Permission Service APIPermission Service API to get and update user permissions.
Optimizely Agent API
The Optimizely Agent APIOptimizely Agent API manages your Optimizely Feature Experimentation AgentAgent instance.