---
title: "Metric documentation"
method: GET
path: "/metrics/{metric}/doc"
---

# Metric documentation

`GET /metrics/{metric}/doc`

## Path parameters

- `metric` string, required

## Headers

- `Accept` 'application/json', required

## Response `200`

- MetricDoc
  - `metric_name` string, required
  - `metric` string, required
  - `deprecated` string, nullable, required
  - `category` string, required
  - `documentation` object, required
    - `abstract` object
      - `last_modified` string, required
      - `body` string, required
    - `description` object
      - `last_modified` string, required
      - `body` string, required
    - `methodology` object
      - `last_modified` string, required
      - `body` string, required
  - `logs` unknown[], required
    - unknown
  - `tags` string[], required

## Other responses

- `400` — Bad request. Reason provided in response body where possible.
- `404` — Not found.
- `429` — Too many requests - request has been throttled.
- `500` — Server error

---

[API](https://skmtc.net/uk-health-security-agency/apis/generic-api.md) · [All operations](https://skmtc.net/uk-health-security-agency/apis/generic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uk-health-security-agency/generic-api/revisions/ac434e5ddc2c/schema)