PATCH /experiments/{experiment_id}

The Experiment ID of the Experiment you want to change

Default value: "application/json"

Action to change the state of the experiment. publish saves and stages your experiment. If you have not started your experiment or the experiment is paused, your changes will not be visible to visitors when you publish. start makes your experiment live to all visitors who are in your targeted audience and changes the status to running. pause stops the experiment and changes the status to paused. No new visitors will see a paused experiment until you restart it. See Differences among publish, start, and pause for details. resume resumes the experiment from a paused status without publishing any new changes. Status will be running. unarchive unarchives an archived experiment. Status will be paused.

Valid values:

• "resume"
• "unarchive"
• "start"
• "publish"
• "pause"

An ordered list of metrics to track for the Experiment

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

Valid values:

• "count"
• "sum"
• "unique"

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

Valid values:

• "revenue"
• "value"

The winning direction of this metric

Valid values:

• "decreasing"
• "increasing"

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"

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

Valid values:

• "event"
• "session"
• "visitor"

A list of Page IDs used in the Experiment. Only url_targeting or page_ids can be used when updating an experiment, but not both.

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

List of IDs of all variations in the Experiment

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

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'.

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.

Value of href attribute to add to element(s) matched by a selector

Value of HTML attribute to add to element(s) matched by a selector

Whether or not to remove the element(s) matched by a selector

Value of text attribute to add to the element(s) matched by a selector

Whether or not to hide the element(s) matched by a selector

Name of the class to set the element(s) matched by a selector to

Value of src attribute to add to element(s) matched by a selector

Value of style attribute to add to element(s) matched by a selector

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

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

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

Configuration properties for the extension

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

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

The ID of the change

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

Name of the change

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

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

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

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'

Valid values:

• "insert_image"
• "extension"
• "attribute"
• "custom_code"
• "custom_css"
• "redirect"
• "insert_html"

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

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

The share link for the provided Variation and Page combination

The ID of the Page to apply changes to

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

Whether the variation is archived

A description for the variation.

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

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

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

Current status of the variation

Valid values:

• "active"
• "archived"
• "paused"

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.

An immutable unique identifier for the variation. Required to update an existing variation.

The description or hypothesis for an Experiment

The time zone to use for Experiment start and stop times with respect to an IANA time zone (ex. "America/New_York"). The time zones expressed by GMT (e.g. "GMT-08:00") are no longer supported.

The start time for the Experiment, in date-time or date format (as defined by ISO 8601), and rounded to the nearest minute. If only date is supplied without time, the start time defaults to 00:00 on the specified start date.

The stop time for the Experiment, in date-time or full-date format (as defined by ISO 8601), and rounded to the nearest minute. If only date is supplied without time, the stop time defaults to 00:00 on the specified stop date.

How this page is activated. See the full documentation on the Page object.

Valid values:

• "manual"
• "url_changed"
• "immediate"
• "callback"
• "polling"
• "dom_changed"

Unique string identifier for this Page within the Project

Stringified Javascript function that determines when the Page is activated. Only required when activation_type is 'polling' or 'callback'.

Conditions to activate the experiment; our knowledge base article on Activation Types is the best guide for how to set up this data.

The unique identifier of the Page that represents the experiment or campaign's URL Targeting.

URL to load in the editor for this page

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

Update the Experiment's status in different Environments based on the environment key.

Valid values:

• "not_started"
• "paused"
• "running"

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

The unique identifier for the variation

The ID of the user being whitelisted

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

The ID of the change

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

Name of the change

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

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

The type of this change.

Valid values:

• "custom_code"
• "custom_css"

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

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

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.

Name of the Experiment

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

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.

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