Search API Parameters

The text used to search an index.

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

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

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

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

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

Filter hits by facet value.

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

Filter on numeric attributes.

Filter hits by tags.

Determines how to calculate the total score for filtering.

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

The maximum number of facet values to return for each facet in a regular search.

Compute facet counts after deduplication (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 for paginating the search results.

Determine the position of a particular record in the dataset.

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

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

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

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

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

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

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

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

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 the radius isn’t defined.

Search inside a rectangular area (in geo coordinates).

Search inside a polygon (using geographical coordinates).

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

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

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

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

Splits compound words into their composing atoms in the query.

Whether Rules should be globally enabled.

Assigns rule contexts to search queries.

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 optional when found in the query.

List of attributes for which you want to turn off 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.

Deduplicate or group results.

Retrieve detailed ranking information.

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

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.

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

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

Whether this search should participate in running AB tests.

Whether this search should use Dynamic Re-ranking.