Get Experiment

Authorizations

STATSIG-API-KEY

string

header

required

Headers

x-respect-review-settings

string

Optional header to respect review settings for mutation endpoints.

Path Parameters

id

string

required

id

Response

200

application/json

Get Experiment Success

message

string

required

A simple string explaining the result of the operation.

data

object

required

A single result.

Show child attributes

data.id

string

required

ID

data.idType

string

required

data.description

string

required

A helpful summary of what this experiment does

Maximum length: 1000

data.lastModifierID

string | null

required

ID of the last modifier.

data.lastModifiedTime

number | null

required

Time of the last modification.

data.lastModifierEmail

string | null

required

Email of the last modifier.

data.lastModifierName

string | null

required

Name of the last modifier.

data.createdTime

number

required

Timestamp when the entity was created.

data.creatorName

string | null

required

Name of the creator.

data.tags

string[]

required

data.hypothesis

string

required

A statement that will be tested by this experiment

data.groups

object[]

required

The test groups for your experiment

Show child attributes

data.groups.name

string

required

data.groups.size

number

required

Required range: 0 <= x <= 100

data.groups.parameterValues

object

required

Show child attributes

data.groups.parameterValues.{key}

any

data.groups.id

string | null

data.groups.disabled

boolean

data.groups.description

string

data.groups.foreignGroupID

string

data.allocation

number

required

Percent of layer allocated to this experiment

Required range: 0 <= x <= 100

data.primaryMetrics

object[]

required

Show child attributes

data.primaryMetrics.name

string

required

data.primaryMetrics.type

string

required

data.primaryMetrics.direction

enum<string>

Available options:

increase,

decrease

data.primaryMetrics.hypothesizedValue

number

data.secondaryMetrics

object[]

required

Show child attributes

data.secondaryMetrics.name

string

required

data.secondaryMetrics.type

string

required

data.secondaryMetrics.direction

enum<string>

Available options:

increase,

decrease

data.secondaryMetrics.hypothesizedValue

number

data.targetingGateID

string | null

required

Restrict your experiment to users passing the selected feature gate

data.bonferroniCorrection

boolean

required

Is Bonferroni correction applied per variant?

data.defaultConfidenceInterval

enum<string>

required

Default error margin used for results

Available options:

80,

90,

95,

98,

99

data.status

enum<string>

required

The current status of the experiment

Available options:

active,

setup,

decision_made,

abandoned,

archived,

experiment_stopped,

assignment_stopped

data.layerID

string | null

required

data.startTime

number | null

required

data.endTime

number | null

required

data.decisionReason

string | null

required

data.decisionTime

number | null

required

data.healthCheckStatus

enum<string>

required

Overall health check status

Available options:

PASSED,

FAILED,

WAITING,

WARNING

data.reviewSettings

object

Show child attributes

data.reviewSettings.requiredReview

boolean

required

data.reviewSettings.allowedReviewers

object[] | null

Show child attributes

data.reviewSettings.allowedReviewers.id

string

required

data.reviewSettings.allowedReviewers.name

string

required

data.reviewSettings.allowedReviewers.email

string

required

data.activeReview

object

Show child attributes

data.activeReview.reviewID

string

required

data.activeReview.reviewStatus

string

required

data.activeReview.description

string

required

data.name

string

Optional name for the configuration.

data.creatorID

string | null

The Statsig ID of the creator of this experiment

data.creatorEmail

string | null

The email of the creator of this experiment

data.targetApps

Target apps assigned to this experiment

data.holdoutIDs

string[]

Holdouts applied to this configuration.

data.team

string | null

The team name associated with the experiment, Enterprise only.

data.teamID

string | null

The team ID associated with the experiment, Enterprise only.

data.version

number

Version number

data.secondaryIDType

string | null

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

data.links

object[]

Links to relevant documentation or resources

Show child attributes

data.links.url

string

required

The URL of the link

data.links.title

string

The title of the link

data.controlGroupID

string

Optional control group ID

data.primaryMetricTags

string[]

Primary metric tags for the experiment

data.secondaryMetricTags

string[]

Secondary metric tags for the experiment

data.duration

integer

How long the experiment is expected to last in days

Required range: x > 1

data.targetExposures

integer

Target exposures for the experiment

Required range: x > 1

