GET Candidate's Assessment Report

This API retrieves the Assessment report of the Candidate.

Request URL

GET /assessments/report/<report_id>

Warning

Make sure to add your API key in Header of the request

Parameters

Parameter	Type	Description
report_id	integer	Report ID of the candidate

Query Parameters

Parameter	Type	Description
include_questions	boolean	Optional. When true, includes section-wise question results. This feature must be enabled for the company associated with the API key.

Response

• A JSON response containing information about the Candidate report given the candidate has completed the assessment and the Invite Link.

{
    "assessment_id": "integer",
    "candidate_id": "integer",
    "completed_date": "string",
    "cut_off": "integer",
    "email": "string",
    "invite_status": "string",
    "name": "string",
    "offtab_count": "integer",
    "overall_percentage": "double",
    "registration_fields": [
        {
            "label": "string",
            "value": "string"
        }
    ],
    "report_id": "integer",
    "report_link": "string",
    "sections": [
        {
            "percentage": "double",
            "section": "string",
            "skill_wise_score": [
                {
                    "skill": "string",
                    "percentage": "float"
                },
            ]
        },
    ],
    "questions": [
        {
            "section_id": "integer",
            "section": "string",
            "percentage": "double",
            "questions": [
                {
                    "question_id": "integer",
                    "index": "integer",
                    "type": "roleplay",
                    "question": "string | object",
                    "skill": "string",
                    "skill_id": "integer",
                    "difficulty": "easy | medium | hard",
                    "max_score": "double",
                    "score": "double",
                    "result": {
                        "transcript": "string",
                        "roleplay_report": {}
                    },
                    "roleplay_report": {}
                }
            ]
        }
    ]
}

Note

• report_link is a signed link to the report and remains active for 7 days from completion. If you need access after it expires, you can use the Shareable Report Link API to generate a new link with your desired expiry time.

• The response for sections may differ based on the assessment configuration. Sections contains the names of all sections along with the corresponding scores obtained for each section.

• Please note that the skill_wise_score will only have the score for those sections which the candidate took up and answered, rest of the other skills will not be included.

• The response for registration_fields also may differ based on the Custom Registration fields set for the assessment.

• questions is included only when include_questions=true and question-level reporting is enabled for the company associated with the API key. Omitting the parameter, or passing a false value, leaves the existing response unchanged.

• Question result fields depend on the question type. Roleplay questions include roleplay_report and may include a transcript. Other question types return only their applicable result fields.

• If include_questions=true is requested by a company for which question-level reporting is not enabled, the API returns HTTP 403 with the following response:

  {
      "error": "include_questions is not enabled for this company"
  }
  

• A JSON response when the candidate has not completed the assessment.

{
    "assessment_id": "integer",
    "candidate_id": "inetger",
    "email": "string",
    "invite_status": "string",
    "name": "string",
    "report_id": "integer"
}

Note

The value for invite_status could be Pending meaning the candidate has not yet started the assessment and Started meaning the candidate is currently taking up the assessment.