Metrics

Get Metric

Retrieve a specific metric definition by ID (scoped to your merchant).

GET
/metrics/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

Use your secret API key as the bearer token

In: header

Path Parameters

id*string

Metric ID

Match^met_[A-Za-z0-9]{22}$

Response Body

application/json

application/json

application/json

curl -X GET "https://api.getlumen.dev/v1/metrics/string"
{
  "id": "met_DQ6f7a8b9c0d1e2f3g4h5i",
  "merchantId": "mer_1234567890abcdefghij",
  "name": "API Calls",
  "description": "Count of successful API calls",
  "queryType": "simple",
  "aggregationType": "COUNT",
  "eventName": "api-call",
  "valueType": "NUMERIC",
  "sqlDefinition": null,
  "createdAt": "2025-02-20T17:00:00.000Z",
  "updatedAt": "2025-02-20T17:00:00.000Z"
}
{
  "error": "Metric not found"
}
{
  "error": "Internal server error"
}