Report

string

required

dateCreated

string

required

dateUpdated

string

required

title

string

required

description

string

required

type

enum<string>

required

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.

Available options:

experiment-snapshot,

experiment

status

enum<string>

UI lifecycle marker. Note: this does NOT control public shareability — see shareLevel for visibility controls.

Available options:

published,

private

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.

Available options:

public,

organization,

private

Public URL for viewing the report. Only present when shareLevel is public.

experimentId

string

snapshotId

string

Snapshot ID (experiment-snapshot type only)

snapshotStatus

enum<string>

Status of the latest snapshot (poll this after refresh)

Available options:

running,

success,

error

snapshotError

string

Error message if snapshot failed

analysisSettings

object

Show child attributes

experimentMetadata

object

Show child attributes

results

object

Show child attributes

{
  "id": "<string>",
  "dateCreated": "<string>",
  "dateUpdated": "<string>",
  "title": "<string>",
  "description": "<string>",
  "shareUrl": "<string>",
  "experimentId": "<string>",
  "snapshotId": "<string>",
  "snapshotError": "<string>",
  "analysisSettings": {
    "goalMetrics": [
      "<string>"
    ],
    "secondaryMetrics": [
      "<string>"
    ],
    "guardrailMetrics": [
      "<string>"
    ],
    "activationMetric": "<string>",
    "metricOverrides": [
      {
        "id": "<string>",
        "windowHours": 123,
        "delayHours": 123,
        "winRisk": 123,
        "loseRisk": 123,
        "properPriorOverride": true,
        "properPriorEnabled": true,
        "properPriorMean": 123,
        "properPriorStdDev": 123,
        "regressionAdjustmentOverride": true,
        "regressionAdjustmentEnabled": true,
        "regressionAdjustmentDays": 123
      }
    ],
    "customMetricSlices": [
      {
        "slices": [
          {
            "column": "<string>",
            "levels": [
              "<string>"
            ]
          }
        ]
      }
    ],
    "dimension": "<string>",
    "dateStarted": "2023-11-07T05:31:56Z",
    "dateEnded": "2023-11-07T05:31:56Z",
    "regressionAdjustmentEnabled": true,
    "sequentialTestingEnabled": true,
    "sequentialTestingTuningParameter": 123,
    "lookbackOverride": {
      "type": "date",
      "value": "<unknown>"
    },
    "trackingKey": "<string>",
    "exposureQueryId": "<string>",
    "segment": "<string>",
    "queryFilter": "<string>",
    "skipPartialData": true
  },
  "experimentMetadata": {
    "variations": [
      {
        "id": "<string>",
        "name": "<string>",
        "key": "<string>",
        "weight": 123
      }
    ],
    "phases": [
      {
        "name": "<string>",
        "dateStarted": "<string>",
        "dateEnded": "<string>",
        "coverage": 123
      }
    ]
  }
}

Introduction

Endpoints

Models