Get all experiments
Get list of all experiments
Query Parameters
- paramsIO object required
- optionalFields string[]
- 200
- 400
- 403
- 423
- 500
- 503
OK
- */*
- Schema
- Example (from schema)
Schema
- Array [
- autoOptimized boolean
- baseURL string required
URL of the website to load in the editor and preview mode for this page
- collectingDataEnabled boolean
- commonCssCode string
CSS code specific to all variations
- commonJavaScriptCode string
JavaScript code specific to all variations
- createdBy int64
Account id to whom created this experiment
- dateCollectingDataStopped date-time
Date of last 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 percent of traffic which will be routed to the variation. Values has to be double numbers in range from 0(0%) to 1(100%).
property name*
number- executeCodeForReference boolean
- goals int64[]
List of goal ids using by this experiment. For get requests: this is an optional field needs to specify in request params.
- id int64
This field is generated by the system to uniquely identify an experiment
- isArchived boolean
- isLegacyEditor boolean
- isMultipleTestingCorrection boolean
Indicates whether multiple testing correction is enabled
- mainGoalId int64
- name string required
The 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*
number- siteCode string required
The site code of the experiment
- siteId int64 required
The website id that an experiment belongs to
- status string
The status of the given experiment
- tags string[]
List of tags using by this experiment. For get requests: this is an optional field needs to specify in request params.
- targetingConfiguration string
Possible values: [
SITE
,PAGE
,URL
,SAVED_TEMPLATE
] - targetingSegmentId int64
trackingTools object[]
Array [adobeOmnitureObject stringcomScoreCustomerId stringcomScoreDomain stringcontentSquareUrl stringcustomIntegrations string[]customVariable int32eulerianUserCentricParameter stringname stringPossible 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
,SMARTLOOK
,MOUSEFLOW
,KLAVIYO
,FULLSTORY
,AMPLITUDE
,SNOWPLOW
,JUNE
,MPARTICLE
,BIGQUERY
,RUDDERSTACK
,SNOWFLAKE
,GLASSBOX
,HUBSPOT
,AIR360
,DATADOG
,KAMELEOON_TRACKING
,CUSTOM_TRACKING
,VERCEL
,AKAMAI
]reportingScript stringuniversalAnalyticsDimension int32]- type string
Possible values: [
CLASSIC
,DEVELOPER
,MVT
,SDK_HYBRID
,FEATURE_FLAG
] - variations int64[]
List of associated variations id for this experiment
- ]
[
{
"autoOptimized": true,
"baseURL": "string",
"collectingDataEnabled": true,
"commonCssCode": "string",
"commonJavaScriptCode": "string",
"createdBy": 0,
"dateCollectingDataStopped": "2024-04-23T16:07:24.742Z",
"dateCreated": "2024-04-23T16:07:24.742Z",
"dateEnded": "2024-04-23T16:07:24.742Z",
"dateModified": "2024-04-23T16:07:24.742Z",
"dateStarted": "2024-04-23T16:07:24.742Z",
"dateStatusModified": "2024-04-23T16:07:24.742Z",
"description": "string",
"deviations": {
"12345": 0.5,
"origin": 0.5
},
"executeCodeForReference": true,
"goals": [
0
],
"id": 0,
"isArchived": true,
"isLegacyEditor": true,
"isMultipleTestingCorrection": true,
"mainGoalId": 0,
"name": "string",
"respoolTime": {
"12345": 833760000,
"origin": 1704067200
},
"siteCode": "string",
"siteId": 0,
"status": "string",
"tags": [
"string"
],
"targetingConfiguration": "SITE",
"targetingSegmentId": 0,
"trackingTools": [
{
"adobeOmnitureObject": "string",
"comScoreCustomerId": "string",
"comScoreDomain": "string",
"contentSquareUrl": "string",
"customIntegrations": [
"string"
],
"customVariable": 0,
"eulerianUserCentricParameter": "string",
"name": "GOOGLE_ANALYTICS4",
"reportingScript": "string",
"universalAnalyticsDimension": 0
}
],
"type": "CLASSIC",
"variations": [
0
]
}
]
Bad Request
- */*
- Schema
- Example (from schema)
Schema
- code string
- impersonator string
- message string
- name string
- status string
Possible values: [
SUCCESS
,ERROR
] - sub string
- time int64
- timestamp date-time
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-04-23T16:07:24.743Z"
}
Forbidden
- */*
- Schema
- Example (from schema)
Schema
- code string
- impersonator string
- message string
- name string
- status string
Possible values: [
SUCCESS
,ERROR
] - sub string
- time int64
- timestamp date-time
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-04-23T16:07:24.743Z"
}
Locked
- */*
- Schema
- Example (from schema)
Schema
- code string
- impersonator string
- message string
- name string
- status string
Possible values: [
SUCCESS
,ERROR
] - sub string
- time int64
- timestamp date-time
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-04-23T16:07:24.743Z"
}
Internal Server Error
- */*
- Schema
- Example (from schema)
Schema
- code string
- impersonator string
- message string
- name string
- status string
Possible values: [
SUCCESS
,ERROR
] - sub string
- time int64
- timestamp date-time
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-04-23T16:07:24.743Z"
}
Service Unavailable
- */*
- Schema
- Example (from schema)
Schema
- object
{}