Skip to main content
GET
Get division leaderboard

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Path Parameters

division_id
string
required

Division whose primary leaderboard should be returned.

Pattern: ^div_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query Parameters

include_recent_rounds
boolean
default:true

Include each entry's recent per-round score history.

Response

LeaderboardEntryPublic · object[] | null

Successful Response

rank
integer
required

Player's position on the leaderboard.

player_id
string
required

Player represented by this entry.

score
number
required

Primary leaderboard value for this player.

rounds_played
integer
required

Rounds represented by this entry.

player_name
string | null

Player display name.

score_label
string
default:Score

Label for the primary leaderboard value.

score_value_type
enum<string>
default:number

Display format for the primary leaderboard value.

Available options:
number,
integer,
string,
boolean,
percent
episode_wins
number | null

Episodes won, including tie credit.

episodes_played
integer | null

Episodes represented by this entry.

win_rate
number | null

Episode win rate from 0 to 1.

policy_label
string | null

Policy label represented by this entry.

recent_rounds
LeaderboardRecentRoundPublic · object[] | null

Recent round results, or null when they were not requested or published.