Skip to main content

Leaderboard

Leaderboard Details​

Use this API to get leaderboard details and points received by Trainees.

 GET /leaderboard/trainee-leaderboard-list

Query string parameters​

FieldTypeDescription
firstRecord
required
integerFirst record to return. Default: 1
count
required
integerNumber of records to be returned starting from the first record. Default: 20, Max count limit: 50
qstringfilter data by user name, email, rank
{
    "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": []
            }
        }
    }
}