Experiment Analysis Settings

datasourceId

string

required

assignmentQueryId

string

required

experimentId

string

required

segmentId

string

required

queryFilter

string

required

inProgressConversions

enum<string>

required

Available options:

include,

exclude

attributionModel

enum<string>

required

Setting attribution model to "experimentDuration" is the same as selecting "Ignore Conversion Windows" for the Conversion Window Override. Setting it to "lookbackOverride" requires a lookbackOverride object to be provided.

Available options:

firstExposure,

experimentDuration,

lookbackOverride

statsEngine

enum<string>

required

Available options:

bayesian,

frequentist

goals

object[]

required

Show child attributes

secondaryMetrics

object[]

required

Show child attributes

guardrails

object[]

required

Show child attributes

lookbackOverride

object

Controls the lookback override for the experiment. For type "window", value must be a non-negative number and valueUnit is required.

Show child attributes

regressionAdjustmentEnabled

boolean

sequentialTestingEnabled

boolean

sequentialTestingTuningParameter

number

postStratificationEnabled

boolean | null

When null, the organization default is used.

decisionFrameworkSettings

object

Controls the decision framework and metric overrides for the experiment. Replaces the entire stored object on update (does not patch individual fields).

Show child attributes

metricOverrides

object[]

Per-metric analysis overrides; also reflected in goals/secondaryMetrics/guardrails overrides when applicable. On create/update, this replaces the entire stored array (it does not patch individual entries).

Show child attributes

activationMetric

object

Show child attributes

{
  "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
    }
  ]
}

Introduction

Endpoints

Models