---
title: "Get a list of dimensions from a dataset (filterable and cantabular datasets only)"
method: GET
path: "/datasets/{id}/editions/{edition}/versions/{version}/dimensions"
tags: ["Public"]
---

# Get a list of dimensions from a dataset (filterable and cantabular datasets only)

`GET /datasets/{id}/editions/{edition}/versions/{version}/dimensions`

## Request

- Base URL: `https://api.beta.ons.gov.uk/v1`
- URL: `https://api.beta.ons.gov.uk/v1/datasets/{id}/editions/{edition}/versions/{version}/dimensions`
- Auth: one of:
  - none
  - API key in header `Authorization`

Get all dimensions which are used in the dataset

## Path parameters

- `edition` string, required
- `id` string, required
- `version` string, required

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

A json list of dimensions

- Dimensions: List of dimensions for a specific dataset version.
  - `count` integer: The number of items returned.
  - `limit` integer: The number of items requested.
  - `offset` integer: The offset of the first item to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter
  - `total_count` integer: The total number of items available.
  - `items` Dimension[]
    - `description` string
    - `dimension` string: The name of the dimension
    - `href` string: A link to the code-list entry for the dimension
    - `id` string: The id of the dimension
    - `is_area_type` boolean: Indicates if a dimension is an area-type (census datasets only)
    - `label` string
    - `links` object
      - `code_list` object: The code list related to this dimension
        - `href` string: A URL to the code list
        - `id` string: The unique id for the code list
      - `options` OptionsLink: A list of links related to this dimension
        - `href` string: A URL to a list of options for this dimension
      - `version` VersionLink: The dataset version this resource belongs to
        - `href` string: A URL to the version this resource relates to
        - `id` string: The version number this resource relates to
    - `number_of_options` integer: The number of options available for this dimension
    - `variable` string: The variable name (census datasets only)

## Other responses

- `400`: Invalid request, reasons can be one of the following: * dataset id was incorrect * edition was incorrect * version was incorrect
- `404`: No dimensions found for version of an edition of a dataset using the id, edition and version provided
- `500`: Failed to process the request due to an internal error

## Changes

- **2025-02-18** `f5f36bf68ba9`: 1 info
  - the endpoint scheme security `Authorization` was added to the API

[Operation history](https://skmtc.dev/office-of-national-statistics/apis/explore-our-data/changes/datasets/:id/editions/:edition/versions/:version/dimensions/get.md)

---

[API](https://skmtc.dev/office-of-national-statistics/apis/explore-our-data.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/explore-our-data/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/explore-our-data/revisions/c24bb51d5217?raw)