Skip to content

Get Matches

GET
/match/v1/match

Get pages of matches

Authorizations

Parameters

Query Parameters

cursor
Any of:
string
page_size
Any of:
integer
>= 1 <= 100

The maximum number of elements to be returned per call

instance_id
Any of:
string
allocation_id
Any of:
string
session_id
Any of:
string
host_player_uuid
Any of:
string
region_id
Any of:
string
player_uuid
Any of:
string

Responses

200

Successful Response

object
matches

List of matches

Array<object>
default:
object
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
2023-01-23T21:07:02.000000+00:00
created_timestamp

Timestamp of when the resource was created

string format: date-time
2023-01-23T21:07:02.000000+00:00
type
Any of:
string
state
Any of:

Match States.

string
Allowed values: pending closed
start_timestamp
Any of:

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
2023-01-23T21:07:02.000000+00:00
end_timestamp
Any of:

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
2023-01-23T21:07:02.000000+00:00
duration_seconds
Any of:
integer
custom_data
Any of:
object
key
additional properties
string
correlation_id
Any of:
string
sessions

List of session IDs for the match

Array<object>
default:
object
session_id
required

Session ID

string
matchmaking_profile_id
Any of:
string
instances

List of MatchInstances for the match

Array<object>
default:
object
instance_id
Any of:
string
host_player_uuid
Any of:
string format: uuid
region_id
Any of:
string
instance_request_template_id
Any of:
string
map
Any of:
string
game_mode
Any of:
string
host_type
Any of:

Whether the host is another player, or a dedicated instance

string
Allowed values: dedicated player
allocations

List of allocation IDs for the match

Array<object>
default:
object
allocation_id
required

Allocation ID

string
match_id
string
segments

List of segments for the match

Array<object>
default:
object
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
2023-01-23T21:07:02.000000+00:00
created_timestamp

Timestamp of when the resource was created

string format: date-time
2023-01-23T21:07:02.000000+00:00
type
Any of:
string
state
Any of:

Match States.

string
Allowed values: pending closed
start_timestamp
Any of:

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
2023-01-23T21:07:02.000000+00:00
end_timestamp
Any of:

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
2023-01-23T21:07:02.000000+00:00
duration_seconds
Any of:
integer
custom_data
Any of:
object
key
additional properties
string
correlation_id
Any of:
string
sessions

List of session IDs for the match

Array<object>
default:
object
session_id
required

Session ID

string
matchmaking_profile_id
Any of:
string
instances

List of MatchInstances for the match

Array<object>
default:
object
instance_id
Any of:
string
host_player_uuid
Any of:
string format: uuid
region_id
Any of:
string
instance_request_template_id
Any of:
string
map
Any of:
string
game_mode
Any of:
string
host_type
Any of:

Whether the host is another player, or a dedicated instance

string
Allowed values: dedicated player
allocations

List of allocation IDs for the match

Array<object>
default:
object
allocation_id
required

Allocation ID

string
match_segment
required

Segment ID of the match

string
>= 1 characters <= 16 characters
match_id
string
players

List of players in the match

Array<object>
default:
object
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
2023-01-23T21:07:02.000000+00:00
created_timestamp

Timestamp of when the resource was created

string format: date-time
2023-01-23T21:07:02.000000+00:00
player_uuid
string format: uuid
team_id
Any of:
string
party_session_id
Any of:
string
placement
Any of:
integer
joined_match_timestamp
Any of:

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
2023-01-23T21:07:02.000000+00:00
left_match_timestamp
Any of:

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
2023-01-23T21:07:02.000000+00:00
duration_seconds
Any of:
integer
starting_rank
Any of:
string
finishing_rank
Any of:
string
custom_data
Any of:
object
key
additional properties
string
players

List of players in the match

Array<object>
default:
object
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
2023-01-23T21:07:02.000000+00:00
created_timestamp

Timestamp of when the resource was created

string format: date-time
2023-01-23T21:07:02.000000+00:00
player_uuid
string format: uuid
team_id
Any of:
string
party_session_id
Any of:
string
placement
Any of:
integer
joined_match_timestamp
Any of:

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
2023-01-23T21:07:02.000000+00:00
left_match_timestamp
Any of:

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
2023-01-23T21:07:02.000000+00:00
duration_seconds
Any of:
integer
starting_rank
Any of:
string
finishing_rank
Any of:
string
custom_data
Any of:
object
key
additional properties
string
cursor
Any of:
string

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