OFoffice-of-national-statistics
Public

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

Changed on

Get all dimensions which are used in the dataset

get/datasets/{id}/editions/{edition}/versions/{version}/dimensions

Request

  • Base URL
    https://api.beta.ons.gov.uk/v1
  • Auth
    • none
    • or API key in header Authorization

Path parameters

editionstring required

An edition of a dataset

idstring required

ID that represents a dataset

versionstring required

A version of a dataset

Query parameters

limitinteger

Maximum number of items that will be returned. A value of zero will return zero items.

offsetinteger

Starting index of the items array that will be returned. By default it is zero, meaning that the returned items will start from the beginning.

Response

A json list of dimensions

countinteger

The number of items returned.

limitinteger

The number of items requested.

offsetinteger

The offset of the first item to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter

total_countinteger

The total number of items available.

Example response

{
  "count": 20,
  "total_count": 123,
  "items": [
    {
      "links": {
        "version": {
          "href": "https://api.beta.ons.gov.uk/v1/datasets/my-dataset/editions/july-september-2017/versions/5",
          "id": "5"
        }
      }
    }
  ]
}

Changes