Jump to Content
Dev guide
API Reference
Recipes
Changelog
User Guide
Dev guide
Recipes
API Reference
Changelog
Commerce Connect
Configured Commerce
Content Management System
Content Marketing Platform
Cross-platform products
Digital Experience Platform
Experimentation Data
Feature Experimentation
Optimizely Connect Platform
Optimizely Data Platform
Performance Edge
Recommendations
Web Experimentation
Campaign
Deprecated Products
Dev guide
API Reference
Recipes
Changelog
User Guide
GitHub
Dev Community
Optimizely Academy
Submit a ticket
Log In
API Reference
GitHub
Dev Community
Optimizely Academy
Submit a ticket
Log In
Feature Experimentation
API Reference
Overview
All
Pages
Start typing to search…
JUMP TO
Rest APIS
About the Feature Experimentation APIs
Generate tokens and use the REST APIs
REST API cookbook
Optimizely Feature Experimentation API
Environments
List Environments
get
Flags
List Flags
get
Update Flags
patch
Create a New Flag
post
Archive Flags
post
Unarchive Flags
post
Delete a Flag
del
Fetch a Single Flag
get
Reports
List Reports
get
Archive Reports
post
Unarchive Reports
post
Delete a Report
del
Fetch a Single Report
get
Reset the results for a Report
post
Rulesets
Fetch the Ruleset for a Flag in an Environment
get
Update the Ruleset for a Flag in an Environment
patch
Disable the Ruleset for a Flag in an Environment
post
Enable the Ruleset for a Flag in an Environment
post
Rules
Fetch the Rule for a Ruleset in an Environment
get
List Rules
get
Fetch holdouts for a specific rule_key
get
Fetch a Rule for a specific experiment_id
get
Variations
List Variations
get
Update Variations
patch
Create a New Variation
post
Archive Variations
post
Brainstorm variations definitions using AI.
post
Unarchive Variations
post
Delete a Variation
del
Fetch a Single Variation
get
Groups
List Exclusion Groups
get
Update Exclusion Groups
patch
Create an Exclusion Group
post
Archive Exclusion Groups
post
Unarchive Exclusion Groups
post
Delete an Exclusion Group
del
Fetch a Single Exclusion Group
get
Variable Definitions
Fetch all variable definitions for flag.
get
Update Variable Definitions
patch
Create Variable Definition
post
Brainstorm variable definitions using AI.
post
Delete a Variable Definition
del
Fetch a single variable definition by its key.
get
Changes
Get Change History
get
Holdouts
List Holdouts for a project
get
Create a new Holdout
post
Delete a Holdout
del
Fetch a single Holdout
get
Update a Holdout using JSON Patch
post
Fetch experiments associated with a holdout
get
Custom Fields
List Custom Fields
get
Create a New Custom Field
post
Update a Custom Field
patch
Archive a Custom Field
post
Unarchive a Custom Field
post
Optimizely API
Overview
Projects
List Projects
get
Create a Project
post
Read a Project
get
Update a Project
patch
Campaigns
List Campaigns
get
Create a Campaign
post
Archive a Campaign
del
Read a Campaign
get
Update a Campaign
patch
Get Campaign results
get
Get a sharable link for the campaign's results page
get
Get Campaign results as a CSV
get
Experiments
List Experiments
get
Create an Experiment
post
Archive an Experiment
del
Read an Experiment
get
Update an Experiment
patch
Get Experiment results
get
Get a sharable link for the experiment's results page
get
Get Experiment results time series
get
Get Experiment results as a CSV
get
Audiences
List Audiences
get
Create an Audience
post
Read an Audience
get
Update an Audience
patch
Pages
List Pages
get
Create a Page
post
Archived a Page
del
Read a page
get
Update a Page
patch
Events
List all Events
get
Get Event by ID
get
Create an In-Page Event
post
Archive an In-Page Event
del
Update an In-Page Event
patch
Create a Custom Event
post
Archive a Custom Event
del
Update a Custom Event
patch
Attributes
List Attributes
get
Create an Attribute
post
Archive an Attribute
del
Read an Attribute
get
Update an Attribute
patch
Groups
List Exclusion Groups
get
Create an Exclusion Group
post
Archive an Exclusion Group
del
Get an Exclusion Group
get
Update an Exclusion Group
patch
Extensions
List Extensions
get
Create an Extension
post
Archive an Extension
del
Get an Extension
get
Update an Extension
patch
Plan
Get Plan & Usage information for all products
get
Scheduled Jobs
Get a list of Scheduled Jobs
get
Create a Scheduled Job
post
Archive a Scheduled Job
del
Get a Scheduled Job
get
Update a Scheduled Job
patch
User
Get current User information
get
List Attributes
Get list attributes by project
get
Create a List Attribute
post
Archive a List Attribute
del
Read a List Attribute
get
Update a List Attribute
patch
Sections
Read all the Sections in a Multivariate Test
get
Create a new Section in a Multivariate Test
post
Archive a Section by ID
del
Read a Section of a Multivariate Test
get
Update a Section by ID
patch
Features
Get Features by Project
get
Create a Feature
post
Archive a Feature
del
Read a Feature
get
Update a Feature
patch
Subject Access Requests
List Subject Access Requests by data source and status
get
Update a Subject Access Request
patch
Update a Subject Access Request
post
List Subject Access Requests
get
Create a Subject Access Request
post
Get Subject Access Request
get
Environments
Get Environments by Project
get
Create an Environment
post
Archive an Environment
del
Read an Environment
get
Update an Environment
patch
Read the datafile of an Environment
get
Search
Search
get
Change History
Retrieve changes for a project.
get
Attribution
Get bucketing information for a visitor
get
Export Credentials
Get aws credentials to access enriched events dataset
get
Impressions Usage
Get Impressions Usage
get
Get Impressions Usage Summary
get
Collaborators
List Collaborators
get
Invite Collaborators
post
List Collaborators who have not yet accepted the invitations
get
ExperimentSummary
Summaries of Experiments and Campaigns
get
Reports
Get Experiment Result's Report
get
Webhooks
Get Webhooks by Project
get
Create a Webhook
post
Delete a Webhook
del
Read a Webhook
get
Update a Webhook
patch
Recommendations
Download a CSV with all current catalog data
get
Download a CSV with all computed recommendations output data
get
Download a CSV with summary stats data
get
Permission Service
Entity
Get User Permissions For Project Entity Type
get
Get Team Permissions For Project Entity Type
get
Get Entity Permissions
get
Change Permissions
patch
Team Management
Get Teams
get
Create Team
post
Delete Team
del
Get Team Info
get
Update Team
patch
Optimizely Flags Scheduling API
Scheduled Changes
List Scheduled changes of a flag
get
Create a Schedule Change for a flag in an environment
post
Scheduled Change
Delete a Scheduled Change for a flag in an environment
del
Update the Scheduled Change for a flag in an environment
patch
Optimizely Agent API
/v1/config
Return the Optimizely config for the given environment
get
/v1/datafile
Return the datafile for the given environment. If you need strict consistency, you can pass the datafile to other Optimizely instances. so that all initialize from exactly the same datafile version (rather than each fetching the datafile separately from the Optimizely CDN).
get
/v1/decide
Decide makes feature decisions for the selected query parameters.
post
/v1/lookup
Lookup returns saved user profile.
post
/v1/save
Save saves user profile.
post
/v1/track
Track event for the given user.
post
/v1/send-odp-event
Send event to Optimizely Data Platform (ODP).
post
/v1/activate
Activate selected features and experiments for the given user.
post
/v1/override
Override an experiment decision for a user
post
/oauth/token
Get JWT token to authenticate all requests.
post
/v1/batch
Batch multiple API endpoints into one request.
post
Powered by
Overview
Ask AI
Overview of the Optimizely API in Feature Experimentation.
