Get Object Position | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

index.getObjectPosition(object results, string objectId)

About this method

Retrieve the given object’s position in the given results set. Can be used to debug relevance.

getObjectPosition may be used to debug the relevance of an objectID in specific results set. If the objectID is found, the position of the object is returned.

Examples

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

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

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

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

1
Not implemented yet.

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

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

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

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

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

Parameters

Response

No response.