Public
Search for an option within a hierarchical dimension
Perform a search on dimension options which are within a hierarchy of a published version of a dataset by the ONS.
get/dimension-search/datasets/{id}/editions/{edition}/versions/{version}/dimensions/{name}
Path parameters
idstring required
Id that represents a dataset
editionstring required
An edition of a dataset
versionstring required
A version of a dataset
namestring required
A dimension from a dataset.
Query parameters
limitinteger
The number of items requested, defaulted to 50 and limited to 1000.
offsetinteger
The first row of resources to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter.
qstring required
The query text to search datasets with.
Response
A json list containing search results of dimension options which are within a hierarchy of a published version of a dataset by the ONS.
Example response
{
"items": [
{
"matches": {
"code": [
{
"start": 3,
"end": 8
}
],
"label": [
{
"start": 3,
"end": 8
}
]
}
}
]
}