Browse for records

Required ACL: browse

Authorizations

x-algolia-application-id

string

header

required

Your Algolia application ID.

x-algolia-api-key

string

header

required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

indexName

string

required

Name of the index on which to perform the operation.

Example:

"ALGOLIA_INDEX_NAME"

Body

application/json

Search parameters as object
Search parameters as query string

Each parameter value, including the query must not be larger than 512 bytes.

query

string

default:""

Search query.

similarQuery

string

default:""

Keywords to be used instead of the search query to conduct a more broader search Using the similarQuery parameter changes other settings

queryType is set to prefixNone.
removeStopWords is set to true.
words is set as the first ranking criterion.
All remaining words are treated as optionalWords Since the similarQuery is supposed to do a broad search, they usually return many results. Combine it with filters to narrow down the list of results.

Example:

"comedy drama crime Macy Buscemi"

filters

string

Filter expression to only include items that match the filter criteria in the response.

You can use these filter expressions:

Numeric filters. <facet> <op> <number>, where <op> is one of <, <=, =, !=, >, >=.
Ranges. <facet>:<lower> TO <upper> where <lower> and <upper> are the lower and upper limits of the range (inclusive).
Facet filters. <facet>:<value> where <facet> is a facet attribute (case-sensitive) and <value> a facet value.
Tag filters. _tags:<value> or just <value> (case-sensitive).
Boolean filters. <facet>: true | false.

You can combine filters with AND, OR, and NOT operators with the following restrictions:

You can only combine filters of the same type with OR. Not supported: facet:value OR num > 3.
You can't use NOT with combinations of filters. Not supported: NOT(facet:value OR facet:value)
You can't combine conjunctions (AND) with OR. Not supported: facet:value OR (facet:value AND facet:value)

Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (OR, AND, NOT), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.

For more information, see Filters.

Example:

"(category:Book OR category:Ebook) AND _tags:published"

facetFilters

Filter the search by facet values, so that only records with the same facet values are retrieved.

Prefer using the filters parameter, which supports all filter types and combinations with boolean operators.

[filter1, filter2] is interpreted as filter1 AND filter2.
[[filter1, filter2], filter3] is interpreted as filter1 OR filter2 AND filter3.
facet:-value is interpreted as NOT facet:value.

While it's best to avoid attributes that start with a -, you can still filter them by escaping with a backslash: facet:\-value.

Example:

[
  ["category:Book", "category:-Movie"],
  "author:John Doe"
]

optionalFilters

Filters to promote or demote records in the search results.

Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter facet:-value, matching records rank after records that don't match.

Optional filters don't work on virtual replicas.
Optional filters are applied after sort-by attributes.
Optional filters are applied before custom ranking attributes (in the default ranking).
Optional filters don't work with numeric attributes.

Example:

["category:Book", "author:John Doe"]

numericFilters

Filter by numeric facets.

Prefer using the filters parameter, which supports all filter types and combinations with boolean operators.

You can use numeric comparison operators: <, <=, =, !=, >, >=. Comparisons are precise up to 3 decimals. You can also provide ranges: facet:<lower> TO <upper>. The range includes the lower and upper boundaries. The same combination rules apply as for facetFilters.

Example:

[
  ["inStock = 1", "deliveryDate < 1441755506"],
  "price < 1000"
]

tagFilters

Filter the search by values of the special _tags attribute.

Prefer using the filters parameter, which supports all filter types and combinations with boolean operators.

Different from regular facets, _tags can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for facetFilters.

Example:

[["Book", "Movie"], "SciFi"]

sumOrFiltersScores

boolean

default:false

Whether to sum all filter scores If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see filter scores.

restrictSearchableAttributes

string[]

Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.

Example:

["title", "author"]

facets

string[]

Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character *. For more information, see facets.

Example:

["*"]

facetingAfterDistinct

boolean

default:false

Whether faceting should be applied after deduplication with distinct This leads to accurate facet counts when using faceting in combination with distinct. It's usually better to use afterDistinct modifiers in the attributesForFaceting setting, as facetingAfterDistinct only computes correct facet counts if all records have the same facet values for the attributeForDistinct.

page

integer

default:0

Page of search results to retrieve.

Required range: x >= 0

offset

integer

Position of the first hit to retrieve.

length

integer

Number of hits to retrieve (used in combination with offset).

Required range: 0 <= x <= 1000

aroundLatLng

