Skip to main content
GET
Get user's position in leaderboard

Authorizations

x-api-token
string
header
required

Path Parameters

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

Query Parameters

inHistoricPeriod
string

Response

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

currentWeekActiveDays
integer

Active days in the current campaign week for Consistent Weeks leaderboards

Required range: 0 <= x <= 3