getRankingInfo

Add details about ranking to each result

• Type: boolean
• Default: false
• Scope: search

The getRankingInfo parameter adds a _rankingInfo object to each result (hit) in the search response. This object contains detailed metadata about how Algolia ranked the result, including scores from ranking criteria.

_rankingInfo

Object with details about ranking of each result.

Show child attributes

_rankingInfo.nbTypos · integer

Number of typos for this match.

_rankingInfo.firstMatchedWord · integer

Encodes both the attribute index (position in searchableAttributes) and the word position. Divide the number by 1,000 to get the attribute index; the remainder gives the word position. Used only for attributes set to "ordered" in searchableAttributes.

For example, if firstMatchedWord is 2,001: the best-matching attribute is the second attribute in the list, and the first matched word is the second word within that attribute (both 0-based).

For more details, see Understanding word position.

_rankingInfo.proximityDistance · integer

Sum of distances between matched query words.

_rankingInfo.userScore · integer

Internal custom ranking score for the record. (Reserved for internal use by Algolia).

_rankingInfo.nbExactWords · integer

Number of words that matched exactly. If alternativesAsExact is not empty, it includes matches with plurals or synonyms.

_rankingInfo.words · integer

Number of matched query words, including prefix and typo-tolerant matches.

_rankingInfo.filters · integer

Filter scores. For more information, see Optional filters’ scoring

_rankingInfo.promoted · boolean

True if the result was promoted by a rule. Absent otherwise.

_rankingInfo.geoDistance · integer

Distance from the query’s location to the matched record’s location, divided by the precision.

_rankingInfo.geoPrecision · integer

Precision for calculating distances, in meters. All distances are multiples of this setting.

_rankingInfo.matchedGeoLocation · object

Details about the matched geographic point, including coordinates and distance.

Show child attributes

matchedGeoLocation.lat · number

Latitude of the matched point.

matchedGeoLocation.lng · number

Longitude of the matched point.

matchedGeoLocation.distance · integer

Distance from the search center to the matched point, in meters.

_rankingInfo.personalization · object

Information about how Personalization influenced this result (if enabled).

_rankingInfo.serverUsed · string

Internal name of the server that processed the request.

_rankingInfo.indexUsed · string

Index name used for the query. This may differ in A/B tests.

_rankingInfo.abTestID · string

ID of the A/B test if applicable.

_rankingInfo.abTestVariantID · integer

Variant ID (position in the list of variants) used in the A/B test. Starts from 1.

_rankingInfo.parsedQuery · string

Normalized query string after stop word removal and advanced syntax processing.

_rankingInfo.timeoutCounts · boolean

True if facet counts were approximated due to a timeout.

_rankingInfo.timeoutHits · boolean

True if the engine did not retrieve all results due to a timeout.

_rankingInfo.appliedRules · list<string>

List of index rule IDs applied to the query.

Example

Current API clients

C#

index.search(
  new Query("query")
    .GetRankingInfo(true)
);

Legacy API clients

C#

index.search(
  new Query("query")
    .GetRankingInfo(true)
);