---
title: "Add a dimension to a filter"
method: POST
path: "/filters/{id}/dimensions"
tags: ["Public"]
---

# Add a dimension to a filter

`POST /filters/{id}/dimensions`

## Request

- Base URL: `/v1` (relative, and the document’s source URL is not known)
- URL: `/v1/filters/{id}/dimensions`
- Auth: none declared. Required headers: `If-Match`

Add a dimension to filter with a list of options. Note - the is_area_type property is required to ensure a successful filter journey.

## Path parameters

- `id` string, required

## Headers

- `If-Match` string, required

## Request body

- Options: A list of options for dimension to filter on a dataset
  - `name` string: The name of the dimension
  - `is_area_type` boolean: Indicates if the dimension is an area type
  - `options` string[]: A list of options for dimension to filter on a dataset

## Response `201`

The dimension was created

## Other responses

- `400`: Invalid request body
- `404`: Filter job was not found
- `409`: Filter was modified by an external entity
- `422`: Unprocessable entity - instance has been removed
- `500`: Failed to process the request due to an internal error

---

[API](https://skmtc.dev/office-of-national-statistics/apis/cantabular-filter-flex-api.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/cantabular-filter-flex-api/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/cantabular-filter-flex-api/revisions/e753ac2d26bd?raw)