This page documents how to use the Optimizely FX API.
With this API you can view and manage Feature Flags and all of their
related entities including Variables, Variations, Rules, and Reports.

. Append any paths
listed in these docs onto that url in order to make requests to the API.

Analyze results

Introduction

ai_cta

ai_identity

ai_chat

ai_product


Data set that refers to a person or a role and contains at least one address via which the person or role can receive messages.

recipient

List Custom Fields for a project

feature-experimentation-api-docs

Feature Experimentation API

About the Feature Experimentation APIs

Generate tokens and use the REST APIs

REST API cookbook

Create a flag and variables

Create variations

Create events

Create attributes

Create audiences

Create experiment

Launch experiment

Conclude experiment

API Recipes

Create a new Custom Field

Update an existing Custom Field

Archive a Custom Field

Unarchive a Custom Field

Custom Fields

List Environments

Environments

List Flags

Update Flags

Create a New Flag

Archive Flags

Unarchive Flags

Delete a Flag

Fetch a Single Flag

Flags

List Reports

Archive Reports

Unarchive Reports

Delete a Report

Fetch a Single Report

Reset the results for a Report

Reports

Fetch the Ruleset for a Flag in an Environment

Update the Ruleset for a Flag in an Environment

Disable the Ruleset for a Flag in an Environment

Enable the Ruleset for a Flag in an Environment

Rulesets

Fetch holdouts for a specific rule_key

Fetch the Rule for a Ruleset in an Environment

List Rules

Fetch a Rule for a specific experiment_id

Rules

List Variations

Update Variations

Create a New Variation

Archive Variations

Brainstorm variations definitions using AI.

Unarchive Variations

Delete a Variation

Fetch a Single Variation

Variations

List Exclusion Groups

Update Exclusion Groups

Create an Exclusion Group

Archive Exclusion Groups

Unarchive Exclusion Groups

Delete an Exclusion Group

Fetch a Single Exclusion Group

Groups

Fetch all variable definitions for flag.

Update Variable Definitions

Create Variable Definition

Brainstorm variable definitions using AI.

Delete a Variable Definition

Fetch a single variable definition by its key.

Variable Definitions

Get Change History

Changes

List Holdouts for a project

Create a new Holdout

Delete a Holdout

Fetch a single Holdout

Update a Holdout using JSON Patch

Fetch experiments associated with a holdout

Holdouts

Download OpenAPI file

Model: AudienceConditions

Model: AudienceConditionsArray

Model: AudienceConditionsString

Model: BrainstormError

Model: BrainstormUserChat

Model: BrainstormVariableDefinition

Model: BrainstormVariablesChat

Model: BrainstormVariablesInteraction

Model: BrainstormVariablesResponse

Model: BrainstormVariation

Model: BrainstormVariationsChat

Model: BrainstormVariationsInteraction

Model: BrainstormVariationsResponse

Model: BulkOperationsRequestBody

Model: ChangeHistory

Model: Environment

Model: EnvironmentMap

Model: Environments

Model: EventPropertyCondition

Model: Flag

Model: FlagEnvironment

Model: FlagMap

Model: FlagRequestBody

Model: Flags

Model: CustomField

Model: CustomFieldRequestBody

Model: CustomFieldUpdateRequestBody

Model: CustomFieldsList

Model: Group

Model: GroupMap

Model: GroupRequestBody

Model: GroupRule

Model: GroupRuleMap

Model: Groups

Model: Holdout

Model: HoldoutExperiment

Model: HoldoutExperiments

Model: HoldoutMap

Model: HoldoutRequestBody

Model: HoldoutsList

Model: HoldoutsPaginatedList

Model: Metric

Model: PatchRequestBody

Model: ProblemDetail

Model: Report

Model: ReportMap

Model: Reports

Model: Rule

Model: RuleAllowList

Model: RuleDetails

Model: RuleGroupRule

Model: RuleMap

Model: RuleVariation

Model: Rules

Model: Ruleset

Model: RulesetRule

Model: RulesetRuleVariation

Model: RulesetSummary

Model: SubMetric

Model: UrlList

Model: UrlValue

Model: VariableDefinition

Model: VariableDefinitions

Model: VariableValue

Model: Variation

Model: VariationMap

Model: VariationRequestBody

Model: Variations

Models

Optimizely Feature Experimentation API

Overview

Projects

Campaigns

Experiments

Audiences

Pages

Events

Attributes

Extensions

Plan

Scheduled Jobs

User

List Attributes

Sections

Features

Subject Access Requests

Search

Change History

Attribution

Export Credentials

Impressions Usage

Collaborators

ExperimentSummary

Webhooks

Recommendations

Optimizely API 2.0

Optimizely API

Get User Permissions For Project Entity Type

Get Team Permissions For Project Entity Type

Get Entity Permissions

Change Permissions

Entity

Get Teams

Create Team

Delete Team

Get Team Info

Update Team

Team Management

Model: AccountRole

Model: EntityPermission

Permission Service