How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GrowthBook experiments API

Experiments (A/B Tests)

GrowthBook experiments API is one of 36 APIs that GrowthBook publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Experiments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 10 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.growthbook.io/api, https://{domain}/api.

12 operations 10 paths 12 schemas 1 DELETE4 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.growthbook.io/api
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

GrowthBook experiments API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • bearerAuth — If using Bearer auth, pass the Secret Key as the token: bash curl https://api.growthbook.io/api/v1/features -H "Authorization: Bearer secretabc123DEF456"
  • basicAuth — If using HTTP Basic auth, pass the Secret Key as the username and leave the password blank: bash curl https://api.growthbook.io/api/v1/features -u secretabc123…

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 1 DELETE, 4 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

experiments 12

Experiments (A/B Tests)

GET
/v1/experiments
Get all experiments
listExperiments 7 params → 200
POST
/v1/experiments
Create a single experiment
postExperiment body → 200
GET
/v1/experiments/{id}
Get a single experiment
getExperiment 1 param → 200
POST
/v1/experiments/{id}
Update a single experiment
updateExperiment 1 param body → 200
GET
/v1/experiments/{id}/results
Get results for an experiment
getExperimentResults 3 params → 200
POST
/v1/experiments/{id}/start
Start an experiment
postExperimentStart 1 param body → 200
POST
/v1/experiments/{id}/stop
Stop an experiment
postExperimentStop 1 param body → 200
POST
/v1/experiments/{id}/modify-temporary-rollout
Modify temporary rollout status for a stopped experiment
postExperimentModifyTemporaryRollout 1 param body → 200
POST
/v1/experiments/{id}/snapshot
Create Experiment Snapshot
postExperimentSnapshot 1 param body → 200
POST
/v1/experiments/{id}/variation/{variationId}/screenshot/upload
Upload a variation screenshot
postVariationImageUpload 2 params body → 200
DELETE
/v1/experiments/{id}/variation/{variationId}/screenshot
Delete a variation screenshot
deleteVariationScreenshot 2 params body → 200
GET
/v1/experiment-names
Get a list of experiments with names and ids
getExperimentNames 1 param → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Experiment (40 properties), ExperimentAnalysisSettings (19 properties), ExperimentMetricOverrideEntry (11 properties), ExperimentResults (10 properties). Each schema is shown below with its type and property counts.

ExperimentMetric
object
2 properties 2 required
screenshot
object
2 properties 2 required
ExperimentResults
object
10 properties 10 required
experiments
object
2 properties 2 required
ExperimentDecisionFrameworkSettings
object
Controls the decision framework and metric overrides for the experiment. Replaces the entire stored object on update (does not patch individual fields).
2 properties
LookbackOverride
object
Controls the lookback override for the experiment. For type "window", value must be a non-negative number and valueUnit is required.
3 properties 2 required
ExperimentAnalysisSettings
object
19 properties 11 required
ExperimentWithEnhancedStatus
snapshot
object
3 properties 3 required
Experiment
object
40 properties 19 required
PaginationFields
object
6 properties 6 required
ExperimentMetricOverrideEntry
object
Per-metric analysis overrides stored on the experiment (matches internal metricOverrides).
11 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

growthbook-experiments-api-openapi.yml Raw ↑

Other APIs GrowthBook publishes across the network.

GrowthBook AnalyticsExplorations API
GrowthBook archetypes API
GrowthBook attributes API
GrowthBook code-references API
GrowthBook CustomFields API
GrowthBook Dashboards API
GrowthBook data-sources API
GrowthBook dimensions API
GrowthBook environments API
GrowthBook ExperimentTemplates API
GrowthBook fact-metrics API
GrowthBook fact-tables API
Where this information came from

This is an independent, third-party profile of GrowthBook experiments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.