Skip to content

Calculate V2 Ranks

POST
/rank/v2/rank:calculate

Calculate a rank update on players and persist their new ranks Requires at least two teams, and the players’ ranks before the last match was played

Required Permissions: rank:update:any

Authorizations

Request Body required

A request body to calculate and update players’ ratings from a match

object
instance_id

ID for the instance the match took place on

string
>= 1 characters <= 128 characters
rank_id
required

ID for the rank type used in this match

string
>= 1 characters
match_length_seconds
required

How many seconds the match lasted

integer
teams
required

List of teams that participated in this match

Array<object>

One team of players from a match along with their placement in the match, and previous rank data about all of the players

object
players
required

List of CalculatedRank objects that give stats about a specific player from the match

Array<object>

Additional data about a specific player’s rank and previous match in order to make rank calculations

object
player_uuid
required

UUID for this specific player

string format: uuid
rank
required

Current rank info about player

object
mu
required

A measure of perceived skill in a player

number
sigma
required

A measure of how confident we are in the perceived skill (high sigma means low confidence)

number
>= 2
custom_data

Custom key-value player rank data

object
key
additional properties
string
>= 1 characters <= 4096 characters
seconds_in_match
required

How many seconds this player was in the match

integer
team_rank
required

What rank this team came in. 1 indicates victory, and higher values are placements. Matching ranks indicate draws

integer
>= 1

Responses

200

Successful Response

Response to successfully updating players’ ranks

object
updated_players
required

List of players and their updated ranks

Array<object>

Response to successfully requesting a player’s rank

object
player_uuid
required

UUID for this specific player

string format: uuid
rank
required

Current rank info about player

object
mu
required

A measure of perceived skill in a player

number
sigma
required

A measure of how confident we are in the perceived skill (high sigma means low confidence)

number
>= 2
custom_data

Custom key-value player rank data

object
key
additional properties
string
>= 1 characters <= 4096 characters
rank_id
required

ID for this rank

string
>= 1 characters

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string