string

default:""

Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.

Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the aroundRadius and minimumAroundRadius settings. This parameter is ignored if you also specify insidePolygon or insideBoundingBox.

Example:

"40.71,-74.01"

aroundLatLngViaIP

boolean

default:false

Whether to obtain the coordinates from the request's IP address.

aroundRadius

Maximum radius for a search around a central location.

This parameter works in combination with the aroundLatLng and aroundLatLngViaIP parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.

Required range: x >= 1

aroundPrecision

default:10

Precision of a coordinate-based search in meters to group results with similar distances.

The Geo ranking criterion considers all matches within the same range of distances to be equal.

minimumAroundRadius

integer

Minimum radius (in meters) for a search around a location when aroundRadius isn't set.

Required range: x >= 1

insideBoundingBox

insidePolygon

number<double>[][]

Coordinates of a polygon in which to search.

Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see filtering inside polygons. This parameter is ignored if you also specify insideBoundingBox.

Required array length: 6 - 20000 elements

Example:

naturalLanguages

enum<string>[]

ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches)

Sets removeStopWords and ignorePlurals to the list of provided languages.
Sets removeWordsIfNoResults to allOptional.
Adds a natural_language attribute to ruleContexts and analyticsTags.

ISO code for a supported language.

Available options:

af,

ar,

az,

bg,

bn,

ca,

cs,

cy,

da,

de,

el,

en,

eo,

es,

et,

eu,

fa,

fi,

fo,

fr,

ga,

gl,

he,

hi,

hu,

hy,

id,

is,

it,

ja,

ka,

kk,

ko,

ku,

ky,

lt,

lv,

mi,

mn,

mr,

ms,

mt,

nb,

nl,

no,

ns,

pl,

ps,

pt,

pt-br,

qu,

ro,

ru,

sk,

sq,

sv,

sw,

ta,

te,

th,

tl,

tn,

tr,

tt,

uk,

ur,

uz,

zh

ruleContexts

string[]

Assigns a rule context to the search query Rule contexts are strings that you can use to trigger matching rules.

Example:

["mobile"]

personalizationImpact

integer

default:100

Impact that Personalization should have on this search The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see Understanding Personalization impact.

Required range: 0 <= x <= 100

userToken

string

Unique pseudonymous or anonymous user identifier.

This helps with analytics and click and conversion events. For more information, see user token.

Example:

"test-user-123"

getRankingInfo

boolean

default:false

Whether the search response should include detailed ranking information.

synonyms

boolean

default:true

Whether to take into account an index's synonyms for this search.

clickAnalytics

boolean

default:false

Whether to include a queryID attribute in the response The query ID is a unique identifier for a search query and is required for tracking click and conversion events.

analytics

boolean

default:true

Whether this search will be included in Analytics.

analyticsTags

string[]

Tags to apply to the query for segmenting analytics data.

percentileComputation

boolean

default:true

Whether to include this search when calculating processing-time percentiles.

enableABTest

boolean

default:true

Whether to enable A/B testing for this search.

attributesToRetrieve

string[]

Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive

* retrieves all attributes, except attributes included in the customRanking and unretrievableAttributes settings.
To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the *: ["*", "-ATTRIBUTE"].
The objectID attribute is always included.

Example:

["author", "title", "content"]

ranking

string[]

Determines the order in which Algolia returns your results.

By default, each entry corresponds to a ranking criteria. The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for sorting by an attribute, you put the sorting attribute at the top of the list.

Modifiers

asc("ATTRIBUTE"). Sort the index by the values of an attribute, in ascending order.
desc("ATTRIBUTE"). Sort the index by the values of an attribute, in descending order.

Before you modify the default setting, you should test your changes in the dashboard, and by A/B testing.

relevancyStrictness

integer

default:100

Relevancy threshold below which less relevant results aren't included in the results You can only set relevancyStrictness on virtual replica indices. Use this setting to strike a balance between the relevance and number of returned results.

Example:

90

attributesToHighlight

string[]

Attributes to highlight By default, all searchable attributes are highlighted. Use * to highlight all attributes or use an empty array [] to turn off highlighting. Attribute names are case-sensitive With highlighting, strings that match the search query are surrounded by HTML tags defined by highlightPreTag and highlightPostTag. You can use this to visually highlight matching parts of a search query in your UI For more information, see Highlighting and snippeting.

Example:

["author", "title", "conten", "content"]

