/filters/{id}/dimensions
GET
Return a list of all dimensions which are going to be used to filter on
Parameters
| Name | Type | Description |
|---|---|---|
| id | path | The unique filter ID for customising a dataset |
| limit | query | Limit the number of items that will be returned. Defaults to 20 and capped at 500 |
| offset | query | 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. |
Responses
200: A list of dimension URLs
Example value
[
{
"count": 0,
"items": [
{
"id": "string",
"label": "string",
"links": {
"filter": {
"href": "string",
"id": "string"
},
"options": {
"href": "string",
"id": "string"
},
"self": {
"href": "string",
"id": "string"
}
},
"name": "string"
}
],
"limit": 0,
"offset": 0,
"total_count": 0
}
]404: Filter not found
500: Failed to process the request due to an internal error
POST
Add a dimension to filter with a list of options. Note - the is_area_type property is required to ensure a successful filter journey.
Parameters
| Name | Type | Description |
|---|---|---|
| id | path | The unique filter ID for customising a dataset |
| options | body | A list of options for a dimension to filter the dataset |
| If-Match | header | Filter resource version, as returned by a previous ETag, to be validated; or '*' to skip the version check |