search mobile facets autocomplete spellcheck crawler rankings weights synonyms analytics engage api customize documentation install setup technology content domains user history info home business cart chart contact email activate analyticsalt analytics autocomplete cart contact content crawling custom documentation domains email engage faceted history info install mobile person querybuilder search setup spellcheck synonyms weights engage_search_term engage_related_content engage_next_results engage_personalized_results engage_recent_results success add arrow-down arrow-left arrow-right arrow-up caret-down caret-left caret-right caret-up check close content conversions-small conversions details edit grid help small-info error live magento minus move photo pin plus preview refresh search settings small-home stat subtract text trash unpin wordpress x alert case_deflection advanced-permissions keyword-detection predictive-ai sso

Faceting

You can use faceting to give you a count of results for each value of a particular field.

q
required
The query used within your search.
engine_key
required
The Engine Key associated with your Engine. Found within your dashboard.
facets
optional
Count the results of a given field within a DocumentType. As such, the facet parameter requires both a DocumentType and a field belonging to that DocumentType.
Example - Return a count of values within the genre field: a book is either fiction or non-fiction.
curl -XGET 'https://search-api.swiftype.com/api/v1/public/engines/search.json' \
  -H 'Content-Type: application/json' \
  -d '{
        "engine_key": "YOUR_ENGINE_KEY",
        "q": "brothers",
        "facets":{
          "books":["genre"]
        }
      }'
Example Response
{
  "records": {
    "books": [
      {
        "title": "The Brothers Karamazov",
        "author": "Fyodor Dostoyevsky",
        "price": "14.95"
      },
      ...
    ]
  },
  "info": {
    "books": {
      "query": "brothers",
      "current_page": 1,
      "num_pages": 1,
      "per_page": 20,
      "total_result_count": 18,
      "facets": {
        "genre": {
           "fiction": 11,
           "non-fiction": 7
        }
      }
    }
  },
  "errors": {}
}

Supported Field Types

Type Faceting
string Yes
text No
enum Yes
integer Yes
float Yes
date Yes
location No

Stuck? Looking for help? Contact support or check out the Site Search community forum!