/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
{
  "type": "array",
  "items": {
    "allOf": [
      {
        "properties": {
          "count": {
            "description": "number of items returned",
            "type": "number"
          },
          "limit": {
            "description": "maximum number of items returned",
            "type": "number"
          },
          "offset": {
            "description": "index of first item returned",
            "type": "number"
          },
          "total_count": {
            "description": "total number of items available",
            "type": "number"
          }
        }
      },
      {
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "properties": {
                "id": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "links": {
                  "properties": {
                    "filter": {
                      "properties": {
                        "href": {
                          "description": "link to resource",
                          "type": "string"
                        },
                        "id": {
                          "description": "id of resource",
                          "type": "string"
                        }
                      }
                    },
                    "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"
                        }
                      }
                    }
                  }
                },
                "name": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}

404: Filter 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. 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

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

409: Filter was modified by an external entity

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