Leaderboard

Motivate your players to engage more on your platform by showing a gamified leaderboard on your website or mobile app

This endpoint allows you to retrieve the players' leaderboard for a date range or all time.

This endpoint is only available for our GURU customers only.

Leaderboard

GET /integrations/leaderboard

This endpoint can retrieve a date range or all time. It also accepts the playerUniqueId as an optional parameter where if provided, the rank of the player in the leaderboard will be returned.

Query Parameters

Name	Type	Description
from	string	Leaderboard query start datetime in the following format YYYY-MM-DD HH:mm (example, 2021-02-13 00:00).
to	string	Leaderboard query end datetime in the following format YYYY-MM-DD HH:mm (example, 2021-02-18 00:00).
limit	string	The size of the returned players in the leaderboard. Default size is 50 players.
playerUniqueId	string	Player unique identifier used to uniquely identify the player on Gameball.

Headers

Name	Type	Description
APIKey	string	Client API key

200

{
    "leaderboard": [
        {
            "displayName": "Player 1",
            "playerUniqueId": "5097238429738",
            "progress": 1748,
            "rank":1,
            "level": {
                "name": "Bronze",
                "icon": "https://cdn.gameball.co/uploads/c007/[e-mail]"
            }
        },
        {
            "displayName": "Player 2",
            "playerUniqueId": "3172250157098",
            "progress": 110,
            "rank":2,
            "level": {
                "name": "Basic",
                "icon": "https://cdn.gameball.co/uploads/c007/[e-mail]"
            }
        }
    ],
    "playerRank": {
        "rowOrder": 2,
        "playersCount": 30
    }
}