Fact Metric

string

required

name

string

required

description

string

required

Maximum string length: 10000

owner

string

required

The userId of the owner (or raw owner name/email for legacy records)

projects

string[]

required

tags

string[]

required

datasource

string

required

metricType

enum<string>

required

Available options:

proportion,

retention,

mean,

quantile,

ratio,

dailyParticipation,

funnel

inverse

boolean

required

Set to true for things like Bounce Rate, where you want the metric to decrease

cappingSettings

object

required

Controls how outliers are handled

Show child attributes

windowSettings

object

required

Controls the conversion window for the metric

Show child attributes

priorSettings

object

required

Controls the bayesian prior for the metric

Show child attributes

regressionAdjustmentSettings

object

required

Controls the regression adjustment (CUPED) settings for the metric

Show child attributes

riskThresholdSuccess

number

required

riskThresholdDanger

number

required

minPercentChange

number

required

maxPercentChange

number

required

minSampleSize

number

required

targetMDE

number

required

managedBy

enum<string>

required

Where this fact metric must be managed from. If not set (empty string), it can be managed from anywhere.

Available options:

api,

admin

dateCreated

string<date-time>

required

dateUpdated

string<date-time>

required

ownerEmail

string

The email address of the owner, when the owner can be resolved to a known user.

numerator

object

Show child attributes

denominator

object

Show child attributes

quantileSettings

object

Controls the settings for quantile metrics (mandatory if metricType is "quantile")

Show child attributes

funnelSettings

object

Funnel metric settings (required when metricType is "funnel")

Show child attributes

displayAsPercentage

boolean

If true and the metric is a ratio metric, variation means will be displayed as a percentage

archived

boolean

metricAutoSlices

string[]

Array of slice column names that will be automatically included in metric analysis. This is an enterprise feature.

replaces

string[]

Ids of older metrics (legacy or fact) that this metric supersedes, for example the legacy metric it was migrated from. Informational only - GrowthBook uses it to link the old and new definitions in the UI and to keep showing results from a snapshot that was created before an experiment switched to this metric.

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "owner": "<string>",
  "projects": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "datasource": "<string>",
  "inverse": true,
  "cappingSettings": {
    "value": 123,
    "ignoreZeros": true
  },
  "windowSettings": {
    "delayValue": 123,
    "windowValue": 123
  },
  "priorSettings": {
    "override": true,
    "proper": true,
    "mean": 123,
    "stddev": 123
  },
  "regressionAdjustmentSettings": {
    "override": true,
    "enabled": true,
    "days": 123
  },
  "riskThresholdSuccess": 123,
  "riskThresholdDanger": 123,
  "minPercentChange": 123,
  "maxPercentChange": 123,
  "minSampleSize": 123,
  "targetMDE": 123,
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateUpdated": "2023-11-07T05:31:56Z",
  "ownerEmail": "<string>",
  "displayAsPercentage": true,
  "archived": true,
  "metricAutoSlices": [
    "<string>"
  ],
  "replaces": [
    "<string>"
  ]
}

Introduction

Endpoints

Models