3. Retrieve an Evaluation

This endpoint is used periodically to check the status of candidate tests. The provided status is shown to users in Comeet. After the test is reported as completed, Comeet will stop checking the test’s status.

Request

Query string params:

Name	Type	Optional	Description
candidate_evaluation_id	string	required	candidate_evaluation_id that was previously provided by the partner

HTTP Headers:

Name	Value
Content-Type	application/json
Authorization	Bearer XXXXXXXXXXXXXXXXXX

GET https://www.evaluation-partner.com/api/get_evaluation?candidate_evaluation_id=000

Response

Name	Type	Optional	Description
status	string	required	40 characters limit. The status of the test will be shown in Comeet. When the test is completed, the status should be "completed"
outcome	string	required	One of the following: "passed"* - the candidate will continue to the next step in the hiring process "review"* - Comeet will create a task to review the results of the test "failed"* - the candidate will be rejected
score	number	optional	Overall score; A real number between 1 to 5, eg. "3.5"
summary	string	optional	Plain text; 2000 characters limit
criteria	array	optional	Array of the criteria that were evaluated
criteria[].title	string	required	Title of the criterion
criteria[].notes	string	optional	Plain text; 500 characters limit
criteria[].score	number	optional	Score for criterion; A real number between 1 to 5, eg. "3.5"
criteria[].group	string	optional	Use this property to group criteria together, eg. "Exercise 1", "Exercise 2", "Overview". Limited to 200 characters
url_for_users	string	optional	URL that registered users can go to to see the completed test page in your app. It is recommended to provide both `url_for_users` and `url_for_non_users`
url_for_non_users	string	optional	URL that non-registered users can go to to see the completed test page in your app. It is recommended to provide both `url_for_users` and `url_for_non_users`

🚧
Handling edge cases
Comeet expects the response to indicate how the hiring process should continue and clearly explain to the recruiter what happened. For example, if the candidate or the test were deleted from your system, the response should be:
{
"status": "completed",
"outcome": "review",
"summary": "-- an explanation to the recruiter about what happened --"
}

{
    "status": "completed",
    "outcome": "passed",
    "score": 4.5,
    "summary": "Performed well.",      
    "criteria": [
        {
            "title": "Riding a Nimbus 2000",
            "notes": "Quidditch World Cup potential.",
            "score": 5
        },
        {
            "title": "Riding a Firebolt",
            "notes": "Impressive maneuvers.",
            "score": 4
        }      
    ],
    "url_for_users": "https://www.evaluation-partner.com/evaluation/1111",
    "url_for_non_users": "https://www.evaluation-partner.com/evaluation/1111?token=hgsadkf3kas56jdgfsdsakjpgdhqfjakansmgdhfrkj56as8h0gdu"      
}