Retrieve Pulse Results (Beta)
Retrieve Pulse Results (Beta)
https://statsigapi.net/console/v1/experiments/{id}/pulse_resultsAuthorizations
STATSIG-API-KEYstringrequiredapiKey (header)
Path parameters
idstringrequiredid
Query parameters
controlstringrequiredControl Group ID
teststringrequiredTest Group ID
cupedstringWhether to apply CUPED. Allowed values are "true" or "false".
confidencestringConfidence interval (0-100)
applyBonferroniPerVariantstringWhether to apply Bonferroni Per Variant. Allowed values are "true" or "false".
applyBonferroniPerMetricstringWhether to apply Bonferroni Per Metric. Allowed values are "true" or "false".
bonferroniPrimaryMetricWeightstringα allocated to primary metrics
applyBenjaminiHochbergPerMetricstringWhether to apply Benjamini-Hochberg Correction Per Metric. Allowed values are "true" or "false".
applyBenjaminiHochbergPerVariantstringWhether to apply Benjamini-Hochberg Correction Per Variant. Allowed values are "true" or "false".
benjaminiPrimaryMetricsOnlystringWhether Benjamini-Hochberg correction should apply only to primary metrics. Allowed values are "true" or "false".
datestringDate for pulse results. format must be YYYY-MM-DD
benjaminiAcrossAllTestGroupsstringWhether to compute the Benjamini-Hochberg / Bonferroni-per-group correction across all of the experiment's test groups (matching the Console Results tab default for multi-group experiments) rather than only the requested test-vs-control pair. The returned results are always scoped to the requested pair; this controls only the correction family. Allowed values are "true" or "false". Defaults to "true".
Response
application/jsonmessagestringrequiredA simple string explaining the result of the operation.
dataobjectrequiredShow child attributes
dsstringrequiredprimaryMetricsobject[]requiredmetricIDstringrequiredmetricNamestringrequireddirectionalitystringrequiredIndicates the desired change direction for the metric. Use "increase" for positive changes and "decrease" for negative changes.
increasedecreaseincreaseabsoluteChangenumberconfidenceIntervalDeltanumberAbsolute confidence interval delta
confidenceIntervalobjectConfidence interval bounds
{"lower":-1.33,"upper":1.33}lowernumberrequireduppernumberrequiredpercentChangenumbersequentialTestingConfidenceIntervalDeltanumbersequentialTestingConfidenceIntervalobjectConfidence interval bounds
{"lower":-1.33,"upper":1.33}lowernumberrequireduppernumberrequiredpercentConfidenceIntervalDeltanumberpercentConfidenceIntervalobjectConfidence interval bounds
{"lower":-1.33,"upper":1.33}lowernumberrequireduppernumberrequiredpercentSequentialTestingConfidenceIntervalDeltanumberpercentSequentialTestingConfidenceIntervalobjectConfidence interval bounds
{"lower":-1.33,"upper":1.33}lowernumberrequireduppernumberrequiredtestMeannumbercontrolMeannumbertestStdnumbercontrolStdnumbertestUnitsnumbercontrolUnitsnumberpValuenumbersequentialTestingPValuenumbernullableadjustedAlphanumberreversePowernumberabsoluteToplineImpactnumberabsoluteToplineImpactDeltanumberrelativeToplineImpactnumberrelativeToplineImpactDeltanumberprojectedAbsoluteToplineImpactnumberprojectedAbsoluteToplineImpactDeltanumberprojectedRelativeToplineImpactnumberprojectedRelativeToplineImpactDeltanumbersecondaryMetricsobject[]requiredmetricIDstringrequiredmetricNamestringrequireddirectionalitystringrequiredIndicates the desired change direction for the metric. Use "increase" for positive changes and "decrease" for negative changes.
increasedecreaseincreaseabsoluteChangenumberconfidenceIntervalDeltanumberAbsolute confidence interval delta
confidenceIntervalobjectConfidence interval bounds
{"lower":-1.33,"upper":1.33}lowernumberrequireduppernumberrequiredpercentChangenumbersequentialTestingConfidenceIntervalDeltanumbersequentialTestingConfidenceIntervalobjectConfidence interval bounds
{"lower":-1.33,"upper":1.33}lowernumberrequireduppernumberrequiredpercentConfidenceIntervalDeltanumberpercentConfidenceIntervalobjectConfidence interval bounds
{"lower":-1.33,"upper":1.33}lowernumberrequireduppernumberrequiredpercentSequentialTestingConfidenceIntervalDeltanumberpercentSequentialTestingConfidenceIntervalobjectConfidence interval bounds
{"lower":-1.33,"upper":1.33}lowernumberrequireduppernumberrequiredtestMeannumbercontrolMeannumbertestStdnumbercontrolStdnumbertestUnitsnumbercontrolUnitsnumberpValuenumbersequentialTestingPValuenumbernullableadjustedAlphanumberreversePowernumberabsoluteToplineImpactnumberabsoluteToplineImpactDeltanumberrelativeToplineImpactnumberrelativeToplineImpactDeltanumberprojectedAbsoluteToplineImpactnumberprojectedAbsoluteToplineImpactDeltanumberprojectedRelativeToplineImpactnumberprojectedRelativeToplineImpactDeltanumberotherMetricsobject[]metricIDstringrequiredmetricNamestringrequireddirectionalitystringrequiredIndicates the desired change direction for the metric. Use "increase" for positive changes and "decrease" for negative changes.
increasedecreaseincreaseabsoluteChangenumberconfidenceIntervalDeltanumberAbsolute confidence interval delta
confidenceIntervalobjectConfidence interval bounds
{"lower":-1.33,"upper":1.33}lowernumberrequireduppernumberrequiredpercentChangenumbersequentialTestingConfidenceIntervalDeltanumbersequentialTestingConfidenceIntervalobjectConfidence interval bounds
{"lower":-1.33,"upper":1.33}lowernumberrequireduppernumberrequiredpercentConfidenceIntervalDeltanumberpercentConfidenceIntervalobjectConfidence interval bounds
{"lower":-1.33,"upper":1.33}lowernumberrequireduppernumberrequiredpercentSequentialTestingConfidenceIntervalDeltanumberpercentSequentialTestingConfidenceIntervalobjectConfidence interval bounds
{"lower":-1.33,"upper":1.33}lowernumberrequireduppernumberrequiredtestMeannumbercontrolMeannumbertestStdnumbercontrolStdnumbertestUnitsnumbercontrolUnitsnumberpValuenumbersequentialTestingPValuenumbernullableadjustedAlphanumberreversePowernumberabsoluteToplineImpactnumberabsoluteToplineImpactDeltanumberrelativeToplineImpactnumberrelativeToplineImpactDeltanumberprojectedAbsoluteToplineImpactnumberprojectedAbsoluteToplineImpactDeltanumberprojectedRelativeToplineImpactnumberprojectedRelativeToplineImpactDeltanumberWas this helpful?