Partially update experiment

Update several fields of an experiment. For a multivariate test (MVT) experiment, use this endpoint to set custom traffic allocation after creation: submit mvtAllocationSettings with the generated section, variation, and combination IDs returned by a GET request. See Create a multivariate experiment.

PATCH /experiments/{experimentId}

Partially update experiment

cURL

curl --request PATCH \
  --url https://api.kameleoon.com/experiments/{experimentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "autoOptimized": true,
  "baseURL": "<string>",
  "commonCssCode": "<string>",
  "commonJavaScriptCode": "<string>",
  "description": "<string>",
  "deviations": {
    "12345": 0.5,
    "origin": 0.5
  },
  "globalScript": "<string>",
  "goals": [
    123
  ],
  "identificationKey": "<string>",
  "isMultipleTestingCorrection": true,
  "mainGoalId": 123,
  "mvtAllocationSettings": {
    "combinationsAllocations": [
      {
        "allocationPart": 123,
        "checked": true,
        "locked": true,
        "sectionId": 123,
        "variationId": "<string>"
      }
    ],
    "exposedPart": 123,
    "sectionsAllocations": [
      {
        "allocationPart": 123,
        "checked": true,
        "locked": true,
        "sectionId": 123,
        "variationId": "<string>"
      }
    ]
  },
  "name": "<string>",
  "respoolTime": {
    "12345": 1704067200,
    "origin": 833760000
  },
  "tags": [
    "<string>"
  ],
  "targetingSegmentId": 123,
  "trackingTools": [
    {
      "adobeOmnitureObject": "<string>",
      "comScoreCustomerId": "<string>",
      "comScoreDomain": "<string>",
      "contentSquareUrl": "<string>",
      "customIntegrations": [
        "<string>"
      ],
      "customVariable": 123,
      "eulerianUserCentricParameter": "<string>",
      "reportingScript": "<string>",
      "universalAnalyticsDimension": 123
    }
  ]
}
'

import requests

url = "https://api.kameleoon.com/experiments/{experimentId}"

payload = {
    "autoOptimized": True,
    "baseURL": "<string>",
    "commonCssCode": "<string>",
    "commonJavaScriptCode": "<string>",
    "description": "<string>",
    "deviations": {
        "12345": 0.5,
        "origin": 0.5
    },
    "globalScript": "<string>",
    "goals": [123],
    "identificationKey": "<string>",
    "isMultipleTestingCorrection": True,
    "mainGoalId": 123,
    "mvtAllocationSettings": {
        "combinationsAllocations": [
            {
                "allocationPart": 123,
                "checked": True,
                "locked": True,
                "sectionId": 123,
                "variationId": "<string>"
            }
        ],
        "exposedPart": 123,
        "sectionsAllocations": [
            {
                "allocationPart": 123,
                "checked": True,
                "locked": True,
                "sectionId": 123,
                "variationId": "<string>"
            }
        ]
    },
    "name": "<string>",
    "respoolTime": {
        "12345": 1704067200,
        "origin": 833760000
    },
    "tags": ["<string>"],
    "targetingSegmentId": 123,
    "trackingTools": [
        {
            "adobeOmnitureObject": "<string>",
            "comScoreCustomerId": "<string>",
            "comScoreDomain": "<string>",
            "contentSquareUrl": "<string>",
            "customIntegrations": ["<string>"],
            "customVariable": 123,
            "eulerianUserCentricParameter": "<string>",
            "reportingScript": "<string>",
            "universalAnalyticsDimension": 123
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    autoOptimized: true,
    baseURL: '<string>',
    commonCssCode: '<string>',
    commonJavaScriptCode: '<string>',
    description: '<string>',
    deviations: {'12345': 0.5, origin: 0.5},
    globalScript: '<string>',
    goals: [123],
    identificationKey: '<string>',
    isMultipleTestingCorrection: true,
    mainGoalId: 123,
    mvtAllocationSettings: {
      combinationsAllocations: [
        {
          allocationPart: 123,
          checked: true,
          locked: true,
          sectionId: 123,
          variationId: '<string>'
        }
      ],
      exposedPart: 123,
      sectionsAllocations: [
        {
          allocationPart: 123,
          checked: true,
          locked: true,
          sectionId: 123,
          variationId: '<string>'
        }
      ]
    },
    name: '<string>',
    respoolTime: {'12345': 1704067200, origin: 833760000},
    tags: ['<string>'],
    targetingSegmentId: 123,
    trackingTools: [
      {
        adobeOmnitureObject: '<string>',
        comScoreCustomerId: '<string>',
        comScoreDomain: '<string>',
        contentSquareUrl: '<string>',
        customIntegrations: ['<string>'],
        customVariable: 123,
        eulerianUserCentricParameter: '<string>',
        reportingScript: '<string>',
        universalAnalyticsDimension: 123
      }
    ]
  })
};

