Pular para o conteúdo principal
POST
Get Leaderboard

Autorizações

X-EntityToken
string
header
obrigatório

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Corpo

application/json

Request to load a leaderboard.

Request to load a leaderboard.

LeaderboardName
string
obrigatório

Name of the leaderboard.

PageSize
number
obrigatório

Maximum number of results to return from the leaderboard. Minimum 1, maximum 100.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

StartingPosition
number

Index position to start from. 1 is beginning of leaderboard.

Version
number

Optional version of the leaderboard, defaults to current version.

Resposta

Leaderboard response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object

Leaderboard response

Exemplo:
Última modificação em 6 de outubro de 2026