OFoffice-of-national-statistics
Public

Get all dimensions used in this filter

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

get/filters/{id}/dimensions

Request

  • Base URL
    /v1 (relative, and the document’s source URL is not known)
  • Auth
    none declared

Path parameters

idstring required

The unique filter ID for customising a dataset

Query parameters

limitinteger

Limit the number of items that will be returned. Defaults to 20 and capped at 1000

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 list of dimension URLs

countinteger

The number of dimensions returned for a filter record

limitinteger

The number of dimensions requested for a filter record

offsetinteger

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_countinteger

The total number of dimensions for a filter record

Changes

No recorded changes to this operation across all 1 revision of this API.