Search API Parameters

The text to search in the index.

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

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

Restricts a given query to look in only a subset of your searchable attributes.

This setting overrides searchableAttributes for specific searches, without changing the priority order of the searchableAttributes.

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

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

Filter hits by facet value.

Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter.

Filter on numeric attributes.

Filter hits by tags.

Determines how to calculate the total score for filtering.

Retrieve facets and their facet values.

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.

Force faceting to be applied after de-duplication (via the Distinct setting).

Controls how facet values are fetched.

List of attributes to highlight.

List of attributes to snippet, with an optional maximum number of words to snippet.

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

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

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

Restrict highlighting and snippeting to items that matched the query.

Specify the page to retrieve.

Set the number of hits per page.

In most cases, page/hitsPerPage is the recommended method for pagination. Check our full discussion on pagination approaches.

Specify the offset of the first hit to return.

In most cases, page/hitsPerPage is the recommended method for pagination. This setting is part of an alternative paging approach.

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

In most cases, page/hitsPerPage is the recommended method for pagination. This setting is part of an alternative paging approach.

Minimum number of characters a word in the query string must contain to accept matches with 1 typo.

Minimum number of characters a word in the query string must contain to accept matches with 2 typos.

Changing this setting to a lower number can negatively affect relevance with short queries, because more records will be considered a match with two typos.

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

Whether to allow typos on numbers (“numeric tokens”) in the query string.

List of attributes on which you want to disable typo tolerance.

Search for entries around a central geolocation, enabling a geo search within a circular area.

Search for entries around a given location automatically computed from the requester’s IP address.

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

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

Minimum radius (in meters) used for a geo search when aroundRadius is not set.

Search inside a rectangular area (in geo coordinates).

Search inside a polygon (in geo coordinates).

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

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

Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.

This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts. These parameters and settings work well together when the query is formatted in natural language instead of keywords, for example when your user performs a voice search.

Splits compound words into their composing atoms in the query.

Whether Rules should be globally enabled.

Enables contextual rules.

Enable the Personalization feature.

Define the impact of the Personalization feature.

Associates a certain user token with the current search.

Controls if and how query words are interpreted as prefixes.

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

Enables the advanced query syntax.

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

List of attributes on which you want to disable the exact ranking criterion.

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

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

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

Enables de-duplication or grouping of results.

Retrieve detailed ranking information.

Enable the Click Analytics feature.

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

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

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

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

Precision of the proximity ranking criterion.

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

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.

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

When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.

Whether this search should participate in running AB tests.

Whether this search should use AI Re-Ranking.