Skip to main content

Partially update experiment

PATCH 
/experiments/:experimentId

Update several fields of an experiment

Request​

Path Parameters

    experimentId int64required

Query Parameters

    action string

    Possible values: [ACTIVATE, PAUSE, RESUME, STOP, SCHEDULE, DEACTIVATE]

    Action to change the status of experiment

Body

    autoOptimized booleandeprecated

    Deprecated. Use trafficAllocationMethod field instead

    baseURL string

    URL of the website to load in the editor and preview mode

    commonCssCode string

    CSS code specific to all variations

    commonJavaScriptCode string

    JavaScript code specific to all variations

    description string

    Description of the experiment

    deviations

    object

    Traffic allocation per variation. Key can be 'origin' (for original page) or variation Id. Value is the percentage of traffic which will be allocated to this variation. It has to be double numbers ranging from 0(0%) to 1(100%).

    property name* double

    Traffic allocation per variation. Key can be 'origin' (for original page) or variation Id. Value is the percentage of traffic which will be allocated to this variation. It has to be double numbers ranging from 0(0%) to 1(100%).

    globalScript string

    JavaScript code that will be executed only for the selected experiment at the end of the Global custom script.

    goals int64[]

    Goal Id(s) associated with this experiment

    identificationKey string
    isMultipleTestingCorrection boolean

    Indicates whether multiple testing correction is enabled

    mainGoalId int64

    Main goal Id of the experiment

    name string

    Name of the experiment

    respoolTime

    object

    The respoolTime map contains key-value pairs where each key is a variation ID and the corresponding value is a timestamp that represents the most recent change to the variation allocation, such as through the Kameleoon app or the Automation API.

    property name* double

    The respoolTime map contains key-value pairs where each key is a variation ID and the corresponding value is a timestamp that represents the most recent change to the variation allocation, such as through the Kameleoon app or the Automation API.

    tags string[]

    Tags associated with this experiment

    targetingConfiguration string

    Possible values: [GRAPHICAL_PAGES, HEAT_SLICE, PAGE, SAVED_TEMPLATE, SITE, URL]

    targetingSegmentId int64

    Id of the segment you want to target in this experiment

    trackingTools

    object[]

    Tracking tools you want use in this experiment

  • Array [

    • adobeOmnitureObject string
    comScoreCustomerId string
    comScoreDomain string
    contentSquareUrl string
    customIntegrations string[]
    customVariable int32
    eulerianUserCentricParameter string
    name string

    Possible values: [GOOGLE_ANALYTICS4, GOOGLE_ANALYTICS4_AUDIENCES, GOOGLE_UNIVERSAL_ANALYTICS, ECONDA, SMART_TAG, PIANO, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, KISSMETRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, SMARTFOCUS, EMARSYS, EXPERTSENDER, TAG_COMMANDER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATIONS, HEAP, SEGMENT, MIXPANEL, CLARITY, IABTCF, DATABRICKS, REDSHIFT, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, QUANTUM_METRIC, KAMELEOON_TRACKING, CUSTOM_TRACKING, VERCEL, AKAMAI]

    reportingScript string
    universalAnalyticsDimension int32

  • ]

    • trafficAllocationMethod string

    Possible values: [CONTEXTUAL_BANDIT, MANUAL, MULTI_ARMED_BANDIT]

Responses​

OK

Schema

    autoOptimized booleandeprecated

    Deprecated. Use trafficAllocationMethod field instead

    baseURL stringrequired

    URL of the website to load in editor and preview mode

    collectingDataEnabled boolean
    commonCssCode string

    CSS code specific to all variations

    commonJavaScriptCode string

    JavaScript code specific to all variations

    createdBy int64

    Account id of the creator of the experiment

    dateCollectingDataStopped date-time

    Date the data collection stops

    dateCreated date-time
    dateEnded date-time
    dateModified date-time
    dateStarted date-time
    dateStatusModified date-time
    description string

    deviations

    object

    Traffic allocation per variation. Key can be 'origin'(for original page) or variation id.Value is the percentage of traffic which will be directed to this variation.It has to be double numbers ranging from 0(0%) to 1(100%).

    property name* double

    Traffic allocation per variation. Key can be 'origin'(for original page) or variation id.Value is the percentage of traffic which will be directed to this variation.It has to be double numbers ranging from 0(0%) to 1(100%).

    executeCodeForReference boolean
    globalScript string

    JavaScript code that will be applied only to the selected experiment and executed in the end of the Global custom script

    goals int64[]

    List of goal ids being used by this experiment.For GET requests, this is an optional field that needs to be specified in request params

    id int64

    Sytem-generated unique ID associated with the experiment

    isArchived boolean
    isLegacyEditor boolean
    isMultipleTestingCorrection boolean

    Indicates whether multiple testing correction is enabled

    mainGoalId int64

    mvtAllocationSettings

    object

    combinationsAllocations

    object[]

  • Array [

    • allocationPart float
    checked boolean
    locked boolean
    sectionId int64
    variationId string

  • ]

    • exposedPart float

    sectionsAllocations

    object[]

  • Array [

    • allocationPart float
    checked boolean
    locked boolean
    sectionId int64
    variationId string

  • ]

    • name stringrequired

    Name of the experiment

    respoolTime

    object

    The respoolTime map contains key-value pairs, where each key is a variation ID and the corresponding value is a timestamp representing the most recent change to the variation’s allocation (for example, using the Kameleoon app or the Automation API).

    property name* double

    The respoolTime map contains key-value pairs, where each key is a variation ID and the corresponding value is a timestamp representing the most recent change to the variation’s allocation (for example, using the Kameleoon app or the Automation API).

    siteCode stringrequired

    Site code of the experiment

    siteId int64required

    ID of the website that the experiment belongs to

    status string

    The status of the given experiment

    tags string[]

    List of tags being used by this experiment.For GET requests, this is an optional field that needs to be specified in request params.

    targetingConfiguration string

    Possible values: [GRAPHICAL_PAGES, HEAT_SLICE, PAGE, SAVED_TEMPLATE, SITE, URL]

    targetingSegmentId int64

    trackingTools

    object[]

  • Array [

    • adobeOmnitureObject string
    comScoreCustomerId string
    comScoreDomain string
    contentSquareUrl string
    customIntegrations string[]
    customVariable int32
    eulerianUserCentricParameter string
    name string

    Possible values: [GOOGLE_ANALYTICS4, GOOGLE_ANALYTICS4_AUDIENCES, GOOGLE_UNIVERSAL_ANALYTICS, ECONDA, SMART_TAG, PIANO, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, KISSMETRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, SMARTFOCUS, EMARSYS, EXPERTSENDER, TAG_COMMANDER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATIONS, HEAP, SEGMENT, MIXPANEL, CLARITY, IABTCF, DATABRICKS, REDSHIFT, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, QUANTUM_METRIC, KAMELEOON_TRACKING, CUSTOM_TRACKING, VERCEL, AKAMAI]

    reportingScript string
    universalAnalyticsDimension int32

  • ]

    • trafficAllocationMethod string

    Possible values: [CONTEXTUAL_BANDIT, MANUAL, MULTI_ARMED_BANDIT]

    type string

    Possible values: [AI, CLASSIC, DEVELOPER, FEATURE_FLAG, MVT, SDK_HYBRID]

    variations int64[]

    List of variation ids for this experiment

Loading...