Examine REST APIs
19. Delete Result of Candidate in Schedule
Definition This DELETE API is used to delete the status or result of a particular candidate in a schedule/ test link if the test has been “completed” or is “Expired”. The tests that are “in-progress” will remain unaffected. *PDF ...
18. Get All Results of Candidate in Account
Definition This GET API is used to fetch all status and results of a particular candidate from each schedule/ test link in your account (such as candidate registration fields, test status, proctoring details and test results if the test is ...
16. Get Results of All Candidates in Schedule
Definition This GET API is used to fetch the status and results of all candidates in a schedule/ test link (such as candidate registration fields, test status, proctoring details and test results if the test is finished). *PDF documentation ...
12. Get Schedule
Definition This GET API is used to fetch the details of a particular schedule/ test link in your account (such as schedule name, id, access key, access URL, assessment details along with the proctoring and security settings). *PDF ...
11. Get All Schedules in Account
Definition This GET API is used to fetch the details of all schedules/ test links in your account (such as schedule name, id, access key, access URL, assessment details along with the proctoring and security settings). *PDF documentation ...
10. Get All Schedules in Assessment
Definition This GET API is used to fetch the details of all schedules/ test links in an assessment (such as schedule name, id, access key, access URL along with the proctoring and security settings). *PDF documentation reference - Section 4.4 ...
9. Edit Assessment Settings
Definition This POST API is used to edit the assessment level settings of a particular assessment. *PDF documentation reference - Section 4.7 Edit Assessment settings for a particular Assessment Endpoints ...
8. Create Assessment
Definition This POST API is used to create an Assessment. *PDF documentation reference - Section 4.1 Create an Assessment Endpoints https://api.mettl.com/v2/assessments https://api.mettl.com/v1/assessments Query Parameters In our REST APIs, ...
7. Get Assessment
Definition This GET API is used to fetch the details of a particular Assessment in your account (such as assessment name, id, duration, tests taken, max marks, candidate registration fields, sectional info, etc.). *PDF documentation reference ...
5. Add PBTs
Definition This POST API is used to add Pre Built Tests from Mercer | Mettl's library to the list of Assessments in your account using PBT Ids which can obtained using Get All PBTs API *PDF documentation reference - Section 3.2 Endpoints ...
3. Update White Label
Definition This POST API is used to update the colors and support numbers as well as upload your favicon and cover image for white labeling the candidate test windows in your account. Only authorized accounts can use this API. To use this API, ...
4. Get All PBTs
Definition This GET API is used to fetch the list and details of all Pre Built Tests available with Mercer | Mettl. This includes PBT Id, name, short and long description, URL, price, sample report URL, relevant industries, and any keywords or tags ...
2. Update Logo
Definition This POST API is used to upload your Logo in your account. *PDF documentation reference - Section 2.2 Logo Upload in Account Endpoints https://api.mettl.com/v2/account/upload-logo https://api.mettl.com/v1/account/upload-logo Query ...
1. Get Account Info
Definition This GET API is used to fetch the details of your account (such as email id, name, account type, logo, white label info, compliance info and candidate registration fields). *PDF documentation reference - Section 2.1 Fetch Mettl ...
17. Get Result of Candidate in Schedule
Definition This GET API is used to fetch the status or result of a particular candidate in a schedule/ test link (such as candidate registration fields, test status, proctoring details and test results if the test is finished). *PDF ...
15. Register Candidates in Schedule
Definition This POST API is used to generate a candidate specific unique test links for each candidate in a schedule/ test link. *PDF documentation reference - Section 6.1.2 Option 2 – Register candidate(s) for a test & receive notifications on Test ...
6. Get All Assessments
Definition This GET API is used to fetch the details of all assessments in your account (such as assessment name, id, duration, tests taken, max marks, candidate registration fields, sectional info, etc.). *PDF documentation reference ...
14. Edit Schedule
Definition This POST API is used to edit a schedule/ test link. *PDF documentation reference - Section 5.2 Edit Schedule for a particular Assessment Endpoints https://api.mettl.com/v2/schedules/{access-key}/edit ...
API Authentication and Signature Generation
Authentication Parameters When accessing Mettl Examine platform using a REST API request, you must always provide 3 mandatory query parameters, i.e., ak , ts and asgn , so that the request can be authenticated. In our REST APIs, Query ...
13. Create Schedule
Definition This POST API is used to create a schedule/ test link for a specific assessment. *PDF documentation reference - Section 5.1 Create Schedule for a particular Assessment Endpoints ...
API Documentation
Welcome to Mercer | Mettl Examine APIs. This page details the REST based APIs using which you can interact and integrate with Mercer | Mettl Examine application. Prerequisites In order to fully comprehend our Examine REST APIs, you should be familiar ...
API Integration Flow
Sample API Integration Flow Diagram The following article details a sample integration flow to help you get started. To read more about each of the APIs mentioned below, request you to refer to our API Documentation. Admin Side Flow Assessment ...
API FAQs
Q: Can we try out Mettl's APIs without writing any code? A: You may try out our APIs without writing any code on our API Demo. However, you will need the API keys of your Mettl account to access this tool. Please reach out to your Account manager for ...
API Signature Generation Code Samples and Java SDK
Sample Signature Generation code for understanding Mettl APIs is available in the follow common programming languages (Refer the attachments for details) C# Java Node.js PHP Python Also, attached is our updated Java SDK.