dataarray[TestCandidate]List of requested candidates
page_totalintegerCount of total candidates in current page
offsetintegerOffset in current page
previousstringURL for previous page. This will be empty when current page is first page
nextstringURL for next page. This will be empty when current page is last page
firststringURL for first page.
laststringURL for last page.
totalstringTotal items for current query
{} TestCandidateidstringID of the test candidate.
full_namestringFull name of the candidate.
emailstringfilterableEmail address of the candidate.
scorefloatScore of the candidate if they have attempted the test.
teststringexpandableTest for the candidate.
userstringfilterableexpandableUser who invited this candidate.
attempt_starttimedatetimefilterableTime at which candidate started the test. This will be null if candidate has not attempted the test yet.
attempt_endtimedatetimefilterableTime at which candidate ended the test. This will be null if candidate has not attempted the test yet.
statusintegerfilterableThis indicates the current status of the candidate. Can be between -1 to 7. -1 indicates that candidate is currently invited, while 7 indicates that candidates has completed the test and a report has been generated for the candidate. All other intermediate states are internal and should not be used.
ats_stateintegerfilterableThis indicates the current state of the candidate application. Value can be from 0 to 22.
integrity_statusstringfilterableConsolidated view of all integrity-related signals for an attempt. Possible values: "High" (high risk), "Medium" (medium risk), "No Issues Detected" (no integrity issues found), nil (not evaluated)
invite_email_donebooleanWhether an invite email has been sent to candidate or not.
invite_validbooleanfilterableWhether this invite is still valid or not.
invited_ondatetimefilterableTimestamp of when candidate was invited for the test.
invite_valid_fromdatetimefilterableTime from when invite for this test candidate is valid. Null value in this field indicates that invite is permanently valid.
invite_valid_todatetimefilterableTime till when invite for this test candidate is valid. Null value in this field indicates that invite is permanently valid.
invite_linkstringInvite test link for the candidate.
invite_metadataobjectCustomizable metadata that can be set for a candidate. This must be a valid JSON object.
evaluator_emailstringEmail address of the evaluator, if different from the test admins and owner.
test_finish_urlstringCandidate will be redirected to this URL when the test gets over. By default, they are sent to the feedback page.
test_result_urlstringWebhook URL for candidate report. When the report is processed the report data will be sent to this URL as a webhook. By default, the inviter will get the report by email.
accept_result_updatesbooleanFlag to send score and status updates to the test_result_url. Please set to "true" if you accept updates. Default is "false".
tagsarray[string]filterableList of tags associated with this candidate.
report_urlstringURL for candidate report that is accessible only to HackerRank users with access to the specific test.
authenticated_report_urlstringURL for candidate report that is accessible to all users in your HackerRank account.
pdf_urlstringURL for a PDF version of the candidate report.
scores_tags_splitobjectScore of candidate split per tag.
scores_skills_splitobjectScore of candidate split per skill.
added_timeintegerAdded time for this candidate.
unclaimed_added_timeintegerUnclaimed added time for this candidate.
commentsobjectadditionalAll the comments left on the summary tab of the report.
For comments left on individual questions, expand questions field too.
questionsQuestionadditionalexpandableQuestion wise score split for this candidate in this attempt.
List of fields when questions is expanded:[answered
, answers
, score
, plagiarism
, name
, preview
, type
, max_score
, comments
]
plagiarism
is an object and has the fields [solve_id
, test_candidate_id
, email
, similarity
]
comments
gives the comments left on the report for the given question (you need to also pass comments
in additional fields for this)
Additional fields
Additional fields can be passed as csv for query parameter additional_fields
ex: additional_fields=questions.time_taken
Additional fields supported in response:
[time_taken
, submissions
, submission_result
]
time_taken
gives the time taken per question by the candidate. Accessed by questions.time_taken
submissions
gives the list of all submissions done by the candidate for the given question. Accessed by questions.solves
submission_result
gives the detailed submission information for each testcase. Accessed by questions.submission_result
plagiarismobjectQuestion wise details of plagiarism.
plagiarism_statusbooleanWhether this candidate has been flagged as plagiarized or not.
max_code_similarityobjectThis gives the question level measure of candidate's code similarity. Candidate's code is compared with that of other candidates for the specific question. Maximum similarity percentage at the time of test submission is returned.
feedbackstringFeedback given by the candidate at the end of the test.
percentage_scorefloatPercentage score of the candidate for the test.
candidate_detailsarray[CandidateDetail]Details of candidate.
out_of_window_eventsintegerWhen candidate_tab_switch is enabled for the test, this field returns the number of times this candidate went out of window.
out_of_window_durationfloatWhen candidate_tab_switch is enabled for the test, this field returns the number of seconds this candidate went out of window.
editor_paste_countintegerwhen track_editor_paste is enabled for the test, this field returns the number of times this candidate pasted a piece of code.
proctor_imagesarray[string]When enable_proctoring is enabled for the test, this field returns a list of urls that contains the images of this candidate taken during the test.