Get a single fact metric

GET /fact-metrics/{id}

cURL

cURL

curl https://api.growthbook.io/api/v1/fact-metrics/fact__123abc \
  -u secret_abc123DEF456:

200

{
  "factMetric": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "owner": "<unknown>",
    "projects": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ],
    "datasource": "<string>",
    "metricType": "proportion",
    "numerator": {
      "factTableId": "<string>",
      "column": "<string>",
      "aggregation": "sum",
      "filters": [
        "<string>"
      ],
      "inlineFilters": {},
      "rowFilters": [
        {
          "operator": "=",
          "values": [
            "<string>"
          ],
          "column": "<string>"
        }
      ],
      "aggregateFilterColumn": "<string>",
      "aggregateFilter": "<string>"
    },
    "inverse": true,
    "cappingSettings": {
      "type": "none",
      "value": 123,
      "ignoreZeros": true
    },
    "windowSettings": {
      "type": "none",
      "delayValue": 123,
      "delayUnit": "minutes",
      "windowValue": 123,
      "windowUnit": "minutes"
    },
    "regressionAdjustmentSettings": {
      "override": true,
      "enabled": true,
      "days": 123
    },
    "riskThresholdSuccess": 123,
    "riskThresholdDanger": 123,
    "minPercentChange": 123,
    "maxPercentChange": 123,
    "minSampleSize": 123,
    "targetMDE": 123,
    "managedBy": "",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "denominator": {
      "factTableId": "<string>",
      "column": "<string>",
      "filters": [
        "<string>"
      ],
      "inlineFilters": {},
      "rowFilters": [
        {
          "operator": "=",
          "values": [
            "<string>"
          ],
          "column": "<string>"
        }
      ]
    },
    "quantileSettings": {
      "type": "event",
      "ignoreZeros": true,
      "quantile": 0.5
    },
    "displayAsPercentage": true,
    "archived": true,
    "metricAutoSlices": [
      "<string>"
    ]
  }
}

Authorizations

bearerAuthbasicAuth

Authorization · string · header · required

If using Bearer auth, pass the Secret Key as the token:

curl https://api.growthbook.io/api/v1 \
  -H "Authorization: Bearer secret_abc123DEF456"

Path Parameters

id · string · required

The id of the requested resource

Response

200 - application/json

Success

factMetric · object · required

Show child attributes