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

Fetch the Ruleset for a Flag in an Environment

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

Fetch a Ruleset for a Flag in a specific Environment of a project.

The Ruleset contains the set of all Rules that apply to the Flag for that Environment.

URL Expired

The URL for this request expired after 30 days.

Path Params

project_id

integer

required

The project identifier

flag_key

string

required

The Flag identifier

environment_key

string

required

The Environment identifier

Responses

Response body

object

archived

boolean

Whether this Ruleset is archived or not. The ruleset is archived if the Flag was archived.

default_variation_key

string

User-facing Unique identifier of the Variation.

default_variation_name

string

User friendly identifer of the Variation.

disable_url

enable_url

enabled

boolean

Defaults to false

Indicates if the rule is enabled or not in an environment.

environment_id

number

Environment id.

environment_key

string

required

User-facing Environment identifier.

environment_name

string

Environment name.

fetch_default_variation_url

string

A url to the variation that will be executed if no rule audience is served.

fetch_flag_url

A url to fetch the Flag used by this Ruleset.

flag_key

string

required

User-facing Unique identifier of the Flag.

integer

revision

integer

Revision number for tracking changes

role

string

Granular permission role

rule_priorities

array of strings

required

Ordered array of rule keys for the set.

rule_priorities*

rules

object

status

string

status of ruleset.

draft running paused

update_url

updated_time

date-time

Timestamp when the Ruleset was last updated

url

required

Link to self

urn

string

required

The URN for the Ruleset

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

404

Not found. No content

Updated about 1 year ago

Reset the results for a Report

Update the Ruleset for a Flag in an Environment

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.optimizely.com/flags/v1/projects/project_id/flags/flag_key/environments/environment_key/ruleset \
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

Reset the results for a Report

Update the Ruleset for a Flag in an Environment

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?

Fetch the Ruleset for a Flag in an Environment

200Successful retrieval or update of a Ruleset. The response includes RESTful JSON (https://restfuljson.org/) styled links. If a link is not present in the response, it indicates a user is not authorized to access the related resource.

400Malformed requests and invalid parameter names and types

401Invalid credentials

403Do not have permission to perform the operation