Skip to content

Get All Profiles

GET
/v1/sandbox/{sandbox_id}/match-making-profile

Get all MatchMakingProfiles 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
profiles

List of MatchMakingProfiles

Array<object>

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
active
required

Flag determining whether or not this profile will actively be ticked

boolean
join_mode

What mode to set on the MatchMakingProfile (normal, etc)

string
Allowed values: normal created_before
rank_id
required

Which rank this queue should use MMR from to make matches from, and update at the end of match (1v1 MMR or 2v2 MMR for example)

string format: uuid
num_sides
required

The number of sides a game in this queue will have (2 in a 1v1 and 3 in a 1v1v1 for example

integer
>= 1
min_players_per_side
required

The minimum number of players that can be on each team

integer
max_players_per_side
required

The maximum number of players that can be on each team

integer
>= 1
min_players_per_linking
required

The minimum number of players that can be on a single linking (a party)

integer
>= 1
max_players_per_linking
required

The maximum number of players that can be on a single linking (a party)

integer
>= 1
max_side_delta
required

The maximum difference in players per side when generating a match from this profile

integer
instance_request_template_id
required

Which instance request template is used for matches generated from this profile

string format: uuid
match_making_stride_id
required

Which matchmaking strides should be used to divide the queue population

string format: uuid
crossplay_partition_id
required

Which set of CrossplayPartitions rules should be used when generating matches in this profile

string format: uuid
taskforce_size_by_time

JSON config for decaying minimum team sizes over time

object
min_decayed_size

The minimum size this taskforce can decay to

integer
>= 1
starting_size

How big the taskforce should be before any decay has occurred

integer
>= 1
decay_power

At what rate should the decay occur. 1 is linear, 2 quadratic etc

integer
>= 1
max_minutes

How many minutes it will take for the taskforce size to fully decay

number
> 0
match_making_function_config
required

JSON config about which matchmaking function should be used to try and propose matches for this profile

object
host

The name of the matchmaking function that will be used to propose matches

string
default: hirez-matchmakingfunction >= 1 characters
port

Which port the specified matchmaking function listens on

integer
default: 50502
type

Which client type the specified matchmaking function uses

string
Allowed values: GRPC REST
legacy_config

Old config used by Legacy systems. These values are ignored by the current APIs

object
queue_type_value_id

Queue type

integer
default: 10006
task_force_number

How many taskforces are in a match

integer
name_msg_id

The message id of this Profile

integer
desc_msg_id

The description message id of this Profile

integer
give_xp_flag

Whether matches should award xp

boolean
giveachievement

Whether matches should award achievements

boolean
block_reward_after_level

Whether or not rewards have a level limit

boolean
servertickrate

The server tick rate

integer
default: 30
serverfubartickrate

Tick rate threshold before the instance is considered fubar

integer
default: 20
playerconnectwait

How long to wait to allow players to connect

integer
default: 90
physicsthreshold

The threshold of acceptable physics

number
default: 0.055
PerformanceGroup

Which performance group instances for this match belong to

integer
game_mode_value_id

The game mode ValidValue

integer
SurveyFreq

How frequently a match should be surveyed

integer
NoTaskforceSelection

Whether or not players should be allowed to choose their own taskforce

boolean
RecordClientStats

Whether or not client stats should be recorded

boolean
ServerDBStatWriteSeconds

How frequently stats should be written to the DB

integer
default: 10
min_players_per_team

Minimum number of players required on each team

integer
default: 4
max_players_per_team

Maximum number of players allowed on each team

integer
default: 4
allowlivespectate

Whether or not these matches can be spectated without a delay

boolean
match_queue_id

Queue id

integer
deserter_flag

Whether or not leaving these matches should give deserter

boolean
ranking_type_id

Rank id

integer
game_type_value_id

Game type ValidValue

integer
PeerToPeer

Whether or not game should be hosted as P2P

boolean
supports_backfill

Flag determining whether or not backfill objects should be created when generating matches in this profile

boolean
default: true
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
match_making_profile_id
required

ID to uniquely identify this MatchMakingProfile

string format: uuid
quality_by_time

Settings to establish the required quality of matches.

object
max_quality

The quality threshold that this profile will start trying to match with

number
max_minutes

The max amount of time we will try to create matches before quality will be disregarded

number
method

Method used to decay the required quality of matches over time. Currently only ‘two_term_quadratic’ is supported

string
Allowed values: two_term_quadratic

422

Validation Error

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