Skip to content
RallyHere Docs

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:

This mixin is meant to give a set of common properties to root config models

object
name

Name of the resource

string
>= 1 characters <= 125 characters
description

Description of the resource

string
>= 1 characters <= 250 characters
custom_data

Custom data associated with the resource

object
key
additional properties
string
max_mu
required

The maximum skill value that can be achieved in this Rank

number
min_mu
required

The minimum skill value that can be achieved in this Rank

number
min_sigma
required

The minimum sigma value achievable in this Rank when calculating with the ranking calculations.

number
> 0
beta

Default beta value for ranking calculations, which represents the distance in rating to have ~76% chance of winning for the higher rated player. The default is 4.167

number
default_mu
required

Default mu value for ranking calculations, which represents player skill. The default is 25

number
default_sigma
required

Default sigma for ranking calculations, which represents the systems uncertainty on the player’s mu (higher values mean more uncertainty). The default is 8.333

number
> 0
draw_probability

Draw probability for ranking calculations. The default is 0.1

number
tau

Tau represents the additive dynamic factor for ranking calculations. The higher the value, the more dynamic ratings will be (wins grant more, and losses lose more). The 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