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

- GetFilterDimensionsResponse[]
  - `limit` number: maximum number of items returned
  - `offset` number: index of first item returned
  - `count` number: number of items returned
  - `total_count` number: total number of items available
  - `items` DimensionItem[]
    - `name` string
    - `id` string
    - `label` string
    - `links` DimensionItemLinks
      - `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

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