Get a user's leaderboard data
Get a user’s rank, value, and daily ranking history for a specific leaderboard.
Authorizations
Headers
The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. The value should be your internal ID for the tenant. Ignored for single-tenant organisations.
Path Parameters
The user's ID in your database.
Unique key of the leaderboard as set when created.
Query Parameters
Specific run date in YYYY-MM-DD format. If not provided, returns the current run.
The number of days to return in the leaderboard history for the user.
0 <= x <= 100Response
Successful operation
A user's data for a specific leaderboard including rank, value, and history.
The unique ID of the leaderboard.
"5100fe51-6bce-6j44-b0hs-bddc4e123682"
The user-facing name of the leaderboard.
"Weekly Word Count Challenge"
The unique key used to reference the leaderboard in APIs.
"weekly-words"
What the leaderboard ranks by.
points, streak, metric "metric"
Deprecated. The key of the attribute to break down this leaderboard by.
"country"
The user attribute keys that this leaderboard is broken down by.
The key of a user attribute in this leaderboard breakdown.
The user-facing description of the leaderboard.
"Compete weekly to see who writes the most words"
The start date of the leaderboard in YYYY-MM-DD format.
"2025-01-01"
The end date of the leaderboard in YYYY-MM-DD format, or null if it runs forever.
"2025-12-31"
When set, ranking only counts activity at or after this time of day in the user's timezone (HH:mm format).
^([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$"09:00"
When set, ranking only counts activity before this time of day in the user's timezone (HH:mm format).
^([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$"17:00"
The maximum number of participants in the leaderboard.
100
The repetition type for recurring leaderboards, or null for one-time leaderboards.
day, month, year, null "day"
The interval between repetitions, relative to the start date and repetition type. Null for one-time leaderboards.
7
The user's current rank in this leaderboard. Null if the user is not on the leaderboard.
2
The user's current value in this leaderboard. Null if the user is not on the leaderboard.
4500
An array of daily change events showing the user's rank and value over time.
The key of the metric to rank by, if rankBy is 'metric'.
"words-written"
The name of the metric to rank by, if rankBy is 'metric'.
"Words Written"
The key of the points system to rank by, if rankBy is 'points'.
"xp-system"
The name of the points system to rank by, if rankBy is 'points'.
"Experience Points"