List Experiment Versions

gethttps://statsigapi.net/console/v1/experiments/{id}/versions

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

idstringrequired

Query parameters

limitinteger

Results per page

Example:10

Constraints:stringnumber

pageinteger

Page number

Example:1

Constraints:stringnumber

Response

application/json

200· List Experiment Versions Success

messagestringrequired

A simple string explaining the result of the operation.

dataobject[]required

Show child attributes

reviewSettingsobject

requiredReviewbooleanrequired

allowedReviewersobject[]

Constraints:nullable

idstringrequired

namestringrequired

emailstringrequired

activeReviewobject

reviewIDstringrequired

reviewStatusstringrequired

descriptionstringrequired

idstringrequired

namestring

The display name of the experiment

Constraints:min length: 3max length: 100pattern: ^[a-zA-Z0-9_\- ]*$

idTypestringrequired

descriptionstringrequired

A helpful summary of what this experiment does

Constraints:max length: 1000

lastModifierIDstringrequired

ID of the last modifier.

Constraints:nullable

lastModifiedTimenumberrequired

Time of the last modification.

Constraints:format: doublenullable

lastModifierEmailstringrequired

Email of the last modifier.

Constraints:nullable

lastModifierNamestringrequired

Name of the last modifier.

Constraints:nullable

creatorIDstring

The Statsig ID of the creator of this experiment

Constraints:nullable

createdTimenumberrequired

Timestamp when the entity was created.

Constraints:format: double

creatorNamestringrequired

Name of the creator.

Constraints:nullable

creatorEmailstring

The email of the creator of this experiment

Constraints:nullable

tagsstring[]required

targetAppsoneOf

Target apps assigned to this experiment

Constraints:stringstring[]

holdoutIDsstring[]

Holdouts applied to this configuration.

teamstring

The team name associated with the experiment, Enterprise only.

Constraints:nullable

teamIDstring

The team ID associated with the experiment, Enterprise only.

Constraints:nullable

versionnumber

Version number

Constraints:format: double

secondaryIDTypestring

The secondary ID type for the experiment used in WHN for ID resolution

Constraints:nullable

identifierMappingModestring

The identifier mapping mode for the experiment used in WHN for ID resolution

Allowed values:strictOneToOnefirstTouchOneToManylastTouchOneToMany

identityResolutionSourcestring

The identity resolution entity property source for the experiment used in WHN for ID resolution

Constraints:nullable

hypothesisstringrequired

A statement that will be tested by this experiment

linksobject[]

Links to relevant documentation or resources

urlstringrequired

The URL of the link

Constraints:format: uri

titlestring

The title of the link

externalEventsobject[]

namestringrequired

timestampnumberrequired

groupsobject[]required

The test groups for your experiment

namestringrequired

idstring

Constraints:nullable

sizenumberrequired

Constraints:min: 0max: 100

parameterValuesobjectrequired

disabledboolean

descriptionstring

foreignGroupIDstring

highlightedboolean

Marks this experiment group as highlighted in analysis views. Highlighted groups are prioritized (shown first) and can be used to filter.

controlGroupIDstring

Optional control group ID

allocationnumberrequired

Percent of layer allocated to this experiment

Constraints:format: doublemin: 0max: 100

userBucketsnumber[]

primaryMetricTagsstring[]

Primary metric tags for the experiment

secondaryMetricTagsstring[]

Secondary metric tags for the experiment

primaryMetricsobject[]required

namestringrequired

The metric name.

typestringrequired

The metric type.

directionstring

The expected direction for one-sided testing (a feature to only measure metric movements in a single direction)

Allowed values:increasedecrease

hypothesizedValuenumber

The comparison value for the one-sample testing (a feature to use a fixed baseline as the control value)

secondaryMetricsobject[]required

namestringrequired

The metric name.

typestringrequired

The metric type.

directionstring

The expected direction for one-sided testing (a feature to only measure metric movements in a single direction)

Allowed values:increasedecrease

hypothesizedValuenumber

The comparison value for the one-sample testing (a feature to use a fixed baseline as the control value)

otherMetricsobject[]

Additional metrics you want to investigate or learn from. The usual corrections applied to Primary and Secondary metrics are not applied to these.

namestringrequired

The metric name.

typestringrequired

