API reference
- Overview
- Insights API
- Recommend API
- Recommendations
- Recommend rules
- Search API
Retrieve recommendations
Retrieves recommendations from selected AI models.
Your Algolia application ID.
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.
Recommend request body.
Recommendation request with parameters depending on the requested model.
Authorizations
Your Algolia application ID.
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.
Body
Recommend request body.
Recommendation request with parameters depending on the requested model.
Index name (case-sensitive).
Minimum score a recommendation must have to be included in the response.
0 < x < 100Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
1 < x < 1000Search parameters for filtering the recommendations.
Keywords to be used instead of the search query to conduct a more broader search.
Using the similarQuery parameter changes other settings:
queryTypeis set toprefixNone.removeStopWordsis set to true.wordsis 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.
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
NOTwith combinations of filters. Not supported:NOT(facet:value OR facet:value) - You can't combine conjunctions (
AND) withOR. 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.
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 asfilter1 AND filter2.[[filter1, filter2], filter3]is interpreted asfilter1 OR filter2 AND filter3.facet:-valueis interpreted asNOT 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.
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 don't work with numeric attributes.
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.
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.
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.
Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
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.
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.
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.
Whether to obtain the coordinates from the request's IP address.
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.
x > 1Precision 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.
Minimum radius (in meters) for a search around a location when aroundRadius isn't set.
x > 1Coordinates 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.
ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches):
- Sets
removeStopWordsandignorePluralsto the list of provided languages. - Sets
removeWordsIfNoResultstoallOptional. - Adds a
natural_languageattribute toruleContextsandanalyticsTags.
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 Assigns a rule context to the search query.
Rule contexts are strings that you can use to trigger matching rules.
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.
0 < x < 100Unique pseudonymous or anonymous user identifier.
This helps with analytics and click and conversion events. For more information, see user token.
Whether the search response should include detailed ranking information.
Whether to take into account an index's synonyms for this search.
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.
Whether this search will be included in Analytics.
Tags to apply to the query for segmenting analytics data.
Whether to include this search when calculating processing-time percentiles.
Whether to enable A/B testing for this search.
Search query.
Attributes used for faceting.
Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive.
Modifiers
-
filterOnly("ATTRIBUTE"). Allows the attribute to be used as a filter but doesn't evaluate the facet values. -
searchable("ATTRIBUTE"). Allows searching for facet values. -
afterDistinct("ATTRIBUTE"). Evaluates the facet count after deduplication withdistinct. This ensures accurate facet counts. You can apply this modifier to searchable facets:afterDistinct(searchable(ATTRIBUTE)).
Creates replica indices.
Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you'll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer be synced with the primary index.
Modifier
virtual("REPLICA"). Create a virtual replica, Virtual replicas don't increase the number of records and are optimized for Relevant sorting.
Maximum number of search results that can be obtained through pagination.
Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed.
x < 20000Attributes that can't be retrieved at query time.
This can be useful if you want to use an attribute for ranking or to restrict access, but don't want to include it in the search results. Attribute names are case-sensitive.
Creates a list of words which require exact matches. This also turns off word splitting and concatenation for the specified words.
Attributes, for which you want to support Japanese transliteration.
Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive.
Attributes for which to split camel case words. Attribute names are case-sensitive.
Searchable attributes to which Algolia should apply word segmentation (decompounding). Attribute names are case-sensitive.
Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, "firefighter". With decompounding, the individual components are indexed separately.
You can specify different lists for different languages.
Decompounding is supported for these languages:
Dutch (nl), German (de), Finnish (fi), Danish (da), Swedish (sv), and Norwegian (no).
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).
Languages for language-specific processing steps, such as word detection and dictionary settings.
You should always specify an indexing 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.
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 Searchable attributes for which you want to turn off prefix matching. Attribute names are case-sensitive.
Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered.
Numeric attributes that can be used as numerical filters. Attribute names are case-sensitive.
By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes.
To turn off filtering for all numeric attributes, specify an attribute that doesn't exist in your index, such as NO_NUMERIC_FILTERING.
Modifier
equalOnly("ATTRIBUTE"). Support only filtering based on equality comparisons=and!=.
Control which non-alphanumeric characters are indexed.
By default, Algolia ignores non-alphanumeric characters like hyphen (-), plus (+), and parentheses ((,)).
To include such characters, define them with separatorsToIndex.
Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
With separatorsToIndex, Algolia treats separator characters as separate words.
For example, in a search for "Disney+", Algolia considers "Disney" and "+" as two separate words.
Attributes used for searching. Attribute names are case-sensitive.
By default, all attributes are searchable and the Attribute ranking criterion is turned off.
With a non-empty list, Algolia only returns results with matches in the selected attributes.
In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of searchableAttributes rank first.
To make matches in two attributes rank equally, include them in a comma-separated string, such as "title,alternate_title".
Attributes with the same priority are always unordered.
For more information, see Searchable attributes.
Modifier
unordered("ATTRIBUTE"). Ignore the position of a match within the attribute.
Without a modifier, matches at the beginning of an attribute rank higher than matches at the end.
An object with custom data.
You can store up to 32kB as custom data.
Characters and their normalized replacements. This overrides Algolia's default normalization.
Attribute that should be used to establish groups of results. Attribute names are case-sensitive.
All records with the same value for this attribute are considered a group.
You can combine attributeForDistinct with the distinct search parameter to control
how many items per group are included in the search results.
If you want to use the same attribute also for faceting, use the afterDistinct modifier of the attributesForFaceting setting.
This applies faceting after deduplication, which will result in accurate facet counts.
Maximum number of facet values to return when searching for facet values.
x < 100Attributes 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 thecustomRankingandunretrievableAttributessettings.- To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the
*:["*", "-ATTRIBUTE"]. - The
objectIDattribute is always included.
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.
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.
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.
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.
HTML tag to insert before the highlighted parts in all highlighted results and snippets.
HTML tag to insert after the highlighted parts in all highlighted results and snippets.
String used as an ellipsis indicator when a snippet is truncated.
Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted.
Minimum number of characters a word in the search query must contain to accept matches with one typo.
Minimum number of characters a word in the search query must contain to accept matches with two typos.
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.
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.
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.
Treat singular, plurals, and other forms of declensions as equivalent. You should only use this feature for the languages used in your index.
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 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.
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 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.
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 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).
Whether to enable rules.
Whether to enable Personalization.
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.
prefixLast, prefixAll, prefixNone 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.
none, lastWords, firstWords, allOptional Whether to support phrase matching and excluding words from search queries.
Use the advancedSyntaxFeatures parameter to control which feature is supported.
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.
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.
attribute, none, word 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 theignorePluralssetting 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.
ignorePlurals, singleWordSynonym, multiWordsSynonym 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 -enginematches records that contain "search" but not "engine".
This setting only has an effect if advancedSyntax is true.
exactPhrase, excludeWords 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.
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.
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.
1 < x < 7Properties 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 attributes should be included.
You can't exclude these properties:
message, warning, cursor, serverUsed, indexUsed,
abTestVariantID, parsedQuery, or any property triggered by the getRankingInfo parameter.
Don't exclude properties that you might need in your search UI.
Maximum number of facet values to return for each facet.
x < 1000Order 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.
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.
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.
The redirect rule container.
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.
Restrict Dynamic Re-Ranking to records that match these filters.
Frequently bought together model.
This model recommends items that have been purchased within 1 day with the item with the ID objectID.
bought-together Unique record identifier.
Response
A/B test ID. This is only included in the response for indices that are part of an A/B test.
Variant ID. This is only included in the response for indices that are part of an A/B test.
x > 1Computed geographical location.
Distance from a central coordinate provided by aroundLatLng.
Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
Whether the facet count is exhaustive (true) or approximate (false). See the related discussion.
The value is false if not all facet values are retrieved.
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.
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.
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.
Rules applied to the query.
See the facetsCount field of the exhaustive object in the response.
See the nbHits field of the exhaustive object in the response.
See the typo field of the exhaustive object in the response.
Statistics for numerical facets.
Index name used for the query.
Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.
Warnings about the query.
Number of hits selected and sorted by the relevant sort algorithm.
Post-normalization query string that will be searched.
Time the server took to process the request, in milliseconds.
Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
Redirect results to a URL, this this parameter is for internal use only.
Source index for the redirect rule.
Destination index for the redirect rule.
Reason for the redirect rule.
Redirect rule status.
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.
Order of facet names and facet values in your UI.
Order of facet names.
Explicit order of facets or facet values.
This setting lets you always show specific facets or facet values at the top of the list.
The redirect rule container.
widgets returned from any rules that are applied to the current search.
Time the server took to process the request, in milliseconds.
Host name of the server that processed the request.
An object with custom data.
You can store up to 32kB as custom data.
Unique identifier for the query. This is used for click analytics.
Whether automatic events collection is enabled for the application.
Page of search results to retrieve.
x > 0Number of results (hits).
Number of pages of results.
Number of hits per page.
1 < x < 1000Unique record identifier.
Surround words that match the query with HTML tags for highlighting.
Surround words that match the query with HTML tags for highlighting.
Highlighted attribute value, including HTML tags.
Whether the whole query string matches or only a part.
none, partial, full List of matched words from the search query.
Whether the entire attribute value is highlighted.
Snippets that show the context around a matching search query.
Snippets that show the context around a matching search query.
Object with detailed information about the record's ranking.
Position of the first matched word in the best matching attribute of the record.
x > 0Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
x > 0Number of exactly matched words.
x > 0Number of typos encountered when matching the record.
x > 0Overall ranking of the record, expressed as a single integer. This attribute is internal.
Whether a filter matched the query.
x > 0Precision used when computing the geo distance, in meters.
x > 1Latitude of the matched location.
Longitude of the matched location.
Distance between the matched location and the search location (in meters).
Whether the record was promoted by a rule.
Number of words between multiple matches in the query plus 1. For single word queries, proximityDistance is 0.
x > 0Number of matched words.
x > 1Whether the record is re-ranked.
Recommendation score.
0 < x < 100Was this page helpful?