Create a new experiment

POST 
/experiments

Create a new experiment with the given parameters

Request

application/json

Body

required

autoOptimized booleandeprecated

Deprecated. Use trafficAllocationMethod field instead

baseURL stringrequired

URL of the website to load in editor and preview mode

collectingDataEnabled boolean

Indicates if data collection is enabled

commonCssCode string

CSS code specific to all variations

commonJavaScriptCode string

JavaScript code specific to all variations

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

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

]

mvtVariations

object[]

Array [

sectionId int64

sectionName string

variations

object[]

Array [

id int64

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

siteId int64required

Site Id of the project the experiment belongs to

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 stringdeprecated

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

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

targetingRule

object

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

segmentConfiguration string

Configuration defining how the segment should be applied

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

segmentId int64

Id of the associated segment (user group) for targeting. If segment is deprecated, no trigger will be available for this rule.

siteId int64required

Id of the project this targeting rule belongs to

targetingConfigurationParam string

Additional parameters for trigger configuration. For SAVED_TEMPLATE/HEAT_SLICE - contains segment Id. For PAGE - contains full URL. For URL - contains URL fragment.

triggerConfiguration string

Configuration defining how the trigger should be applied. ALL_VISITORS configuration is not allowed for this trigger type

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

triggerId int64

Id of the associated trigger (activation condition)

targetingSegmentId int64deprecated

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

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, HEAP_COHORTS, SEGMENT, MIXPANEL, CLARITY, IABTCF, DATABRICKS, REDSHIFT, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, QUANTUM_METRIC, GLASSBOX_V2, BRAZE, 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, PROMPT, SDK_HYBRID]

Responses

201

Created

*/*

Schema

Schema

autoOptimized booleandeprecated

Deprecated. Use trafficAllocationMethod field instead

baseURL stringrequired

URL of the website to load in editor and preview mode

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 int64

Account Id of the creator of the experiment

dateCollectingDataStopped date-time

Date the data collection stops

dateCreated date-time
dateEnded date-time

Date the experiment ceased

dateModified date-time

Date the experiment was modified

dateStarted date-time

Date the experiment was launched

dateStatusModified date-time

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

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 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 int64

Unique Id of the experiment

isArchived boolean

Indicates if experiment is archived

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

]

mvtVariations

object[]

Array [

sectionId int64

sectionName string

variations

object[]

Array [

id int64

name 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

Site Id of the project the experiment belongs to

status string

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 stringdeprecated

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

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

targetingRule

object

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

id int64

Unique Id of the targeting rule

segmentConfiguration string

Configuration defining how the segment should be applied

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

segmentId int64

Id of the associated segment (user group) for targeting. If segment is deprecated, no trigger will be available for this rule.

siteId int64required

Id of the project this targeting rule belongs to

targetingConfigurationParam string

Additional parameters for trigger configuration. For SAVED_TEMPLATE/HEAT_SLICE - contains segment Id. For PAGE - contains full URL. For URL - contains URL fragment.

triggerConfiguration string

Configuration defining how the trigger should be applied. ALL_VISITORS configuration is not allowed for this trigger type

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

triggerId int64

Id of the associated trigger (activation condition)

targetingRuleId int64deprecated

Deprecated. Use TargetingRule instead.

targetingSegmentId int64deprecated

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

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, HEAP_COHORTS, SEGMENT, MIXPANEL, CLARITY, IABTCF, DATABRICKS, REDSHIFT, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, QUANTUM_METRIC, GLASSBOX_V2, BRAZE, 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, PROMPT, SDK_HYBRID]

variations int64[]

List of variation ids for this experiment

Example (from schema)

{
  "baseURL": "string",
  "collectingDataEnabled": true,
  "commonCssCode": "string",
  "commonJavaScriptCode": "string",
  "createdBy": 0,
  "dateCollectingDataStopped": "2024-07-29T15:51:28.071Z",
  "dateCreated": "2024-07-29T15:51:28.071Z",
  "dateEnded": "2024-07-29T15:51:28.071Z",
  "dateModified": "2024-07-29T15:51:28.071Z",
  "dateStarted": "2024-07-29T15:51:28.071Z",
  "dateStatusModified": "2024-07-29T15:51:28.071Z",
  "description": "string",
  "deviations": {
    "12345": 0.5,
    "origin": 0.5
  },
  "executeCodeForReference": true,
  "globalScript": "string",
  "goals": [
    0
  ],
  "id": 0,
  "isArchived": true,
  "isLegacyEditor": true,
  "isMultipleTestingCorrection": true,
  "mainGoalId": 0,
  "mvtAllocationSettings": {
    "combinationsAllocations": [
      {
        "allocationPart": 0,
        "checked": true,
        "locked": true,
        "sectionId": 0,
        "variationId": "string"
      }
    ],
    "exposedPart": 0,
    "sectionsAllocations": [
      {
        "allocationPart": 0,
        "checked": true,
        "locked": true,
        "sectionId": 0,
        "variationId": "string"
      }
    ]
  },
  "mvtVariations": [
    {
      "sectionId": 0,
      "sectionName": "string",
      "variations": [
        {
          "id": 0,
          "name": "string"
        }
      ]
    }
  ],
  "name": "string",
  "respoolTime": {
    "12345": 833760000,
    "origin": 1704067200
  },
  "siteCode": "string",
  "siteId": 0,
  "status": "string",
  "tags": [
    "string"
  ],
  "targetingRule": {
    "id": 0,
    "segmentConfiguration": "ALL_VISITORS",
    "segmentId": 0,
    "siteId": 0,
    "targetingConfigurationParam": "string",
    "triggerConfiguration": "ALL_VISITORS",
    "triggerId": 0
  },
  "trackingTools": [
    {
      "adobeOmnitureObject": "string",
      "comScoreCustomerId": "string",
      "comScoreDomain": "string",
      "contentSquareUrl": "string",
      "customIntegrations": [
        "string"
      ],
      "customVariable": 0,
      "eulerianUserCentricParameter": "string",
      "name": "GOOGLE_ANALYTICS4",
      "reportingScript": "string",
      "universalAnalyticsDimension": 0
    }
  ],
  "trafficAllocationMethod": "CONTEXTUAL_BANDIT",
  "type": "AI",
  "variations": [
    0
  ]
}

400

Bad Request

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

401

Unauthorized

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

403

Forbidden

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

404

Not Found

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

422

Unprocessable Entity

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

423

Locked

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

500

Internal Server Error

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

Loading...