API Reference / Search API Parameters

Search Parameters

Here is the list of parameters you can use with the search method (search scope).

Parameters that can also be used in setSettings will have the settings scope.

search

query
search

The text used to search an index.

similarQuery
search

Overrides the query parameter and performs a more generic search to find “similar” results.

attributes

attributesToRetrieve
settings search

This parameter controls which attributes to retrieve and which not to retrieve.

restrictSearchableAttributes
search

Limit the search for a given query to a subset of your searchable attributes.

ranking

relevancyStrictness
settings search

Controls the relevancy threshold below which less relevant results aren’t included in the results.

filtering

filters
search

Filter the query with numeric, facet, or tag filters.

facetFilters
search

Filter hits by facet value.

optionalFilters
search

Boost or bury records based on specific criteria, but without hiding those records.

numericFilters
search

Filter on numeric attributes.

tagFilters
search

Filter hits by tags.

sumOrFiltersScores
search

Determines how to calculate the total score for filtering.

faceting

facets
search

Retrieve facets, their facet values, and the number of matching facet values.

maxValuesPerFacet
settings search

The maximum number of values to return for each facet.

facetingAfterDistinct
search

Compute facet counts after deduplication (via the distinct setting).

sortFacetValuesBy
settings search

Controls how facet values are fetched.

highlighting-snippeting

attributesToHighlight
settings search

List of attributes to highlight.

attributesToSnippet
settings search

Attributes to snippet, with an optional maximum word limit.

highlightPreTag
settings search

The HTML string to insert before the highlighted parts in all highlight and snippet results.

highlightPostTag
settings search

The HTML string to insert after the highlighted parts in all highlight and snippet results.

snippetEllipsisText
settings search

String used as an ellipsis indicator when a snippet is truncated.

restrictHighlightAndSnippetArrays
settings search

Restrict highlighting and snippeting to items that matched the query.

pagination

page
search

Specify the page to retrieve.

hitsPerPage
settings search

Set the number of hits per page for paginating the search results.

offset
search

Determine the position of a particular record in the dataset.

length
search

Set the number of hits to retrieve (used only with offset).

typos

minWordSizefor1Typo
settings search

The minimum number of characters in a query word before typos are considered.

minWordSizefor2Typos
settings search

The minimum number of characters in a query word before two typos are considered.

typoTolerance
settings search

Controls whether typo tolerance is enabled and how it is applied.

allowTyposOnNumericTokens
settings search

Whether to allow numeric typos in the query.

disableTypoToleranceOnAttributes
settings search

A list of searchable attributes for which you want to turn off typo tolerance.

geo-search

aroundLatLng
search

Search for entries around a central location, enabling a geographical search within a circular area.

aroundLatLngViaIP
search

Search for entries around a central location automatically computed from the user’s IP address, enabling a geographical search within a circular area.

aroundRadius
search

Define the maximum radius for a geo search (in meters).

aroundPrecision
search

Precision of geo search (in meters), to add grouping by geo location to the ranking formula.

minimumAroundRadius
search

Minimum radius (in meters) used for a geo search when the radius isn’t defined.

insideBoundingBox
search

Search inside a rectangular area (in geo coordinates).

insidePolygon
search

Search inside a polygon (using geographical coordinates).

languages

ignorePlurals
settings search

Treats singular, plurals, and other forms of declensions as matching terms.

removeStopWords
settings search

Removes stop (common) words from the query before executing it.

queryLanguages
settings search

Sets languages for language-specific settings such as plurals, stop words, and dictionaries for detecting words in CJK languages.

naturalLanguages
search

Change the default of parameters for handling natural language searches as opposed to keyword searches, for example, for voice search.

decompoundQuery
settings search

Splits compound words into their composing atoms in the query.

rules

enableRules
search settings

Whether Rules should be globally enabled.

ruleContexts
search

Assigns rule contexts to search queries.

personalization

enablePersonalization
search settings

Enable the Personalization feature.

personalizationImpact
search

Define the impact of the Personalization feature.

userToken
search

Associates a certain user token with the current search.

query-strategy

queryType
search settings

Determine how query words are interpreted as prefixes.

removeWordsIfNoResults
settings search

Selects a strategy to remove words from the query when it doesn’t match any hits.

advancedSyntax
settings search

Enables the advanced query syntax.

optionalWords
settings search

A list of words that should be considered optional when found in the query.

disableExactOnAttributes
settings search

List of attributes for which you want to turn off the exact ranking criterion.

exactOnSingleWordQuery
settings search

Controls how the exact ranking criterion is computed when the query contains only one word.

alternativesAsExact
settings search

List of alternatives that should be considered an exact match by the exact ranking criterion.

advancedSyntaxFeatures
settings search

Allows you to specify which advanced syntax features are active when ‘advancedSyntax’ is enabled.

advanced

distinct
settings search

Deduplicate or group results.

getRankingInfo
search

Retrieve detailed ranking information.

clickAnalytics
search

Add a query ID parameter to the response for tracking click and conversion events.

analytics
search

Whether the current query will be taken into account in the Analytics.

analyticsTags
search

List of tags to apply to the query for analytics purposes.

synonyms
search

Whether to take into account an index’s synonyms for a particular search.

replaceSynonymsInHighlight
settings search

Whether to highlight and snippet the original word that matches the synonym or the synonym itself.

minProximity
settings search

Precision of the proximity ranking criterion.

responseFields
settings search

Choose which fields to return in the API response. This parameters applies to search and browse queries.

maxFacetHits
settings search

Maximum number of facet hits to return during a search for facet values.

percentileComputation
search

Whether to include or exclude a query from the processing-time percentile computation.

attributeCriteriaComputedByMinProximity
settings search

When the Attribute criterion is ranked higher than Proximity in your ranking formula, Proximity selects which searchable attribute is matched in the Attribute criterion.

enableABTest
search

Whether this search should participate in running AB tests.

enableReRanking
search

Whether this search should use Dynamic Re-ranking.