attributesToSnippet

string[]

Attributes for which to enable snippets. Attribute names are case-sensitive Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: ATTRIBUTE:NUMBER, where NUMBER is the number of words to be extracted.

Example:

["content:80", "description"]

highlightPreTag

string

default:

HTML tag to insert before the highlighted parts in all highlighted results and snippets.

highlightPostTag

string

default:

HTML tag to insert after the highlighted parts in all highlighted results and snippets.

snippetEllipsisText

string

default:…

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

restrictHighlightAndSnippetArrays

boolean

default:false

Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted.

hitsPerPage

integer

default:20

Number of hits per page.

Required range: 1 <= x <= 1000

minWordSizefor1Typo

integer

default:4

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

minWordSizefor2Typos

integer

default:8

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

typoTolerance

default:true

Whether typo tolerance is enabled and how it is applied.

If typo tolerance is true, min, or strict, word splitting and concatenation are also active.

allowTyposOnNumericTokens

boolean

default:true

Whether to allow typos on numbers in the search query Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers.

disableTypoToleranceOnAttributes

string[]

Attributes for which you want to turn off typo tolerance. Attribute names are case-sensitive Returning only exact matches can help when

Searching in hyphenated attributes.
Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions Consider alternatives such as disableTypoToleranceOnWords or adding synonyms if your attributes have intentional unusual spellings that might look like typos.

Example:

["sku"]

ignorePlurals

Treat singular, plurals, and other forms of declensions as equivalent. You should only use this feature for the languages used in your index.

ISO code for a supported language.

Available options:

af,

ar,

az,

bg,

bn,

ca,

cs,

cy,

da,

de,

el,

en,

eo,

es,

et,

eu,

fa,

fi,

fo,

fr,

ga,

gl,

he,

hi,

hu,

hy,

id,

is,

it,

ja,

ka,

kk,

ko,

ku,

ky,

lt,

lv,

mi,

mn,

mr,

ms,

mt,

nb,

nl,

no,

ns,

pl,

ps,

pt,

pt-br,

qu,

ro,

ru,

sk,

sq,

sv,

sw,

ta,

te,

th,

tl,

tn,

tr,

tt,

uk,

ur,

uz,

zh

Example:

["ca", "es"]

removeStopWords

Removes stop words from the search query.

Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, "the", "a", or "and" are stop words.

You should only use this feature for the languages used in your index.

ISO code for a supported language.

Available options:

af,

ar,

az,

bg,

bn,

ca,

cs,

cy,

da,

de,

el,

en,

eo,

es,

et,

eu,

fa,

fi,

fo,

fr,

ga,

gl,

he,

hi,

hu,

hy,

id,

is,

it,

ja,

ka,

kk,

ko,

ku,

ky,

lt,

lv,

mi,

mn,

mr,

ms,

mt,

nb,

nl,

no,

ns,

pl,

ps,

pt,

pt-br,

qu,

ro,

ru,

sk,

sq,

sv,

sw,

ta,

te,

th,

tl,

tn,

tr,

tt,

uk,

ur,

uz,

zh

Example:

["ca", "es"]

queryLanguages

enum<string>[]

Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries This setting sets a default list of languages used by the removeStopWords and ignorePlurals settings. This setting also sets a dictionary for word detection in the logogram-based CJK languages. To support this, you must place the CJK language first You should always specify a query language. If you don't specify an indexing language, the search engine uses all supported languages, or the languages you specified with the ignorePlurals or removeStopWords parameters. This can lead to unexpected search results. For more information, see Language-specific configuration.

ISO code for a supported language.

Available options:

af,

ar,

az,

bg,

bn,

ca,

cs,

cy,

da,

de,

el,

en,

eo,

es,

et,

eu,

fa,

fi,

fo,

fr,

ga,

gl,

he,

hi,

hu,

hy,

id,

is,

it,

ja,

ka,

kk,

ko,

ku,

ky,

lt,

lv,

mi,

mn,

mr,

ms,

mt,

nb,

nl,

no,

ns,

pl,

ps,

pt,

pt-br,

qu,

ro,

ru,

sk,

sq,

sv,

sw,

ta,

te,

th,

tl,

tn,

tr,

tt,

uk,

ur,

uz,

zh

Example:

["es"]

decompoundQuery

boolean

default:true

