Model: ExperimentUpdate

1 min

Model Parameters

ExperimentUpdate
- audience_conditionsstring
  Example
```
[
  "and",
  {
    "audience_id": 7000
  },
  {
    "audience_id": 7001
  }
]
```
  Description
  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
- changesSharedCodeChange[]
  Description
  Custom CSS or JavaScript that will run before all variations in the Experiment (for Experiments in Web Projects only)
  - asyncboolean
    Description
    Indicates whether or not to execute the change asyncronously. If true, src will be returned in the response. Otherwise, it will be not included.
  - dependenciesstring[]
    Example
    [ "993fd09c-b64a-4c13-95a9-13b3ed2c454e", "95cf0144-fb63-431d-829b-193fe55ada18" ]
    Description
    A list of dependent change IDs that must happen before this change
  - idstring<uuid>
    Description
    The ID of the change
    Format
    uuid
  - namestring
    Example
    Setting button text
    Description
    Name of the change
  - selectorstring
    Example
    head
    Description
    CSS selector to determine where changes are applied. Required for changes of type 'custom_css'.
  - srcstring
    Description
    The path to the change payload on the CDN. Only present if 'async' is True.
  - typestring<custom_code | custom_css>required
    Description
    The type of this change.
    Allowed
    custom_codecustom_css
  - valuestringrequired
    Example
    window.someGlobalFunction();
    Description
    The value for the change can be JavaScript or CSS as a string.
- custom_field_valuesmap<string, string>
  Description
  Map of custom field api_name to value for the Experiment's parent Campaign. Keys correspond to the api_name of a custom field definition for the Project, and values are typed according to that definition's field_type. Updating these values on an A/B or Multivariate experiment updates the parent Campaign. Not supported for personalization experiences — update those via the parent Campaign endpoint. Send an empty object to clear all values.
- descriptionstring
  Example
  AB Test to see if the Blue Button converts more visitors
  Description
  The description or hypothesis for an Experiment
- environmentsmap<string, ExperimentEnvironmentUpdate>
  Description
  String identifier for the Experiment's status in each Environment based on the environment key.
- feature_idinteger<int64>
  Example
  1000
  Description
  The ID of a Feature to attach to the Experiment. This turns an Experiment into a Feature Test.
  Format
  int64
- holdbackinteger
  Example
  5000
  Description
  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.
  Minimum
  0
  Maximum
  10000
- keystring
  Example
  home_page_experiment
  Description
  Unique string idz for this Experiment within the Project. Only applicable for Full Stack and Mobile projects.
  Max Length
  64
  Pattern
  ^[a-zA-Z0-9_\-]+$
- metricsMetric[]
  Description
  An ordered list of metrics to track for the Experiment
  - aggregatorstring<unique | count | sum | bounce | exit | ratio>
    Description
    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
    Allowed
    uniquecountsumbounceexitratio
  - display_titlestring
    Description
    Display title for the metric
  - event_idinteger<int64>
    Description
    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"
    Format
    int64
  - event_propertiesMetricEventProperties
    Description
    The conditions used to filter the metric on specific event property values.
    - filterMetricFilter
      Description
      The set of event property conditions a conversion must match to be counted toward the metric.
      - combine_operatorstring<and | or>
        Description
        Determines whether all conditions (and) or any condition (or) must be met.
        Allowed
        andor
      - conditionsMetricFilterCondition[]
        Description
        defines the event property values and operator used to check whether the conversion meets the condition.
        namestring
        Description
        The name of the event property to match to.
        operatorstring<equal_to | not_equal_to | greater_than | greater_than_or_equal_to | less_than | less_than_or_equal_to | contains | does_not_contain>
        Description
        The type of match to be performed. equal_to and not_equal_to are available for all property types. greater_than, greater_than_or_equal_to, less_than, and less_than_or_equal_to are only available for properties with type number. contains and does_not_contain are only available for properties with type string.
        Allowed
        equal_tonot_equal_togreater_thangreater_than_or_equal_toless_thanless_than_or_equal_tocontainsdoes_not_contain
        typestring<boolean | number | string>
        Description
        The data type of the event property.
        Allowed
        booleannumberstring
        valuestring
        Description
        The value the conversion's property should match, according to the operator.
  - fieldstring<revenue | value>
    Description
    The field to aggregate for the numerator of the metric. Required when 'aggregator' = 'sum', otherwise omitted
    Allowed
    revenuevalue
  - metricsCompoundSubMetric[]
    Description
    A list of all metrics that will be used in the calculation of a ratio metric.
    - aggregatorstring<unique | count | sum>
      Description
      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.
      Default
      unique
      Allowed
      uniquecountsum
    - event_idinteger<int64>
      Description
      The ID for the Event to select data from.
      Format
      int64
    - event_typestring<custom | click | pageview>
      Description
      The type of this Event.
      Allowed
      customclickpageview
    - fieldstring<revenue | value>
      Description
      The field to aggregate for the numerator of the metric. Required when 'aggregator' = 'sum', otherwise omitted.
      Allowed
      revenuevalue
    - scopestring<session | visitor | event>
      Description
      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.
      Default
      visitor
      Allowed
      sessionvisitorevent
  - scopestring<session | visitor | event>
    Description
    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
    Allowed
    sessionvisitorevent
  - time_windowstring
    Description
    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_directionstring<increasing | decreasing>
    Description
    The winning direction of this metric
    Allowed
    increasingdecreasing
