Get user's position in leaderboard

Retrieves the authenticated user’s position and score in the specified leaderboard

GET /leaderboards/{configId}/position

Get user's position in leaderboard

cURL

curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/leaderboards/{configId}/position \
  --header 'x-api-token: <api-key>'

200

{
  "position": 123,
  "totalParticipants": 123,
  "userScore": 123
}

Authorizations

x-api-token · string · header · required

Path Parameters

configId · string · required

Pattern: ^[0-9a-fA-F]{24}$

Response

200

application/json

Successful response

The current user's position and stats on a leaderboard

position · number · required

The user's current rank/position on the leaderboard

totalParticipants · number · required

The total number of participants in the leaderboard

userScore · number · required

The user's current score on the leaderboard