v2
latestOpenAPI 3.0.02026-08-073221853.1 MBMetrics
Metrics
Read Metric Definition
get/console/v1/metrics/{id}
Path parameters
idstring required
id
Response
Get Metric Definition response
Example response
{
"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": []
}
],
"permalink": "https://console.statsig.com/company_id/metrics/metrics_catalog/TestMetricCapi/sum"
}
}