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 |
| limit | Number of schedules/ test links to fetch from your account. You can input a value from 1 to 100, with the default value being 20. |
| offset | Returns the list of schedules/ test links starting from the offset position. You can input a value from 0 to 1 less than the total number of schedules/ test links in your account, with the default value being 0. |
| sort | Property used to sort the list of schedules/ test links. You can input either createdAt, testTaken or name, with the default value being createdAt. |
| sort_order | Ascending or Descending order used to sort the list of schedules/ test links. You can input either asc or desc, with the default value being desc. |
| filter | This is a JSON string containing details of schedules/ test links to be used as a filter from the list of all schedules/ test links in your account. The format for the JSON is given below. |
| Property | Sub Property | Sub Property | Description |
| visualProctoring | Filters for Advanced Visual Proctoring settings. This value is a nested JSON . | ||
| ↳ | mode | Filters results where Advanced Visual Proctoring is enabled when "PHOTO" is chosen. This value is a string and only accepts "PHOTO" or "OFF". | |
| ↳ | options | Filters for additional settings of Advanced Visual Proctoring when enabled. This value is a nested JSON . | |
| ↳ | candidateScreenCapture | Filters results where screen-grabs of candidates test screen is enabled when true is chosen. This value is a boolean. | |
| ↳ | candidateAuthorization | Filters results where manual live authorization process is enabled for starting the test when true is chosen. This value is a boolean. | |
| webProctoring | Filters for Browsing tolerance settings. This value is a nested JSON. | ||
| ↳ | enabled | Filters results where Browsing tolerance is enabled when true is chosen. This value is a boolean and mandatory within webProctoring propertry. | |
| ↳ | count | Filter for the number of times a test taker is allowed to navigate away from the test window, before the test ends. This value is an integer and should be more than or equal to 0. | |
| ↳ | showRemainingCounts | Filters results where showing remaining counts of Browsing tolerance is enabled when true is chosen. This value is a boolean. | |
| type | Filters results for Open access or Private invitation only schedules/ test links. This value is a string and only accepts "OpenForAll" or "ByInvitation". | ||
| scheduleType | Filters results for access time settings in schedules/ test links. This value is a string and only accepts "AlwaysOn" or "Fixed". |