Get Match Segment

GET 
/match/v1/match/:match_id/segment/:segment_id

Get match segment by match_id and segment_id.

• For any match any of: match:*, match:match:any:read

• For match if the player was in match any of: match:*, match:match:player:read

Request

Path Parameters

match_id Match Idrequired
segment_id Segment Idrequired

Responses

200

Successful Response

application/json

Schema

Schema

last_modified_timestamp date-time

Timestamp of when the resource was last modified

created_timestamp date-time

Timestamp of when the resource was created

type

object

Type of match

anyOf

MOD1

string

state

object

State of the match

anyOf

MatchState

Match States.

string

Possible values: [pending, closed]

start_timestamp

object

Start time of the match

anyOf

Time Zone Aware Datetime

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

string

end_timestamp

object

End time of the match

anyOf

Time Zone Aware Datetime

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

string

duration_seconds

object

Duration in seconds of the match

anyOf

MOD1

integer

custom_data

object

Custom data for the match

anyOf

MOD1

property name* string

correlation_id

object

Correlation ID for the match

anyOf

MOD1

string

sessions

object[]

List of session IDs for the match

Array [

session_id Session Id (string)required

Possible values: non-empty and <= 128 characters

Session ID

matchmaking_profile_id

object

Profile ID

anyOf

MOD1

string

]

instances

object[]

List of MatchInstances for the match

Array [

instance_id Instance Id (string)required

Possible values: non-empty and <= 128 characters

Instance ID

host_player_uuid

object

Player UUID of the host

anyOf

MOD1

string

region_id

object

Region ID the instance is in

anyOf

MOD1

string

instance_request_template_id

object

Launch request template ID

anyOf

MOD1

string

map

object

Map the instance is on

anyOf

MOD1

string

game_mode

object

Game mode the instance is in

anyOf

MOD1

string

host_type

object

Type of host

anyOf

HostType

Whether the host is another player, or a dedicated instance

string

Possible values: [dedicated, player]

]

allocations

object[]

List of allocation IDs for the match

Array [

allocation_id Allocation Id (string)required

Possible values: non-empty and <= 128 characters

Allocation ID

]

match_segment Match Segment (string)required

Possible values: non-empty and <= 16 characters

Segment ID of the match

match_id Match Id (string)

Possible values: non-empty and <= 128 characters

players

object[]

List of players in the match

Array [

last_modified_timestamp date-time

Timestamp of when the resource was last modified

created_timestamp date-time

Timestamp of when the resource was created

player_uuid uuid

team_id

object

Team ID the player was on

anyOf

MOD1

string

party_session_id

object

Party session ID the player was in

anyOf

MOD1

string

placement

object

Placement of the player in the match

anyOf

MOD1

integer

joined_match_timestamp

object

Time the player joined the match

anyOf

Time Zone Aware Datetime

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

string

left_match_timestamp

object

Time the player left the match

anyOf

Time Zone Aware Datetime

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

string

duration_seconds

object

Duration in seconds the player was in the match

anyOf

MOD1

integer

starting_rank

object

Starting rank of the player in the match

anyOf

MOD1

string

finishing_rank

object

Finishing rank of the player in the match

anyOf

MOD1

string

custom_data

object

Custom data for the player

anyOf

MOD1

property name* string

]

Example (from schema)

{
  "last_modified_timestamp": "2023-01-23T21:07:02.000000+00:00",
  "created_timestamp": "2023-01-23T21:07:02.000000+00:00",
  "type": "string",
  "state": "pending",
  "start_timestamp": "2023-01-23T21:07:02.000000+00:00",
  "end_timestamp": "2023-01-23T21:07:02.000000+00:00",
  "duration_seconds": 0,
  "custom_data": {},
  "correlation_id": "string",
  "sessions": [
    {
      "session_id": "string",
      "matchmaking_profile_id": "string"
    }
  ],
  "instances": [
    {
      "instance_id": "string",
      "host_player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "region_id": "string",
      "instance_request_template_id": "string",
      "map": "string",
      "game_mode": "string",
      "host_type": "dedicated"
    }
  ],
  "allocations": [
    {
      "allocation_id": "string"
    }
  ],
  "match_segment": "string",
  "match_id": "string",
  "players": [
    {
      "last_modified_timestamp": "2023-01-23T21:07:02.000000+00:00",
      "created_timestamp": "2023-01-23T21:07:02.000000+00:00",
      "player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "team_id": "string",
      "party_session_id": "string",
      "placement": 0,
      "joined_match_timestamp": "2023-01-23T21:07:02.000000+00:00",
      "left_match_timestamp": "2023-01-23T21:07:02.000000+00:00",
      "duration_seconds": 0,
      "starting_rank": "string",
      "finishing_rank": "string",
      "custom_data": {}
    }
  ]
}

403

Error Codes:

• auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token

• auth_invalid_version - Invalid Authorization - version

• auth_malformed_access - Invalid Authorization - malformed access token

• auth_not_jwt - Invalid Authorization

• auth_token_expired - Token is expired

• auth_token_format - Invalid Authorization - {}

• auth_token_invalid_claim - Token contained invalid claim value: {}

• auth_token_invalid_type - Invalid Authorization - Invalid Token Type

• auth_token_sig_invalid - Token Signature is invalid

• auth_token_unknown - Failed to parse token

• insufficient_permissions - Insufficient Permissions

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

404

Not Found

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...