Skip to main content
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.

Example

Current API clients

var response = await client.SearchSingleIndexAsync<Hit>(
  "INDEX_NAME",
  new SearchParams(new SearchParamsObject { Query = "test", GetRankingInfo = true })
);
final response = await client.searchSingleIndex(
  indexName: "INDEX_NAME",
  searchParams: SearchParamsObject(
    query: "test",
    getRankingInfo: true,
  ),
);
response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(
  "INDEX_NAME").WithSearchParams(search.SearchParamsObjectAsSearchParams(
  search.NewEmptySearchParamsObject().SetQuery("test").SetGetRankingInfo(true))))
if err != nil {
  // handle the eventual error
  panic(err)
}
SearchResponse response = client.searchSingleIndex(
  "INDEX_NAME",
  new SearchParamsObject().setQuery("test").setGetRankingInfo(true),
  Hit.class
);
const response = await client.searchSingleIndex({
  indexName: 'indexName',
  searchParams: { query: 'test', getRankingInfo: true },
});
var response =
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = SearchParamsObject(query = "test", getRankingInfo = true),
  )
$response = $client->searchSingleIndex(
    'INDEX_NAME',
    ['query' => 'test',
        'getRankingInfo' => true,
    ],
);
response = client.search_single_index(
    index_name="INDEX_NAME",
    search_params={
        "query": "test",
        "getRankingInfo": True,
    },
)
response = client.search_single_index(
  "INDEX_NAME",
  Algolia::Search::SearchParamsObject.new(query: "test", get_ranking_info: true)
)
val response = Await.result(
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = Some(
      SearchParamsObject(
        query = Some("test"),
        getRankingInfo = Some(true)
      )
    )
  ),
  Duration(100, "sec")
)
let response: SearchResponse<Hit> = try await client.searchSingleIndex(
    indexName: "INDEX_NAME",
    searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(
        query: "test",
        getRankingInfo: true
    ))
)
index.search(
  new Query("query")
    .GetRankingInfo(true)
);
res, err := index.Search(
	"query",
	opt.GetRankingInfo(true),
)
index.search(
  new Query("query")
    .setGetRankingInfo(true)
);
index
  .search("query", {
    getRankingInfo: true,
  })
  .then(({ hits }) => {
    console.log(hits.map((hit) => hit._rankingInfo));
  });
val query = query("query") {
    getRankingInfo = true
}

index.search(query)
$results = $index->search('query', [
  'getRankingInfo' => true
]);

//foreach ($results['hits'] as $hit) {
//  var_dump($hit['_rankingInfo']);
//}
results = index.search("query", {"getRankingInfo": True})

# for hit in results['hits']:
#   print(hit['_rankingInfo'])
results = index.search(
  "query",
  {
    getRankingInfo: true
  }
)

# results['hits'].each do |hit|
#   puts hit['_rankingInfo']
# end
client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    getRankingInfo = Some(true)
  )
}
let query = Query("query")
  .set(\.getRankingInfo, to: true)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}
Last modified on May 19, 2026