---
title: "Metric props"
method: GET
path: "/metrics/props"
---

# Metric props

`GET /metrics/props`

## Request

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

## Query parameters

- `by` 'category' | 'tag' | 'areaType'

## Headers

- `Accept` 'application/json', required

## Response `200`

## 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-22** `5e256a1f0f74`: 2 breaking, 1 warning, 1 info
  - the mandatory response header `phe-website-request` removed for the status `200`
  - the mandatory response header `x-phe-media-type` removed for the status `200`
  - the optional response header `phe-server-loc` removed for the status `200`
  - the `query` request parameter `by` became optional
- **2021-11-22** `44611f090a79`: 3 breaking, 1 warning
  - the `query` request parameter `by` became required
  - the mandatory response header `ukhsa-website-request` removed for the status `200`
  - the mandatory response header `x-ukhsa-media-type` removed for the status `200`
  - the optional response header `ukhsa-server-loc` removed for the status `200`
- **2021-11-22** `5894ea78dfb2`: 2 breaking, 1 warning, 2 info
  - the mandatory response header `phe-website-request` removed for the status `200`
  - the mandatory response header `x-phe-media-type` removed for the status `200`
  - the optional response header `phe-server-loc` removed for the status `200`
  - the `query` request parameter `by` became optional
  - …1 more
- **2021-08-17** `5a83f3354351`: 1 info
  - added the media type `application/json` for the response with the status `200`
- …earlier changes not shown

[Operation history](https://skmtc.dev/uk-health-security-agency/apis/generic-api/changes/metrics/props/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)