Retrieve Pulse Results

Retrieve Pulse Results

gethttps://statsigapi.net/console/v1/holdouts/{id}/pulse_results

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

idstringrequired

id

Query parameters

cupedstring

Whether to apply CUPED. Allowed values are "true" or "false".

confidencestring

Confidence interval (0-100)

Response

application/json
200· Get Pulse Results Success
messagestringrequired

A simple string explaining the result of the operation.

dataobjectrequired
Show child attributes
dsstringrequired
monitoringMetricsobject[]required
metricIDstringrequired
metricNamestringrequired
directionalitystringrequired

Indicates the desired change direction for the metric. Use "increase" for positive changes and "decrease" for negative changes.

Allowed values:increasedecrease
Example:increase
erroroneOf

Machine-readable reason when pulse statistics are unavailable. Common values include no_data (insufficient data), echidna_unripe (not yet loaded), and setup_incomplete (misconfigured metric source). Additional string values may appear for cohort/bake windows or other load failures.

Example:no_data
Constraints:nullablestringstring
warningsstring[]

Human-readable warnings about metric data quality, load state, or partial pipeline failures.

absoluteChangenumber
confidenceIntervalDeltanumber

Absolute confidence interval delta

confidenceIntervalobject

Confidence interval bounds

Example:{"lower":-1.33,"upper":1.33}
lowernumberrequired
uppernumberrequired
percentChangenumber
sequentialTestingConfidenceIntervalDeltanumber
sequentialTestingConfidenceIntervalobject

Confidence interval bounds

Example:{"lower":-1.33,"upper":1.33}
lowernumberrequired
uppernumberrequired
percentConfidenceIntervalDeltanumber
percentConfidenceIntervalobject

Confidence interval bounds

Example:{"lower":-1.33,"upper":1.33}
lowernumberrequired
uppernumberrequired
percentSequentialTestingConfidenceIntervalDeltanumber
percentSequentialTestingConfidenceIntervalobject

Confidence interval bounds

Example:{"lower":-1.33,"upper":1.33}
lowernumberrequired
uppernumberrequired
testMeannumber
controlMeannumber
testStdnumber
controlStdnumber
testUnitsnumber
controlUnitsnumber
pValuenumber
sequentialTestingPValuenumber
Constraints:nullable
adjustedAlphanumber
reversePowernumber
absoluteToplineImpactnumber
absoluteToplineImpactDeltanumber
relativeToplineImpactnumber
relativeToplineImpactDeltanumber
projectedAbsoluteToplineImpactnumber
projectedAbsoluteToplineImpactDeltanumber
projectedRelativeToplineImpactnumber
projectedRelativeToplineImpactDeltanumber

Was this helpful?