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

Highlight Fields

Highlight query matches within result text for a given field.

Highlighting wraps relevant text in <em></em> tags, which can be styled however you choose.

engine_key
required
The Engine Key associated with your Engine. Found within your dashboard.
q
required
The query used within your search.
highlight_fields
optional
Returns highlighted query matches within the given fields. Expects a DocumenType, a field name, and parameters. The size parameter indicates the number of characters to return. If fallback is set to true, will return raw text instead of a styled result if no exact query matches are found. If false, will return nothing.
Example - Return documents from the books DocumentType that match the query "brothers", highlighting 60 characters of the title field. It will fallback to raw, unstyled results if no matches are found.
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",
        "highlight_fields":{
          "books":{"title":{"size":60,"fallback":true}}
        }
      }'
Example - Use escaped quotes to highlight only an exact match - case insensitive.
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\"",
       "highlight_fields": {
         "books": { "title": { "size": 60, "fallback": true } }
       }
     }'

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