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

pageinteger

Page number

Response

application/json

200List Experiment Versions Success

messagestringrequired

A simple string explaining the result of the operation.

dataobject[]required

Show child attributes

reviewSettings[]object

Show child attributes

requiredReviewbooleanrequired

allowedReviewersobject[]

Show child attributes

id[]stringrequired

name[]stringrequired

email[]stringrequired

activeReview[]object

Show child attributes

reviewIDstringrequired

reviewStatusstringrequired

descriptionstringrequired

id[]stringrequired

name[]string

The display name of the experiment

idType[]stringrequired

description[]stringrequired

A helpful summary of what this experiment does

lastModifierID[]stringrequired

ID of the last modifier.

lastModifiedTime[]numberrequired

Time of the last modification.

lastModifierEmail[]stringrequired

Email of the last modifier.

lastModifierName[]stringrequired

Name of the last modifier.

creatorID[]string

The Statsig ID of the creator of this experiment

createdTime[]numberrequired

Timestamp when the entity was created.

creatorName[]stringrequired

Name of the creator.

creatorEmail[]string

The email of the creator of this experiment

tags[]string[]required

targetApps[]oneOf

Target apps assigned to this experiment

holdoutIDs[]string[]

Holdouts applied to this configuration.

team[]string

The team name associated with the experiment, Enterprise only.

teamID[]string

The team ID associated with the experiment, Enterprise only.

version[]number

Version number

secondaryIDType[]string

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

identifierMappingMode[]string

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

identityResolutionSource[]string

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

hypothesis[]stringrequired

A statement that will be tested by this experiment

links[]object[]

Links to relevant documentation or resources

Show child attributes

url[]stringrequired

The URL of the link

title[]string

The title of the link

externalEvents[]object[]

Show child attributes

name[]stringrequired

timestamp[]numberrequired

groups[]object[]required

The test groups for your experiment

Show child attributes

name[]stringrequired

id[]string

size[]numberrequired

parameterValues[]objectrequired

disabled[]boolean

description[]string

foreignGroupID[]string

highlighted[]boolean

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

controlGroupID[]string

Optional control group ID

allocation[]numberrequired

Percent of layer allocated to this experiment

userBuckets[]number[]

primaryMetricTags[]string[]

Primary metric tags for the experiment

secondaryMetricTags[]string[]

Secondary metric tags for the experiment

primaryMetrics[]object[]required

Show child attributes

name[]stringrequired

The metric name.

type[]stringrequired

The metric type.

direction[]string

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

hypothesizedValue[]number

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

secondaryMetrics[]object[]required

Show child attributes

name[]stringrequired

The metric name.

type[]stringrequired

The metric type.

direction[]string

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

hypothesizedValue[]number

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

otherMetrics[]object[]

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

Show child attributes

name[]stringrequired

The metric name.

type[]stringrequired

The metric type.

direction[]string

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

hypothesizedValue[]number

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

duration[]integer

How long the experiment is expected to last in days

targetExposures[]integer

Target exposures for the experiment

targetingGateID[]stringrequired

Restrict your experiment to users passing the selected feature gate

sequentialTesting[]boolean

Apply sequential testing?

bonferroniCorrection[]booleanrequired

Is Bonferroni correction applied per variant?

bonferroniCorrectionPerMetric[]boolean

Is Bonferroni correction applied per metric?

benjaminiHochbergPerVariant[]boolean

Is Benjamini-Hochberg procedure applied per variant?

benjaminiHochbergPerMetric[]boolean

Is Benjamini-Hochberg procedure applied per metric?

benjaminiPrimaryMetricsOnly[]boolean

Is Benjamini-Hochberg procedure applied for primary metrics only?

defaultConfidenceInterval[]stringrequired

Default error margin used for results

defaultRollupWindow[]integer

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

defaultChanceToBeatThreshold[]number

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

bayesianPriors[]object[]

Bayesian prior settings by metric.

Show child attributes

metric[]objectrequired

Show child attributes

namestringrequired

typestringrequired

priorMean[]numberrequired

priorStdDev[]numberrequired

manualQualityScores[]object[]

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

criteriaName[]oneOfrequired

status[]stringrequired

criteriaDescription[]stringrequired

score[]numberrequired

weight[]numberrequired

status[]stringrequired

The current status of the experiment

launchedGroupID[]string

ID of the launched group, null otherwise

assignmentSourceName[]string

assignmentSourceExperimentName[]string

Name of the source experiment for assignment

isAnalysisOnly[]boolean

allocationDuration[]integer

Warehouse Native Only - Allocation duration in days

cohortedAnalysisDuration[]integer

Warehouse Native Only - Cohorted analysis duration in days

cohortedMetricsMatureAfterEnd[]boolean

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

cohortWaitUntilEndToInclude[]boolean

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

fixedAnalysisDuration[]integer

Fixed analysis duration in days

scheduledReloadHour[]integer

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

scheduledReloadType[]string

Warehouse Native only - reload type for scheduled reloads

