Leaderboard row

One player place on a board — where they came and the record that got them there.

Properties

ranknumber | null
Placement, 1 being first.
groupstring · optionalon group stage boards
Which group the player was in, for example "Group A".
playerstring | null
The player display name.
playerIdstring | null
The public player id, when the player has one. Use it to get that player's battles.See GET /api/v1/users/{publicId}/battles
factionstring | null
Faction played.
battlePointsnumber
Battle points earned, scored the way the organiser set up.
winsnumber
Battles won.
drawsnumber
Battles drawn.
lossesnumber
Battles lost.
victoryPointsnumber
Victory points scored across every battle.
victoryPointsDiffnumber
Victory points scored minus victory points given away.

Example — a group stage row

json
{
  "rank": 1,
  "group": "Group A",
  "player": "Anders Larsson",
  "playerId": "L80MTI4R",
  "faction": "Slaves to Darkness",
  "battlePoints": 92,
  "wins": 4,
  "draws": 0,
  "losses": 1,
  "victoryPoints": 121,
  "victoryPointsDiff": 37
}