This is your Public-API-Key, which Mettl uses to identify your account.
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.
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.
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 an Assessment. The format for the JSON is given below.
|Filters for Advanced Visual Proctoring settings. This value is a nested JSON .
|Filters results where Advanced Visual Proctoring is enabled when "PHOTO" is chosen. This value is a string and only accepts "PHOTO" or "OFF".
|Filters for additional settings of Advanced Visual Proctoring when enabled. This value is a nested JSON .
|Filters results where screen-grabs of candidates test screen is enabled when true is chosen. This value is a boolean.
|Filters results where manual live authorization process is enabled for starting the test when true is chosen. This value is a boolean.
|Filters for Browsing tolerance settings. This value is a nested JSON.
|Filters results where Browsing tolerance is enabled when true is chosen. This value is a boolean and mandatory within webProctoring propertry.
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.
|Filters results where showing remaining counts of Browsing tolerance is enabled when true is chosen. This value is a boolean.
|Filters results for Open access or Private invitation only schedules/ test links. This value is a string and only accepts "OpenForAll" or "ByInvitation".
|Filters results for access time settings in schedules/ test links. This value is a string and only accepts "AlwaysOn" or "Fixed".
|Number of schedules/ test links to fetch from your assessment. This value is an integer and only accepts a value from 1 to 100, with the default value being 20.
available in v3 only.
|Returns the list of the schedules/ test links offset from the starting position. This value is an integer and only accepts a value from 0 to 1 less than the total number schedules in your assessment, with the default value being 0.
available in v3 only.