Retrieve Experiment Summary Charts (Beta)
Retrieve Experiment Summary Charts (Beta)
https://statsigapi.net/console/v1/experiments/{id}/summary_chartsAuthorizations
STATSIG-API-KEYstringrequiredapiKey (header)
Path parameters
idstringrequiredid
Query parameters
controlstringOptional override control group ID
teststringOptional override test group ID. Use "*" to query against all test groups.
Response
application/jsonmessagestringrequiredA simple string explaining the result of the operation.
dataobjectrequiredShow child attributes
experimentIDstringrequiredsectionsobject[]requiredsectionLabelstringrequiredchartsobject[]requiredchartSourcestringrequiredexperimentcustom_queryscheduled_custom_queryunsupportedmessagestringcontrolstringteststringdisplaystringcumulativedailydxbartablecupedbooleansequentialTestingbooleanmetricsobject[]metricIDstringrequiredmetricNamestringrequireddirectionalitystringrequiredIndicates the desired change direction for the metric. Use "increase" for positive changes and "decrease" for negative changes.
increasedecreaseincreaseerroroneOfMachine-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.
no_datanullablestringstringwarningsstring[]Human-readable warnings about metric data quality, load state, or partial pipeline failures.
absoluteChangenumberconfidenceIntervalDeltanumberAbsolute 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}lowernumberrequireduppernumberrequiredtestMeannumbercontrolMeannumbertestStdnumbercontrolStdnumbertestUnitsnumbercontrolUnitsnumberpValuenumbersequentialTestingPValuenumbernullableadjustedAlphanumberreversePowernumberpercentCredibleIntervalobjectBayesian credible interval for the percent change. Only returned when results are computed with Bayesian analysis.
{"lower":-1.33,"upper":1.33}lowernumberrequireduppernumberrequiredexpectedLossnumberBayesian expected loss. Only returned when results are computed with Bayesian analysis.
chanceToBeatnumberBayesian probability that the test beats the control. Only returned when results are computed with Bayesian analysis.
absoluteToplineImpactnumberabsoluteToplineImpactDeltanumberrelativeToplineImpactnumberrelativeToplineImpactDeltanumberprojectedAbsoluteToplineImpactnumberprojectedAbsoluteToplineImpactDeltanumberprojectedRelativeToplineImpactnumberprojectedRelativeToplineImpactDeltanumberdimensionBreakdownobject[]metricIDstringrequiredmetricNamestringrequireddirectionalitystringrequiredIndicates the desired change direction for the metric. Use "increase" for positive changes and "decrease" for negative changes.
increasedecreaseincreaseerroroneOfMachine-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.
no_datanullablestringstringwarningsstring[]Human-readable warnings about metric data quality, load state, or partial pipeline failures.
absoluteChangenumberconfidenceIntervalDeltanumberAbsolute 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}lowernumberrequireduppernumberrequiredtestMeannumbercontrolMeannumbertestStdnumbercontrolStdnumbertestUnitsnumbercontrolUnitsnumberpValuenumbersequentialTestingPValuenumbernullableadjustedAlphanumberreversePowernumberpercentCredibleIntervalobjectBayesian credible interval for the percent change. Only returned when results are computed with Bayesian analysis.
{"lower":-1.33,"upper":1.33}lowernumberrequireduppernumberrequiredexpectedLossnumberBayesian expected loss. Only returned when results are computed with Bayesian analysis.
chanceToBeatnumberBayesian probability that the test beats the control. Only returned when results are computed with Bayesian analysis.
absoluteToplineImpactnumberabsoluteToplineImpactDeltanumberrelativeToplineImpactnumberrelativeToplineImpactDeltanumberprojectedAbsoluteToplineImpactnumberprojectedAbsoluteToplineImpactDeltanumberprojectedRelativeToplineImpactnumberprojectedRelativeToplineImpactDeltanumberdimensionKeystringrequireddimensionTypestringdimensionValuestringrequiredWas this helpful?