About the Feature Experimentation APIs
Generate tokens and use the REST APIs
REST API cookbook

Environments
- List Environmentsget
Flags
Reports
Rulesets
Rules
Variations
Groups
Variable Definitions
Changes
- Get Change Historyget
Holdouts

Overview
Projects
Campaigns
Experiments
Audiences
Pages
Events
Attributes
Groups
Extensions
Plan
- Get Plan & Usage information for all productsget
Scheduled Jobs
User
- Get current User informationget
List Attributes
Sections
Features
Subject Access Requests
Environments
Search
- Searchget
Change History
- Retrieve changes for a project.get
Attribution
- Get bucketing information for a visitorget
Export Credentials
- Get aws credentials to access enriched events datasetget
Impressions Usage
- Get Impressions Usageget
- Get Impressions Usage Summaryget
Collaborators
ExperimentSummary
- Summaries of Experiments and Campaignsget
Reports
- Get Experiment Result's Reportget
Webhooks
Recommendations

Entity
Team Management

Scheduled Changes
- List Scheduled changes of a flagget
- Create a Schedule Change for a flag in an environmentpost
Scheduled Change
- Delete a Scheduled Change for a flag in an environmentdelete
- Update the Scheduled Change for a flag in an environmentpatch

/v1/config
- Return the Optimizely config for the given environmentget
/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 userpost
/oauth/token
- Get JWT token to authenticate all requests.post
/v1/batch
- Batch multiple API endpoints into one request.post

MetricSets
Metrics

List Environments

get https://api.optimizely.com/flags/v1/projects/{project_id}/environments

Get a list of Environments within a Project
You can use query parameters to filter/sort the response.

URL Expired

The URL for this request expired after 30 days.

Path Params

project_id

integer

required

The project identifier

Query Params

per_page

int64

The max number of items to include per page or results.

page_token

string

Pagination page token. Implements prev, next, last, first

page_window

integer

Number of previous and next page links to supply for the request (defaults to 1).

archived

boolean

Filter the Environments by archived. An Environment can be either archived (archived=true) or unarchived (archived=false)

sort

array of strings

Sort the Environments based on the attributes from left to right.

sort

Responses

Response body

object

count

integer

required

Number of Environments on the current page.

filter_url

string

A single url.

first_url

string

required

A single url.

items

array of objects

required

items*

object

account_id

int64

The ID of the Account

archived

boolean

required

int64

The ID of the Environment

key

string

required

length ≤ 64

User-facing key to identify this Environment.

name

string

required

Name of the Environment.

priority

integer

required

Integer representing the priority of the Environment. This is used for ordering in the UI.

project_id

int64

required

The ID of the Project this Flag belongs to

revision

integer

Revision number for tracking changes

role

string

Granular permission role

last_url

string

required

A single url.

next_url

array of strings

A list of urls.

next_url

page

integer

required

Number of the current page. 1-index based.

prev_url

array of strings

A list of urls.

prev_url

reset_url

string

A single url.

total_count

integer

required

Total number of Environments for this series.

total_pages

integer

required

Total number of pages for this series.

url

string

required

A single url.

Response body

object

detail

string

required

A human-readable explanation specific to this occurrence of the problem.

status

integer

required

The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

title

string

required

A short, human-readable summary of the problem type.

type

string

required

A URI reference [RFC3986] that identifies the problem type. Contains 'about:blank' if unspecified.

uuid

string

Error reference for customer support

Response body

object

detail

string

required

A human-readable explanation specific to this occurrence of the problem.

status

integer

required

The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

title

string

required

A short, human-readable summary of the problem type.

type

string

required

A URI reference [RFC3986] that identifies the problem type. Contains 'about:blank' if unspecified.

uuid

string

Error reference for customer support

Response body

object

detail

string

required

A human-readable explanation specific to this occurrence of the problem.

status

integer

required

The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

title

string

required

A short, human-readable summary of the problem type.

type

string

required

A URI reference [RFC3986] that identifies the problem type. Contains 'about:blank' if unspecified.

uuid

string

Error reference for customer support

Updated about 1 year ago

REST API cookbook

Flags

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.optimizely.com/flags/v1/projects/project_id/environments \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

Updated about 1 year ago

REST API cookbook

Flags

Rest APIS
About the Feature Experimentation APIs
Generate tokens and use the REST APIs
REST API cookbook

Optimizely Feature Experimentation API
Environments
List Environmentsget
Flags
Fetch a Single Flagget
Delete a Flagdelete
Unarchive Flagspost
Archive Flagspost
Create a New Flagpost
Update Flagspatch
List Flagsget
Reports
Reset the results for a Reportpost
Fetch a Single Reportget
Delete a Reportdelete
Unarchive Reportspost
Archive Reportspost
List Reportsget
Rulesets
Enable the Ruleset for a Flag in an Environmentpost
Disable the Ruleset for a Flag in an Environmentpost
Update the Ruleset for a Flag in an Environmentpatch
Fetch the Ruleset for a Flag in an Environmentget
Rules
Fetch a Rule for a specific experiment_idget
Fetch holdouts for a specific rule_keyget
List Rulesget
Fetch the Rule for a Ruleset in an Environmentget
Variations
Fetch a Single Variationget
Delete a Variationdelete
Unarchive Variationspost
Brainstorm variations definitions using AI.post
Archive Variationspost
Create a New Variationpost
Update Variationspatch
List Variationsget
Groups
Fetch a Single Exclusion Groupget
Delete an Exclusion Groupdelete
Unarchive Exclusion Groupspost
Archive Exclusion Groupspost
Create an Exclusion Grouppost
Update Exclusion Groupspatch
List Exclusion Groupsget
Variable Definitions
Fetch a single variable definition by its key.get
Delete a Variable Definitiondelete
Brainstorm variable definitions using AI.post
Create Variable Definitionpost
Update Variable Definitionspatch
Fetch all variable definitions for flag.get
Changes
Get Change Historyget
Holdouts
Update Holdoutspost
Fetch a single Holdoutget
Delete a Holdoutdelete
Create a new Holdoutpost
List Holdouts for a projectget

