/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 1000 |
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
{
"description": "A response containing dimension information.",
"type": "object",
"properties": {
"count": {
"description": "The number of dimensions returned for a filter record",
"type": "integer",
"readOnly": true
},
"items": {
"description": "An array of dimensions",
"type": "array",
"items": {
"properties": {
"filter": {
"properties": {
"href": {
"description": "link to resource",
"type": "string"
},
"id": {
"description": "id of resource",
"type": "string"
}
}
},
"id": {
"description": "The id of the dimension",
"type": "string",
"readOnly": true
},
"name": {
"description": "The name of the dimension",
"type": "string",
"readOnly": true
},
"options": {
"properties": {
"href": {
"description": "link to resource",
"type": "string"
},
"id": {
"description": "id of resource",
"type": "string"
}
}
},
"self": {
"properties": {
"href": {
"description": "link to resource",
"type": "string"
},
"id": {
"description": "id of resource",
"type": "string"
}
}
}
}
}
},
"limit": {
"description": "The number of dimensions requested for a filter record",
"type": "integer"
},
"offset": {
"description": "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",
"type": "integer"
},
"total_count": {
"description": "The total number of dimensions for a filter record",
"type": "integer",
"readOnly": true
}
}
}
404: Filter not found
Example value
null
500: Failed to process the request due to an internal error
Example value
null