fetch('https://api.kameleoon.com/experiments/{experimentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kameleoon.com/experiments/{experimentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'autoOptimized' => true,
    'baseURL' => '<string>',
    'commonCssCode' => '<string>',
    'commonJavaScriptCode' => '<string>',
    'description' => '<string>',
    'deviations' => [
        '12345' => 0.5,
        'origin' => 0.5
    ],
    'globalScript' => '<string>',
    'goals' => [
        123
    ],
    'identificationKey' => '<string>',
    'isMultipleTestingCorrection' => true,
    'mainGoalId' => 123,
    'mvtAllocationSettings' => [
        'combinationsAllocations' => [
                [
                                'allocationPart' => 123,
                                'checked' => true,
                                'locked' => true,
                                'sectionId' => 123,
                                'variationId' => '<string>'
                ]
        ],
        'exposedPart' => 123,
        'sectionsAllocations' => [
                [
                                'allocationPart' => 123,
                                'checked' => true,
                                'locked' => true,
                                'sectionId' => 123,
                                'variationId' => '<string>'
                ]
        ]
    ],
    'name' => '<string>',
    'respoolTime' => [
        '12345' => 1704067200,
        'origin' => 833760000
    ],
    'tags' => [
        '<string>'
    ],
    'targetingSegmentId' => 123,
    'trackingTools' => [
        [
                'adobeOmnitureObject' => '<string>',
                'comScoreCustomerId' => '<string>',
                'comScoreDomain' => '<string>',
                'contentSquareUrl' => '<string>',
                'customIntegrations' => [
                                '<string>'
                ],
                'customVariable' => 123,
                'eulerianUserCentricParameter' => '<string>',
                'reportingScript' => '<string>',
                'universalAnalyticsDimension' => 123
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kameleoon.com/experiments/{experimentId}"

	payload := strings.NewReader("{\n  \"autoOptimized\": true,\n  \"baseURL\": \"<string>\",\n  \"commonCssCode\": \"<string>\",\n  \"commonJavaScriptCode\": \"<string>\",\n  \"description\": \"<string>\",\n  \"deviations\": {\n    \"12345\": 0.5,\n    \"origin\": 0.5\n  },\n  \"globalScript\": \"<string>\",\n  \"goals\": [\n    123\n  ],\n  \"identificationKey\": \"<string>\",\n  \"isMultipleTestingCorrection\": true,\n  \"mainGoalId\": 123,\n  \"mvtAllocationSettings\": {\n    \"combinationsAllocations\": [\n      {\n        \"allocationPart\": 123,\n        \"checked\": true,\n        \"locked\": true,\n        \"sectionId\": 123,\n        \"variationId\": \"<string>\"\n      }\n    ],\n    \"exposedPart\": 123,\n    \"sectionsAllocations\": [\n      {\n        \"allocationPart\": 123,\n        \"checked\": true,\n        \"locked\": true,\n        \"sectionId\": 123,\n        \"variationId\": \"<string>\"\n      }\n    ]\n  },\n  \"name\": \"<string>\",\n  \"respoolTime\": {\n    \"12345\": 1704067200,\n    \"origin\": 833760000\n  },\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"targetingSegmentId\": 123,\n  \"trackingTools\": [\n    {\n      \"adobeOmnitureObject\": \"<string>\",\n      \"comScoreCustomerId\": \"<string>\",\n      \"comScoreDomain\": \"<string>\",\n      \"contentSquareUrl\": \"<string>\",\n      \"customIntegrations\": [\n        \"<string>\"\n      ],\n      \"customVariable\": 123,\n      \"eulerianUserCentricParameter\": \"<string>\",\n      \"reportingScript\": \"<string>\",\n      \"universalAnalyticsDimension\": 123\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.kameleoon.com/experiments/{experimentId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"autoOptimized\": true,\n  \"baseURL\": \"<string>\",\n  \"commonCssCode\": \"<string>\",\n  \"commonJavaScriptCode\": \"<string>\",\n  \"description\": \"<string>\",\n  \"deviations\": {\n    \"12345\": 0.5,\n    \"origin\": 0.5\n  },\n  \"globalScript\": \"<string>\",\n  \"goals\": [\n    123\n  ],\n  \"identificationKey\": \"<string>\",\n  \"isMultipleTestingCorrection\": true,\n  \"mainGoalId\": 123,\n  \"mvtAllocationSettings\": {\n    \"combinationsAllocations\": [\n      {\n        \"allocationPart\": 123,\n        \"checked\": true,\n        \"locked\": true,\n        \"sectionId\": 123,\n        \"variationId\": \"<string>\"\n      }\n    ],\n    \"exposedPart\": 123,\n    \"sectionsAllocations\": [\n      {\n        \"allocationPart\": 123,\n        \"checked\": true,\n        \"locked\": true,\n        \"sectionId\": 123,\n        \"variationId\": \"<string>\"\n      }\n    ]\n  },\n  \"name\": \"<string>\",\n  \"respoolTime\": {\n    \"12345\": 1704067200,\n    \"origin\": 833760000\n  },\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"targetingSegmentId\": 123,\n  \"trackingTools\": [\n    {\n      \"adobeOmnitureObject\": \"<string>\",\n      \"comScoreCustomerId\": \"<string>\",\n      \"comScoreDomain\": \"<string>\",\n      \"contentSquareUrl\": \"<string>\",\n      \"customIntegrations\": [\n        \"<string>\"\n      ],\n      \"customVariable\": 123,\n      \"eulerianUserCentricParameter\": \"<string>\",\n      \"reportingScript\": \"<string>\",\n      \"universalAnalyticsDimension\": 123\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/experiments/{experimentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"autoOptimized\": true,\n  \"baseURL\": \"<string>\",\n  \"commonCssCode\": \"<string>\",\n  \"commonJavaScriptCode\": \"<string>\",\n  \"description\": \"<string>\",\n  \"deviations\": {\n    \"12345\": 0.5,\n    \"origin\": 0.5\n  },\n  \"globalScript\": \"<string>\",\n  \"goals\": [\n    123\n  ],\n  \"identificationKey\": \"<string>\",\n  \"isMultipleTestingCorrection\": true,\n  \"mainGoalId\": 123,\n  \"mvtAllocationSettings\": {\n    \"combinationsAllocations\": [\n      {\n        \"allocationPart\": 123,\n        \"checked\": true,\n        \"locked\": true,\n        \"sectionId\": 123,\n        \"variationId\": \"<string>\"\n      }\n    ],\n    \"exposedPart\": 123,\n    \"sectionsAllocations\": [\n      {\n        \"allocationPart\": 123,\n        \"checked\": true,\n        \"locked\": true,\n        \"sectionId\": 123,\n        \"variationId\": \"<string>\"\n      }\n    ]\n  },\n  \"name\": \"<string>\",\n  \"respoolTime\": {\n    \"12345\": 1704067200,\n    \"origin\": 833760000\n  },\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"targetingSegmentId\": 123,\n  \"trackingTools\": [\n    {\n      \"adobeOmnitureObject\": \"<string>\",\n      \"comScoreCustomerId\": \"<string>\",\n      \"comScoreDomain\": \"<string>\",\n      \"contentSquareUrl\": \"<string>\",\n      \"customIntegrations\": [\n        \"<string>\"\n      ],\n      \"customVariable\": 123,\n      \"eulerianUserCentricParameter\": \"<string>\",\n      \"reportingScript\": \"<string>\",\n      \"universalAnalyticsDimension\": 123\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "baseURL": "<string>",
  "name": "<string>",
  "siteCode": "<string>",
  "siteId": 123,
  "autoOptimized": true,
  "collectingDataEnabled": true,
  "commonCssCode": "<string>",
  "commonJavaScriptCode": "<string>",
  "createdBy": 123,
  "dateCollectingDataStopped": "2023-11-07T05:31:56Z",
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateEnded": "2023-11-07T05:31:56Z",
  "dateModified": "2023-11-07T05:31:56Z",
  "dateStarted": "2023-11-07T05:31:56Z",
  "dateStatusModified": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "deviations": {
    "12345": 0.5,
    "origin": 0.5
  },
  "executeCodeForReference": true,
  "globalScript": "<string>",
  "goals": [
    123
  ],
  "id": 123,
  "isArchived": true,
  "isLegacyEditor": true,
  "isMultipleTestingCorrection": true,
  "mainGoalId": 123,
  "mvtAllocationSettings": {
    "combinationsAllocations": [
      {
        "allocationPart": 123,
        "checked": true,
        "locked": true,
        "sectionId": 123,
        "variationId": "<string>"
      }
    ],
    "exposedPart": 123,
    "sectionsAllocations": [
      {
        "allocationPart": 123,
        "checked": true,
        "locked": true,
        "sectionId": 123,
        "variationId": "<string>"
      }
    ]
  },
  "mvtVariations": [
    {
      "sectionId": 123,
      "sectionName": "<string>",
      "variations": [
        {
          "id": 123,
          "name": "<string>"
        }
      ]
    }
  ],
  "respoolTime": {
    "12345": 833760000,
    "origin": 1704067200
  },
  "status": "<string>",
  "tags": [
    "<string>"
  ],
  "targetingRule": {
    "siteId": 123,
    "id": 123,
    "segmentId": 123,
    "targetingConfigurationParam": "<string>",
    "triggerId": 123
  },
  "targetingRuleId": 123,
  "targetingSegmentId": 123,
  "trackingTools": [
    {
      "adobeOmnitureObject": "<string>",
      "comScoreCustomerId": "<string>",
      "comScoreDomain": "<string>",
      "contentSquareUrl": "<string>",
      "customIntegrations": [
        "<string>"
      ],
      "customVariable": 123,
      "eulerianUserCentricParameter": "<string>",
      "reportingScript": "<string>",
      "universalAnalyticsDimension": 123
    }
  ],
  "variations": [
    123
  ]
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

experimentId · integer<int64> · required

Query Parameters

action · enum<string>

Action to change the status of experiment

Available options: ACTIVATE, PAUSE, RESUME, STOP, SCHEDULE, DEACTIVATE, REVERT_TO_DRAFT

Body

application/json

autoOptimized · boolean · deprecated

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%).

Show child attributes

Example:

{ "12345": 0.5, "origin": 0.5 }

globalScript · string

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

goals · integer<int64>[]

Goal Id(s) associated with this experiment

identificationKey · string

isMultipleTestingCorrection · boolean

Indicates whether multiple testing correction is enabled

mainGoalId · integer<int64>

Main goal Id of the experiment

mvtAllocationSettings · Mvt allocation · object

Traffic allocation settings for a multivariate test (MVT) experiment. On POST /experiments, Kameleoon accepts this object but always applies equal allocation across variations, regardless of the values you submit. To set custom allocation, submit this object again in a PATCH /experiments/{experimentId} request, using the generated IDs returned by a GET request. Populate only one of sectionsAllocations or combinationsAllocations, not both.

Show child attributes

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.

Show child attributes

Example:

{ "12345": 1704067200, "origin": 833760000 }

tags · string[]

Tags belonging to this experiment

targetingConfiguration · enum<string> · deprecated

Deprecated. Use the https://api.kameleoon.com/targeting-rules endpoint to update the targeting of your experiment

Available options: ALL_VISITORS, AUTOPROMO_AUTODEFINED, GRAPHICAL_PAGES, HEAT_SLICE, PAGE, SAVED_TEMPLATE, SITE, URL

targetingRule · Targeting rule · object

Targeting Rule defines the conditions for displaying content to specific user groups based on segments and triggers

Show child attributes

targetingSegmentId · integer<int64> · deprecated

Deprecated. Use the https://api.kameleoon.com/targeting-rules endpoint to update the targeting of your experiment

trackingTools · Tracking tool · object[]

Tracking tools being used in this experiment

Show child attributes

trafficAllocationMethod · enum<string>

Method for allocating traffic across variations. Set to MANUAL to control the allocation yourself using deviations (classic and developer experiments) or mvtAllocationSettings (multivariate test experiments).

Available options: CONTEXTUAL_BANDIT, MANUAL, MULTI_ARMED_BANDIT

Response

200

*/*

OK

baseURL · string · required

URL of the website to load in editor and preview mode

name · string · required

Name of the experiment

siteCode · string · required · read-only

Site code of the experiment

siteId · integer<int64> · required

Site Id of the project the experiment belongs to

autoOptimized · boolean · deprecated

Deprecated. Use trafficAllocationMethod field instead

collectingDataEnabled · boolean

Indicates if data collection is enabled

commonCssCode · string

CSS code specific to all variations

commonJavaScriptCode · string

JavaScript code specific to all variations

createdBy · integer<int64> · read-only

Account Id of the creator of the experiment

dateCollectingDataStopped · string<date-time> · read-only

Date the data collection stops

dateCreated · string<date-time> · read-only

dateEnded · string<date-time> · read-only

Date the experiment ceased

dateModified · string<date-time> · read-only

Date the experiment was modified

dateStarted · string<date-time> · read-only

Date the experiment was launched

dateStatusModified · string<date-time> · read-only

Date the experiment was last modified

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%).

Show child attributes

Example:

{ "12345": 0.5, "origin": 0.5 }

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 · integer<int64>[]

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

id · integer<int64> · read-only

Unique Id of the experiment

isArchived · boolean · read-only

Indicates if experiment is archived

isLegacyEditor · boolean

isMultipleTestingCorrection · boolean

Indicates whether multiple testing correction is enabled

mainGoalId · integer<int64>

mvtAllocationSettings · Mvt allocation · object

Traffic allocation settings for a multivariate test (MVT) experiment. On POST /experiments, Kameleoon accepts this object but always applies equal allocation across variations, regardless of the values you submit. To set custom allocation, submit this object again in a PATCH /experiments/{experimentId} request, using the generated IDs returned by a GET request. Populate only one of sectionsAllocations or combinationsAllocations, not both.

Show child attributes

mvtVariations · Variation combination · object[]

Sections and variations for a multivariate test (MVT) experiment. On creation, the sectionId and variation id values you submit link entries in this array to entries in mvtAllocationSettings; Kameleoon replaces them with its own generated IDs in the response. Kameleoon doesn't return this field on subsequent GET requests.

Show child attributes

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

Show child attributes

Example:

{ "12345": 833760000, "origin": 1704067200 }

status · string · read-only

Status of the 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 · enum<string> · deprecated

Deprecated. Use the https://api.kameleoon.com/targeting-rules endpoint to update the targeting of your experiment

Available options: ALL_VISITORS, AUTOPROMO_AUTODEFINED, GRAPHICAL_PAGES, HEAT_SLICE, PAGE, SAVED_TEMPLATE, SITE, URL

targetingRule · Targeting rule · object

Targeting Rule defines the conditions for displaying content to specific user groups based on segments and triggers

Show child attributes

targetingRuleId · integer<int64> · deprecated · read-only

Deprecated. Use TargetingRule instead.

targetingSegmentId · integer<int64> · deprecated

Deprecated. Use the https://api.kameleoon.com/targeting-rules endpoint to update the targeting of your experiment

trackingTools · Tracking tool · object[]

Show child attributes

trafficAllocationMethod · enum<string>

Method for allocating traffic across variations. Set to MANUAL to control the allocation yourself using deviations (classic and developer experiments) or mvtAllocationSettings (multivariate test experiments).

Available options: CONTEXTUAL_BANDIT, MANUAL, MULTI_ARMED_BANDIT

type · enum<string>

Available options: AI, CLASSIC, DEVELOPER, FEATURE_FLAG, MVT, PROMPT, SDK_HYBRID

variations · integer<int64>[] · read-only

List of variation ids for this experiment