dataarray[Tests]List of requested tests
page_totalintegerCount of total tests 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
{} TestsidstringID of the test
unique_idstringCandidate facing ID of the test
namestringName of the test.
starttimedatetimeIf set, then logins before this time will be disabled. Candidates already logged in will not be affected.
endtimedatetimeIf set, then logins after this time will be disabled. Candidates who are already logged in will be able to give the test normally even after endtime.
durationintegerDuration of test in minutes.
ownerstringexpandableUser who created this test.
instructionsstringHTML for instructions displayed to candidate in the test login page.
starredbooleanWhether this test has been 'starred' by the user of the api
created_atdateTimeTimestamp when this test was created
statestringfilterableCurrent state of the testCan be active
or archived
lockedbooleanWhether this test is locked or not. Locked test cannot be edited, however candidates can be invited to the test.
draftbooleanDescribes if this test is currently in Draft(true
)/Published(false
) state. Candidates can only be invited for published tests.Can be true
or false
languagesarray[string]additionalList of languages available in the test for coding and approximate questions. Note: *null* in this fields means that all languages are enabled
candidate_detailsarray[string]additionalList of details that candidates will be asked to enter before logging into the test. These details will be available in the report view of the test. It should be an Array of JSON.
List of default fields:[full_name
, city
, work_experience
, roll_number
, email_address
, year_of_graduation
, cgpa
, univ
, phone_number
, contact_recruiter
, branch
, gender
, degree
, role
, resume
, pgdegree
, city_graduation
, gpa
, major
, linkedin
]
For default fields add field in following way {predefined_label: 'roll_number', required: true}
in the array.
If you want to add another field to candidate_details not present in default list, you can add in the following way:
{title: 'First Name', required: true, type: 'input'}
. Following are the supported input types: [input, select, radio, checkbox, file]
In case of input being select, you can send options for select in following way: {title: 'Age', required: true, type: 'select', options: ['<20', '20-30', '>30']}
Order of candidate_details will be same as order of array
custom_acknowledge_textstringadditionalCandidate will be asked to agree to this text before logging into the test.
cutoff_scoreintegeradditionalIf set, then candidates scoring equal or more than this value will automatically be placed into "Qualified" bucket, while candidates scoring less will be placed in "Failed" bucket
master_passwordstringadditionalIf set, candidates can login to the test using this password
hide_compile_testbooleanadditionalIf set to true then candidate will not be able to see compile button for coding and approximate type questions.
tagsarray[string]filterableList of tags associated with this test
role_idsarray[string]List of role ids associated with this test.
experiencearray[string]Experience levels associated with this test.Can be Intern
, New Graduate
, 0-2 years
, 2-5 years
, >5 years
or All Experience Levels
questionsarray[string]List of question ids associated with this test.
sectionsobjectSection slot data for the test.
mcq_incorrect_scoreintegeradditionalScore to deduct from total score per incorect MCQ question
mcq_correct_scoreintegeradditionalScore to add to total score per correct MCQ question
locked_bystringadditionalexpandableUser who locked this test (if any).
securebooleanadditionalIf set to true then test will be fulllscreened for candidates
short_login_urlstringadditionalLogin URL for the test. This requires master password to be setup for test.
public_login_urlstringadditionalPublic login URL for the test. This URL do not require a password.
shuffle_questionsbooleanadditionalIf true than questions will be shuffled
test_adminsarray[string]additionalTest admins will also receive summary report mails when candidate completes a test.
hide_templatebooleanadditionalIf set to true then head and tail templates will not be shown to candidates.
enable_acknowledgementbooleanadditionalIf set to false, then candidate will not be asked to agree to acknowledgement text.
enable_proctoringbooleanadditionalIf set to true, then this will force the candidate to turn their webcam on before starting the Test.We will take snapshots periodically during the Test, and you can view them in the Candidate's report.
By default this field is set to false.
candidate_tab_switchbooleanadditionalIf set to true, then this will track if the candidate moved out of the tab during the test.
By default this field is set to false.
track_editor_pastebooleanadditionalIf set to true, this will track candidate's editor paste activity.If they still copy/paste code, you can view the pasted code in the candidate's report.
By default this field is set to true.
Note: This flag only works for Coding, Approximate & Database questions.
ide_configstringadditionalConfigure IDE for candidates to solve Front-end, Back-end, and Full-stack questions.
Default is set to ide_and_git.Option | Usage |
---|
ide_and_git | Use the online IDE or download via Git. |
ide | Only use the online IDE (downloading via Git is disabled). |
git | Download via Git and work offline (Online IDE is disabled). |
Can be ide_and_git
, ide
or git