Search API parameters
| query || |
The text to search in the index.
| attributesToRetrieve || |
Gives control over which attributes to retrieve and which not to retrieve.
| restrictSearchableAttributes || |
Restricts a given query to look in only a subset of your searchable attributes.
This setting overrides searchableAttributes for specific searches.
| filters || |
Filter the query with numeric, facet and/or tag filters.
| facetFilters || |
Filter hits by facet value.
| optionalFilters || |
Create filters for ranking purposes, where records that match the filter are ranked highest.
| numericFilters || |
Filter on numeric attributes.
| tagFilters || |
Filter hits by tags.
| sumOrFiltersScores || |
Determines how to calculate the total score for filtering.
| facets || |
Facets to retrieve.
| maxValuesPerFacet || |
Maximum number of facet values to return for each facet during a regular search.
If you want to change the number of retrieved facet hits during a search for facet values, see maxFacetHits.
| facetingAfterDistinct || |
Force faceting to be applied after de-duplication (via the Distinct setting).
| sortFacetValuesBy || |
Controls how facet values are sorted.
| attributesToHighlight || |
List of attributes to highlight.
| attributesToSnippet || |
List of attributes to snippet, with an optional maximum number of words to snippet.
| highlightPreTag || |
The HTML string to insert before the highlighted parts in all highlight and snippet results.
| highlightPostTag || |
The HTML string to insert after the highlighted parts in all highlight and snippet results.
| snippetEllipsisText || |
String used as an ellipsis indicator when a snippet is truncated.
| restrictHighlightAndSnippetArrays || |
Restrict highlighting and snippeting to items that matched the query.
| page || |
Specify the page to retrieve.
| hitsPerPage || |
Set the number of hits per page.
| offset || |
Specify the offset of the first hit to return.
| length || |
Set the number of hits to retrieve (used only with offset).
| minWordSizefor1Typo || |
Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
| minWordSizefor2Typos || |
Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
| typoTolerance || |
Controls whether typo tolerance is enabled and how it is applied.
| allowTyposOnNumericTokens || |
Whether to allow typos on numbers (“numeric tokens”) in the query string.
| disableTypoToleranceOnAttributes || |
List of attributes on which you want to disable typo tolerance.
| aroundLatLng || |
Search for entries around a central geolocation, enabling a geo search within a circular area.
| aroundLatLngViaIP || |
Search for entries around a given location automatically computed from the requester’s IP address.
| aroundRadius || |
Define the maximum radius for a geo search (in meters).
| aroundPrecision || |
Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
| minimumAroundRadius || |
Minimum radius (in meters) used for a geo search when aroundRadius is not set.
| insideBoundingBox || |
Search inside a rectangular area (in geo coordinates).
| insidePolygon || |
Search inside a polygon (in geo coordinates).
| ignorePlurals || |
Treats singular, plurals, and other forms of declensions as matching terms.
| removeStopWords || |
Removes stop (common) words from the query before executing it.
| queryLanguages |
| enableRules || |
Whether rules should be globally enabled.
| ruleContexts || |
Enables contextual rules.
| queryType || |
Controls if and how query words are interpreted as prefixes.
| removeWordsIfNoResults || |
Selects a strategy to remove words from the query when it doesn’t match any hits.
| advancedSyntax || |
Enables the advanced query syntax.
| optionalWords || |
A list of words that should be considered as optional when found in the query.
| disableExactOnAttributes || |
List of attributes on which you want to disable the
| exactOnSingleWordQuery || |
Controls how the
| alternativesAsExact || |
List of alternatives that should be considered an exact match by the
| distinct || |
Enables de-duplication or grouping of results.
| getRankingInfo || |
Retrieve detailed ranking information.
| clickAnalytics || |
Enable the Click Analytics feature.
| analytics || |
Whether the current query will be taken into account in the Analytics.
| analyticsTags || |
List of tags to apply to the query in the analytics.
| synonyms || |
Whether to take into account an index’s synonyms for a particular search.
| replaceSynonymsInHighlight || |
Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
| minProximity || |
Precision of the
| responseFields || |
Choose which fields the response will contain. Applies to search and browse queries.
| maxFacetHits || |
Maximum number of facet hits to return during a search for facet values.
If you want to change the number of retrieved facet values for a regular search, see maxValuesPerFacet.
| percentileComputation || |
Whether to include or exclude a query from the processing-time percentile computation.
Did you find this page helpful?
We're always looking for advice to help improve our documentation!
Please let us know what's working (or what's not!).
We're constantly iterating thanks to the feedback we receive.