Battle player
One side of a battle — who played, what they brought and what they scored. Every battle has exactly two.
Properties
playerstring- 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.
subFactionstring | null- Battle formation, also called sub-faction.
outcome"win" | "loss" | "draw" | null- How the battle went for this player. Null while the battle is unfinished.
battlePointsnumber | null- Battle points earned from this battle.
victoryPointsnumber | null- Victory points scored across every round.
objectivePointsnumber · optionalwhen the battle pack scores objectives- Objective points scored across every round.
battleTacticsScorednumber · optionalwhen the battle pack uses battle tactics- How many battle tactics the player completed.
grandStrategystring | null · optionalwhen the battle pack uses grand strategies- The grand strategy the player picked.
grandStrategyScoredboolean · optionalwhen the battle pack uses grand strategies- Whether the grand strategy came off.
dropsnumber | null- Number of deployment drops. Null when none were recorded for the player.
role"attacker" | "defender" | null- The role the player had in the scenario. Null when the battle did not record attacker and defender.
metricsobject- Anything else the organiser tracked, keyed by the name they gave it. Numbers are totalled, yes/no metrics are counted. Always present, and empty when there is nothing extra.
listArmyList | nullGET /api/v1/battles/{id} only- The army the player brought, or null when none was recorded. Repeats faction and subFaction, which stay on the player itself so the battle listings can name them without carrying the list text.
roundsPlayerRound[]GET /api/v1/battles/{id} only- Round-by-round detail.
Example — GET /battles/{id}
json
{
"player": "Anders Larsson",
"playerId": "L80MTI4R",
"faction": "Disciples of Tzeentch",
"subFaction": "Guild of Summoners",
"outcome": "win",
"battlePoints": 20,
"victoryPoints": 28,
"objectivePoints": 18,
"battleTacticsScored": 3,
"grandStrategy": "Master of Destiny",
"grandStrategyScored": false,
"drops": 6,
"role": "attacker",
"metrics": {"Håll fler": 4},
"list": {
"faction": "Disciples of Tzeentch",
"subFaction": "Guild of Summoners",
"points": 1990,
"battleTacticCards": ["Sever the Head", "Bring it Down"],
"text": "Allegiance: Disciples of Tzeentch\n..."
},
"rounds": [
{
"round": 1,
"victoryPoints": 3,
"objectivePoints": 3,
"objectives": ["Hold 1", "Primary"],
"battleTactic": "Endless Expanse",
"battleTacticScored": false,
"priority": true
}
]
}