/filters/{id}/dimensions/{name}

GET

Return details of a specific dimension within a filter

Responses

200: A Dimension within a filter was returned

Example value
{
  "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"
    }
  }
}

400: Filter was not found

Example value
null

404: Dimension name was not found

Example value
null

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

Example value
null

POST

Add a dimension to filter with a list of options

Parameters

Name Type Description
options body A list of options for a dimension to filter the dataset
id path The unique filter ID for customising a dataset
name path The name of a dimension

Responses

201: The dimension was created

Example value
null

400: Invalid request body

Example value
null

404: Filter job was not found

Example value
null

422: Unprocessable entity - instance has been removed

Example value
null

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

Example value
null

DELETE

Remove a dimension and any options set within the dimension

Responses

204: The dimension was removed

Example value
null

400: Filter was not found

Example value
null

404: Dimension name was not found

Example value
null

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

Example value
null

PATCH

Patch a list of dimension options for a filter

Parameters

Name Type Description
patch body A list of options for a dimension to filter the dataset
id path The unique filter ID for customising a dataset
name path The name of a dimension

Responses

200: The dimension was patched

Example value
{
  "description": "A list of options for dimension to filter on a dataset",
  "type": "object",
  "properties": {
    "options": {
      "description": "A list of options for dimension to filter on a dataset",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

400: Invalid request body

Example value
null

401: Unauthorised, request lacks valid authentication credentials

Example value
null

404: Filter job was not found

Example value
null

422: Unprocessable entity - instance has been removed

Example value
null

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

Example value
null