v2

latestOpenAPI 3.0.02026-08-073221853.1 MB

Experiments

Get Experiment

get/console/v1/experiments/{id}

Path parameters

idstring required

Query parameters

fieldsstring[]

Comma-separated list of top-level fields to return (sparse fieldset), e.g. id,name,hypothesis,groups. id is always included. Reduces response size; when omitted the full experiment is returned.

Response

Get Experiment Success

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Experiments listed successfully.",
  "data": {
    "id": "a_experiment",
    "permalink": "https://console.statsig.com/company_id/experiments/a_experiment",
    "description": "",
    "lastModifiedTime": 1707427635442,
    "lastModifierEmail": null,
    "createdTime": 1707427634717,
    "creatorName": "CONSOLE API",
    "lastModifierName": "CONSOLE API",
    "lastModifierID": "4FKF0sUbi1D7xZFW5vcHWB",
    "idType": "userID",
    "status": "setup",
    "experimentType": "BASE",
    "launchedGroupID": null,
    "layerID": "statsig::a_experiment_layer",
    "hypothesis": "",
    "primaryMetrics": [],
    "primaryMetricTags": [],
    "secondaryMetrics": [],
    "secondaryMetricTags": [],
    "startTime": null,
    "endTime": null,
    "decisionTime": null,
    "groups": [
      {
        "name": "Control",
        "id": "4HbgLdfqlIeN3sHkyMG1qC",
        "size": 50,
        "parameterValues": {},
        "isControl": true
      },
      {
        "name": "Test",
        "size": 50,
        "parameterValues": {},
        "isControl": false
      }
    ],
    "allocation": 100,
    "duration": 14,
    "targetingGateID": "",
    "defaultConfidenceInterval": "95",
    "bonferroniCorrection": false,
    "tags": [
      "* Core"
    ],
    "decisionReason": "",
    "owner": {
      "ownerType": "USER",
      "ownerName": "Test User"
    },
    "healthCheckStatus": "PASSED",
    "isStale": false,
    "inlineTargetingRulesJSON": "{}",
    "powerAnalyses": [
      {
        "id": "experiment_data_report_id",
        "name": "My Power Analysis",
        "status": "ready",
        "isPrimary": true
      }
    ]
  }
}