The metric type.

directionstring

The expected direction for one-sided testing (a feature to only measure metric movements in a single direction)

Allowed values:increasedecrease

hypothesizedValuenumber

The comparison value for the one-sample testing (a feature to use a fixed baseline as the control value)

durationinteger

How long the experiment is expected to last in days

Constraints:format: int64min: 1

targetExposuresinteger

Target exposures for the experiment

Constraints:format: int64min: 1

targetingGateIDstringrequired

Restrict your experiment to users passing the selected feature gate

Constraints:nullable

sequentialTestingboolean

Apply sequential testing?

bonferroniCorrectionbooleanrequired

Is Bonferroni correction applied per variant?

bonferroniCorrectionPerMetricboolean

Is Bonferroni correction applied per metric?

benjaminiHochbergPerVariantboolean

Is Benjamini-Hochberg procedure applied per variant?

benjaminiHochbergPerMetricboolean

Is Benjamini-Hochberg procedure applied per metric?

benjaminiPrimaryMetricsOnlyboolean

Is Benjamini-Hochberg procedure applied for primary metrics only?

defaultConfidenceIntervalstringrequired

Default error margin used for results

Allowed values:8090959899

defaultRollupWindowinteger

Default rollup window in days for experiment results. Use -1 for cumulative. Only -1, 1, and 7 allowed for cloud experiments.

Constraints:format: int64

defaultChanceToBeatThresholdnumber

Default chance-to-beat threshold used for Bayesian results.

Constraints:format: double

bayesianPriorsobject[]

Bayesian prior settings by metric.

metricobjectrequired

namestringrequired

typestringrequired

priorMeannumberrequired

priorStdDevnumberrequired

manualQualityScoresobject[]

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

criteriaNameoneOfrequired

Constraints:stringstring

statusstringrequired

Allowed values:PASSEDFAILEDWARNING

criteriaDescriptionstringrequired

scorenumberrequired

weightnumberrequired

statusstringrequired

The current status of the experiment

Allowed values:activesetupdecision_madeabandonedarchivedexperiment_stoppedassignment_stopped

launchedGroupIDstring

ID of the launched group, null otherwise

Constraints:nullable

assignmentSourceNamestring

assignmentSourceExperimentNamestring

Name of the source experiment for assignment

isAnalysisOnlyboolean

allocationDurationinteger

Warehouse Native Only - Allocation duration in days

Constraints:format: int64nullablemin: 1

cohortedAnalysisDurationinteger

Warehouse Native Only - Cohorted analysis duration in days

Constraints:format: int64min: 1

cohortedMetricsMatureAfterEndboolean

Warehouse Native Only - Allow cohort metrics to mature after experiment end

cohortWaitUntilEndToIncludeboolean

Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists

fixedAnalysisDurationinteger

Fixed analysis duration in days

Constraints:format: int64min: 1

scheduledReloadHourinteger

Warehouse Native only - UTC hour at which to run scheduled pulse loads

Constraints:format: int64nullablemin: 0max: 23

scheduledReloadTypestring

Warehouse Native only - reload type for scheduled reloads

Allowed values:fullincremental

scheduledReloadDaysinteger[]

Warehouse Native only - days on which to run scheduled reloads from 0 to 6, 0 meaning Sunday. Null to run reloads on all days.

Constraints:nullable

turboModeboolean

Warehouse Native only - whether to run scheduled reloads with Turbo mode.

autoLoadToplineImpactboolean

Warehouse Native only - whether to automatically run topline and projected launch impact calculations when reloading experiments.

analysisEndTimestring

assignmentSourceFiltersobject[]

Array of criteria for filtering assignment sources.

columnstring

Column to filter on.

conditionstringrequired

Allowed values:innot_in=><>=<=is_nullnon_nullcontainsnot_containssql_filterstarts_withends_withafter_exposurebefore_exposureis_trueis_false

valuesstring[]

Optional array of values for the criterion to match against.

analyticsTypestring

Constraints:nullable

defaultSPRTPowerParamnumber

Constraints:format: double

defaultSPRTMDEnumber

Constraints:format: double

sprtBaselineModestring

Allowed values:manualin_experiment_control

sprtMDESettingsobject[]

metricKeystringrequired

groupSettingsobject[]required

