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

# Metric documentation

`GET /metrics/{metric}/doc`

## Request

- Base URL: `https://api.coronavirus.data.gov.uk/generic`
- URL: `https://api.coronavirus.data.gov.uk/generic/metrics/{metric}/doc`
- Auth: none declared. Required headers: `Accept`
- TypeScript: <https://skmtc.dev/uk-health-security-agency/apis/generic-api/docs/metrics/:metric/doc/get.ts> (a function with typed inputs; its response is checked against the schema)

## 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

## Changes

- **2021-11-24** `1e2ad86d4357`: 1 info
  - endpoint added
- **2021-11-22** `44611f090a79`: 1 breaking
  - api path removed without deprecation
- **2021-11-22** `3f9e454142d3`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/uk-health-security-agency/apis/generic-api/changes/metrics/:metric/doc/get.md)

---

[API](https://skmtc.dev/uk-health-security-agency/apis/generic-api.md) - [All operations](https://skmtc.dev/uk-health-security-agency/apis/generic-api/llms.txt) - [OpenAPI document](https://skmtc.dev/uk-health-security-agency/apis/generic-api/revisions/ac434e5ddc2c?raw)