Whether to split compound words in the query into their building blocks For more information, see Word segmentation. Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with non-spacing mark Unicode characters. For example, Gartenstühle won't be decompounded if the ü consists of u (U+0075) and ◌̈ (U+0308).

enableRules

boolean

default:true

Whether to enable rules.

enablePersonalization

boolean

default:false

Whether to enable Personalization.

queryType

enum<string>

default:prefixLast

Determines if and how query words are interpreted as prefixes.

By default, only the last query word is treated as a prefix (prefixLast). To turn off prefix search, use prefixNone. Avoid prefixAll, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower.

For more information, see Prefix searching.

Available options:

prefixLast,

prefixAll,

prefixNone

removeWordsIfNoResults

enum<string>

default:none

Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results.

none. No words are removed when a query doesn't return results.
lastWords. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed.
firstWords. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed.
allOptional. Treat all words as optional.

For more information, see Remove words to improve results.

Available options:

none,

lastWords,

firstWords,

allOptional

Example:

"firstWords"

mode

enum<string>

default:keywordSearch

Search mode the index will use to query for results.

This setting only applies to indices, for which Algolia enabled NeuralSearch for you.

Available options:

neuralSearch,

keywordSearch

semanticSearch

object

Settings for the semantic search part of NeuralSearch. Only used when mode is neuralSearch.

Show child attributes

semanticSearch.eventSources

string[] | null

Indices from which to collect click and conversion events.

If null, the current index and all its replicas are used.

advancedSyntax

boolean

default:false

Whether to support phrase matching and excluding words from search queries Use the advancedSyntaxFeatures parameter to control which feature is supported.

optionalWords

Words that should be considered optional when found in the query.

By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is "action video" and "video" is an optional word, the search engine runs two queries. One for "action video" and one for "action". Records that match all words are ranked higher.

For a search query with 4 or more words and all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records:

If optionalWords has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words.
If optionalWords has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.

For more information, see Optional words.

disableExactOnAttributes

string[]

Searchable attributes for which you want to turn off the Exact ranking criterion. Attribute names are case-sensitive This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.

Example:

["description"]

exactOnSingleWordQuery

enum<string>

default:attribute

Determines how the Exact ranking criterion is computed when the search query has only one word.

attribute. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for "road" will match the value "road", but not "road trip".
none. The Exact ranking criterion is ignored on single-word searches.
word. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't.

Available options:

attribute,

none,

word

alternativesAsExact

enum<string>[]

Determine which plurals and synonyms should be considered an exact matches By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as exact matches when searching. For example

"swimsuit" and "swimsuits" are treated the same
"swimsuit" and "swimwear" are treated the same (if they are synonyms)
ignorePlurals. Plurals and similar declensions added by the ignorePlurals setting are considered exact matches
singleWordSynonym. Single-word synonyms, such as "NY" = "NYC", are considered exact matches
multiWordsSynonym. Multi-word synonyms, such as "NY" = "New York", are considered exact matches.

Available options:

ignorePlurals,

singleWordSynonym,

multiWordsSynonym,

ignoreConjugations

advancedSyntaxFeatures

enum<string>[]

Advanced search syntax features you want to support

exactPhrase. Phrases in quotes must match exactly. For example, sparkly blue "iPhone case" only returns records with the exact string "iPhone case"
excludeWords. Query words prefixed with a - must not occur in a record. For example, search -engine matches records that contain "search" but not "engine" This setting only has an effect if advancedSyntax is true.

Available options:

exactPhrase,

excludeWords

distinct

Determines how many records of a group are included in the search results.

Records with the same value for the attributeForDistinct attribute are considered a group. The distinct setting controls how many members of the group are returned. This is useful for deduplication and grouping.

The distinct setting is ignored if attributeForDistinct is not set.

Example:

1

replaceSynonymsInHighlight

boolean

default:false

Whether to replace a highlighted word with the matched synonym By default, the original words are highlighted even if a synonym matches. For example, with home as a synonym for house and a search for home, records matching either "home" or "house" are included in the search results, and either "home" or "house" are highlighted With replaceSynonymsInHighlight set to true, a search for home still matches the same records, but all occurrences of "house" are replaced by "home" in the highlighted response.

minProximity

integer

default:1

Minimum proximity score for two matching words This adjusts the Proximity ranking criterion by equally scoring matches that are farther apart For example, if minProximity is 2, neighboring matches and matches with one word between them would have the same score.

