> ## Documentation Index
> Fetch the complete documentation index at: https://docs.growthbook.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Create a new report
## OpenAPI
````yaml openapi.yaml POST /v1/reports
openapi: 3.1.0
info:
version: 5.1.0
title: GrowthBook REST API
description: >
GrowthBook offers a full REST API for interacting with the application.
Request data can use either JSON or Form data encoding (with proper
`Content-Type` headers). All response bodies are JSON-encoded.
The API base URL for GrowthBook Cloud is `https://api.growthbook.io/api`.
For self-hosted deployments, it is the same as your API_HOST environment
variable (defaults to `http://localhost:3100/api`). The rest of these docs
will assume you are using GrowthBook Cloud.
## Versioning
Endpoints are versioned by path prefix:
- `/v1/...` — stable, widely-supported endpoints
- `/v2/...` — updated endpoints with improved shapes (e.g. unified per-rule
environment scope for feature flags)
New integrations should prefer v2 where available.
## Authentication
We support both the HTTP Basic and Bearer authentication schemes for
convenience.
You first need to generate a new API Key in GrowthBook. Different keys have
different permissions:
- **Personal Access Tokens**: These are sensitive and provide the same level
of access as the user has to an organization. These can be created by going
to `Personal Access Tokens` under the your user menu.
- **Secret Keys**: These are sensitive and provide the level of access for
the role, which currently is either `admin` or `readonly`. Only Admins with
the `manageApiKeys` permission can manage Secret Keys on behalf of an
organization. These can be created by going to `Settings -> API Keys`
If using HTTP Basic auth, pass the Secret Key as the username and leave the
password blank (when using curl, add `:` at the end of the secret to
indicate an empty password)
```bash
curl https://api.growthbook.io/api/v1/features \
-u secret_abc123DEF456:
```
If using Bearer auth, pass the Secret Key as the token:
```bash
curl https://api.growthbook.io/api/v1/features \
-H "Authorization: Bearer secret_abc123DEF456"
```
## Errors
The API may return the following error status codes:
- **400** - Bad Request - Often due to a missing required parameter
- **401** - Unauthorized - No valid API key provided
- **402** - Request Failed - The parameters are valid, but the request
failed
- **403** - Forbidden - Provided API key does not have the required access
- **404** - Not Found - Unknown API route or requested resource
- **422** - Unprocessable Entity - The request is valid, but a warning,
validation rule, approval requirement, or another publishing gate blocked
it. Do not assume that `ignoreWarnings` clears every 422 response.
- **429** - Too Many Requests - You exceeded the rate limit of 60 requests
per minute. Try again later.
- **5XX** - Server Error - Something went wrong on GrowthBook's end (these
are rare)
The response body will be a JSON object with the following properties:
- **message** - Information about the error
### Publishing gates
Publish responses include a `gates` array that explains every blocker:
- `type`, `severity`, and `messages` identify the problem.
- `override` names the request-body field that can bypass it. This is
`ignoreWarnings` for warnings, `skipSchemaValidation` for schema and
invariant failures, or `skipHooks` for Custom Hook rejections. A value of
`null` means there is no request-body override.
- `requiresPermission` identifies any additional permission needed to use
the override.
- `resolution` provides an API action, method, and path when the blocker
must be resolved another way.
For example, an approval gate is cleared by approving the revision or by
using a caller with **Bypass draft approvals** access. A Config lock is
cleared through the unlock route in `resolution`.
When a successful publish bypasses a gate, the response includes
`bypassedGates`. Each entry reports the gate `type` and how it was bypassed
in `via`, which is one of `ignoreWarnings`, `skipSchemaValidation`,
`skipHooks`, `bypassApprovalPermission`, `restApiBypassesReviews`, or
`revertsBypassApproval` (reverts only). This field is omitted when no gates
were bypassed.
servers:
- url: https://api.growthbook.io/api
description: GrowthBook Cloud
- url: https://{domain}/api
description: Self-hosted GrowthBook
variables:
domain:
default: localhost:3100
description: Your self-hosted GrowthBook host (and port)
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: projects
x-displayName: Projects
description: Projects are used to organize your feature flags and experiments
- name: environments
x-displayName: Environments
description: >-
GrowthBook comes with one environment by default (production), but you can
add as many as you need. When used with feature flags, you can
enable/disable feature flags on a per-environment basis.
- name: features-v2
x-displayName: Feature Flags
description: >-
Control your feature flags programmatically.
Rules are returned as a unified top-level array; each rule carries
`allEnvironments` / `environments` scope fields instead of being bucketed
by environment.
- name: feature-revisions-v2
x-displayName: Feature Revisions
description: >-
Draft revisions for feature flags, including rules, scheduling, and
approval workflows.
Revision `rules` is a flat array with per-rule scope fields.
- name: features
x-displayName: Feature Flags (legacy)
description: >-
Control your feature flags programmatically.
**These are v1 endpoints.** New integrations should use the v2 Feature
Flags endpoints, which expose a unified per-rule environment scope instead
of per-environment rule arrays.
- name: feature-revisions
x-displayName: Feature Revisions (legacy)
description: >-
Draft revisions for feature flags, including rules, scheduling, and
approval workflows.
**These are v1 endpoints.** New integrations should use the v2 Feature
Revisions endpoints.
- name: ramp-schedules
x-displayName: Ramp Schedules
description: >-
Multi-step rollout schedules that gradually increase feature rule traffic
over time, with optional real-time monitoring. Each step supports interval
timers, approval gates, and hold conditions. Monitored steps are backed by
a live analysis experiment that can automatically hold, roll back, or
advance the ramp based on guardrail and signal metric health.
- name: data-sources
x-displayName: Data Sources
description: >-
How GrowthBook connects and queries your data, including cached database
schema metadata (information schemas) for tables and columns.
- name: fact-tables
x-displayName: Fact Tables
description: Fact Tables describe the shape of your data warehouse tables
- name: fact-metrics
x-displayName: Fact Metrics
description: Fact Metrics are metrics built on top of Fact Table definitions
- name: metrics
x-displayName: Metrics (legacy)
description: Metrics used as goals and guardrails for experiments
- name: experiments
x-displayName: Experiments
description: Experiments (A/B Tests)
- name: namespaces
x-displayName: Namespaces
description: >-
Namespaces partition your user population into buckets so that experiments
using the same hash attribute do not overlap unintentionally. Each
namespace defines a 0–1 range and individual experiments claim sub-ranges
within it.
- name: snapshots
x-displayName: Experiment Snapshots
description: Experiment Snapshots (the individual updates of an experiment)
- name: dimensions
x-displayName: Dimensions
description: Dimensions used during experiment analysis
- name: segments
x-displayName: Segments
description: Segments used during experiment analysis
- name: reports
x-displayName: Experiment Reports
description: >-
Custom analysis reports built on top of experiment snapshots. Reports let
you re-run analysis with different metrics, date ranges, stats engines,
and other settings without modifying the underlying experiment.
- name: sdk-connections
x-displayName: SDK Connections
description: Client keys and settings for connecting SDKs to a GrowthBook instance
- name: visual-changesets
x-displayName: Visual Changesets
description: Groups of visual changes made by the visual editor to a single page
- name: saved-groups
x-displayName: Saved Groups
description: >-
Defined sets of attribute values which can be used with feature rules for
targeting features at particular users.
- name: saved-group-revisions
x-displayName: Saved Group Revisions
description: >-
Draft revisions for saved groups, including pending changes, approvals,
and lifecycle (publish, discard, revert).
Most callers can interact with these endpoints via shorthand actions
(`/items/add`, `/items/remove`, single-field PUTs) instead of authoring
JSON Patch ops directly. Pass `version: "new"` on edit endpoints to
auto-create a draft.
- name: constants
x-displayName: Constants
description: >-
**Beta** — these endpoints are new and may change in
backwards-incompatible ways.
Reusable named values referenced from feature flag values as `@const:key`
and resolved into the SDK payload at build time. String constants are
interpolated via `{{ @const:key }}`; JSON (object) constants are composed
via an `$extends` array. A constant's own keys **replace** what its
`$extends` bases provide, wholesale — constants are atomic building
blocks. (Config and feature values compose as deep, targeted patches
instead.)
- name: constant-revisions
x-displayName: Constant Revisions
description: >-
**Beta** — these endpoints are new and may change in
backwards-incompatible ways.
Draft revisions for constants, including pending changes, approvals, and
lifecycle (publish, discard, revert). Pass `version: "new"` on edit
endpoints to auto-create a draft.
- name: configs
x-displayName: Configs
description: >-
**Beta** — these endpoints are new and may change in
backwards-incompatible ways.
Reusable, typed, inheritable JSON objects referenced from feature flag
values as `@config:key`. A config carries a field `schema` (with
TypeScript/JSON Schema import-export) and a lineage `parent`. Inheritance
is expressed via `parent`, never an in-value `@config:` entry. Values
layer as a **deep, targeted patch**: a child (or a config-backed feature
value) restates only the leaves it changes and inherits the rest — unlike
a constant's `$extends`, whose own keys replace wholesale. Schema fields
colliding with a published ancestor's key follow 'base wins': identical
re-declarations are stripped with a warning, differing ones are rejected.
- name: config-revisions
x-displayName: Config Revisions
description: >-
**Beta** — these endpoints are new and may change in
backwards-incompatible ways.
Draft revisions for configs, including value and schema edits, schema
import (JSON Schema / TypeScript / inferred), approvals, and lifecycle
(publish, discard, revert). Publishing a schema change cascades the "base
wins" normalization to descendant configs; a publish that removes or
retypes fields descendants still use soft-blocks with a 422 unless the
request body sets `ignoreWarnings: true`. Pass `version: "new"` on edit
endpoints to auto-create a draft.
- name: releases
x-displayName: Releases
description: >-
**Beta** — these endpoints are new and may change in
backwards-incompatible ways.
Coordinated multi-entity publishing: publish a set of revisions across
Feature Flags, Saved Groups, configs, and constants as one all-or-nothing
operation, validated against the combined end-state instead of each
in-between state. Requires the `releases` commercial feature.
- name: custom-hooks
x-displayName: Custom Hooks
description: >-
Sandboxed JavaScript validation hooks that run when features, configs, or
their revisions are saved or published. Throwing an Error blocks the save;
`addWarning(msg)` raises a soft warning. Hooks are scoped by projects, or
pinned to a single feature/config via `entityType`/`entityId`; a
config-scoped hook also runs for every config inheriting from it (its
whole descendant lineage). Scope can be retargeted on update (or cleared
with nulls). Requires an enterprise plan; not available on GrowthBook
Cloud.
- name: organizations
x-displayName: Organizations
description: >-
Organizations are used for multi-org deployments where different teams can
run their own isolated feature flags and experiments. These endpoints are
only via a super-admin's Personal Access Token.
- name: members
x-displayName: Members
description: Members are users who have been invited to an organization.
- name: code-references
x-displayName: Code References
description: >-
Intended for use with our code reference CI utility,
[`gb-find-code-refs`](https://github.com/growthbook/gb-find-code-refs).
- name: archetypes
x-displayName: Archetypes
description: >-
Archetypes allow you to simulate the result of targeting rules on pre-set
user attributes
- name: queries
x-displayName: Queries
description: Retrieve queries used in experiments to calculate results.
- name: settings
x-displayName: Settings
description: Get the organization settings.
- name: attributes
x-displayName: Attributes
description: Used when targeting feature flags and experiments.
- name: usage
x-displayName: Usage
description: Usage information for metrics in experiments.
- name: meta
x-displayName: Meta
description: >-
Server metadata, including the running build's version and commit for
version-skew checks.
- name: ContextualBandits
x-displayName: Contextual Bandits
description: ''
- name: Dashboards
x-displayName: Dashboards
description: ''
- name: ContextualBanditQueries
x-displayName: Contextual Bandit Queries
description: ''
- name: CustomFields
x-displayName: Custom Fields
description: ''
- name: MetricGroups
x-displayName: Metric Groups
description: ''
- name: Teams
x-displayName: Teams
description: ''
- name: ExperimentTemplates
x-displayName: Experiment Templates
description: ''
- name: AnalyticsExplorations
x-displayName: Analytics Explorations
description: ''
- name: RampScheduleTemplates
x-displayName: Ramp Schedule Templates
description: Reusable step configurations for ramp schedules.
- name: Learnings
x-displayName: Learnings
description: >-
Saved learnings captured across experiments, including AI-discovered
patterns.
- name: Holdouts
x-displayName: Holdouts
description: >-
Hold a share of traffic out of all experiments to measure their combined
effect.
- name: AutoRuns
x-displayName: Auto Runs
description: ''
- name: AggregatedFactTable_model
x-displayName: Aggregated Fact Table
description:
- name: AnalyticsExploration_model
x-displayName: Analytics Exploration
description:
- name: Archetype_model
x-displayName: Archetype
description:
- name: Attribute_model
x-displayName: Attribute
description:
- name: AutoRun_model
x-displayName: Auto Run
description:
- name: CodeRef_model
x-displayName: Code Ref
description:
- name: Config_model
x-displayName: Config
description:
- name: ConfigKeyUsage_model
x-displayName: Config Key Usage
description:
- name: ConfigLineage_model
x-displayName: Config Lineage
description:
- name: ConfigReferences_model
x-displayName: Config References
description:
- name: ConfigRevision_model
x-displayName: Config Revision
description:
- name: ConfigRevisionActivityLogEntry_model
x-displayName: Config Revision Activity Log Entry
description: >-
- name: ConfigRevisionRef_model
x-displayName: Config Revision Ref
description:
- name: ConfigRevisionReview_model
x-displayName: Config Revision Review
description:
- name: ConfigSchemaExport_model
x-displayName: Config Schema Export
description:
- name: ConfigSchemaSource_model
x-displayName: Config Schema Source
description:
- name: ConfigSchemaVerify_model
x-displayName: Config Schema Verify
description:
- name: ConfigSchemaWarning_model
x-displayName: Config Schema Warning
description:
- name: Constant_model
x-displayName: Constant
description:
- name: ConstantReferences_model
x-displayName: Constant References
description:
- name: ConstantRevision_model
x-displayName: Constant Revision
description:
- name: ConstantRevisionActivityLogEntry_model
x-displayName: Constant Revision Activity Log Entry
description: >-
- name: ConstantRevisionRef_model
x-displayName: Constant Revision Ref
description:
- name: ConstantRevisionReview_model
x-displayName: Constant Revision Review
description: >-
- name: ContextualBandit_model
x-displayName: Contextual Bandit
description:
- name: ContextualBanditQuery_model
x-displayName: Contextual Bandit Query
description: >-
- name: CustomField_model
x-displayName: Custom Field
description:
- name: CustomHook_model
x-displayName: Custom Hook
description:
- name: Dashboard_model
x-displayName: Dashboard
description:
- name: DataSource_model
x-displayName: Data Source
description:
- name: Dimension_model
x-displayName: Dimension
description:
- name: Environment_model
x-displayName: Environment
description:
- name: EventUser_model
x-displayName: Event User
description:
- name: Experiment_model
x-displayName: Experiment
description:
- name: Experiment Rule_model
x-displayName: Experiment Rule
description:
- name: ExperimentAnalysisSettings_model
x-displayName: Experiment Analysis Settings
description: >-
- name: ExperimentDecisionFrameworkSettings_model
x-displayName: Experiment Decision Framework Settings
description: >-
- name: ExperimentMetric_model
x-displayName: Experiment Metric
description:
- name: ExperimentMetricOverrideEntry_model
x-displayName: Experiment Metric Override Entry
description: >-
- name: ExperimentResults_model
x-displayName: Experiment Results
description:
- name: ExperimentSnapshot_model
x-displayName: Experiment Snapshot
description:
- name: ExperimentTemplate_model
x-displayName: Experiment Template
description:
- name: ExperimentWithEnhancedStatus_model
x-displayName: Experiment With Enhanced Status
description: >-
- name: FactMetric_model
x-displayName: Fact Metric
description:
- name: FactTable_model
x-displayName: Fact Table
description:
- name: FactTableColumn_model
x-displayName: Fact Table Column
description:
- name: FactTableFilter_model
x-displayName: Fact Table Filter
description:
- name: FeatureBaseRule_model
x-displayName: Feature Base Rule
description:
- name: FeatureContextualBanditRefRule_model
x-displayName: Feature Contextual Bandit Ref Rule
description: >-
- name: FeatureDefinition_model
x-displayName: Feature Definition
description:
- name: FeatureEnvironmentV1_model
x-displayName: Feature Environment V1
description:
- name: FeatureEnvironmentV2_model
x-displayName: Feature Environment V2
description:
- name: FeatureExperimentRefRule_model
x-displayName: Feature Experiment Ref Rule
description: >-
- name: FeatureExperimentRule_model
x-displayName: Feature Experiment Rule
description: >-
- name: FeatureForceRule_model
x-displayName: Feature Force Rule
description:
- name: FeatureRevisionRef_model
x-displayName: Feature Revision Ref
description:
- name: FeatureRevisionSummary_model
x-displayName: Feature Revision Summary
description: >-
- name: FeatureRevisionV1_model
x-displayName: Feature Revision V1
description:
- name: FeatureRevisionV2_model
x-displayName: Feature Revision V2
description:
- name: FeatureRolloutRule_model
x-displayName: Feature Rollout Rule
description:
- name: FeatureRuleV1_model
x-displayName: Feature Rule V1
description:
- name: FeatureRuleV2_model
x-displayName: Feature Rule V2
description:
- name: FeatureSafeRolloutRule_model
x-displayName: Feature Safe Rollout Rule
description: >-
- name: FeatureV1_model
x-displayName: Feature V1
description:
- name: FeatureV2_model
x-displayName: Feature V2
description:
- name: FeatureWithRevisionsV1_model
x-displayName: Feature With Revisions V1
description: >-
- name: FeatureWithRevisionsV2_model
x-displayName: Feature With Revisions V2
description: >-
- name: Holdout_model
x-displayName: Holdout
description:
- name: InformationSchema_model
x-displayName: Information Schema
description:
- name: InformationSchemaTable_model
x-displayName: Information Schema Table
description: >-
- name: Learning_model
x-displayName: Learning
description:
- name: LookbackOverride_model
x-displayName: Lookback Override
description:
- name: Member_model
x-displayName: Member
description:
- name: Metric_model
x-displayName: Metric
description:
- name: MetricAnalysis_model
x-displayName: Metric Analysis
description:
- name: MetricGroup_model
x-displayName: Metric Group
description:
- name: MetricUsage_model
x-displayName: Metric Usage
description:
- name: Namespace_model
x-displayName: Namespace
description:
- name: NamespaceExperimentMember_model
x-displayName: Namespace Experiment Member
description: >-
- name: Organization_model
x-displayName: Organization
description:
- name: PaginationFields_model
x-displayName: Pagination Fields
description:
- name: Project_model
x-displayName: Project
description:
- name: Query_model
x-displayName: Query
description:
- name: RampSchedule_model
x-displayName: Ramp Schedule
description:
- name: RampScheduleTemplate_model
x-displayName: Ramp Schedule Template
description:
- name: Report_model
x-displayName: Report
description:
- name: RequireReviewRule_model
x-displayName: Require Review Rule
description:
- name: RequireReviewRuleInput_model
x-displayName: Require Review Rule Input
description: >-
- name: RevisionIdRef_model
x-displayName: Revision Id Ref
description:
- name: Safe Rollout Rule_model
x-displayName: Safe Rollout Rule
description:
- name: SavedGroup_model
x-displayName: Saved Group
description:
- name: SavedGroupApprovalRule_model
x-displayName: Saved Group Approval Rule
description: >-
- name: SavedGroupReferenceResource_model
x-displayName: Saved Group Reference Resource
description: >-
- name: SavedGroupReferences_model
x-displayName: Saved Group References
description:
- name: SavedGroupRevision_model
x-displayName: Saved Group Revision
description:
- name: SavedGroupRevisionActivityLogEntry_model
x-displayName: Saved Group Revision Activity Log Entry
description: >-
- name: SavedGroupRevisionRef_model
x-displayName: Saved Group Revision Ref
description: >-
- name: SavedGroupRevisionReview_model
x-displayName: Saved Group Revision Review
description: >-
- name: ScheduleRule_model
x-displayName: Schedule Rule
description:
- name: ScheduledStopPlan_model
x-displayName: Scheduled Stop Plan
description:
- name: SdkConnection_model
x-displayName: Sdk Connection
description:
- name: Segment_model
x-displayName: Segment
description:
- name: Settings_model
x-displayName: Settings
description:
- name: Targeting Rule_model
x-displayName: Targeting Rule
description:
- name: TargetingReviewRule_model
x-displayName: Targeting Review Rule
description:
- name: Team_model
x-displayName: Team
description:
- name: VisualChange_model
x-displayName: Visual Change
description:
- name: VisualChangeset_model
x-displayName: Visual Changeset
description:
paths:
/v1/reports:
post:
tags:
- reports
summary: Create a new report
operationId: postReport
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
experimentId:
description: The experiment to create a report for
type: string
title:
description: Report title (defaults to experiment name)
type: string
description:
description: Report description
type: string
owner:
description: >-
The userId or email address of the owner. If an email
address is provided, it will be used to look up the userId
of the matching organization member. If an ID is provided,
it will be validated as existing in the organization. When
omitted, it defaults to the user associated with the
request's Personal Access Token (PAT), if one is being used.
type: string
statsEngine:
description: Stats engine override
type: string
enum:
- bayesian
- frequentist
goalMetrics:
description: Goal metric IDs (defaults to experiment's goal metrics)
type: array
items:
type: string
secondaryMetrics:
description: >-
Secondary metric IDs (defaults to experiment's secondary
metrics)
type: array
items:
type: string
guardrailMetrics:
description: >-
Guardrail metric IDs (defaults to experiment's guardrail
metrics)
type: array
items:
type: string
activationMetric:
description: Activation metric ID
type: string
dimension:
description: Dimension to cut results by
type: string
dateStarted:
format: date-time
description: Analysis start date (ISO 8601)
type: string
dateEnded:
format: date-time
description: Analysis end date (ISO 8601)
type: string
regressionAdjustmentEnabled:
description: Enable CUPED regression adjustment
type: boolean
sequentialTestingEnabled:
description: Enable sequential testing
type: boolean
sequentialTestingTuningParameter:
description: Tuning parameter for sequential testing (frequentist only)
type: number
differenceType:
description: >-
How lifts are expressed in results. Defaults to experiment
setting.
type: string
enum:
- relative
- absolute
- scaled
attributionModel:
description: >-
Metric conversion window attribution model. Defaults to
experiment setting.
type: string
enum:
- firstExposure
- experimentDuration
- lookbackOverride
lookbackOverride:
description: >-
Lookback window when `attributionModel` is
`lookbackOverride`
anyOf:
- type: object
properties:
type:
type: string
const: date
value: {}
required:
- type
- value
additionalProperties: false
- type: object
properties:
type:
type: string
const: window
value:
type: number
minimum: 0
valueUnit:
type: string
enum:
- minutes
- hours
- days
- weeks
required:
- type
- value
- valueUnit
additionalProperties: false
metricOverrides:
description: Per-metric window, risk, and regression-adjustment overrides
type: array
items:
type: object
properties:
id:
type: string
windowType:
type: string
enum:
- conversion
- lookback
- ''
windowHours:
type: number
delayHours:
type: number
winRisk:
type: number
loseRisk:
type: number
properPriorOverride:
type: boolean
properPriorEnabled:
type: boolean
properPriorMean:
type: number
properPriorStdDev:
type: number
exclusiveMinimum: 0
regressionAdjustmentOverride:
type: boolean
regressionAdjustmentEnabled:
type: boolean
regressionAdjustmentDays:
type: number
required:
- id
additionalProperties: false
customMetricSlices:
description: Custom metric slice definitions
type: array
items:
type: object
properties:
slices:
type: array
items:
type: object
properties:
column:
type: string
levels:
type: array
items:
type: string
required:
- column
- levels
additionalProperties: false
required:
- slices
additionalProperties: false
segment:
description: >-
Segment ID to filter users by. Defaults to experiment
setting.
type: string
queryFilter:
description: >-
Raw SQL WHERE clause added to the exposure query. Defaults
to experiment setting.
type: string
skipPartialData:
description: >-
When true, exclude users who have not completed the full
conversion window.
type: boolean
shareLevel:
description: >-
Visibility of the created report. Defaults to `private`. Set
to `public` to receive a shareable `shareUrl` in the
response.
type: string
enum:
- public
- organization
- private
required:
- experimentId
additionalProperties: false
responses:
'200':
description: Resource created
content:
application/json:
schema:
type: object
properties:
report:
$ref: '#/components/schemas/Report'
required:
- report
additionalProperties: false
x-codeSamples:
- lang: cURL
source: |-
curl -X POST 'https://api.growthbook.io/api/v1/reports' \
-H 'Authorization: Bearer YOUR_API_KEY'
components:
schemas:
Report:
type: object
properties:
id:
type: string
dateCreated:
type: string
dateUpdated:
type: string
title:
type: string
description:
type: string
type:
description: >-
Report type. `experiment-snapshot` is the current shape and is what
`POST /reports` always creates. `experiment` is a deprecated legacy
shape that is read-only through this API; it cannot be created or
refreshed and is preserved only for backward compatibility when
reading reports created before the new shape existed.
type: string
enum:
- experiment-snapshot
- experiment
status:
description: >-
UI lifecycle marker. Note: this does NOT control public shareability
— see `shareLevel` for visibility controls.
type: string
enum:
- published
- private
shareLevel:
description: >-
Visibility of the report. `private` (default) restricts access to
the API caller and admins. `organization` makes it visible to all
members of the organization in the GrowthBook UI. `public`
additionally exposes it via a shareable URL (returned as
`shareUrl`); anyone with the URL can view it without authentication.
type: string
enum:
- public
- organization
- private
shareUrl:
description: >-
Public URL for viewing the report. Only present when `shareLevel` is
`public`.
type: string
experimentId:
type: string
owner:
description: >-
The userId of the report owner. Absent for reports created before
owner attribution existed.
type: string
ownerEmail:
description: >-
The email address of the owner, when the owner can be resolved to a
known user.
type: string
snapshotId:
description: Snapshot ID (experiment-snapshot type only)
type: string
snapshotStatus:
description: Status of the latest snapshot (poll this after refresh)
type: string
enum:
- running
- success
- error
snapshotError:
description: Error message if snapshot failed
type: string
analysisSettings:
type: object
properties:
statsEngine:
type: string
enum:
- bayesian
- frequentist
goalMetrics:
type: array
items:
type: string
secondaryMetrics:
type: array
items:
type: string
guardrailMetrics:
type: array
items:
type: string
activationMetric:
type: string
metricOverrides:
description: Per-metric window, risk, and regression-adjustment overrides
type: array
items:
type: object
properties:
id:
type: string
windowType:
type: string
enum:
- conversion
- lookback
- ''
windowHours:
type: number
delayHours:
type: number
winRisk:
type: number
loseRisk:
type: number
properPriorOverride:
type: boolean
properPriorEnabled:
type: boolean
properPriorMean:
type: number
properPriorStdDev:
type: number
exclusiveMinimum: 0
regressionAdjustmentOverride:
type: boolean
regressionAdjustmentEnabled:
type: boolean
regressionAdjustmentDays:
type: number
required:
- id
additionalProperties: false
customMetricSlices:
description: Custom metric slice definitions
type: array
items:
type: object
properties:
slices:
type: array
items:
type: object
properties:
column:
type: string
levels:
type: array
items:
type: string
required:
- column
- levels
additionalProperties: false
required:
- slices
additionalProperties: false
dimension:
type: string
differenceType:
description: >-
How lifts are expressed in results: `relative` (% change),
`absolute` (raw difference), or `scaled` (scaled impact)
type: string
enum:
- relative
- absolute
- scaled
dateStarted:
format: date-time
type: string
dateEnded:
format: date-time
type: string
regressionAdjustmentEnabled:
type: boolean
sequentialTestingEnabled:
type: boolean
sequentialTestingTuningParameter:
description: Tuning parameter for sequential testing (frequentist only)
type: number
attributionModel:
description: >-
Metric conversion window attribution model: `firstExposure`,
`experimentDuration`, or `lookbackOverride`
type: string
enum:
- firstExposure
- experimentDuration
- lookbackOverride
lookbackOverride:
description: >-
Lookback window used when `attributionModel` is
`lookbackOverride`
anyOf:
- type: object
properties:
type:
type: string
const: date
value: {}
required:
- type
- value
additionalProperties: false
- type: object
properties:
type:
type: string
const: window
value:
type: number
minimum: 0
valueUnit:
type: string
enum:
- minutes
- hours
- days
- weeks
required:
- type
- value
- valueUnit
additionalProperties: false
trackingKey:
description: Tracking key used to identify experiment exposures
type: string
exposureQuery:
description: >-
The assignment query, grouping its ID with the identifier type
analyzed on.
type: object
properties:
id:
description: The ID of one of the data source's assignment queries.
type: string
identifierType:
description: >-
The identifier type analyzed on. Null when none can be
resolved: no assignment query is selected, or a record saved
before identifier types were stored points at a query that
no longer exists.
anyOf:
- type: string
- type: 'null'
required:
- id
- identifierType
additionalProperties: false
exposureQueryId:
description: 'Deprecated: use `exposureQuery`.'
deprecated: true
type: string
segment:
description: Segment ID to filter users by
type: string
queryFilter:
description: Raw SQL WHERE clause added to the exposure query
type: string
skipPartialData:
description: >-
When true, exclude users who have not completed the full
conversion window
type: boolean
additionalProperties: false
experimentMetadata:
type: object
properties:
type:
description: Experiment type
type: string
enum:
- standard
- multi-armed-bandit
- holdout
variations:
description: >-
Variation metadata with current traffic weights — use to label
result columns
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
key:
type: string
weight:
description: Traffic weight (0–1)
type: number
required:
- id
- name
- key
- weight
additionalProperties: false
phases:
description: Experiment phases
type: array
items:
type: object
properties:
name:
type: string
dateStarted:
type: string
dateEnded:
type: string
coverage:
description: Traffic coverage (0–1)
type: number
additionalProperties: false
additionalProperties: false
results:
$ref: '#/components/schemas/ExperimentResults'
required:
- id
- dateCreated
- dateUpdated
- title
- description
- type
additionalProperties: false
ExperimentResults:
type: object
properties:
id:
type: string
dateUpdated:
type: string
experimentId:
type: string
phase:
type: string
dateStart:
type: string
dateEnd:
type: string
dimension:
type: object
properties:
type:
type: string
id:
type: string
dimensions:
type: array
items:
type: object
properties:
type:
type: string
id:
type: string
required:
- type
additionalProperties: false
required:
- type
additionalProperties: false
settings:
$ref: '#/components/schemas/ExperimentAnalysisSettings'
queryIds:
type: array
items:
type: string
results:
type: array
items:
type: object
properties:
dimension:
type: string
totalUsers:
type: number
checks:
type: object
properties:
srm:
type: number
required:
- srm
additionalProperties: false
metrics:
type: array
items:
type: object
properties:
metricId:
type: string
metricName:
type: string
variations:
type: array
items:
type: object
properties:
variationId:
type: string
variationName:
type: string
users:
type: number
analyses:
type: array
items:
type: object
properties:
engine:
type: string
enum:
- bayesian
- frequentist
numerator:
type: number
denominator:
type: number
mean:
type: number
stddev:
type: number
percentChange:
type: number
effectStandardError:
description: >-
Standard error of the estimated effect
(`percentChange`).
type: number
ciLow:
type: number
ciHigh:
type: number
pValue:
type: number
risk:
type: number
chanceToBeatControl:
type: number
errorMessage:
type: string
required:
- engine
- numerator
- denominator
- mean
- stddev
- percentChange
- effectStandardError
- ciLow
- ciHigh
additionalProperties: false
required:
- variationId
- analyses
additionalProperties: false
required:
- metricId
- variations
additionalProperties: false
required:
- dimension
- totalUsers
- checks
- metrics
additionalProperties: false
required:
- id
- dateUpdated
- experimentId
- phase
- dateStart
- dateEnd
- dimension
- settings
- queryIds
- results
additionalProperties: false
ExperimentAnalysisSettings:
type: object
properties:
datasourceId:
type: string
assignmentQuery:
description: >-
The assignment query, grouping its ID with the identifier type
analyzed on.
type: object
properties:
id:
description: The ID of one of the data source's assignment queries.
type: string
identifierType:
description: >-
The identifier type analyzed on. Null when none can be resolved:
no assignment query is selected, or a record saved before
identifier types were stored points at a query that no longer
exists.
anyOf:
- type: string
- type: 'null'
required:
- id
- identifierType
additionalProperties: false
assignmentQueryId:
description: 'Deprecated: use `assignmentQuery`.'
deprecated: true
type: string
experimentId:
type: string
segmentId:
type: string
queryFilter:
type: string
inProgressConversions:
type: string
enum:
- include
- exclude
attributionModel:
description: >-
Setting attribution model to `"experimentDuration"` is the same as
selecting "Ignore Conversion Windows" for the Conversion Window
Override. Setting it to `"lookbackOverride"` requires a
`lookbackOverride` object to be provided.
type: string
enum:
- firstExposure
- experimentDuration
- lookbackOverride
lookbackOverride:
$ref: '#/components/schemas/LookbackOverride'
statsEngine:
type: string
enum:
- bayesian
- frequentist
regressionAdjustmentEnabled:
type: boolean
sequentialTestingEnabled:
type: boolean
sequentialTestingTuningParameter:
type: number
postStratificationEnabled:
description: When null, the organization default is used.
anyOf:
- description: When null, the organization default is used.
type: boolean
- description: When null, the organization default is used.
type: 'null'
decisionFrameworkSettings:
$ref: '#/components/schemas/ExperimentDecisionFrameworkSettings'
description: >-
Controls the decision framework and metric overrides for the
experiment. Replaces the entire stored object on update (does not
patch individual fields).
metricOverrides:
description: >-
Per-metric analysis overrides; also reflected in
goals/secondaryMetrics/guardrails overrides when applicable. On
create/update, this replaces the entire stored array (it does not
patch individual entries).
type: array
items:
$ref: '#/components/schemas/ExperimentMetricOverrideEntry'
goals:
type: array
items:
$ref: '#/components/schemas/ExperimentMetric'
secondaryMetrics:
type: array
items:
$ref: '#/components/schemas/ExperimentMetric'
guardrails:
type: array
items:
$ref: '#/components/schemas/ExperimentMetric'
activationMetric:
$ref: '#/components/schemas/ExperimentMetric'
required:
- datasourceId
- assignmentQuery
- assignmentQueryId
- experimentId
- segmentId
- queryFilter
- inProgressConversions
- attributionModel
- statsEngine
- goals
- secondaryMetrics
- guardrails
additionalProperties: false
LookbackOverride:
description: >-
Controls the lookback override for the experiment. For type "window",
value must be a non-negative number and valueUnit is required.
type: object
properties:
type:
type: string
enum:
- date
- window
value:
description: >-
For "window" type - non-negative numeric value (e.g. 7 for 7 days).
For "date" type a date string.
anyOf:
- description: >-
For "window" type - non-negative numeric value (e.g. 7 for 7
days). For "date" type a date string.
type: number
- format: date-time
description: >-
For "window" type - non-negative numeric value (e.g. 7 for 7
days). For "date" type a date string.
type: string
valueUnit:
description: Used when type is "window". Defaults to "days".
type: string
enum:
- minutes
- hours
- days
- weeks
required:
- type
- value
additionalProperties: false
ExperimentDecisionFrameworkSettings:
description: >-
Controls the decision framework and metric overrides for the experiment.
Replaces the entire stored object on update (does not patch individual
fields).
type: object
properties:
decisionCriteriaId:
type: string
decisionFrameworkMetricOverrides:
type: array
items:
type: object
properties:
id:
description: ID of the metric to override settings for.
type: string
targetMDE:
description: >-
The target relative MDE to use for the metric, expressed as
proportions (e.g. use 0.1 for 10%). Must be greater than 0.
type: number
exclusiveMinimum: 0
required:
- id
additionalProperties: false
additionalProperties: false
ExperimentMetricOverrideEntry:
description: >-
Per-metric analysis overrides stored on the experiment (matches internal
metricOverrides).
type: object
properties:
id:
description: ID of the metric to override settings for.
type: string
windowType:
type: string
enum:
- conversion
- lookback
- ''
windowHours:
type: number
delayHours:
type: number
properPriorOverride:
description: >-
Must be true for the override to take effect. If true, the other
proper prior settings in this object will be used if present.
type: boolean
properPriorEnabled:
type: boolean
properPriorMean:
type: number
properPriorStdDev:
type: number
regressionAdjustmentOverride:
description: >-
Must be true for the override to take effect. If true, the other
regression adjustment settings in this object will be used if
present.
type: boolean
regressionAdjustmentEnabled:
type: boolean
regressionAdjustmentDays:
type: number
required:
- id
additionalProperties: false
ExperimentMetric:
type: object
properties:
metricId:
type: string
overrides:
type: object
properties:
delayHours:
type: number
windowHours:
type: number
window:
type: string
enum:
- conversion
- lookback
- ''
winRiskThreshold:
deprecated: true
type: number
loseRiskThreshold:
deprecated: true
type: number
properPriorOverride:
type: boolean
properPriorEnabled:
type: boolean
properPriorMean:
type: number
properPriorStdDev:
type: number
regressionAdjustmentOverride:
type: boolean
regressionAdjustmentEnabled:
type: boolean
regressionAdjustmentDays:
type: number
additionalProperties: false
required:
- metricId
- overrides
additionalProperties: false
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >
If using Bearer auth, pass the Secret Key as the token:
```bash
curl https://api.growthbook.io/api/v1/features -H "Authorization:
Bearer secret_abc123DEF456"
```
basicAuth:
type: http
scheme: basic
description: >
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 secret_abc123DEF456:
# The ":" at the end stops curl from asking for a password
```
````