List Experiments

GET /console/v1/experiments

List Experiments

cURL

curl --request GET \
  --url https://statsigapi.net/console/v1/experiments \
  --header 'STATSIG-API-KEY: <api-key>'

200

{
  "message": "Experiments listed successfully.",
  "data": [
    {
      "id": "a_experiment",
      "name": "a_experiment",
      "description": "description",
      "idType": "userID",
      "lastModifierID": "1vaQaBoLlkauH9iiuOSBP2",
      "lastModifiedTime": 1707427635442,
      "lastModifierName": "CONSOLE API",
      "lastModifierEmail": null,
      "creatorID": "1vaQaBoLlkauH9iiuOSBP2",
      "createdTime": 1707427634717,
      "creatorName": "CONSOLE API",
      "creatorEmail": null,
      "targetApps": [],
      "holdoutIDs": [],
      "tags": [],
      "status": "setup",
      "launchedGroupID": null,
      "startTime": null,
      "endTime": null,
      "layerID": null,
      "hypothesis": "This will be a good feature :)",
      "primaryMetrics": [
        {
          "name": "d1_retention_rate",
          "type": "user"
        }
      ],
      "primaryMetricTags": [],
      "secondaryMetrics": [],
      "secondaryMetricTags": [],
      "groups": [
        {
          "name": "Control",
          "id": "6sEQvUd4c6E55V6ljBYMeJ",
          "size": 50,
          "parameterValues": {
            "assigned_group": "control"
          },
          "description": ""
        },
        {
          "name": "Test",
          "id": "6sEQvVS6EoNzpkEgUJUpxL",
          "size": 50,
          "parameterValues": {
            "assigned_group": "test"
          },
          "description": ""
        }
      ],
      "allocation": 100,
      "duration": 14,
      "targetingGateID": "",
      "defaultConfidenceInterval": "95",
      "bonferroniCorrection": false,
      "decisionReason": null,
      "decisionTime": null,
      "healthChecks": [],
      "owner": {
        "ownerType": "USER",
        "ownerName": "Test User"
      },
      "inlineTargetingRulesJSON": "{}",
      "healthCheckStatus": "PASSED"
    },
    {
      "id": "b_experiment",
      "name": "b experiment",
      "description": "",
      "idType": "userID",
      "inlineTargetingRulesJSON": "{}",
      "lastModifierID": "68ztZp2v2nFc81RAsvuvj4",
      "lastModifiedTime": 1706744900374,
      "lastModifierName": "jacob O'Quinn",
      "lastModifierEmail": "[e-mail]",
      "creatorID": "68ztZp2v2nFc81RAsvuvj4",
      "createdTime": 1678394676162,
      "creatorName": "jacob O'Quinn",
      "creatorEmail": "[e-mail]",
      "targetApps": [],
      "holdoutIDs": [],
      "tags": [
        "customTag",
        "asdf"
      ],
      "status": "archived",
      "launchedGroupID": null,
      "startTime": null,
      "endTime": null,
      "layerID": null,
      "hypothesis": "",
      "primaryMetrics": [],
      "primaryMetricTags": [],
      "secondaryMetrics": [],
      "secondaryMetricTags": [
        "★ Core"
      ],
      "groups": [
        {
          "name": "Control",
          "id": "7dCnwm0by2laSOcBNKIL8r",
          "size": 50,
          "parameterValues": {
            "control": "control value"
          },
          "description": ""
        },
        {
          "name": "Test",
          "id": "7dCnwnFe0kuFcdKxoSEort",
          "size": 50,
          "parameterValues": {
            "control": "test value"
          },
          "description": ""
        }
      ],
      "allocation": 100,
      "duration": 14,
      "targetingGateID": "targeting_gate_to_select_users",
      "defaultConfidenceInterval": "95",
      "bonferroniCorrection": false,
      "decisionReason": null,
      "decisionTime": null,
      "healthCheckStatus": "WAITING",
      "healthChecks": [
        {
          "name": "Checks not yet detected",
          "status": "WAITING",
          "description": "This experiment has not recorded any exposure checks in production yet."
        },
        {
          "name": "Valid unit type not yet verified",
          "status": "WAITING",
          "description": "Exposure checks for this experiment are pending evaluation. This experiment requires exposure checks with unit IDs of type userID"
        },
        {
          "name": "Event metric data not yet verified",
          "status": "WAITING",
          "description": "This experiment has recorded no event metric with a valid unit ID yet, or these event metrics are pending evaluation. If you are importing events, this may take up to a day to reflect. This experiment requires metrics with unit IDs of type userID"
        },
        {
          "name": "Pulse metrics not yet available",
          "status": "WAITING",
          "description": "Expect to see your Pulse Results within 24 hours. Statsig computes Pulse results on a daily basis."
        },
        {
          "name": "Exposure balance not yet verified",
          "status": "WAITING",
          "description": "Exposure balance for this experiment is pending evaluation. As the experiment records more exposures, Statsig will continue to evaluate experiment exposure balance."
        }
      ]
    }
  ]
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Query Parameters

layerID · string

Which layer to place the experiment into.

idType · string

The idType the experiment will be performed on

status · string string[]

The current status of the experiment

creatorName · string | null

Name of the creator.

creatorID · string | null

ID of the user who created the entity.

tags · string string[]

Filter by tags

limit · integer

Results per page

Example:

10

page · integer

Page number

Example:

1

Response

200

application/json

List Experiments Success

message · string · required

A simple string explaining the result of the operation.

data · object[] · required

Array of results returned by pagination limit.

Show child attributes

pagination · object · required

Pagination metadata for checking if there is next page for example.

Show child attributes