Required range: 1 <= x <= 7

responseFields

string[]

Properties to include in the API response of search and browse requests By default, all response properties are included. To reduce the response size, you can select which properties should be included An empty list may lead to an empty API response (except properties you can't exclude) You can't exclude these properties: message, warning, cursor, abTestVariantID, or any property added by setting getRankingInfo to true Your search depends on the hits field. If you omit this field, searches won't return any results. Your UI might also depend on other properties, for example, for pagination. Before restricting the response size, check the impact on your search experience.

maxValuesPerFacet

integer

default:100

Maximum number of facet values to return for each facet.

Required range: x <= 1000

sortFacetValuesBy

string

default:count

Order in which to retrieve facet values

count. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value
alpha. Retrieve facet values alphabetically This setting doesn't influence how facet values are displayed in your UI (see renderingContent). For more information, see facet value display.

attributeCriteriaComputedByMinProximity

boolean

default:false

Whether the best matching attribute should be determined by minimum proximity This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the ranking setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the searchableAttributes setting.

renderingContent

object

Extra data that can be used in the search UI.

You can use this to control aspects of your search UI, such as the order of facet names and values without changing your frontend code.

Show child attributes

renderingContent.facetOrdering

object

Order of facet names and facet values in your UI.

Show child attributes

renderingContent.facetOrdering.facets

object

Order of facet names.

Show child attributes

renderingContent.facetOrdering.facets.order

string[]

Explicit order of facets or facet values.

This setting lets you always show specific facets or facet values at the top of the list.

renderingContent.facetOrdering.values

object

Order of facet values. One object for each facet.

Show child attributes

renderingContent.facetOrdering.values.{key}

object

Show child attributes

renderingContent.facetOrdering.values.{key}.order

string[]

Explicit order of facets or facet values.

This setting lets you always show specific facets or facet values at the top of the list.

renderingContent.facetOrdering.values.{key}.sortRemainingBy

enum<string>

Order of facet values that aren't explicitly positioned with the order setting.

count. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value.
alpha. Sort facet values alphabetically.
hidden. Don't show facet values that aren't explicitly positioned.

Available options:

count,

alpha,

hidden

renderingContent.facetOrdering.values.{key}.hide

string[]

Hide facet values.

renderingContent.redirect

object

The redirect rule container.

Show child attributes

renderingContent.redirect.url

string

renderingContent.widgets

object

Widgets returned from any rules that are applied to the current search.

Show child attributes

renderingContent.widgets.banners

object[]

Banners defined in the Merchandising Studio for a given search.

Show child attributes

renderingContent.widgets.banners.image

object

Image to show inside a banner.

Show child attributes

renderingContent.widgets.banners.image.urls

object[]

Show child attributes

renderingContent.widgets.banners.image.urls.url

string

renderingContent.widgets.banners.image.title

string

renderingContent.widgets.banners.link

object

Link for a banner defined in the Merchandising Studio.

Show child attributes

renderingContent.widgets.banners.link.url

string

enableReRanking

boolean

default:true

Whether this search will use Dynamic Re-Ranking This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.

reRankingApplyFilter

Restrict Dynamic Re-Ranking to records that match these filters.

cursor

string

Cursor to get the next page of the response.

The parameter must match the value returned in the response of a previous request. The last page of the response does not return a cursor attribute.

Example:

"jMDY3M2MwM2QwMWUxMmQwYWI0ZTN"

Response

hits

object[]

required

Search results (hits).

Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.

Show child attributes

hits.objectID

string

required

Unique record identifier.

Example:

"test-record-123"

hits._highlightResult

highlightResultMap · object

Surround words that match the query with HTML tags for highlighting.

Show child attributes

hits._highlightResult.{key}

Surround words that match the query with HTML tags for highlighting.

Show child attributes

hits._highlightResult.{key}.value

string

required

Highlighted attribute value, including HTML tags.

Example:

"George Clooney"

hits._highlightResult.{key}.matchLevel

enum<string>

required

Whether the whole query string matches or only a part.

Available options:

none,

partial,

full

hits._highlightResult.{key}.matchedWords

string[]

required

List of matched words from the search query.

Example:

["action"]

hits._highlightResult.{key}.fullyHighlighted

boolean

Whether the entire attribute value is highlighted.

hits._snippetResult

snippetResultMap · object

Snippets that show the context around a matching search query.

Show child attributes

hits._snippetResult.{key}

Snippets that show the context around a matching search query.

Show child attributes

hits._snippetResult.{key}.value

string

required

Highlighted attribute value, including HTML tags.

Example:

"George Clooney"

hits._snippetResult.{key}.matchLevel

enum<string>

required

Whether the whole query string matches or only a part.

Available options:

none,

partial,

full

hits._rankingInfo

object

Object with detailed information about the record's ranking.

Show child attributes

hits._rankingInfo.firstMatchedWord

integer

required

Position of the first matched word in the best matching attribute of the record.

Required range: x >= 0

hits._rankingInfo.geoDistance

integer

required

Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).

