List Experiments

get https://api.optimizely.com/v2/experiments

Get a list of all the Experiments by Project or Campaign. Either the project_id or campaign_id query parameter is required.

Query Params

per_page

integer

≤ 100

Defaults to 25

Optional pagination argument that specifies the maximum number of objects to return per request

page

integer

Defaults to 1

Optional pagination argument that specifies the page to return. If you have 140 objects and you choose to return 100 objects per page you will be able to access the last 40 objects on page 2. The default value is 1.

project_id

int64

The Project ID of the Project you would like to list all Experiments for. You have to either use this argument or the campaign_id argument

campaign_id

int64

The Campaign ID of the Campaign you would like to list all Experiments for. You have to either use this argument or the project_id argument

include_classic

boolean

Defaults to false

Whether or not to include classic Experiments in the list of Experiments. If this parameter is not provided it will default to false

Responses

Response body

array of objects

object

allocation_policy

string

Traffic allocation policy across variations in this experiment

audience_conditions

string

Defaults to everyone

The audiences that should see this experiment. To target everyone, use the string "everyone" or omit this field. Multiple audiences can be combined with "and" or "or" using the same structure as audience conditions

campaign_id

int64

For Personalization experiences, this ID corresponds to the parent Campaign. For standalone experiments this campaign_id does not correspond to a campaign object.

changes

array of objects

Custom CSS or JavaScript that will run before all variations in the Experiment (for Experiments in Web Projects only)

changes

object

async

boolean

Indicates whether or not to execute the change asyncronously. If true, src will be returned in the response. Otherwise, it will be not included.

dependencies

array of strings

A list of dependent change IDs that must happen before this change

dependencies

string

The ID of the change

name

string

Name of the change

selector

string

CSS selector to determine where changes are applied. Required for changes of type 'custom_css'.

src

string

The path to the change payload on the CDN. Only present if 'async' is True.

type

string

required

The type of this change.

custom_code custom_css

value

string

required

The value for the change can be JavaScript or CSS as a string.

created

date-time

The time when the Experiment was initially created

description

string

The description or hypothesis for an Experiment

earliest

date-time

The first time the Experiment was activated

environments

object

String identifier for the Experiment's status in each Environment based on the environment key.

feature_id

int64

The ID of a Feature to attach to the Experiment. This turns an Experiment into a Feature Test.

feature_key

string

The key for the Feature attached to the Experiment. Applies to Feature Tests only. Valid keys contain alphanumeric characters, hyphens, and underscores, and are limited to 64 characters.

feature_name

string

The feature flag name to display in the Optimizely app. Whitespaces and other non-alphanumeric characters allowed. Defaults to feature key if left empty.

holdback

integer

0 to 10000

Percent of traffic to exclude from the experiment, measured in basis points. 100 basis points = 1% traffic. For example, a value of 9900 would mean that 1% of visitors will be eligible for the experiment. This is only applicable for Web.

int64

The unique identifier for the Experiment

is_classic

boolean

Defaults to false

Whether or not the Experiment is a classic Experiment. If true, the Experiment is read-only

key

string

length ≤ 64

Unique string identifier for this Experiment within the Project. Only applicable for Full Stack and Mobile projects.

last_modified

date-time

The last time the Experiment was modified

latest

date-time

The last time the Experiment was paused (not present if the Experiment is still running). For campaign experiences, this field represents the last time the Campaign was paused.

metrics

array of objects

Defaults to

An ordered list of metrics to track for the Experiment. Required for Web, Full Stack, and Mobile Experimentation. Not applicable for Web Personalization Experiences.

metrics

object

aggregator

string

The aggregation function for the numerator of the metric. 'unique' measures the number of unique visitors/sessions that include the specified Event. 'count' measures the total number of occurrences of Event for the scope (visitor/session). 'sum' is the sum of the 'field' value

unique count sum bounce exit ratio

event_id

int64 | null

The ID for the Event to select data from. Omitted for global metrics that are not relative to a specific Event, i.e. "overall revenue"

event_properties

object

The conditions used to filter the metric on specific event property values.

field

string

The field to aggregate for the numerator of the metric. Required when 'aggregator' = 'sum', otherwise omitted

revenue value

metrics

array of objects

A list of all metrics that will be used in the calculation of a ratio metric.

metrics

object

aggregator

string

Defaults to unique

unique count sum

event_id

int64 | null

The ID for the Event to select data from.

event_type

string

The type of this Event.

custom click pageview

field

string | null

The field to aggregate for the numerator of the metric. Required when 'aggregator' = 'sum', otherwise omitted.

revenue value

scope

string

Defaults to visitor

Specifies how Events should be grouped. Can also be thought of as the denominator of the metric. 'session' divides by the number of sessions. "Influenced sessions", or sessions that do not contain a decision Event but carry a decision from a previous session are not included in counts for numerator or denominator. 'visitor' divides by the number of visitors. 'event' divides by the total occurrences (impressions) of the specified Event.

session visitor event

scope

string

Specifies how Events should be grouped together. Can also be thought of as the denonimator of the metric. 'session' divides by the number of sessions. "Influenced sessions", or sessions that do not contain a decision Event but carry a decision from a previous session are not included in counts for numerator or denominator. 'visitor' divides by the number of visitors. 'event' divides by the total occurrences (impressions) of the specified Event

session visitor event

time_window

string

The maximum amount of time a numerator event can differ from a denominator event in order to be included in a ratio metric. This can be an integer, or an integer followed by a letter denoting the unit of time (d = days, h = hours, m = minutes). If no unit of time is supplied, hours is assumed. If no value is supplied, a time window of 48 hours is assumed.

