Skip to content

Get All Ranks

GET
/v1/sandbox/{sandbox_id}/rank

Get all Ranks in a sandbox

Requires any of permissions: sandbox:config:view, sandbox:config:edit

Authorizations

Parameters

Path Parameters

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Query Parameters

page_size

The maximum number of elements to be returned per call

integer
default: 50 >= 1 <= 10000

The maximum number of elements to be returned per call

cursor

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string
default: 0 >= 1 characters <= 128 characters

Cursor to designate where you are in iterating through values. Start with '0', and pass this on subsequent calls to continue iteration

Responses

200

Successful Response

object
cursor
required

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string
>= 1 characters <= 128 characters
ranks

A list of Ranks

Array<object>
default:
object
name
required

Readable name to identify this Rank

string
>= 1 characters <= 50 characters
rank_max
required

The maximum skill value that can be achieved in this Rank

number
rank_min
required

The minimum skill value that can be achieved in this Rank

number
trueskill_sigma_min

The minimum sigma value achievable in this Rank when calculating with Trueskill

number
trueskill_beta

Trueskill’s default beta value, which represents the distance in rating to have ~76% chance of winning for the higher rated player. Trueskill’s default is 4.167

number
trueskill_default_mu

Trueskill’s default mu value, which represents player skill. Trueskill’s default is 25

number
trueskill_default_sigma

Trueskill’s default sigma, which represents the systems uncertainty on the player’s mu (higher values mean more uncertainty). Trueskill’s default is 8.333

number
trueskill_draw_probability

Trueskill’s draw probability. Trueskill’s default is 0.1

number
trueskill_tau

Trueskill’s tau, which represents the additive dynamic factor. The higher the value, the more dynamic ratings will be (wins grant more, and losses lose more). Trueskill’s default value is 0.083

number
sandbox_id

ID of the Sandbox

string format: uuid
last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
created_timestamp

Timestamp of when this resource was created

string format: date-time
rank_id
required
string format: uuid

422

Validation Error

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