Describe a metric

GET

/v1/metrics/{id}

Returns metadata for a single metric (label, description, category, unit, shape, accepted periods, required capability) without resolving a value. Useful for catalog browsing and form-building without paying resolver cost.

Authorizations

BearerAuth

API key in the form one_pk_<random>. Mint at /settings/api-keys.

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The metric id, e.g. revenue.total or cash.balance. See the metric reference for the full list.

Type

string

Required

Example"123"

Responses

The metric's metadata wrapped in the standard envelope.

Content-Type

application/json

{

  

"data": {

  

  

"id": "string",

  

  

"label": "string",

  

  

"description": "string",

  

  

"category": "string",

  

  

"unit": "string",

  

  

"shape": "string",

  

  

"periodKind": "string",

  

  

"requiresCapability": "string",

  

  

"related": [

  

  

  

"string"

  

  

],

  

  

"tags": [

  

  

  

"string"

  

  

]

  

},

  

"meta": {

  

  

"version": 0,

  

  

"computedAt": "string"

  

}

}

GET

/v1/metrics/{id}

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI