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

Changes

Changed in 3 of the 8 revisions of this API.2622

Aug 26, 20261fd471fa03cc26See the full diff
- ●
  added the new after enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new any enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new any_case_sensitive enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new array_contains_all enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new array_contains_any enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new array_contains_none enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new before enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new encoded_any enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new gt enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new gte enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new is_not_null enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new is_null enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new lt enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new lte enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new none enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new none_case_sensitive enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new not_array_contains_all enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new on enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new str_contains_any enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new str_contains_none enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new str_matches enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new version_eq enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new version_gt enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new version_gte enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new version_lt enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new version_lte enum value to the allOf[subschema #2]/data/inlineTargetingRules/items/conditions/items/operator response property for the response status 200
  response-property-enum-value-added
Aug 11, 2026439e60273a2e11See the full diff
- ○
  added the optional property allOf[subschema #2]/data/allowOverridesInPulse to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/bonferroniPrimaryMetricWeight to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/defaultImpactMultiplier to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/defaultSPRTControlDelta to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/defaultSPRTTestDelta to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/excludePausedExposuresAndEvents to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/isHistoricalCloudExperiment to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/isImpactBankEnabled to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/originalScheduledReloadHour to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/originalTargetExposures to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/reviewsRequiredLocally to the response with the 200 status
  response-optional-property-added
Aug 7, 20263189f450c93b11See the full diff
- ○
  added the optional property allOf[subschema #2]/data/groups/items/foreignGroupIDVerified to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/groups/items/images to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/groups/items/isControl to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/groups/items/shipped to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/isPromptExperiment to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/isTemplate to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/originalTargetDuration to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/restartReason to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/salt to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/scheduledStartTime to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/wasAutoDisabled to the response with the 200 status
  response-optional-property-added

Full history