Skip to main content
GET
/
console
/
v1
/
metrics
/
{name}
/
{type}
Read Metric Definition by Name
curl --request GET \
  --url https://statsigapi.net/console/v1/metrics/{name}/{type} \
  --header 'STATSIG-API-KEY: <api-key>'
{
  "message": "Metric read successfully.",
  "data": {
    "id": "TestMetricCapi::sum",
    "name": "TestMetricCapi",
    "directionality": "increase",
    "type": "sum",
    "description": "Capi Metric",
    "isPermanent": false,
    "isReadOnly": false,
    "isHidden": false,
    "isVerified": false,
    "tags": [],
    "creatorName": "CONSOLE API",
    "creatorEmail": null,
    "createdTime": 1720218271796,
    "owner": {
      "name": "John Doe",
      "ownerID": "user123",
      "ownerType": "USER",
      "ownerName": "John Doe",
      "ownerEmail": "owner123@test.com"
    },
    "lineage": {
      "events": [
        "add_to_cart"
      ],
      "metrics": []
    },
    "team": "Console Team",
    "unitTypes": [
      "userID"
    ],
    "metricEvents": [
      {
        "name": "add_to_cart",
        "type": "metadata",
        "criteria": []
      }
    ]
  }
}

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

type
string
required

type

Response

Get Metric Definition by name response

message
string
required

A simple string explaining the result of the operation.

data
object
required

A single result.

I