Required range: x >= 0

hits._rankingInfo.nbExactWords

integer

required

Number of exactly matched words.

Required range: x >= 0

hits._rankingInfo.nbTypos

integer

required

Number of typos encountered when matching the record.

Required range: x >= 0

hits._rankingInfo.userScore

integer

required

Overall ranking of the record, expressed as a single integer. This attribute is internal.

hits._rankingInfo.filters

integer

Whether a filter matched the query.

Required range: x >= 0

hits._rankingInfo.geoPrecision

integer

Precision used when computing the geo distance, in meters.

Required range: x >= 1

hits._rankingInfo.matchedGeoLocation

object

Show child attributes

hits._rankingInfo.matchedGeoLocation.lat

number<double>

Latitude of the matched location.

hits._rankingInfo.matchedGeoLocation.lng

number<double>

Longitude of the matched location.

hits._rankingInfo.matchedGeoLocation.distance

integer

Distance between the matched location and the search location (in meters).

hits._rankingInfo.personalization

object

Show child attributes

hits._rankingInfo.personalization.filtersScore

integer

The score of the filters.

hits._rankingInfo.personalization.rankingScore

integer

The score of the ranking.

hits._rankingInfo.personalization.score

integer

The score of the event.

hits._rankingInfo.promoted

boolean

Whether the record was promoted by a rule.

hits._rankingInfo.proximityDistance

integer

Number of words between multiple matches in the query plus 1. For single word queries, proximityDistance is 0.

Required range: x >= 0

hits._rankingInfo.words

integer

Number of matched words.

Required range: x >= 1

hits._rankingInfo.promotedByReRanking

boolean

Whether the record is re-ranked.

hits._distinctSeqID

integer

query

string

default:""

required

Search query.

params

string

required

URL-encoded string of all search parameters.

Example:

"query=a&hitsPerPage=20"

abTestID

integer

A/B test ID. This is only included in the response for indices that are part of an A/B test.

abTestVariantID

integer

Variant ID. This is only included in the response for indices that are part of an A/B test.

Required range: x >= 1

aroundLatLng

string

Computed geographical location.

Example:

"40.71,-74.01"

automaticRadius

string

Distance from a central coordinate provided by aroundLatLng.

exhaustive

exhaustive · object

Whether certain properties of the search response are calculated exhaustive (exact) or approximated.

Show child attributes

exhaustive.facetsCount

boolean

Whether the facet count is exhaustive (true) or approximate (false). See the related discussion.

exhaustive.facetValues

boolean

The value is false if not all facet values are retrieved.

exhaustive.nbHits

boolean

Whether the nbHits is exhaustive (true) or approximate (false). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). nbHits is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.

exhaustive.rulesMatch

boolean

Rules matching exhaustivity. The value is false if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.

exhaustive.typo

boolean

Whether the typo search was exhaustive (true) or approximate (false). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.

appliedRules

appliedRules · object[]

Rules applied to the query.

exhaustiveFacetsCount

boolean

deprecated

See the facetsCount field of the exhaustive object in the response.

exhaustiveNbHits

boolean

deprecated

See the nbHits field of the exhaustive object in the response.

exhaustiveTypo

boolean

deprecated

See the typo field of the exhaustive object in the response.

facets

facets · object

Facet counts.

Show child attributes

facets.{key}

object

Show child attributes

facets.{key}.{key}

integer

Example:

{ "category": { "food": 1, "tech": 42 } }

facets_stats

object

Statistics for numerical facets.

Show child attributes

facets_stats.{key}

facetStats · object

Show child attributes

facets_stats.{key}.min

number<double>

Minimum value in the results.

facets_stats.{key}.max

number<double>

Maximum value in the results.

facets_stats.{key}.avg

number<double>

