Calculate V3 Ranks
POST /rank/v3/rank:calculate
Calculate a rank update on players and return the results without persisting them Requires at least two teams, the players’ ranks before the last match was played, and parameters on how to calculate the rank changes
Required Permissions:
- For any player (including themselves) any of:
rank:*
,rank:calculate
Authorizations
Request Body required
A request body to calculate players’ rankings, and return the results. Player ranks will not be updated
object
How many seconds the match lasted
List of teams that participated in this match
One team of players from a match along with their placement in the match, and previous rank data about all of the players
object
List of CalculatedRank objects that give stats about a specific player from the match
Additional data about a specific player’s rank and previous match in order to make rank calculations
object
UUID for this specific player
Current rank info about player
object
A measure of perceived skill in a player
A measure of how confident we are in the perceived skill (high sigma means low confidence)
Custom key-value player rank data
object
How many seconds this player was in the match
What rank this team came in. 1 indicates victory, and higher values are placements. Matching ranks indicate draws
Configs about how to recalculate and clamp newly calculated ranks
object
The maximum mu value achievable. Any attempts to update a rank value to be higher than this get clamped to the maximum
The minimum mu value achievable. Any attempts to update a rank value to be lower than this get clamped to the minimum
The minimum sigma allowed. Any attempts to update sigma to be lower than this get clamped to the minimum
The distance between skill ranks that yields ~76% chance of winning. Recommended value is half the default sigma
The default mu value for this rank id. Will be used when players do not have any rank history
The default sigma for this rank id. Will be used when players do not have any rank history
The percent probability of a draw occuring in the game. Must be in [0, 1)
Factor that determines how quickly a player’s sigma is adjusted. A larger tau will result in more volatile in ranks. Recommended value is is (default_sigma * .01)
Responses
200
Successful Response
A response to recalculating players’ ranks
object
List of players and their updated ranks
Rank data about a specific player
object
UUID for this specific player
Current rank info about player
object
A measure of perceived skill in a player
A measure of how confident we are in the perceived skill (high sigma means low confidence)
Custom key-value player rank data
object
403
Forbidden
object
422
Validation Error