curl --request GET \
--url https://statsigapi.net/console/v1/experiments \
--header 'STATSIG-API-KEY: <api-key>'{
"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",
"experimentType": "BASE",
"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": "[email protected]",
"creatorID": "68ztZp2v2nFc81RAsvuvj4",
"createdTime": 1678394676162,
"creatorName": "jacob O'Quinn",
"creatorEmail": "[email protected]",
"targetApps": [],
"holdoutIDs": [],
"tags": [
"customTag",
"asdf"
],
"status": "archived",
"experimentType": "BASE",
"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."
}
]
}
]
}curl --request GET \
--url https://statsigapi.net/console/v1/experiments \
--header 'STATSIG-API-KEY: <api-key>'{
"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",
"experimentType": "BASE",
"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": "[email protected]",
"creatorID": "68ztZp2v2nFc81RAsvuvj4",
"createdTime": 1678394676162,
"creatorName": "jacob O'Quinn",
"creatorEmail": "[email protected]",
"targetApps": [],
"holdoutIDs": [],
"tags": [
"customTag",
"asdf"
],
"status": "archived",
"experimentType": "BASE",
"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."
}
]
}
]
}Optional header to respect review settings for mutation endpoints.
Which layer to place the experiment into.
The idType the experiment will be performed on
The team ID associated with the experiment, Enterprise only.
The current status of the experiment
active, setup, decision_made, abandoned, archived, experiment_stopped, assignment_stopped Expected valid date in the form of YYYY-MM-DD
"2024-01-01"
Expected valid date in the form of YYYY-MM-DD
"2024-01-01"
Filter by experiment type
BASE, GEO, SWITCHBACK, PROMPT, SIDECAR, GRID_SEARCH Name of the creator.
ID of the user who created the entity.
Filter by tags
Results per page
10
Page number
1
List Experiments Success
A simple string explaining the result of the operation.
Array of results returned by pagination limit.
Show child attributes
ID
A helpful summary of what this experiment does
1000ID of the last modifier.
Time of the last modification.
Email of the last modifier.
Name of the last modifier.
Timestamp when the entity was created.
Name of the creator.
A statement that will be tested by this experiment
The test groups for your experiment
Show child attributes
0 <= x <= 100Percent of layer allocated to this experiment
0 <= x <= 100Restrict your experiment to users passing the selected feature gate
Is Bonferroni correction applied per variant?
Default error margin used for results
80, 90, 95, 98, 99 The current status of the experiment
active, setup, decision_made, abandoned, archived, experiment_stopped, assignment_stopped Overall health check status
PASSED, FAILED, WAITING, WARNING The type of experiment
BASE, GEO, SWITCHBACK, PROMPT, SIDECAR, GRID_SEARCH Show child attributes
The display name of the experiment
3 - 100The Statsig ID of the creator of this experiment
The email of the creator of this experiment
Target apps assigned to this experiment
Holdouts applied to this configuration.
The team name associated with the experiment, Enterprise only.
The team ID associated with the experiment, Enterprise only.
Version number
The secondary ID type for the experiment used in WHN for ID resolution
The identifier mapping mode for the experiment used in WHN for ID resolution
strictOneToOne, firstTouchOneToMany, lastTouchOneToMany The identity resolution entity property source for the experiment used in WHN for ID resolution
Optional control group ID
Primary metric tags for the experiment
Secondary metric tags for the experiment
Additional metrics you want to investigate or learn from. The usual corrections applied to Primary and Secondary metrics are not applied to these.
How long the experiment is expected to last in days
x > 1Target exposures for the experiment
x > 1Apply sequential testing?
Is Bonferroni correction applied per metric?
Is Benjamini-Hochberg procedure applied per variant?
Is Benjamini-Hochberg procedure applied per metric?
Is Benjamini-Hochberg procedure applied for primary metrics only?
Up to 10 manually set quality scores for an experiment. The scores and weights will be added to the existing weights and scores, and then weights will be renormalized to 100. This can be set via the Statsig Console API. If targeting a default check, the weight of the check will be updated, but not the status or description. A default score can be removed by setting the weight to 0. The default score identifiers are one of: HYPOTHESIS_LENGTH, BALANCED_EXPOSURE, PRIMARY_METRICS_LENGTH, COMPARISON_CORRECTION, GUARDRAIL_METRIC_TAGS, SUFFICIENT_SAMPLE, POWER_ANALYSIS, SEQUENTIAL_TESTING
Show child attributes
HYPOTHESIS_LENGTH, BALANCED_EXPOSURE, PRIMARY_METRICS_LENGTH, COMPARISON_CORRECTION, GUARDRAIL_METRIC_TAGS, SUFFICIENT_SAMPLE, POWER_ANALYSIS, SEQUENTIAL_TESTING PASSED, FAILED, WARNING ID of the launched group, null otherwise
Name of the source experiment for assignment
Warehouse Native Only - Allocation duration in days
x > 1Warehouse Native Only - Cohorted analysis duration in days
x > 1Warehouse Native Only - Allow cohort metrics to mature after experiment end
Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists
Fixed analysis duration in days
x > 1Warehouse Native only - UTC hour at which to run scheduled pulse loads
0 <= x <= 23Warehouse Native only - reload type for scheduled reloads
full, incremental Warehouse Native only - days on which to run scheduled reloads from 0 to 6, 0 meaning Sunday. Null to run reloads on all days.
0 <= x <= 6Warehouse Native only - whether to run scheduled reloads with Turbo mode.
Array of criteria for filtering assignment sources.
Show child attributes
in, not_in, =, >, <, >=, <=, is_null, non_null, contains, not_contains, sql_filter, starts_with, ends_with, after_exposure, before_exposure, is_true, is_false Column to filter on.
Optional array of values for the criterion to match against.
Whether this is a Statsig Sidecar experiment.
The stratified sampling settings for the experiment
Show child attributes
pending, success, error conversion, reactivation, retention Show child attributes
PASSED, FAILED, WAITING, WARNING Show child attributes
has_checks, has_valid_unit_type, has_balanced_exposures, has_event_metrics, has_pulse_metrics, assignment_health, has_crossover, has_exposures, has_recent_exposures_for_analyze_whn, user_metrics_exist, deduplication_rate, deduplication_rate_group_level, windowed_metrics_have_outliers, exposures_data_is_behind, pre_experimental_bias_check, segments_of_interest_analysis, has_changed_parameter, metric_history_for_topline_impact, default_value_mismatch, has_data_gaps, has_correct_target_app, has_dag_failures, has_exploration_completed, autotune_has_outcomes Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.
Show child attributes
ID of the owner
"abc123"
Type of the owner (e.g., SDK_KEY or USER)
"USER"
The name of the owner. This field is optional.
"John Doe"
The email of the owner. This field is optional.
{
"ownerID": "user123",
"ownerType": "USER",
"ownerName": "John Doe",
"ownerEmail": "[email protected]"
}Pagination metadata for checking if there is next page for example.
Was this page helpful?