scheduledReloadDays[]integer[]

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

turboMode[]boolean

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

autoLoadToplineImpact[]boolean

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

analysisEndTime[]string

assignmentSourceFilters[]object[]

Array of criteria for filtering assignment sources.

Show child attributes

column[]string

Column to filter on.

condition[]stringrequired

values[]string[]

Optional array of values for the criterion to match against.

analyticsType[]string

defaultSPRTPowerParam[]number

defaultSPRTMDE[]number

sprtBaselineMode[]string

sprtMDESettings[]object[]

Show child attributes

metricKey[]stringrequired

groupSettings[]object[]required

Show child attributes

groupKey[]stringrequired

mde[]numberrequired

mean[]number

stdDev[]number

isSidecar[]boolean

Whether this is a Statsig Sidecar experiment.

decisionReason[]stringrequired

preComputedUserDimensions[]object[]

User dimensions that will be computed for every metric in WHN

Show child attributes

propertySource[]string

name[]stringrequired

cureCovariates[]object[]

CURE Covariates to use in this experiment

Show child attributes

name[]stringrequired

type[]stringrequired

stratifiedSampling[]object

The stratified sampling settings for the experiment

Show child attributes

statusstringrequired

metricobject

Show child attributes

namestringrequired

typestring

startDatestringrequired

endDatestringrequired

entityPropertySourceobject

Show child attributes

propertySourceNamestringrequired

columnstringrequired

csvobject

Show child attributes

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.

spreadReductionnumber

Observed reduction in spread after running stratified sampling.

enabledNonProdEnvironments[]string[]

subtype[]string

externalExperimentName[]string

layerID[]stringrequired

startTime[]numberrequired

endTime[]numberrequired

decisionTime[]numberrequired

healthChecks[]object[]

Show child attributes

name[]stringrequired

description[]stringrequired

status[]stringrequired

metadata[]object

Show child attributes

typestringrequired

lastPulseLoadTimenumber

crossoverPercentnumber

p_valuenumber

assignmentSourceIDstring

assignmentSourceNamestring

foreignExperimentIDstring

deduplication_ratenumber

deduplication_ratesobject[]

Show child attributes

group_id[]stringrequired

rate[]numberrequired

group_name[]stringrequired

primary_id_typestringrequired

secondary_id_typestring

missingMetricsstring[]

metricsobject[]

Show child attributes

metric_name[]stringrequired

earliest_date[]stringrequired

latest_date[]stringrequired

lastUpdatedDsstring

groupsobject[]

Show child attributes

groupID[]stringrequired

groupName[]stringrequired

status[]stringrequired

metrics[]object[]required

Show child attributes

metricKey[]stringrequired

metricTitle[]stringrequired

status[]stringrequired

groupBucketInfoobject[]

Show child attributes

groupID[]stringrequired

averageBucketSize[]numberrequired

type[]string

healthCheckStatus[]stringrequired

Overall health check status

experimentType[]stringrequired

The type of experiment

isStale[]booleanrequired

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

owner[]object

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

Show child attributes

ownerIDstring

ID of the owner

ownerTypestring

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

ownerNamestring

The name of the owner. This field is optional.

ownerEmailstring

The email of the owner. This field is optional.

inlineTargetingRulesJSON[]string

A raw JSON string of the inline targeting rules

inlineTargetingRules[]object[]

A formatted array of the inline targeting rules

Show child attributes

name[]stringrequired

The name of this rule.

passPercentage[]numberrequired

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

conditions[]object[]required

An array of Condition objects.

Show child attributes

targetValue[]oneOf

operator[]string

field[]string

customID[]string

type[]stringrequired

environments[]string[]

The environments this rule is enabled for.

id[]string

The Statsig ID of this rule.

baseID[]string

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

returnValue[]object

The return value of the rule.

completedAutomatedRollouts[]object[]

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

Show child attributes

time[]number

passPercent[]numberrequired

pendingAutomatedRollouts[]object[]

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

Show child attributes

time[]number

passPercent[]numberrequired

qualityScore[]object

The experiment quality score and per-criterion breakdown.

Show child attributes

scorenumberrequired

The normalized experiment quality score.

breakdownobject[]required

The per-criterion quality score breakdown.

Show child attributes

criterion[]stringrequired

The quality score criterion name.

status[]stringrequired

The quality score status for the criterion.

passingDescription[]stringrequired

The passing description for the criterion.

score[]numberrequired

The normalized score contribution for this criterion.

weight[]numberrequired

The normalized weight for this criterion.

summarySections[]object[]

Show child attributes

name[]stringrequired

content[]stringrequired

permalink[]stringrequired

A permalink to this experiment in the Statsig Console.

shipWithHoldout[]object

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.

Show child attributes

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.

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.

expectedDurationnumber

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

paginationobjectrequired

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

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

statusintegerrequired

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"

404

Response

{
  "status": 404,
  "message": "Not Found. The requested resource could not be found."
}

Was this helpful?