---
title: "Get all dimensions used in this filter"
method: GET
path: "/filters/{id}/dimensions"
tags: ["Public"]
---

# Get all dimensions used in this filter

`GET /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

Return a list of all dimensions which are going to be used to filter on

## Path parameters

- `id` string, required

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

A list of dimension URLs

- DimensionsResponse: A response containing dimension information.
  - `count` integer: The number of dimensions returned for a filter record
  - `items` DimensionItemLinks[]: An array of dimensions
    - `id` string: The id of the dimension
    - `self` Link
      - `href` string: link to resource
      - `id` string: id of resource
    - `options` Link
      - `href` string: link to resource
      - `id` string: id of resource
    - `filter` Link
      - `href` string: link to resource
      - `id` string: id of resource
    - `name` string: The name of the dimension
  - `limit` integer: The number of dimensions requested for a filter record
  - `offset` integer: The first row of dimension for a filter record to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter
  - `total_count` integer: The total number of dimensions for a filter record

## Other responses

- `404`: Filter not found
- `500`: Failed to process the request due to an internal error

---

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