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

DocumentTypes

Search within a single DocumentType or through specific, multiple DocumentTypes.

Single DocumentType

Searching for a single DocumentType.

q
required
The query used within your search.
engine_key
required
The Engine Key associated with your Engine. Found within your dashboard.
document_types
optional
The DocumentType within which to search. See the API Overview for more information on DocumentTypes.
Example - An example when searching one document_type_id. The document_type_id will be the only DocumentType searched upon.
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",
        "document_types": ["videos"]
      }'

Multiple DocumentTypes

Searching against one of more DocumentTypes.

q
required
The query used for a prefix match. Queries shorter than a few characters may not return results.
engine_key
required
The Engine Key associated with your Engine. Found within your dashboard.
document_types
optional
The DocumentTypes within which to search. See the API Overview for more information on DocumentTypes.
Example - Return results matching "brothers" in the magazines and comics DocumentTypes using a Public search query.
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",
        "document_types": ["magazines", "comics"]
      }'

Errors

Example - Errors for limiting DocumentTypes searched to a DocumentType that doesn't exist
{
  "engine_key": "YOUR_ENGINE_KEY",
  "q": "brothers",
  "document_types": ["books", "folios"]
}
Example Response
{
  "records": {
    "books": [...]
  },
  "info": {...},
  "errors": {
    "document_types": ["DocumentType 'folios' does not exist in this Engine."]
  }
}
Example - Errors for fetching a field that doesn't exist in a DocumentType.
{
  "engine_key": "YOUR_ENGINE_KEY",
  "q": "brothers",
  "fetch_fields": {"books": ["title", "publisher"]}
}
Example Response
{
  "records": {
    "books": [...]
  },
  "info": {...},
  "errors": {
    "fetch_fields": {
      "books": ["DocumentType 'books' does not have a field 'publisher'."]
    }
  }
}
Example - Errors for specifying search fields for a DocumentType that doesn't exist in the Engine
{
  "engine_key": "YOUR_ENGINE_KEY",
  "q": "brothers",
  "search_fields": {"folios": ["title"]}
}
Example Response
{
  "records": {
    "books": [...]
  },
  "info": {...},
  "errors": {
    "search_fields": {
      "folios": ["DocumentType 'folios' does not exist in this Engine."]
    }
  }
}
Example - Errors for specifying search fields for a DocumentType that exists in the Engine but is excluded
{
  "engine_key": "YOUR_ENGINE_KEY",
  "q": "brothers",
  "search_fields": {"magazines": ["title"]},
  "document_types": ["books"]
}
Example Response
{
  "records": {
    "books": [...]
  },
  "info": {...},
  "errors": {
    "search_fields": {
      "magazines": ["DocumentType 'magazines' exists in this Engine but is not included in the list of DocumentTypes to search."]
    }
  }
}

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