Skip to main 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

Request​

Path Parameters

    sandbox_id uuidrequired

    Sandbox ID

Query Parameters

    page_size Page Size

    Possible values: >= 1 and <= 10000

    Default value: 50

    The maximum number of elements to be returned per call

    cursor Cursor

    Possible values: non-empty and <= 128 characters

    Default value: 0

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

Responses​

Successful Response

Schema

    cursor Cursor (string)required

    Possible values: non-empty and <= 128 characters

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

    profiles

    object[]

    List of MatchMakingProfiles

  • Array [

    • name Name (string)

    Possible values: non-empty and <= 125 characters

    Name of the resource

    description Description (string)

    Possible values: <= 250 characters

    Description of the resource

    custom_data

    object

    Custom data associated with the resource

    property name* string
    active Active (boolean)required

    Flag determining whether or not this profile will actively be ticked

    join_mode Join Mode (string)

    Possible values: [normal, created_before]

    Mode that determines what types of match requests the ticket will appear in

    rank_id uuid

    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)

    num_sides Num Sides (integer)required

    Possible values: >= 1

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

    min_players_per_side Min Players Per Side (integer)required

    The minimum number of players that can be on each team

    max_players_per_side Max Players Per Side (integer)required

    Possible values: >= 1

    The maximum number of players that can be on each team

    min_players_per_linking Min Players Per Linking (integer)required

    Possible values: >= 1

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

    max_players_per_linking Max Players Per Linking (integer)required

    Possible values: >= 1

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

    max_side_delta Max Side Delta (integer)required

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

    instance_request_template_id uuid

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

    match_making_stride_id uuidrequired

    Which matchmaking strides should be used to divide the queue population

    crossplay_partition_id uuidrequired

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

    deserter_id uuid

    Which deserter will be checked before a session is allowed to put themselves in matchmaking for this profile

    taskforce_size_by_time

    object

    JSON config for decaying minimum team sizes over time

    min_decayed_size Min Decayed Size (integer)

    The minimum size this taskforce can decay to

    starting_size Starting Size (integer)

    Possible values: >= 1

    How big the taskforce should be before any decay has occurred

    decay_power Decay Power (integer)

    Possible values: >= 1

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

    max_minutes Max Minutes (number)

    Possible values: > 0

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

    match_making_function_config

    object

    required

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

    host Host (string)deprecated

    Possible values: non-empty

    Default value: hirez-matchmakingfunction

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

    port Port (integer)deprecated

    Default value: 50502

    Which port the specified matchmaking function listens on

    type Match Making Function Client Type (string)deprecated

    Possible values: [GRPC, REST]

    Default value: GRPC

    Which client type the specified matchmaking function uses

    proposal_type Match Making Function Type (string)

    Possible values: [ranked_timed_sampling_unproposed_first, ranked_timed_sampling_unseen_first, ranked_timed_sampling, propose_every_ticket, any_valid_match, any_valid_match_calculate_quality, many_valid_matches, many_valid_matches_calculate_quality]

    Which MatchMakingFunction to use. If specified as CUSTOM_MMF, a Custom MMF ID must be provided.

    legacy_config

    object

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

    queue_type_value_id Queue Type Value Id (integer)

    Default value: 10006

    Queue type

    task_force_number Task Force Number (integer)

    Default value: 0

    How many taskforces are in a match

    name_msg_id Name Msg Id (integer)

    Default value: 0

    The message id of this Profile

    desc_msg_id Desc Msg Id (integer)

    Default value: 0

    The description message id of this Profile

    give_xp_flag Give Xp Flag (boolean)

    Whether matches should award xp

    giveachievement Giveachievement (boolean)

    Whether matches should award achievements

    block_reward_after_level Block Reward After Level (boolean)

    Whether or not rewards have a level limit

    servertickrate Servertickrate (integer)

    Default value: 30

    The server tick rate

    serverfubartickrate Serverfubartickrate (integer)

    Default value: 20

    Tick rate threshold before the instance is considered fubar

    playerconnectwait Playerconnectwait (integer)

    Default value: 90

    How long to wait to allow players to connect

    physicsthreshold Physicsthreshold (number)

    Default value: 0.055

    The threshold of acceptable physics

    PerformanceGroup Performancegroup (integer)

    Default value: 0

    Which performance group instances for this match belong to

    game_mode_value_id Game Mode Value Id (integer)

    Default value: 0

    The game mode ValidValue

    SurveyFreq Surveyfreq (integer)

    Default value: 0

    How frequently a match should be surveyed

    NoTaskforceSelection Notaskforceselection (boolean)

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

    RecordClientStats Recordclientstats (boolean)

    Whether or not client stats should be recorded

    ServerDBStatWriteSeconds Serverdbstatwriteseconds (integer)

    Default value: 10

    How frequently stats should be written to the DB

    min_players_per_team Min Players Per Team (integer)

    Default value: 4

    Minimum number of players required on each team

    max_players_per_team Max Players Per Team (integer)

    Default value: 4

    Maximum number of players allowed on each team

    allowlivespectate Allowlivespectate (boolean)

    Whether or not these matches can be spectated without a delay

    match_queue_id Match Queue Id (integer)

    Default value: 0

    Queue id

    deserter_flag Deserter Flag (boolean)

    Whether or not leaving these matches should give deserter

    ranking_type_id Ranking Type Id (integer)

    Default value: 0

    Rank id

    game_type_value_id Game Type Value Id (integer)

    Default value: 0

    Game type ValidValue

    PeerToPeer Peertopeer (boolean)

    Whether or not game should be hosted as P2P

    supports_backfill Supports Backfill (boolean)

    Default value: true

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

    session_template_id uuidrequired

    What type of session should be created as the result of matchmaking in this profile

    quality_by_time

    object

    Settings to establish the required quality of matches.

    max_quality Max Quality (number)

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

    max_minutes Max Minutes (number)

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

    method Quality By Time Method (string)

    Possible values: [two_term_quadratic]

    Default value: two_term_quadratic

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

    backfill_request_styles BackfillRequestStyle (string)[]

    Possible values: [team_request, composition]

    Which styles of backfill requests to use. If notspecified, the defaults will be used. Multiple backfill styles may be used at the same time. team_request handle backfill using only a single number specifying the number of players needed. composition provides the full match composition allowing backfill to use match rating and quality systems

    backfill_override_match_making_profile_id uuid

    Which MatchMakingProfile to use for backfilling. If unset then this profile is used.

    created_before_minutes Created Before Minutes (number)

    Possible values: < 0

    How old tickets must be before getting considered for this profile. Should be negative. For example, setting this to -1 will require tickets must be at least a minute old before getting considered

    created_after_minutes Created After Minutes (number)

    Possible values: < 0

    How old tickets must be to stop getting considered for this profile. Should be negative. For example, setting this to -1 will stop considering tickets once they are a minute old

    last_modified_account_id uuid

    Account ID of the user who last modified the resource

    last_modified_timestamp date-time

    Timestamp of when the resource was last modified

    created_timestamp date-time

    Timestamp of when this resource was created

    match_making_profile_id uuidrequired

    ID to uniquely identify this MatchMakingProfile

  • ]

Loading...