FilterOptionsViewModel

The options available for a filterable characteristic about the data set (excluding geography or time).

Properties

Property	Type	Required	Description
id	string	true	The ID of the filter.
column	string	true	The name of the filter CSV column.
label	string	true	The human-readable label describing the filter.
hint	string	false	A hint to assist in describing the filter.
options	array (FilterOptionViewModel)	true	The filter options belonging to this filter.

Example schema

{
  "id": "BRlj4",
  "column": "school_type",
  "label": "School type",
  "hint": "Additional detail about the filter.",
  "options": [
    {
      "id": "q1g3J",
      "label": "State-funded primary",
      "isAggregate": true
    }
  ]
}