API reference / Metrics / List the metrics a workspace can read

List the metrics a workspace can read

GET/metrics/catalog

Authenticate with a signed-in Foliot Console session.

Every metric GET /workspaces/{workspaceId}/metrics/query answers: its name, what it counts, its unit, type and labels, and whether it has history. The same for everyone and about no one’s data, so any signed-in person may read it. Metrics about the whole server are not listed.

Responses

200 object OK

401 Error Missing, malformed or unknown bearer token.

403 Error The token is valid but not permitted on this route.

503 Error A dependency this route needs is unreachable.

cURL

curl "https://api.foliot.app/metrics/catalog" \
  -H "Authorization: Bearer $FOLIOT_TOKEN"

RESPONSE 200 OK

{
  "metrics": [
    {
      "description": "string",
      "labels": [],
      "name": "string",
      "source": "rollup",
      "type": "counter",
      "unit": "string"
    }
  ]
}