Get a leaderboard
Get a leaderboard by ID.
Authorizations
Headers
The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. Pass your own internal customer ID for the tenant. Ignored for single-tenant organisations.
Path Parameters
The UUID of the leaderboard to retrieve.
Response
Successful operation
A leaderboard returned from the admin leaderboards endpoints.
The UUID of the leaderboard.
The leaderboard name.
The leaderboard key.
The current user-facing status of the leaderboard.
inactive, active, scheduled, finished What the leaderboard ranks by.
metric, streak, points The maximum number of participants.
The leaderboard start date in YYYY-MM-DD format.
The UUIDs of the user attributes used for ranking breakdowns.
The leaderboard description.
The metric ID used when rankBy is metric.
The points system ID used when rankBy is points.
The optional leaderboard end date in YYYY-MM-DD format.
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 recurrence unit when the leaderboard repeats.
day, month, year The number of recurrence units between leaderboard runs.