Retrieve Experiment Summary Charts (Beta)

Retrieve Experiment Summary Charts (Beta)

gethttps://statsigapi.net/console/v1/experiments/{id}/summary_charts

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

idstringrequired

id

Query parameters

controlstring

Optional override control group ID

teststring

Optional override test group ID. Use "*" to query against all test groups.

Response

application/json
200· Get Experiment Summary Charts Success
messagestringrequired

A simple string explaining the result of the operation.

dataobjectrequired
Show child attributes
experimentIDstringrequired
sectionsobject[]required
sectionLabelstringrequired
chartsobject[]required
chartSourcestringrequired
Allowed values:experimentcustom_queryscheduled_custom_queryunsupported
messagestring
controlstring
teststring
displaystring
Allowed values:cumulativedailydxbartable
cupedboolean
sequentialTestingboolean
metricsobject[]
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
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
dimensionBreakdownobject[]
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
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
dimensionKeystringrequired
dimensionTypestring
dimensionValuestringrequired

Was this helpful?