Get object position

Use this method to debug the relevance of an objectID in specific results set. If the objectID is found, the position of the record is returned.

Examples

var position = searchResponse.GetObjectPosition("a-unique-identifier");

position := queryRes.GetObjectPosition("a-unique-identifier")

int position = searchResponse.getObjectPosition("a-unique-identifier", Hit.class);

const position = index.getObjectPosition(results, 'a-unique-identifier');

val position: Int = responseSearch.getObjectPosition(ObjectID("a-unique-identifier"))

$position = SearchIndex::getObjectPosition($results, 'a-unique-identifier');

position = SearchIndex.get_object_position(results, 'a-unique-identifier')

position = Algolia::Search::Index.get_object_position(objects, 'a-unique-identifier')

val position = res.getObjectPosition[Hit.class]("a-unique-identifier")

let position = searchResponse.getPositionOfObject(withID: "a-unique-identifier")

class

required

Java and Scala only: the type of the hits.

string

required

The objectID of the record.

object

required

The results set of a search.

Last modified on September 14, 2026