Skip to content

Get Match Making Templates V2

GET
/session/v2/match-making-templates/{template_group_id}

Get match making templates, rules, and profiles for a template group. Groups can be found on the queue information from the queues config endpoints

Required Permissions:

  • For any player (including themselves) any of: session:*, session:read:config

Required Session Permissions: None DEPRECATED Use the V2 endpoint instead

Authorizations

Parameters

Path Parameters

template_group_id
required
string format: uuid

Header Parameters

if-none-match

If you provide the ETag that matches the current ETag for this resource, a 304 response will be returned - indicating that the resource has not changed.

string

If you provide the ETag that matches the current ETag for this resource, a 304 response will be returned - indicating that the resource has not changed.

Responses

200

Successful Response

A collection of MatchMakingTemplates that may be used when a session enters a queue. The first template that satisfies the necessary rules will be used

object
match_making_template_group_id
required

ID for this set of potential matchmaking templates

string format: uuid
template_options
required

List of the different matchmaking templates that could be used. The config is chosen based on a set of rules in each MatchMakingTemplate object. If there are no rules, it’s the default template

Array<object>

Configuration about what rules must be satisfied to use this template, and what matchmaking profiles the ticket will be a part of

object
match_making_template_id

ID for this unique MatchMakingTemplate

string format: uuid
mmr_grouping_method
required

What method should be used to calculate a group’s MMR based on the individual player’s ranks

string
Allowed values: worst best avg_weighted_by_sigma avg
ruleset

A set of rules that determine whether or not this matchmaking config should be used.

object
rules

A list of the rules to be checked for this ruleset

Array<object>
default:

A rule to determine which MatchMakingTemplate should be used on a session entering matchmaking

object
rule_type
required

What type of rule this is

string
Allowed values: Inventory LinkingSize JoiningSessionSize
item_id

Id of the item we are comparing if this is an inventory rule

integer
comparison_operation
required

Comparison operation to be performed

string
Allowed values: eq ne lt le gt ge
comparison_value
required

Value to compare to

integer
determiner

Determiner of how many rules must be satisfied in this rulest (all, any, one, none)

string
Allowed values: allOf anyOf oneOf noneOf
players_to_validate

Which members of a session must be validated to satisfy this ruleset

string
Allowed values: leader all_members any_member
profiles
required

A list of which match making profiles are going to be created on the ticket

Array<object>

A profile that describes what pools of players a session will be a part of when matchmaking

object
match_making_profile_id
required

ID of the matchmaking profile to join

string
>= 1 characters <= 128 characters
join_mode

What mode to set on the matchmaking profile (normal, backfill etc)

string
Allowed values: normal backfill created_before
instance_request_template_id
required

Which instance template to use when launching a match in this profile

string format: uuid
rank_id

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

string
num_sides

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

integer
max_players_per_side

The maximum number of players that can be on each team

integer
min_players_per_side

The minimum number of players that can be on each team

integer
legacy_config

Legacy config to help migrate clients

object
deserter_id

Which deserter this profile should check before allowing players to join matchmaking

string
session_template_id

What type of session should result from matchmaking on this profile

string format: uuid
required_item_ids

Set of all the item ids that are required to validate every rule contained in this template group

Array<integer>
default: unique items
requires_all_players_items

Whether or not the rulesets under this group will require us to query all players inventory, or just the leader’s

boolean

Headers

ETag
string

Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

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