Read experiment health and decisions through the REST API
Experiment results in the REST API include the same health checks and decision status that GrowthBook shows in the app. A script, dashboard, or agent can check for problems such as sample ratio mismatch and read the app's current recommendation before it acts on the numbers.
What the responses include
GET /v1/experiments/{id}/results can return two objects alongside the analysis:
result.healthcovers the snapshot as a whole. It reports sample ratio mismatch (SRM), multiple exposures, unknown variation IDs, a mid-experiment power estimate, and covariate imbalance. The SRM and multiple-exposure checks returnhealthy,unhealthy, ornot-enough-trafficagainst your organization's thresholds.experiment.enhancedStatuscan includeneedsAttention, which matches whether the app flags the experiment. For a running experiment, it can also include adecisionwith a status, the reason the app shows, and the variations it applies to.
A null power or covariate-imbalance check means the snapshot didn't produce one. Treat it as unknown, not healthy.
GET /v1/experiments/results lists the latest results for many experiments and can include health for each one. GET /v1/experiments/{id} can return enhancedStatus with the same needsAttention and decision fields.
Reading the decision
decisionuses the latest successful standard snapshot of the latest phase. It's omitted when there is nothing to report yet. If you request an earlier phase, the response omitsenhancedStatus.ship-now,rollback-now, andready-for-revieware recommendations from the Experiment Decision Framework. They appear only when your organization has the Decision Framework enabled, which is available on Pro and Enterprise plans. Each listed variation then has an action ofship,rollback, orreview, ornullwhen no rule applied.- When
decision.statusisunhealthy,healthIssuesnames the failing checks. When it'sdata-incomplete,erroredMetricIdslists the metrics that couldn't be computed.
Getting started
Create a Secret Key under Settings → API Keys. Then request an experiment's results and inspect result.health and experiment.enhancedStatus:
Self-hosted instances use their own API_HOST in place of https://api.growthbook.io/api. The Get results for an experiment reference documents every field.