Query Parameter | Description |
ak | This is your Public-API-Key, which Mettl uses to identify your account. |
ts | This is the current UNIX or Epoch Timestamp (the number of seconds between 1970-01-01 00:00:00 and current UTC Time). Any current generated Timestamp will be valid for 24 hours only. |
asgn | This is a unique Signature which has to be generated for each API request. The Signature is generated by creating a String-to-Sign and hashing it with your Private-API-Key using the HMAC-SHA256 (for version v2 and v3) or HMAC-SHA1 (for v1) hashing algorithm with Base-64 and URL encoding. Read more about the above Signature Generation Process in API Authentication and Signature Generation. |
Query Parameter | Description |
qr | Enables sending responses for essay questions where manual grading is required. You can input either true or false, with the default value being false. |
limit | Number of candidate status and results to fetch from your schedule/ test link. You can input a value from 1 to 100, with the default value being 20. Only available in v3. |
offset | Returns the list of candidate status and results starting from the offset position. You can input a value from 0 to 1 less than the total number of the specified candidates status and results in your account, with the default value being 0. Only available in v3. |
completionMode (in API Response) | Test Finish Mode (in Candidate Reports) | Description |
AutoCompleted | Auto Submit | Test Time finished before candidate could attempt all questions. |
NA | Blocked | Candidate blocked at the authorization stage (For Proctored Test with Authorization On). |
BrowsingToleranceExceeded | Browsing Tolerance Exceeded | When browsing tolerance is set and test taker navigates away from the test window more than the permissible number or times (browsing tolerance limit). |
Expired | Expired | If candidate gets disconnect (Loss of internet connection, etc) or his/her system shuts down abruptly and he/she is unable to resume the test. |
Completed | Normal | Finish Test button Clicked. |
ParentFinished | Normal | The background parent window is closed. |
ProctoredFinish | Proctored Finish | Image Proctored Test ended by Proctor. |
ResumeEnabled | Resume Enabled | Candidate allowed to resume tests from same point where test got over, only can be done if initial status was Expired. |
SuspiciousSoftwareFinish | Suspicious Software Finish | Suspicious Software detected Eg TeamViewer, SplashTop etc also found running and Mettl automatically closes test. |
CandidateClosed | Test Window Closed | Test Window Closed without clicking on Finish Test. |