Facet
The Facet Resource is a json resource containing zero or more facet values describing the filters that can be applied to the search query. It also contains additional properties and links:
|
Name |
Type |
Description |
|---|---|---|
|
properties |
Object |
A dictionary object containing the properties and values. Properties include a title, an identifier for the property/field we do faceting on, and a number of matched results. |
|
values |
Array |
An array of facet values. The number of resources included is capped to a fixed value. |
|
list_all |
Link |
A hyperlink to the resource that represents the collection of all facet objects for this identifier and the current search. |
Example:
RequestResponse
{
"properties": {
"matches": 96,
"title": "Brand",
"identifier": "myFieldId"
},
"values": [
The array of facet values
],
"list_all": {
"href":"http://<hostname>/api/list_facets?q=myQuery&id=myFieldId"
}
}