logo
logo

Facet Resource

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:

NameTypeDescription
propertiesObjectA 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.
valuesArrayAn array of facet values. The number of resources included is capped to a fixed value.
list_allLinkA hyperlink to the resource that represents the collection of all facet objects for this identifier and the current search.

Example:

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

Can we improve this article ? Provide feedback