Model: Campaign

1 min

Model Parameters

Campaign
- archivedboolean
  Description
  Whether the Campaign has been archived
  Default
  false
- changesSharedCodeChange[]
  Description
  A list of changes to apply to the Campaign. This corresponds to the Campaign's Shared Code in the application. Only supports 'custom_css' or 'custom_code' type changes.
  - 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.
- concludedboolean
  Description
  Whether the Campaign has been concluded.
- concluded_atstring<date-time>
  Description
  The time the Campaign was concluded.
  Format
  date-time
- concluded_bystring
  Description
  The email of the user who concluded the Campaign.
- concluded_conclusionsstring
  Description
  The conclusions note recorded when the Campaign was concluded.
- concluded_results_outcomestring<positive | negative | inconclusive | >
  Description
  The results outcome recorded when the Campaign was concluded.
  Allowed
  positivenegativeinconclusivenull
- createdstring<date-time>
  Description
  The time the Campaign was initially created
  Format
  date-time
- custom_field_valuesmap<string, string>
  Description
  Map of custom field api_name to value for this 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. Returns an empty object when no values are set.
- descriptionstring
  Example
  Tailor the landing page hero element for specific audiences
  Description
  The description or goal for a Campaign
- earlieststring<date-time>
  Description
  The first time the Campaign was activated
  Format
  date-time
- experiment_prioritiesarray[]
  Description
  A list of lists of Experiment IDs that indicate the relative priority of how to show those Experiments in the context of the Campaign. Each list inside of the list represents a group of Experiments of equal priority where groups that appear earlier in the list are of higher priority to be shown.
- for_journeyboolean
  Description
  Whether the Campaign has been part of journey or not
  Default
  false
- holdbackinteger
  Example
  500
  Description
  Percentage of visitors to exclude from personalization, measured in basis points. 100 basis points = 1% traffic. For example, a value of 500 would mean that 95% of visitors will see a personalized experience and 5% will see the holdback.
  Minimum
  0
  Maximum
  10000
- idinteger<int64>
  Example
  2000
  Description
  The unique identifier for the Campaign
  Format
  int64
- journey_idstring
  Description
  The journey this campaign is associated with, or null if not set
- last_modifiedstring<date-time>
  Description
  The last time the Campaign was modified
  Format
  date-time
- lateststring<date-time>
  Description
  The last time the Campaign was paused (not present if the Campaign still running)
  Format
  date-time
- metricsMetric[]
  Description
  An ordered list of metrics to track for the Campaign
  - 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
  Landing Page Optimization
  Description
  The name of the Campaign
- page_idsinteger[]
  Description
  A list of Page IDs used in the Campaign
- project_idinteger<int64>required
  Example
  1000
  Description
  The Project ID the Campaign is in
  Format
  int64
- statusstring<not_started | running | paused | archived | concluded>
  Description
  Current state of the Campaign. not_started means the Campaign has never been published to the world. running means the Campaign is currently live to the world. paused means the Campaign has been published, but is currently not running. archived means the Campaign is paused and not visible in the web UI. concluded means the Campaign has been concluded and is no longer running.
  Allowed
  not_startedrunningpausedarchivedconcluded
- typestring<personalization | other>
  Description
  Indicates the type of this campaign. Campaigns created or fetched via the API should currently all have a type of personalization, but if you get a campaign_id for an experiment and look it up, you may get an other value.
  Default
  personalization
  Allowed
  personalizationother
- 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