Get All Pex Client Scores By Filter

GET

/match/v1/pex/client/score

Get pages of PEX client score data based on provided filters

Required Permissions:

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

Authorizations

• HTTPBearerHeadersOrCookie

Parameters

Query Parameters

cursor

Any of:

string

string

null

null

page_size

Any of:

integer

integer

>= 1 <= 100

null

null

The maximum number of elements to be returned per call

to_datetime

Any of:

Time Zone Aware Datetime

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

null

null

from_datetime

Any of:

Time Zone Aware Datetime

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

null

null

match_id

Any of:

string

string

null

null

region_id

Any of:

string

string

null

null

server_id

Any of:

string

string

null

null

allocation_id

Any of:

string

string

null

null

datacenter_provider

Any of:

string

string

null

null

datacenter_location

Any of:

string

string

null

null

machine_class

Any of:

string

string

null

null

address_ip

Any of:

string

string

null

null

map_name

Any of:

string

string

null

null

game_mode

Any of:

string

string

null

null

matchmaking_profile_id

Any of:

string

string

null

null

expected_team_size

Any of:

integer

integer

null

null

expected_player_count

Any of:

integer

integer

null

null

host_player_uuid

Any of:

string

string

null

null

owning_player_uuid

Any of:

string

string

null

null

version

Any of:

string

string

null

null

player_uuid

Any of:

string

string

null

null

device_info

Any of:

string

string

null

null

Responses

200

Successful Response

object

results

List of PEX reports for this 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

frame_time

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

delta_time

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

tick_count

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

delayed_tick_count

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

memory_ws

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

memory_vb

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

cpu_process

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

ping

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

in_packets

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

out_packets

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

total_packets

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

in_packet_loss

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

out_packet_loss

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

total_packet_loss

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

in_packet_loss_pct

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

out_packet_loss_pct

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

total_packet_loss_pct

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

total_disconnects

Any of:

PexCount

object

count

Any of:

number

number

null

null

null

null

match_duration

Any of:

PexCount

object

count

Any of:

number

number

null

null

null

null

game_thread_time

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

render_thread_time

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

gpu_time

Any of:

PexStat

object

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

avg

Any of:

number

number

null

null

stddev

Any of:

number

number

null

null

null

null

scores

Any of:

PexClientScores

object

overall_match_score

Any of:

boolean

boolean

null

null

app_score

Any of:

boolean

boolean

null

null

gameplay_score

Any of:

boolean

boolean

null

null

network_score

Any of:

boolean

boolean

null

null

connection_count_score

Any of:

boolean

boolean

null

null

frame_time_score

Any of:

boolean

boolean

null

null

delta_time_score

Any of:

boolean

boolean

null

null

tick_count_score

Any of:

boolean

boolean

null

null

delayed_tick_count_score

Any of:

boolean

boolean

null

null

memory_ws_score

Any of:

boolean

boolean

null

null

memory_vb_score

Any of:

boolean

boolean

null

null

cpu_process_score

Any of:

boolean

boolean

null

null

ping_score

Any of:

boolean

boolean

null

null

in_packet_loss_score

Any of:

boolean

boolean

null

null

out_packet_loss_score

Any of:

boolean

boolean

null

null

total_disconnects_score

Any of:

boolean

boolean

null

null

null

null

match_id

required

Match ID

string

region_id

Any of:

string

string

null

null

server_id

Any of:

string

string

null

null

allocation_id

Any of:

string

string

null

null

datacenter_provider

Any of:

string

string

null

null

datacenter_location

Any of:

string

string

null

null

address_ip

Any of:

string

string

null

null

map_name

Any of:

string

string

null

null

game_mode

Any of:

string

string

null

null

matchmaking_profile_id

Any of:

string

string

null

null

expected_team_size

Any of:

integer

integer

null

null

expected_player_count

Any of:

integer

integer

null

null

host_player_uuid

Any of:

string

string format: uuid

null

null

owning_player_uuid

Any of:

string

string format: uuid

null

null

version

Any of:

string

string

null

null

player_uuid

required

Player UUID

string format: uuid

device_info

Any of:

string

string

null

null

cursor

Any of:

string

string

null

null

filters

object

to_datetime

Any of:

Time Zone Aware Datetime

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

null

null

from_datetime

Any of:

Time Zone Aware Datetime

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

null

null

match_id

Any of:

string

string

null

null

region_id

Any of:

string

string

null

null

server_id

Any of:

string

string

null

null

allocation_id

Any of:

string

string

null

null

datacenter_provider

Any of:

string

string

null

null

datacenter_location

Any of:

string

string

null

null

machine_class

Any of:

string

string

null

null

address_ip

Any of:

string

string

null

null

map_name

Any of:

string

string

null

null

game_mode

Any of:

string

string

null

null

matchmaking_profile_id

Any of:

string

string

null

null

expected_team_size

Any of:

integer

integer

null

null

expected_player_count

Any of:

integer

integer

null

null

host_player_uuid

Any of:

string

string

null

null

owning_player_uuid

Any of:

string

string

null

null

version

Any of:

string

string

null

null

player_uuid

Any of:

string

string

null

null

device_info

Any of:

string

string

null

null

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

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