Leaderboard
Leaderboard Details
Use this API to get leaderboard details and points received by Trainees.
GET /leaderboard/trainee-leaderboard-list Try now
Query string parameters
| Field | Type | Description |
|---|---|---|
| firstRecord required | integer | First record to return. Default: 1 |
| count required | integer | Number of records to be returned starting from the first record. Default: 20, Max count limit: 50 |
| q | string | filter data by user name, email, rank |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"leaderBoardInfo": [
{
"label": "On Login",
"value": "5 points"
},
{
"label": "On Completion of a Unit/Document",
"value": "5 points"
},
{
"label": "On Successful Completion of a Course",
"value": "50 points"
},
{
"label": "On Completion of an Assessment",
"value": "10 points"
},
{
"label": "On Submission of an Assignment",
"value": "15 points"
},
{
"label": "On Adding a new post or replying to existing post in Forum",
"value": "10 points"
},
{
"label": "On Enrolling to a Course in Course Library",
"value": "20 points"
},
{
"label": "On Completion of a Survey",
"value": "15 points"
},
{
"label": "On Passing an Exam: Trainee will be alloted points on the basis of percentage acheived. e.g.: 70% = 70 points",
"value": "TBD"
}
],
"leaderboardData": {
"leaderboardList": [
{
"userId": 8,
"uniqueId": "10105",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"points": 10406,
"rank": 3
}
],
"totalRecords": 34
}
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| leaderBoardInfo | array | Array of leader board information objects. |
| label | string | Label describing the earning event. |
| value | string | Value representing the points earned for the specific event. |
| leaderboardData | object | Leaderboard data containing user details and ranking information. |
| leaderboardList | array | Array of user objects with leaderboard information. |
| userId | number | ID of the user. |
| uniqueId | string | Unique identifier of the user. |
| firstName | string | First name of the user. |
| lastName | string | Last name of the user. |
| string | Email address of the user. | |
| points | number | Total points earned by the user. |
| rank | number | Ranking of the user. |
| totalRecords | number | Total number of records in the response. |
| Code | Description |
|---|---|
| 1001 | "Invali firstRecord" |
| 1002 | "Invalid count" |
| 1003 | "Leaderboard not configured" |