groupKeystringrequired

mdenumberrequired

meannumber

stdDevnumber

isSidecarboolean

Whether this is a Statsig Sidecar experiment.

decisionReasonstringrequired

Constraints:nullable

preComputedUserDimensionsobject[]

User dimensions that will be computed for every metric in WHN

propertySourcestring

namestringrequired

cureCovariatesobject[]

CURE Covariates to use in this experiment

namestringrequired

typestringrequired

stratifiedSamplingobject

The stratified sampling settings for the experiment

Constraints:nullable

statusstringrequired

Allowed values:pendingsuccesserror

metricobject

namestringrequired

typestring

startDatestringrequired

endDatestringrequired

entityPropertySourceobject

propertySourceNamestringrequired

columnstringrequired

csvobject

originalstringrequired

identifierstringrequired

useStratifiedSaltboolean

Whether successful stratified sampling is currently used for experiment assignment.

useUnitsboolean

Whether stratified sampling was configured to use allocated units directly.

deltaReductionnumber

Observed reduction in delta after running stratified sampling.

Constraints:format: double

spreadReductionnumber

Observed reduction in spread after running stratified sampling.

Constraints:format: double

enabledNonProdEnvironmentsstring[]

subtypestring

Allowed values:conversionreactivationretention

externalExperimentNamestring

layerIDstringrequired

Constraints:nullable

startTimenumberrequired

Constraints:format: doublenullable

endTimenumberrequired

Constraints:format: doublenullable

decisionTimenumberrequired

Constraints:format: doublenullable

healthChecksobject[]

namestringrequired

descriptionstringrequired

statusstringrequired

Allowed values:PASSEDFAILEDWAITINGWARNINGNOT_APPLIED

metadataobject

typestringrequired

lastPulseLoadTimenumber

crossoverPercentnumber

p_valuenumber

assignmentSourceIDstring

assignmentSourceNamestring

foreignExperimentIDstring

deduplication_ratenumber

deduplication_ratesobject[]

group_idstringrequired

ratenumberrequired

group_namestringrequired

primary_id_typestringrequired

secondary_id_typestring

missingMetricsstring[]

metricsobject[]

metric_namestringrequired

earliest_datestringrequired

Constraints:format: date-timenullable

latest_datestringrequired

Constraints:format: date-timenullable

lastUpdatedDsstring

groupsobject[]

groupIDstringrequired

groupNamestringrequired

statusstringrequired

Allowed values:PASSEDFAILEDWAITINGWARNINGNOT_APPLIED

metricsobject[]required

metricKeystringrequired

metricTitlestringrequired

statusstringrequired

Allowed values:PASSEDFAILEDWAITINGWARNINGNOT_APPLIED

groupBucketInfoobject[]

groupIDstringrequired

averageBucketSizenumberrequired

typestring

Allowed values:has_checkshas_valid_unit_typehas_balanced_exposureshas_event_metricshas_pulse_metricsassignment_healthhas_crossoverhas_exposureshas_recent_exposures_for_analyze_whnuser_metrics_existdeduplication_ratededuplication_rate_group_levelwindowed_metrics_have_outliersexposures_data_is_behindpre_experimental_bias_checksegments_of_interest_analysishas_changed_parametermetric_history_for_topline_impactdefault_value_mismatchhas_data_gapshas_correct_target_apphas_dag_failureshas_exploration_completedautotune_has_outcomesmetric_stabilityhas_balanced_exposures

healthCheckStatusstringrequired

Overall health check status

Allowed values:PASSEDFAILEDWAITINGWARNINGNOT_APPLIED

experimentTypestringrequired

The type of experiment

Allowed values:BASEGEOSWITCHBACKPROMPTSIDECARGRID_SEARCH

isStalebooleanrequired

Whether the experiment is considered stale (e.g. in progress or decision-made and not modified in 30+ days).

ownerobject

Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.

Example:{"ownerID":"user123","ownerType":"USER","ownerName":"John Doe","ownerEmail":"owner123@test.com"}

Constraints:nullable

ownerIDstring

ID of the owner

Example:abc123

ownerTypestring

Type of the owner (e.g., SDK_KEY or USER)

Example:USER

ownerNamestring

The name of the owner. This field is optional.

Example:John Doe

ownerEmailstring