winning_direction

string

The winning direction of this metric

increasing decreasing

multivariate_traffic_policy

string

For Experiments of type multivariate, this specifies how the weights and statuses of combinations will be decided. In full_factorial mode, | combination weights are read-only, and are generated by multiplying together weights of section variations.

full_factorial

name

string

Name of the Experiment. Required for Web Experimentation. Optional for Web Personalization experiences and Full Stack experiments. Not applicable for Mobile Experiments.

page_ids

array of int64s

A list of Page IDs used in the Experiment. url_targeting or page_ids, but not both.

page_ids

project_id

int64

required

The Project the Experiment is in

results_token

string

temporary token based on experiment id, used to access data platform services from other parts of the product

schedule

object

status

string

Current state of the Experiment.
In Full Stack, this is the Experiment's state in the primary (production) environment.

running paused archived campaign_paused concluded not_started

traffic_allocation

integer

0 to 10000

Percent of traffic allocated for the experiment, measured in basis points. 100 basis points = 1% traffic. For example, a value of 5500 would mean that 55% of visitors will be eligible for the experiment. This is only applicable for Full Stack.

type

string

Defaults to a/b

Indicates whether this is an a/b, multivariate, feature, or multiarmed_bandit test or an experience within a personalization campaign. Note that the default for this field is a/b. If another test type is desired, populate this field with the appropriate string (from one of the possible values).

a/b feature multivariate personalization multiarmed_bandit

url_targeting

object

variations

array of objects

A list of variations that each define an experience to show in the context of the Experiment for the purpose of comparison against each other

variations

object

actions

array of objects

A collection of changes to run for each page in an experiment. Only applicable to Optimizely X Web.

actions

object

changes

array of objects

The list of changes to apply to the Page. If 'dependencies' is supplied in a Change within 'changes', each ID in 'dependencies' must also be in 'changes'.

changes

object

allow_additional_redirect

boolean

Whether or not to allow additional redirects after redirecting to destination. Required for changes of type 'redirect'

async

boolean

Indicates whether or not to execute the change asyncronously. If true, src will be returned in the response. Otherwise, it will be not included.

attributes

object

config

object

Configuration properties for the extension

Has additional fields

css

object

dependencies

array of strings

A list of dependent change IDs that must happen before this change

dependencies

destination

string

URL to redirect to. Required for changes of type 'redirect'. destination and destination_function cannot be used at the same time

destination_function

string

A function string to redirect to. Required for changes of type 'redirect'. destination and destination_function cannot be used at the same time

extension_id

string

ID of the extension to insert. Required for changes of type 'extension'

string

The ID of the change

name

string

Name of the change

operator

string

Where to instert HTML or image for types 'insert_html' and 'insert_image' with respect to the element(s) matched by 'selector'

preserve_parameters

boolean

Whether or not to preserve parameters from original request when redirecting to new destination URL. Required for changes of type 'redirect'. For redirects using destination_function, preserve_parameters must be false.

rearrange

object

A directive to place the DOM element(s) matched by 'selector' to the position of the element matched by 'insertSelector', with the relation specified by 'operator'. The supplied example moves element matched by 'selector' above the element of class .greyBox

Has additional fields

selector

string

CSS selector to determine where changes are applied. Required for changes of type 'attribute', 'insert_html', and 'insert_image'

src

string

The path to the change payload on the CDN. Only present if 'async' is True.

type

string

required

The type of this change.

Changes of type 'attribute' have required fields 'selector' and 'attributes'
Changes of type 'custom_code' have required field 'value'
Changes of type 'custom_css' have required field 'value'
Changes of type 'extension' have required field 'extension_id'
Changes of type 'insert_html' have required field 'selector'
Changes of type 'insert_image' have required field 'selector'
Changes of type 'redirect' have required fields 'destination', 'preserve_parameters', and 'allow_additional_redirect'

attribute custom_code custom_css extension insert_html insert_image redirect

value

string

The value for the change can be custom Javascript or CSS as a string. Required for changes of type 'custom_css' and 'custom_code'

page_id

int64

required

The ID of the Page to apply changes to

share_link

url

The share link for the provided Variation and Page combination

archived

boolean

Whether the variation is archived

description

string

A description of the variation.

feature_enabled

boolean

For Feature Tests, indicates if the feature should be enabled for the variation

key

string

length ≤ 64

Unique string identifier for this variation within the Experiment. Only applicable for Full Stack and Mobile projects.

name

string

The name of the variation. Required for Web Experiments and Personalization experiences. Not required for Full Stack Experiments.

status

string

Current status of the variation

active paused archived

variable_values

object

For Feature Tests, the variable values for the variation represented as a map of Variable keys to their values.

Has additional fields

variation_id

int64

The unique identifier for the variation

weight

integer

required

0 to 10000

The percentage of your visitors that should see this variation, measured in basis points. 100 basis points = 1% traffic. Variation weights must add up to 10000.

whitelist

array of objects

A list containing the user IDs and variations of users who have been whitelisted

whitelist

object

user_id

string

required

The ID of the user being whitelisted

variation_id

int64

required

The unique identifier for the variation

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.optimizely.com/v2/experiments?per_page=25&page=1&include_classic=false' \
3
     --header 'accept: application/json'

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

application/json

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

List Experiments

200Return all Experiments

401Invalid credentials

403You do not have access to Experiments under the specified Project or Campaign

404Project not found

defaultUnexpected error