Rankings

A Candidate Ranking that represents how relevant a Candidate is to a certain set of query criteria.

Relationships:

  • Ranking to Candidate is 1-1

  • Ranking to Summary is 1-1

Query Ranking Target

You can search rank against different types of resources: Job, Candidate, Attachment, and string.

  • What's the difference between target_resource_id and filter_job_id? The target_resource_id determines how the candidates results are ranked (aka the relevance order) and does NOT control filtering - all results will be returned if all results are paginated through. The filter_job_id controls whether specific results are returned at all but does NOT control relevance. Filtering may be useful for example for filtering on candidates who have actively applied to a job.

Below are each of the ranking targets for the query and their corresponding use cases:

Examples

Using target_resource_id

curl -X GET "${BASE_URL}/api/v1/candidate_rankings?target_resource_id=e69e1198-f02e-4340-ab24-51901afcefac&filter_job_id=e5e597e2-cdac-4339-a1aa-74dcd3895fc3&offset=100&limit=50" \
-H "Authorization: Bearer ${ACCESS_TOKEN}"

Using q

curl -X GET "${BASE_URL}/api/v1/candidate_rankings?q=Experienced%20with%20Figma&filter_job_id=e5e597e2-cdac-4339-a1aa-74dcd3895fc3&offset=100&limit=50" \
-H "Authorization: Bearer ${ACCESS_TOKEN}"

There are two endpoints for retrieving rankings, one to retrieve a full list of rankings and one to retrieve the score evaluation for just a single candidate.

Get Candidate rankings

GET https://endorsed.ai/api/v1/candidate_rankings

Query Parameters

Headers

{
  "is_error": false,
  "results": [
    {
      "score": 0.74,
      "candidate_id": "aaaad869-f919-472e-8142-29e5265d546f",
      "candidate_remote_id": "WVJ1n-mWVFcbkAPxkDrrA",
      "summary_id": "bbbb6d91-871c-453b-81bf-370bce9921a3",
      "nomination_id": "6702ef79-8d46-4143-92a2-83275b9ad51b"
    },
    {
      "score": 0.7325,
      "candidate_id": "cccc89de-c44d-4164-924a-569c2992dde3",
      "candidate_remote_id": "n3O_eaU4pzMM6Iow2QkaR",
      "summary_id": "dddd38ea-774e-43df-bf1f-1c8e0474542e",
      "nomination_id": "6702ef79-8d46-4143-92a2-83275b9ad51b"
    },
    {
      "score": 0.57,
      "candidate_id": "eeeebc51-babe-4668-84d0-94f22d58d4b8",
      "candidate_remote_id": "44Z84EvHejLxJl8OaxdOh",
      "summary_id": "ffffb070-4d79-4847-9077-fbe7e8860d72",
      "nomination_id": "6702ef79-8d46-4143-92a2-83275b9ad51b"
    }
  ]
}

Get Candidate ranking by Candidate ID

GET https://endorsed.ai/api/v1/candidate_rankings/{candidate_id}

Retrieve a single Candidate Ranking result, including evaluated score for a given Candidate.

Query Parameters

{
  "is_error": false,
  "result": {
     "score": 0.74,
     "candidate_id": "aaaad869-f919-472e-8142-29e5265d546f",
     "candidate_remote_id": "WVJ1n-mWVFcbkAPxkDrrA",
     "summary_id": "bbbb6d91-871c-453b-81bf-370bce9921a3",
     "nomination_id": "6702ef79-8d46-4143-92a2-83275b9ad51b"
  }
}

Last updated

© 2024 Endorsed