- namestring
  Example
  Blue Button Experiment
  Description
  Name of the Experiment
- page_idsinteger[]
  Description
  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.
- scheduleScheduleUpdate
  - start_timestring
    Example
    2019-02-20T15:00
    Description
    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
    on the specified start date.
    Pattern
    ^\d{4}-\d{2}-\d{2}(T\d{2}(:\d{2}(:00(.000)?)?)?((Z)?))?$
  - stop_timestring
    Example
    2019-02-20T18:00
    Description
    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
    on the specified stop date.
    Pattern
    ^\d{4}-\d{2}-\d{2}(T\d{2}(:\d{2}(:00(.000)?)?)?((Z)?))?$
  - time_zonestring
    Example
    America/New_York
    Description
    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
    ") are no longer supported.
    Pattern
    ^[A-Za-z\-\_\/]+$
- traffic_allocationinteger
  Example
  5000
  Description
  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.
  Minimum
  0
  Maximum
  10000
- url_targetingURLTargeting
  - activation_codestring
    Example
    function callbackFn(activate, options) { activate(); }
    Description
    Stringified Javascript function that determines when the Page is activated. Only required when activation_type is 'polling' or 'callback'.
  - activation_typestring<immediate | manual | polling | callback | dom_changed | url_changed>
    Example
    callback
    Description
    How this page is activated. See the full documentation on the Page object.
    Allowed
    immediatemanualpollingcallbackdom_changedurl_changed
  - conditionsstring
    Example
    [ "and", { "type": "url", "match_type": "substring", "value": "optimize" } ]
    Description
    Conditions to activate the experiment; our knowledge base article on Activation Types is the best guide for how to set up this data.
  - edit_urlstringrequired
    Example
    https://www.optimizely.com
    Description
    URL to load in the editor for this page
  - keystring
    Example
    home_page
    Description
    Unique string identifier for this Page within the Project
    Max Length
    64
    Pattern
    ^[a-zA-Z0-9_]+$
  - page_idinteger<int64>
    Example
    6700
    Description
    The unique identifier of the Page that represents the experiment or campaign's URL Targeting.
    Format
    int64
