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
sectionLabel[]stringrequired
charts[]object[]required
chartSource[]stringrequired
message[]string
control[]string
test[]string
display[]string
cuped[]boolean
sequentialTesting[]boolean
metrics[]object[]
metricID[]stringrequired
metricName[]stringrequired
directionality[]stringrequired

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

absoluteChange[]number
confidenceIntervalDelta[]number

Absolute confidence interval delta

confidenceInterval[]object

Confidence interval bounds

lowernumberrequired
uppernumberrequired
percentChange[]number
sequentialTestingConfidenceIntervalDelta[]number
sequentialTestingConfidenceInterval[]object

Confidence interval bounds

lowernumberrequired
uppernumberrequired
percentConfidenceIntervalDelta[]number
percentConfidenceInterval[]object

Confidence interval bounds

lowernumberrequired
uppernumberrequired
percentSequentialTestingConfidenceIntervalDelta[]number
percentSequentialTestingConfidenceInterval[]object

Confidence interval bounds

lowernumberrequired
uppernumberrequired
testMean[]number
controlMean[]number
testStd[]number
controlStd[]number
testUnits[]number
controlUnits[]number
pValue[]number
sequentialTestingPValue[]number
adjustedAlpha[]number
reversePower[]number
absoluteToplineImpact[]number
absoluteToplineImpactDelta[]number
relativeToplineImpact[]number
relativeToplineImpactDelta[]number
projectedAbsoluteToplineImpact[]number
projectedAbsoluteToplineImpactDelta[]number
projectedRelativeToplineImpact[]number
projectedRelativeToplineImpactDelta[]number
dimensionBreakdown[]object[]
metricID[]stringrequired
metricName[]stringrequired
directionality[]stringrequired

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

absoluteChange[]number
confidenceIntervalDelta[]number

Absolute confidence interval delta

confidenceInterval[]object

Confidence interval bounds

lowernumberrequired
uppernumberrequired
percentChange[]number
sequentialTestingConfidenceIntervalDelta[]number
sequentialTestingConfidenceInterval[]object

Confidence interval bounds

lowernumberrequired
uppernumberrequired
percentConfidenceIntervalDelta[]number
percentConfidenceInterval[]object

Confidence interval bounds

lowernumberrequired
uppernumberrequired
percentSequentialTestingConfidenceIntervalDelta[]number
percentSequentialTestingConfidenceInterval[]object

Confidence interval bounds

lowernumberrequired
uppernumberrequired
testMean[]number
controlMean[]number
testStd[]number
controlStd[]number
testUnits[]number
controlUnits[]number
pValue[]number
sequentialTestingPValue[]number
adjustedAlpha[]number
reversePower[]number
absoluteToplineImpact[]number
absoluteToplineImpactDelta[]number
relativeToplineImpact[]number
relativeToplineImpactDelta[]number
projectedAbsoluteToplineImpact[]number
projectedAbsoluteToplineImpactDelta[]number
projectedRelativeToplineImpact[]number
projectedRelativeToplineImpactDelta[]number
dimensionKey[]stringrequired
dimensionType[]string
dimensionValue[]stringrequired

Was this helpful?