The email of the owner. This field is optional.

inlineTargetingRulesJSONstring

A raw JSON string of the inline targeting rules

Constraints:nullable

inlineTargetingRulesobject[]

A formatted array of the inline targeting rules

namestringrequired

The name of this rule.

passPercentagenumberrequired

Of the users that meet the conditions of this rule, what percent should return true.

Constraints:min: 0max: 100

conditionsobject[]required

An array of Condition objects.

targetValueoneOf

Constraints:nullablestring[]number[]stringnumber

operatorstring

fieldstring

Constraints:nullable

customIDstring

Constraints:nullable

typestringrequired

Allowed values:app_versionbrowser_namebrowser_versioncountrycustom_fieldemailenvironment_tierfails_gatefails_segmentip_addresslocaleos_nameos_versionpasses_gatepasses_segmentpublictimeunit_iduser_iduser_agenturljavascriptdevice_modeltarget_appexperiment_group

environmentsstring[]

The environments this rule is enabled for.

Constraints:nullable

idstring

The Statsig ID of this rule.

baseIDstring

The base ID of this rule, i.e. without any added metadata. Will remain the exact same throughout

returnValueobject

The return value of the rule.

completedAutomatedRolloutsobject[]

Read-only: Automated rollout phases that have already completed.

timenumber

passPercentnumberrequired

pendingAutomatedRolloutsobject[]

Read-only: Automated rollout phases that are scheduled but not yet complete.

timenumber

passPercentnumberrequired

qualityScoreobject

The experiment quality score and per-criterion breakdown.

Constraints:nullable

scorenumberrequired

The normalized experiment quality score.

Constraints:format: double

breakdownobject[]required

The per-criterion quality score breakdown.

criterionstringrequired

The quality score criterion name.

statusstringrequired

The quality score status for the criterion.

Allowed values:PASSEDFAILEDWAITINGWARNINGNOT_APPLIED

Constraints:nullable

passingDescriptionstringrequired

The passing description for the criterion.

scorenumberrequired

The normalized score contribution for this criterion.

weightnumberrequired

The normalized weight for this criterion.

summarySectionsobject[]

Constraints:nullable

namestringrequired

contentstringrequired

Constraints:nullable

permalinkstringrequired

A permalink to this experiment in the Statsig Console.

Constraints:format: uri

shipWithHoldoutobject

Present when the experiment has been shipped with a holdback group via make_decision (i.e. the winning variant is live for most users but a control slice is held back for ongoing measurement). Absent for experiments that have not been shipped, or that were shipped fully without a holdback.

holdoutPercentintegerrequired

Integer percentage of users held back when the experiment was shipped with holdback. Each non-shipped group receives this percentage of traffic and the shipped group receives the remainder.

Example:10

Constraints:format: int64

shippedGroupIDstringrequired

ID of the group that was shipped (i.e. the winning variant).

shippedGroupNamestringrequired

Name of the group that was shipped.

shippedWithHoldoutTimenumber

Unix timestamp (ms) at which the experiment was shipped with holdback.

Constraints:format: double

expectedDurationnumber

Expected duration of the holdback period in days, if specified when shipping.

Constraints:format: double

powerAnalysesobject[]required

The power analyses linked to this experiment. Empty when no power analysis is linked.

idstringrequired

The ID of the linked power analysis report.

namestringrequired

The name of the linked power analysis report.

Constraints:nullable

statusstringrequired

The status of the linked power analysis report.

Allowed values:pendingfailedreadyexpired

isPrimarybooleanrequired

Whether this is the experiment's primary attached power analysis report.

paginationobjectrequired

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

Show child attributes

itemsPerPagenumberrequired

Constraints:format: double

pageNumbernumberrequired

Constraints:format: double

nextPagestringrequired

Constraints:nullable

previousPagestringrequired

Constraints:nullable

totalItemsnumber

Constraints:format: double

allstring

404· Not Found. The requested resource could not be found.

statusintegerrequired

Allowed values:404

messagestringrequired

List Experiment Versions

curl -X GET "https://statsigapi.net/console/v1/experiments/{id}/versions?limit=10&page=1" \
  -H "Content-Type: application/json" \
  -H "STATSIG-API-KEY: YOUR_API_KEY"

Was this helpful?