- variationsVariationUpdate[]
  Description
  List of IDs of all variations in the Experiment
  - actionsAction[]
    Description
    A collection of changes to run for each page in an experiment. Only applicable to Optimizely X Web.
    - changesChange[]
      Description
      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'.
      - allow_additional_redirectboolean
        Description
        Whether or not to allow additional redirects after redirecting to destination. Required for changes of type 'redirect'
      - asyncboolean
        Description
        Indicates whether or not to execute the change asyncronously. If true, src will be returned in the response. Otherwise, it will be not included.
      - attributesChangeAttribute
        classstring
        Example
        intro
        Description
        Name of the class to set the element(s) matched by a selector to
        hideboolean
        Description
        Whether or not to hide the element(s) matched by a selector
        hrefstring
        Example
        example.com
        Description
        Value of href attribute to add to element(s) matched by a selector
        htmlstring
        Example
        New Title
        Description
        Value of HTML attribute to add to element(s) matched by a selector
        removeboolean
        Description
        Whether or not to remove the element(s) matched by a selector
        srcstring
        Example
        song.mp3
        Description
        Value of src attribute to add to element(s) matched by a selector
        stylestring
        Example
        background-color:blue;
        Description
        Value of style attribute to add to element(s) matched by a selector
        textstring
        Example
        Some nice message
        Description
        Value of text attribute to add to the element(s) matched by a selector
      - configobject
        Example
        { "name": "Flash Sale Today!", "color": "blue" }
        Description
        Configuration properties for the extension
      - cssCSSAttribute
        background-colorstring
        background-imagestring
        border-colorstring
        border-stylestring
        border-widthstring
        colorstring
        font-familystring
        font-sizestring
        font-weightstring
        heightstring
        positionstring
        widthstring
      - dependenciesstring[]
        Example
        [ "ad1f6acb-78f2-4653-b955-913abd777e16", "ad20a6dd-2083-4964-8ed2-f0dc7baef687" ]
        Description
        A list of dependent change IDs that must happen before this change
      - destinationstring
        Example
        https://app.optimizely.com/
        Description
        URL to redirect to. Required for changes of type 'redirect'. destination and destination_function cannot be used at the same time
      - destination_functionstring
        Example
        https://app.optimizely.com/
        Description
        A function string to redirect to. Required for changes of type 'redirect'. destination and destination_function cannot be used at the same time
      - extension_idstring
        Description
        ID of the extension to insert. Required for changes of type 'extension'
      - idstring<uuid>
        Description
        The ID of the change
        Format
        uuid
      - isOpalManagedboolean
        Description
        Whether this change is managed by Opal. Provenance metadata; preserved on round-trip so automated writers (e.g. the MAB publish job) are not misread as editing custom JavaScript. See PMOD-3772 / PMOD-3781.
      - namestring
        Example
        Setting button text
        Description
        Name of the change
      - operatorstring
        Example
        after
        Description
        Where to instert HTML or image for types 'insert_html' and 'insert_image' with respect to the element(s) matched by 'selector'
      - preserve_parametersboolean
        Description
        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.
      - rearrangeobject
        Example
        { "insertSelector": ".greyBox", "operator": "before" }
        Description
        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
      - selectorstring
        Example
        a[href*="optimizely"]
        Description
        CSS selector to determine where changes are applied. Required for changes of type 'attribute', 'insert_html', and 'insert_image'
      - srcstring
        Description
        The path to the change payload on the CDN. Only present if 'async' is True.
      - typestring<attribute | custom_code | custom_css | extension | insert_html | insert_image | redirect>required
        Description
        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'
        
        Allowed
        attributecustom_codecustom_cssextensioninsert_htmlinsert_imageredirect
      - valuestring
        Example
        window.someGlobalFunction();
        Description
        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_idinteger<int64>required
      Description
      The ID of the Page to apply changes to
      Format
      int64
    - share_linkstring<url>
      Description
      The share link for the provided Variation and Page combination
      Format
      url
  - archivedboolean
    Description
    Whether the variation is archived
  - descriptionstring
    Example
    Change the CTA button background color from green to blue.
    Description
    A description for the variation.
  - feature_enabledboolean
    Description
    For Feature Tests, indicates if the feature should be enabled for the variation
  - keystring
    Example
    blue_button_variation
    Description
    Unique string identifier for this variation within the Experiment. Only applicable for Full Stack and Mobile projects.
    Max Length
    64
    Pattern
    ^[a-zA-Z0-9_\-]+$
  - namestring
    Example
    Blue Button
    Description
    The name of the variation. Required for Web Experiments and Personalization experiences. Not required for Full Stack Experiments.
  - statusstring<active | paused | archived>
    Description
    Current status of the variation
    Allowed
    activepausedarchived
  - variable_valuesmap<string, string>
    Description
    For Feature Tests, the variable values for the variation represented as a map of Variable keys to their values.
  - variation_idinteger<int64>
    Description
    An immutable unique identifier for the variation. Required to update an existing variation.
    Format
    int64
  - weightintegerrequired
    Description
    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.
    Minimum
    0
    Maximum
    10000
- whitelistobject[]
  Description
  A list containing the user IDs and variations of users who have been whitelisted
  - user_idstringrequired
    Example
    user_1
    Description
    The ID of the user being whitelisted
  - variation_idinteger<int64>required
    Example
    12345
    Description
    The unique identifier for the variation
    Format
    int64