Get Leaderboards

GET 
/v1/clients/:clientID/leaderboards/:leaderboardKey

Endpoint to return Leaderboard by a combination of:

• clientID
• leaderboard key (i.e. competitionId, seasonId, roundId, questionId)
• features (i.e. POINTS, EXPERIENCE, SCORES)
• dimensions (i.e. GLOBAL, EUROPE, AUTHENTICATED)

Request

Path Parameters

clientID stringrequired
leaderboardKey stringrequired

Query Parameters

features string
dimension string
size string
page string

Responses

200

Successful operation

application/json

Schema

Schema

• Array [
authId number
screenName string

User screen name

rank number

user rank for this leaderboard

denseRank number

user dense rank for this leaderboard. The difference between denseRank and rank, is that denseRank groups user with the same score

features object
features can be configured to support different leaderboard types (i.e. POINTS, SCORES, EXPERIENCE)
POINTS number
EXPERIENCE number
SCORES number
• ]

Example (from schema)

[
  {
    "authId": 1234,
    "screenName": "SomeUserScreenName123",
    "rank": 2,
    "denseRank": 2,
    "features": {
      "POINTS": 1000,
      "EXPERIENCE": 500,
      "SCORES": 10
    }
  }
]

Loading...