Get division leaderboard

GET/v2/divisions/{division_id}/leaderboard

Return the primary leaderboard for a visible division.

Authorization

BearerAuth

AuthorizationBearer <token>

Bearer token issued by Softmax

In: header

Path Parameters

division_id*Division Id

Division whose primary leaderboard should be returned.

Match^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?Include Recent Rounds

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

Defaulttrue

bash

curl -X GET "https://example.com/v2/divisions/string/leaderboard"

json

[
  {
    "rank": 0,
    "player_id": "string",
    "player_name": "string",
    "score": 0,
    "score_label": "Score",
    "score_value_type": "number",
    "rounds_played": 0,
    "episode_wins": 0,
    "episodes_played": 0,
    "win_rate": 0,
    "policy_label": "string",
    "recent_rounds": [
      {
        "id": "string",
        "round_number": 0,
        "status": "pending",
        "rank": 0,
        "score": 0,
        "episode_wins": 0,
        "episodes_played": 0,
        "started_at": "2019-08-24T14:15:22Z",
        "completed_at": "2019-08-24T14:15:22Z",
        "policy_version_id": "7cd41427-f4be-4006-ab17-5ead7f8f8446"
      }
    ]
  }
]