MetricsGET /metrics/{id}

GET /metrics/{id}

Get metric by id

Parameters

NameInRequiredTypeDescription
idpathyesstring

Example request

curl -X GET "/api/v1/metrics/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY"

Responses

200: ok

{
  "id": "string",
  "title": "string",
  "description": "string",
  "query": "string",
  "created_at": "2026-01-01T00:00:00.000Z",
  "current_status": null,
  "current_value": null,
  "current_timestamp": null
}

401: missing or invalid bearer token

title: unauthenticated. No bearer token was sent, or the key is invalid or revoked. detail distinguishes the two.

403: missing required scope

title: forbidden. The key is valid but does not carry read:metrics.

404: not found

title: not_found. No metric with that id is available to this key. A metric owned by another organisation returns the same response, so a 404 does not confirm that the id is unused.

429: rate limit exceeded

title: rate_limited. A burst or daily limit was exceeded; detail names which. The body carries retry_after in seconds.

500: internal error

title: internal_error. An unhandled server error. Safe to retry.

Every error is an RFC 7807 problem detail served as application/problem+json:

{
  "type": "https://observer.example/problems/forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: read:metrics"
}

Branch on title, not on detail. See Errors and status codes for the full catalogue and the rate-limit headers.