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 assessments 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 assessments starting from the offset position. You can input a value from 0 to 1 less than the total number assessments in your account, with the default value being 0. |
sort | Property used to sort the list of assessments. 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 assessments. You can input either asc or desc, with the default value being desc. |