Optimizely API
Overview
Projects
Update a Projectpatch
Read a Projectget
Create a Projectpost
List Projectsget
Campaigns
Get Campaign results as a CSVget
Get a sharable link for the campaign's results pageget
Get Campaign resultsget
Update a Campaignpatch
Read a Campaignget
Archive a Campaigndelete
Create a Campaignpost
List Campaignsget
Experiments
Get Experiment results as a CSVget
Get Experiment results time seriesget
Get a sharable link for the experiment's results pageget
Get Experiment resultsget
Update an Experimentpatch
Read an Experimentget
Archive an Experimentdelete
Create an Experimentpost
List Experimentsget
Audiences
Update an Audiencepatch
Read an Audienceget
Create an Audiencepost
List Audiencesget
Pages
Update a Pagepatch
Read a pageget
Archived a Pagedelete
Create a Pagepost
List Pagesget
Events
Update a Custom Eventpatch
Archive a Custom Eventdelete
Create a Custom Eventpost
Update an In-Page Eventpatch
Archive an In-Page Eventdelete
Create an In-Page Eventpost
Get Event by IDget
List all Eventsget
Attributes
Update an Attributepatch
Read an Attributeget
Archive an Attributedelete
Create an Attributepost
List Attributesget
Groups
Update an Exclusion Grouppatch
Get an Exclusion Groupget
Archive an Exclusion Groupdelete
Create an Exclusion Grouppost
List Exclusion Groupsget
Extensions
Update an Extensionpatch
Get an Extensionget
Archive an Extensiondelete
Create an Extensionpost
List Extensionsget
Plan
Get Plan & Usage information for all productsget
Scheduled Jobs
Update a Scheduled Jobpatch
Get a Scheduled Jobget
Archive a Scheduled Jobdelete
Create a Scheduled Jobpost
Get a list of Scheduled Jobsget
User
Get current User informationget
List Attributes
Update a List Attributepatch
Read a List Attributeget
Archive a List Attributedelete
Create a List Attributepost
Get list attributes by projectget
Sections
Update a Section by IDpatch
Read a Section of a Multivariate Testget
Archive a Section by IDdelete
Create a new Section in a Multivariate Testpost
Read all the Sections in a Multivariate Testget
Features
Update a Featurepatch
Read a Featureget
Archive a Featuredelete
Create a Featurepost
Get Features by Projectget
Subject Access Requests
Get Subject Access Requestget
Create a Subject Access Requestpost
List Subject Access Requestsget
Update a Subject Access Requestpost
Update a Subject Access Requestpatch
List Subject Access Requests by data source and statusget
Environments
Read the datafile of an Environmentget
Update an Environmentpatch
Read an Environmentget
Archive an Environmentdelete
Create an Environmentpost
Get Environments by Projectget
Search
Searchget
Change History
Retrieve changes for a project.get
Attribution
Get bucketing information for a visitorget
Export Credentials
Get aws credentials to access enriched events datasetget
Impressions Usage
Get Impressions Usage Summaryget
Get Impressions Usageget
Collaborators
List Collaborators who have not yet accepted the invitationsget
Invite Collaboratorspost
List Collaboratorsget
ExperimentSummary
Summaries of Experiments and Campaignsget
Reports
Get Experiment Result's Reportget
Webhooks
Update a Webhookpatch
Read a Webhookget
Delete a Webhookdelete
Create a Webhookpost
Get Webhooks by Projectget
Recommendations
Download a CSV with summary stats dataget
Download a CSV with all computed recommendations output dataget
Download a CSV with all current catalog dataget

Permission Service
Entity
Change Permissionspatch
Get Entity Permissionsget
Get Team Permissions For Project Entity Typeget
Get User Permissions For Project Entity Typeget
Team Management
Update Teampatch
Get Team Infoget
Delete Teamdelete
Create Teampost
Get Teamsget

Optimizely Flags Scheduling API
Scheduled Changes
Create a Schedule Change for a flag in an environmentpost
List Scheduled changes of a flagget
Scheduled Change
Update the Scheduled Change for a flag in an environmentpatch
Delete a Scheduled Change for a flag in an environmentdelete

Optimizely Agent API
/v1/config
Return the Optimizely config for the given environmentget
/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 userpost
/oauth/token
Get JWT token to authenticate all requests.post
/v1/batch
Batch multiple API endpoints into one request.post

Metrics Hub Service API
MetricSets
List Metric Sets by Metric idsget
Update a Metric Setpatch
Delete Metric Setsdelete
Create a Metric Setput
List Metric Setsget
Metrics
Delete a Metricdelete
Read a Metricget
Update a Metricpatch
Create a Metricpost
List Metricsget

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

List Environments

400Malformed requests and invalid parameter names and types

401Invalid credentials

403Do not have permission to perform the operation