Skip to main content
POST
Export fresh leaderboard rankings

Authorizations

x-admin-user-access-token
string
header
required

An admin user access token. Service-only API keys cannot download user identities.

Headers

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

Body

application/json
configId
string
required
Pattern: ^[0-9a-fA-F]{24}$
fieldKeys
enum<string>[]
required
Required array length: 1 - 5 elements
Available options:
userId,
username,
email,
externalUserId,
displayName
format
enum<string>
required
Available options:
rankings,
exclusions
inHistoricPeriod
string<date-time> | null

An ISO date in the selected historic period; omit or pass null for the current period.

Response

CSV from one fixed snapshot

The response is of type string.