GET
/
console
/
v1
/
metrics
/
metric_source
/
{name}
/
metrics
Read Metric Source Metrics
curl --request GET \
  --url https://statsigapi.net/console/v1/metrics/metric_source/{name}/metrics \
  --header 'STATSIG-API-KEY: <api-key>'
{
  "message": "<string>",
  "data": [
    {
      "name": "metricName",
      "type": "sum",
      "isVerified": false,
      "isReadOnly": false,
      "unitTypes": [
        "stableID",
        "userID"
      ],
      "metricEvents": [
        {
          "name": "event1",
          "type": "value"
        }
      ],
      "metricComponentMetrics": [],
      "description": "the description of this metric",
      "directionality": "increase",
      "tags": [
        "tag1",
        "tag2"
      ],
      "isPermanent": false,
      "rollupTimeWindow": "custom",
      "customRollUpStart": 1,
      "customRollUpEnd": 1,
      "funnelEventList": [
        {
          "name": "event1",
          "type": "event_dau"
        }
      ],
      "funnelCountDistinct": "events",
      "warehouseNative": {
        "aggregation": "count",
        "metricSourceName": "<string>",
        "criteria": [
          {
            "type": "value",
            "column": "<string>",
            "condition": "in",
            "values": [
              "<string>"
            ],
            "nullVacuousOverride": true
          }
        ],
        "waitForCohortWindow": true,
        "denominatorCriteria": [
          {
            "type": "value",
            "column": "<string>",
            "condition": "in",
            "values": [
              "<string>"
            ],
            "nullVacuousOverride": true
          }
        ],
        "denominatorAggregation": "count",
        "denominatorCustomRollupEnd": 123,
        "denominatorCustomRollupStart": 123,
        "denominatorMetricSourceName": "<string>",
        "denominatorRollupTimeWindow": "<string>",
        "denominatorValueColumn": "<string>",
        "funnelCalculationWindow": 123,
        "funnelCountDistinct": "sessions",
        "funnelEvents": [
          {
            "criteria": [
              {
                "type": "value",
                "column": "<string>",
                "condition": "in",
                "values": [
                  "<string>"
                ],
                "nullVacuousOverride": true
              }
            ],
            "metricSourceName": "<string>",
            "name": "<string>",
            "sessionIdentifierField": "<string>"
          }
        ],
        "funnelStartCriteria": "start_event",
        "metricDimensionColumns": [
          "<string>"
        ],
        "metricBakeDays": 123,
        "numeratorAggregation": "count",
        "valueColumn": "<string>",
        "winsorizationHigh": 0.5,
        "winsorizationLow": 0.5,
        "cupedAttributionWindow": 123,
        "onlyIncludeUsersWithConversionEvent": true,
        "percentile": 123,
        "valueThreshold": 123,
        "cap": 123,
        "rollupTimeWindow": "<string>",
        "customRollUpStart": 123,
        "customRollUpEnd": 123,
        "allowNullRatioDenominator": true
      },
      "team": "<string>",
      "teamID": "<string>",
      "dryRun": true,
      "id": "metricId",
      "isHidden": false,
      "lineage": {
        "events": [
          "event1",
          "event2"
        ],
        "metrics": [
          "metric1",
          "metric2"
        ]
      },
      "creatorName": "creatorName",
      "creatorEmail": "creatorEmail",
      "createdTime": 1716230400,
      "lastModifierID": "<string>",
      "lastModifiedTime": 123,
      "lastModifierEmail": "<string>",
      "lastModifierName": "<string>",
      "owner": {
        "name": "ownerName"
      }
    }
  ],
  "pagination": {
    "itemsPerPage": 123,
    "pageNumber": 123,
    "nextPage": "<string>",
    "previousPage": "<string>",
    "totalItems": 123,
    "all": "<string>"
  }
}

Authorizations

​
STATSIG-API-KEY
string
header
required

Headers

​
x-respect-review-settings
string

Optional header to respect review settings for mutation endpoints.

Path Parameters

​
name
string
required

name

Query Parameters

​
limit
integer

Results per page

Example:

10

​
page
integer

Page number

Example:

1

Response

200
application/json

Read metric source metrics response

The response is of type object.