List metrics
GET
/v1/metrics
Returns the catalog of metrics visible to the caller. Capability filtering happens automatically — metrics requiring scopes the caller doesn't have are omitted.
Authorizations
BearerAuth
API key in the form one_pk_<random>. Mint at /settings/api-keys.
Type
HTTP (bearer)
Parameters
Query Parameters
category
Filter metrics by category. Omit to list all visible metrics.
Type
string
Valid values
"revenue""profitability""expenses""cash""ar""ap""tax""balance_sheet""people""growth""diversity""pay_equity""quality""vendor""customer""operations"Responses
List of metric metadata with total count and computedAt timestamp.
application/json
JSON "data": [ { "id": "string", "label": "string", "description": "string", "category": "string", "unit": "string", "shape": "string", "periodKind": "string", "requiresCapability": "string", "related": [ "string" ], "tags": [ "string" ] } ], "meta": { "total": 0, "version": 0, "computedAt": "string" }
{
}