Experiment

string

required

trackingKey

string

required

dateCreated

string<date-time>

required

dateUpdated

string<date-time>

required

name

string

required

type

enum<string>

required

Available options:

standard,

multi-armed-bandit,

holdout

project

string

required

hypothesis

string

required

description

string

required

Maximum string length: 10000

tags

string[]

required

owner

string

required

The userId of the owner (or raw owner name/email for legacy records)

archived

boolean

required

status

string

required

autoRefresh

boolean

required

hashAttribute

string

required

hashVersion

required

variations

object[]

required

Show child attributes

phases

object[]

required

Show child attributes

settings

object

required

Show child attributes

ownerEmail

string

The email address of the owner, when the owner can be resolved to a known user.

fallbackAttribute

string

disableStickyBucketing

boolean

bucketVersion

number

minBucketVersion

number

resultSummary

object

Show child attributes

Available options:

public,

organization

publicUrl

string

banditScheduleValue

number

banditScheduleUnit

enum<string>

Available options:

days,

hours

banditBurnInValue

number

banditBurnInUnit

enum<string>

Available options:

days,

hours

banditConversionWindowValue

number

banditConversionWindowUnit

enum<string>

Available options:

days,

hours

linkedFeatures

string[]

attributeScopeAllProjects

boolean

hasVisualChangesets

boolean

hasURLRedirects

boolean

customFields

object

Show child attributes

customMetricSlices

object[]

Custom slices that apply to ALL applicable metrics in the experiment

Show child attributes

precomputedUnitDimensionIds

string[]

Maximum array length: 3

defaultDashboardId

string

ID of the default dashboard for this experiment.

templateId

string

statusUpdateSchedule

object | null

Scheduled start/end for an experiment. All fields optional; the end may be an absolute stopAt or a deferred relative stopAfter, but not both.

Show child attributes

nextScheduledStatusUpdate

object | null

Show child attributes

{
  "id": "<string>",
  "trackingKey": "<string>",
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateUpdated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "project": "<string>",
  "hypothesis": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "owner": "<string>",
  "archived": true,
  "status": "<string>",
  "autoRefresh": true,
  "hashAttribute": "<string>",
  "hashVersion": 1,
  "variations": [
    {
      "variationId": "<string>",
      "key": "<string>",
      "name": "<string>",
      "description": "<string>",
      "screenshots": [
        "<string>"
      ]
    }
  ],
  "phases": [
    {
      "name": "<string>",
      "dateStarted": "<string>",
      "dateEnded": "<string>",
      "reasonForStopping": "<string>",
      "seed": "<string>",
      "coverage": 123,
      "trafficSplit": [
        {
          "variationId": "<string>",
          "weight": 123
        }
      ],
      "targetingCondition": "<string>",
      "prerequisites": [
        {
          "id": "<string>",
          "condition": "<string>"
        }
      ],
      "savedGroupTargeting": [
        {
          "savedGroups": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "settings": {
    "datasourceId": "<string>",
    "assignmentQueryId": "<string>",
    "experimentId": "<string>",
    "segmentId": "<string>",
    "queryFilter": "<string>",
    "goals": [
      {
        "metricId": "<string>",
        "overrides": {
          "delayHours": 123,
          "windowHours": 123,
          "winRiskThreshold": 123,
          "loseRiskThreshold": 123,
          "properPriorOverride": true,
          "properPriorEnabled": true,
          "properPriorMean": 123,
          "properPriorStdDev": 123,
          "regressionAdjustmentOverride": true,
          "regressionAdjustmentEnabled": true,
          "regressionAdjustmentDays": 123
        }
      }
    ],
    "secondaryMetrics": [
      {
        "metricId": "<string>",
        "overrides": {
          "delayHours": 123,
          "windowHours": 123,
          "winRiskThreshold": 123,
          "loseRiskThreshold": 123,
          "properPriorOverride": true,
          "properPriorEnabled": true,
          "properPriorMean": 123,
          "properPriorStdDev": 123,
          "regressionAdjustmentOverride": true,
          "regressionAdjustmentEnabled": true,
          "regressionAdjustmentDays": 123
        }
      }
    ],
    "guardrails": [
      {
        "metricId": "<string>",
        "overrides": {
          "delayHours": 123,
          "windowHours": 123,
          "winRiskThreshold": 123,
          "loseRiskThreshold": 123,
          "properPriorOverride": true,
          "properPriorEnabled": true,
          "properPriorMean": 123,
          "properPriorStdDev": 123,
          "regressionAdjustmentOverride": true,
          "regressionAdjustmentEnabled": true,
          "regressionAdjustmentDays": 123
        }
      }
    ],
    "regressionAdjustmentEnabled": true,
    "sequentialTestingEnabled": true,
    "sequentialTestingTuningParameter": 123,
    "postStratificationEnabled": true,
    "decisionFrameworkSettings": {
      "decisionCriteriaId": "<string>",
      "decisionFrameworkMetricOverrides": [
        {
          "id": "<string>",
          "targetMDE": 123
        }
      ]
    },
    "metricOverrides": [
      {
        "id": "<string>",
        "windowHours": 123,
        "delayHours": 123,
        "properPriorOverride": true,
        "properPriorEnabled": true,
        "properPriorMean": 123,
        "properPriorStdDev": 123,
        "regressionAdjustmentOverride": true,
        "regressionAdjustmentEnabled": true,
        "regressionAdjustmentDays": 123
      }
    ]
  },
  "ownerEmail": "<string>",
  "fallbackAttribute": "<string>",
  "disableStickyBucketing": true,
  "bucketVersion": 123,
  "minBucketVersion": 123,
  "publicUrl": "<string>",
  "banditScheduleValue": 123,
  "banditBurnInValue": 123,
  "banditConversionWindowValue": 123,
  "linkedFeatures": [
    "<string>"
  ],
  "attributeScopeAllProjects": true,
  "hasVisualChangesets": true,
  "hasURLRedirects": true,
  "customFields": {},
  "customMetricSlices": [
    {
      "slices": [
        {
          "column": "<string>",
          "levels": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "precomputedUnitDimensionIds": [
    "<string>"
  ],
  "defaultDashboardId": "<string>",
  "templateId": "<string>",
  "statusUpdateSchedule": {
    "startAt": "2023-11-07T05:31:56Z",
    "stopAt": "2023-11-07T05:31:56Z"
  },
  "nextScheduledStatusUpdate": {
    "date": "2023-11-07T05:31:56Z"
  }
}

Introduction

Endpoints

Models