Skip to main content
POST
Get Leaderboard For Entities

Authorizations

X-EntityToken
string
header
required

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

Body

application/json

Request a leaderboard limited to a collection of entities.

Request a leaderboard limited to a collection of entities.

EntityIds
string[]
required

Collection of Entity IDs to include in the leaderboard.

LeaderboardName
string
required

Name of the leaderboard.

CustomTags
object

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

Version
number

Optional version of the leaderboard, defaults to current.

Response

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

Example:
Last modified on October 1, 2026