/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

Responses

200: A list of dimension URLs

Example value
{
  "type": "array",
  "items": {
    "description": "A dimension to filter on a dataset. Information on a dimension can be gathered using the `Dataset API`",
    "type": "object",
    "properties": {
      "dimension_url": {
        "description": "A link to the filtered options within the dimension",
        "type": "string",
        "items": {
          "type": "string",
          "example": "/filters/00001/dimensions/age"
        }
      },
      "name": {
        "description": "The name of the dimension to filter on",
        "type": "string"
      }
    }
  }
}

404: Filter not found

Example value
null

500: Failed to process the request due to an internal error

Example value
null