Create Pex Player

POST 
/match/v1/pex/client

Create PEX Client

Required Permissions:

• For any pex client any of: match:*, match:pex:client:write

Request

application/json

Body

required

frame_time

object

Frametime

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

delta_time

object

Delta time

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

tick_count

object

Server tick rate

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

delayed_tick_count

object

Delayed tick count

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

memory_ws

object

Memory working set

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

memory_vb

object

Memory video buffer

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

cpu_process

object

CPU process

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

ping

object

Average ping across players

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

in_packets

object

In packets metrics

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

out_packets

object

Out packets metrics

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

total_packets

object

Total packets metrics

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

in_packet_loss

object

In packets lost metrics

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

out_packet_loss

object

Out packets lost metrics

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

total_packet_loss

object

Total packets lost metrics

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

in_packet_loss_pct

object

Packets lost percentage in

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

out_packet_loss_pct

object

Packets lost percentage out

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

total_packet_loss_pct

object

Total packet lost percentage

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

total_disconnects

object

Total disconnects

anyOf

PexCount

count

object

Count of values

anyOf

MOD1

number

match_duration

object

Match duration

anyOf

PexCount

count

object

Count of values

anyOf

MOD1

number

game_thread_time

object

Game thread time

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

render_thread_time

object

Render thread time

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

gpu_time

object

GPU time

anyOf

PexStat

min

object

Minimum value

anyOf

MOD1

number

max

object

Maximum value

anyOf

MOD1

number

avg

object

Average value

anyOf

MOD1

number

stddev

object

Standard deviation

anyOf

MOD1

number

match_id Match Id (string)required

Match ID

region_id

object

Region ID

anyOf

MOD1

string

server_id

object

Server ID

anyOf

MOD1

string

allocation_id

object

Allocation ID

anyOf

MOD1

string

datacenter_provider

object

Datacenter provider

anyOf

MOD1

string

datacenter_location

object

Datacenter location

anyOf

MOD1

string

address_ip

object

IP address

anyOf

MOD1

string

map_name

object

Map name

anyOf

MOD1

string

game_mode

object

Game mode

anyOf

MOD1

string

matchmaking_profile_id

object

Matchmaking profile ID

anyOf

MOD1

string

expected_team_size

object

Expected team size

anyOf

MOD1

integer

expected_player_count

object

Expected player count

anyOf

MOD1

integer

host_player_uuid

object

Player UUID of the host

anyOf

MOD1

string

owning_player_uuid

object

Player UUID of the owner

anyOf

MOD1

string

version

object

Version

anyOf

MOD1

string

device_info

object

Device info

anyOf

MOD1

string

platform_id

object

Platform ID

anyOf

Platform

string

Possible values: [Anon, Basic, XboxLive, PSN, NintendoNAID, NintendoSwitch, NintendoPPID, Google, GooglePlay, Apple, Epic, Steam, Amazon, Twitch, RallyHere, LegacyName]

custom_data

object

Custom data

anyOf

MOD1

property name* string
player_uuid uuidrequired

Player UUID

Responses

204

Successful Response

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"
}

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...