Average facet value in the results.

facets_stats.{key}.sum

number<double>

Sum of all values in the results.

index

string

Index name used for the query.

Example:

"indexName"

indexUsed

string

Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.

Example:

"indexNameAlt"

message

string

Warnings about the query.

nbSortedHits

integer

Number of hits selected and sorted by the relevant sort algorithm.

Example:

20

parsedQuery

string

Post-normalization query string that will be searched.

Example:

"george clo"

processingTimeMS

integer

Time the server took to process the request, in milliseconds.

Example:

20

processingTimingsMS

object

Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.

queryAfterRemoval

string

Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.

redirect

redirect · object

Redirect results to a URL, this this parameter is for internal use only.

Show child attributes

redirect.index

object[]

Show child attributes

redirect.index.source

string

required

Source index for the redirect rule.

redirect.index.dest

string

required

Destination index for the redirect rule.

redirect.index.reason

string

required

Reason for the redirect rule.

redirect.index.succeed

boolean

required

Redirect rule status.

redirect.index.data

redirectRuleIndexData · object

required

Redirect rule data.

Show child attributes

redirect.index.data.ruleObjectID

string

required

renderingContent

object

Extra data that can be used in the search UI.

You can use this to control aspects of your search UI, such as the order of facet names and values without changing your frontend code.

Show child attributes

renderingContent.facetOrdering

object

Order of facet names and facet values in your UI.

Show child attributes

renderingContent.facetOrdering.facets

object

Order of facet names.

Show child attributes

renderingContent.facetOrdering.facets.order

string[]

Explicit order of facets or facet values.

This setting lets you always show specific facets or facet values at the top of the list.

renderingContent.facetOrdering.values

object

Order of facet values. One object for each facet.

Show child attributes

renderingContent.facetOrdering.values.{key}

object

Show child attributes

renderingContent.facetOrdering.values.{key}.order

string[]

Explicit order of facets or facet values.

This setting lets you always show specific facets or facet values at the top of the list.

renderingContent.facetOrdering.values.{key}.sortRemainingBy

enum<string>

Order of facet values that aren't explicitly positioned with the order setting.

count. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value.
alpha. Sort facet values alphabetically.
hidden. Don't show facet values that aren't explicitly positioned.

Available options:

count,

alpha,

hidden

renderingContent.facetOrdering.values.{key}.hide

string[]

Hide facet values.

renderingContent.redirect

object

The redirect rule container.

Show child attributes

renderingContent.redirect.url

string

renderingContent.widgets

object

Widgets returned from any rules that are applied to the current search.

Show child attributes

renderingContent.widgets.banners

object[]

Banners defined in the Merchandising Studio for a given search.

Show child attributes

renderingContent.widgets.banners.image

object

Image to show inside a banner.

Show child attributes

renderingContent.widgets.banners.image.urls

object[]

Show child attributes

renderingContent.widgets.banners.image.urls.url

string

renderingContent.widgets.banners.image.title

string

renderingContent.widgets.banners.link

object

Link for a banner defined in the Merchandising Studio.

Show child attributes

renderingContent.widgets.banners.link.url

string

serverTimeMS

integer

Time the server took to process the request, in milliseconds.

Example:

20

serverUsed

string

Host name of the server that processed the request.

Example:

"c2-uk-3.algolia.net"

userData

any

default:{}

An object with custom data.

You can store up to 32kB as custom data.

Example:

{
  "settingID": "f2a7b51e3503acc6a39b3784ffb84300",
  "pluginVersion": "1.6.0"
}

queryID

string

Unique identifier for the query. This is used for click analytics.

Example:

"a00dbc80a8d13c4565a442e7e2dca80a"

_automaticInsights

boolean

Whether automatic events collection is enabled for the application.

page

integer

default:0

Page of search results to retrieve.

Required range: x >= 0

nbHits

integer

Number of results (hits).

Example:

20

nbPages

integer

Number of pages of results.

Example:

1

hitsPerPage

integer

default:20

Number of hits per page.

Required range: 1 <= x <= 1000

cursor

string

Cursor to get the next page of the response.

The parameter must match the value returned in the response of a previous request. The last page of the response does not return a cursor attribute.

Example:

"jMDY3M2MwM2QwMWUxMmQwYWI0ZTN"

Search API endpoints

Index settings/API parameters

Browse for records

Authorizations

Path Parameters

Body

Response