data.sequentialTesting

boolean

Apply sequential testing?

data.bonferroniCorrectionPerMetric

boolean

Is Bonferroni correction applied per metric?

data.benjaminiHochbergPerVariant

boolean

Is Benjamini-Hochberg procedure applied per variant?

data.benjaminiHochbergPerMetric

boolean

Is Benjamini-Hochberg procedure applied per metric?

data.benjaminiPrimaryMetricsOnly

boolean

Is Benjamini-Hochberg procedure applied for primary metrics only?

data.launchedGroupID

string | null

ID of the launched group, null otherwise

data.assignmentSourceName

string

data.assignmentSourceExperimentName

string

Name of the source experiment for assignment

data.isAnalysisOnly

boolean

data.allocationDuration

integer | null

Warehouse Native Only - Allocation duration in days

Required range: x > 1

data.cohortedAnalysisDuration

integer

Warehouse Native Only - Cohorted analysis duration in days

Required range: x > 1

data.cohortedMetricsMatureAfterEnd

boolean

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

data.cohortWaitUntilEndToInclude

boolean

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

data.fixedAnalysisDuration

integer

Fixed analysis duration in days

Required range: x > 1

data.scheduledReloadHour

integer

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

Required range: 0 <= x <= 23

data.scheduledReloadType

enum<string>

Warehouse Native only - reload type for scheduled reloads

Available options:

full,

incremental

data.analysisEndTime

string

data.precommitWebhook

object | null

Show child attributes

data.precommitWebhook.url

string

required

data.precommitWebhook.internalStatusUrl

string

required

data.assignmentSourceFilters

object[]

Array of criteria for filtering assignment sources.

Show child attributes

data.assignmentSourceFilters.condition

enum<string>

required

Available options:

in,

not_in,

=,

>,

<,

>=,

<=,

is_null,

non_null,

contains,

not_contains,

sql_filter,

starts_with,

ends_with,

after_exposure

data.assignmentSourceFilters.column

string

Column to filter on.

data.assignmentSourceFilters.values

string[]

Optional array of values for the criterion to match against.

data.analyticsType

string | null

data.subtype

enum<string>

Available options:

conversion,

reactivation,

retention

data.externalExperimentName

string

data.healthChecks

object[]

Show child attributes

data.healthChecks.name

string

required

data.healthChecks.description

string

required

data.healthChecks.status

enum<string>

required

Available options:

PASSED,

FAILED,

WAITING,

WARNING

data.healthChecks.metadata

object

Show child attributes

data.healthChecks.metadata.type

string

required

data.healthChecks.metadata.primary_id_type

string

required

data.healthChecks.metadata.lastPulseLoadTime

number

data.healthChecks.metadata.crossoverPercent

number

data.healthChecks.metadata.assignmentSourceID

string

data.healthChecks.metadata.assignmentSourceName

string

data.healthChecks.metadata.foreignExperimentID

string

data.healthChecks.metadata.deduplication_rate

number

data.healthChecks.metadata.deduplication_rates

object[]

Show child attributes

data.healthChecks.metadata.deduplication_rates.group_id

string

required

data.healthChecks.metadata.deduplication_rates.rate

number

required

data.healthChecks.metadata.deduplication_rates.group_name

string

required

data.healthChecks.metadata.secondary_id_type

string

data.healthChecks.metadata.missingMetrics

string[]

data.healthChecks.metadata.metrics

object[]

Show child attributes

data.healthChecks.metadata.metrics.metric_name

string

required

data.healthChecks.metadata.metrics.earliest_date

string | null

required

data.healthChecks.metadata.metrics.latest_date

string | null

required

data.healthChecks.metadata.lastUpdatedDs

string

data.healthChecks.type

enum<string>

Available options:

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

data.owner

object | null

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

Show child attributes

data.owner.ownerID

string

ID of the owner

Example:

"abc123"

data.owner.ownerType

string

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

Example:

"USER"

data.owner.ownerName

string

The name of the owner. This field is optional.

Example:

"John Doe"

data.owner.ownerEmail

string

The email of the owner. This field is optional.

Example:

{
  "ownerID": "user123",
  "ownerType": "USER",
  "ownerName": "John Doe",
  "ownerEmail": "[e-mail]"
}

data.inlineTargetingRulesJSON

string | null