;

Retrieve candidate test report

Retrieves candidate test report using testinvitation id
GET https://apiv3.interviewmocha.com/v3/reports/{testInvitationId}
  • Docs
  • Try it
Request URL Parameters
Field Type Required Default
testInvitationId Integer64 Yes -
Request Body Parameters
Field Type Required Default
reportType Integer No 1
ReportType
Field Type Description
reportType 1 Return assessment report with test summary with section level score information.
reportType 2 Return assessment report with skill wise score information.
reportType 3 Return assessment report with both section wise and skill wise information.
Response
Field Type Description
testInvitationId Integer64 Unique identifier given to each test attempt
testId String Unique identifier given to each test
candidateEmail String Email address associated with test attempt
attemptedOn Datetime Candidate test attempt date and time in ISO 8601 UTC format
Status String Test status
score Float Points scored by the candidate in test ( Deprecated soon ). Use scorePercentage to get percentage based scoring
scorePercentage Integer Points scored by the candidate in test. Rounded to closet integer value. Can be calculated manually from candidatePoints and totalTestPoints.
candidatePoints Float Points scored by the candidate in test
totalTestPoints Float Total points of the test
testName String Name of the test
pdfReportUrl String Direct PDF report url
sections Array Array comprised of detailed information of each section
Section object properties
candidateScore Float Candidate score in that section
sectionScore Float Total score of the section
noOfQue Integer Total number of questions in that section
sectionId Integer64 Unique Identifier given to section in given test
sectionName String Name of the section
sectionTime Integer Amount of time allocated to given section in minutes
sectionTimeTaken Integer Amount time taken by candidate in given section in seconds
Skill object properties
candidateQbScore Float Candidate score in given skill
qbScore Float Total score of the given skill
noOfQue Integer Total number of questions in that skill
qbId Integer64 Unique identifier given to skill in given section
qbName String Name of the skill
sectionId Integer64 Unique Identifier given to section in given test
sectionName String Name of the section
Example API endpoint

URL 1: /v3/reports/2807324?reportType=3

Successful response

Status 200 OK

Response
{ "testInvitationId": 225634, "testId": 11223, "candidateEmail": "dave@yopmail.com", "attemptedOn": "2020-03-12T11:33:48.04Z", "status": "Complete", "score": 1.0, "candidatePoints": 1.0, "totalTestPoints": 89.0, "testName": "Test with All question types", "pdfReportUrl": "https://app.interviewmocha.com/PDFReport?id=Hp2MdRaTmBEnI7%2bbD2G%2f", "sections": [ { "candidateScore": 1.0, "sectionScore": 4.0, "noOfQue": 4, "sectionID": 1465186, "sectionName": "YARN", "sectionTime": 8, "sectionTimeTaken": 9, "Skills": [ { "candidateQbScore": 1.0, "qbScore": 4.0, "noOfQue": 4, "qbId": 78689, "qbName": "YARN", "sectionId": 1465186, "sectionName": "YARN" } ] }, { "candidateScore": 0.0, "sectionScore": 20.0, "noOfQue": 4, "sectionID": 1465193, "sectionName": "Essay Writing", "sectionTime": 8, "sectionTimeTaken": 15, "Skills": [ { "candidateQbScore": 0.0, "qbScore": 20.0, "noOfQue": 4, "qbId": 31164, "qbName": "Essay Writing", "sectionId": 1465193, "sectionName": "Essay Writing" } ] } ] }
Failed response

Status 400 Bad Request

If required parameters are null or empty or has invalid values.

Response
{ "errors": [ "ApiKey is not invalid or incorrect" ] }
Request Query Parameters
Parameter Value Description Parameter Type Data Type
testInvitationId testInvitationId associated with candidate giving particular test Query Integer64
reportType reportType describes various report levels Query Integer
  • Response Body