Get All Pex Host Scores By Filter

GET 
/match/v1/pex/host/score

Get pages of PEX host scores based on provided filters

Required Permissions:

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

Request

Query Parameters

cursor any
page_size any

The maximum number of elements to be returned per call

to_datetime any
from_datetime any
match_id any
region_id any
server_id any
allocation_id any
datacenter_provider any
datacenter_location any
machine_class any
address_ip any
map_name any
game_mode any
matchmaking_profile_id any
expected_team_size any
expected_player_count any
host_player_uuid any
owning_player_uuid any
version any
platform_id any

Responses

200

Successful Response

application/json

Schema

Schema

results

object[]

List of PEX reports for this match

Array [

created_timestamp date-time

Timestamp of when the resource was created

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

connection_count

object

Connection 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

total_unique_players

object

Total players

anyOf

PexCount

count

object

Count of values

anyOf

MOD1

number

scores

object

Scores

anyOf

PexHostScores

overall_match_score

object

Overall match score

anyOf

MOD1

boolean

app_score

object

App game score

anyOf

MOD1

boolean

gameplay_score

object

Gameplay score

anyOf

MOD1

boolean

network_score

object

Network score

anyOf

MOD1

boolean

connection_count_score

object

Connection count score

anyOf

MOD1

boolean

frame_time_score

object

Frame time score

anyOf

MOD1

boolean

delta_time_score

object

Delta time score

anyOf

MOD1

boolean

tick_count_score

object

Tick count score

anyOf

MOD1

boolean

delayed_tick_count_score

object

Delayed tick count score

anyOf

MOD1

boolean

memory_ws_score

object

Memory working set score

anyOf

MOD1

boolean

memory_vb_score

object

Memory video buffer score

anyOf

MOD1

boolean

cpu_process_score

object

CPU process score

anyOf

MOD1

boolean

ping_score

object

Ping score

anyOf

MOD1

boolean

in_packet_loss_score

object

In packet loss score

anyOf

MOD1

boolean

out_packet_loss_score

object

Out packet loss score

anyOf

MOD1

boolean

total_disconnects_score

object

Total disconnects score

anyOf

MOD1

boolean

total_unique_players_score

object

Total players score

anyOf

MOD1

boolean

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

machine_class

object

Machine class

anyOf

MOD1

string

]

cursor

object

Base64 encoded json that contains the filters and cursor position

anyOf

MOD1

string

filters

object

to_datetime

object

To datetime

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

from_datetime

object

From datetime

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

match_id

object

Match ID

anyOf

MOD1

string

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

machine_class

object

Machine class

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

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]

Example (from schema)

{
  "results": [
    {
      "created_timestamp": "2023-01-23T21:07:02.000000+00:00",
      "frame_time": {},
      "delta_time": {},
      "tick_count": {},
      "delayed_tick_count": {},
      "memory_ws": {},
      "memory_vb": {},
      "cpu_process": {},
      "ping": {},
      "in_packets": {},
      "out_packets": {},
      "total_packets": {},
      "in_packet_loss": {},
      "out_packet_loss": {},
      "total_packet_loss": {},
      "in_packet_loss_pct": {},
      "out_packet_loss_pct": {},
      "total_packet_loss_pct": {},
      "total_disconnects": {},
      "match_duration": {},
      "connection_count": {},
      "total_unique_players": {},
      "scores": {},
      "match_id": "string",
      "region_id": "string",
      "server_id": "string",
      "allocation_id": "string",
      "datacenter_provider": "string",
      "datacenter_location": "string",
      "address_ip": "string",
      "map_name": "string",
      "game_mode": "string",
      "matchmaking_profile_id": "string",
      "expected_team_size": 0,
      "expected_player_count": 0,
      "host_player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "owning_player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "version": "string",
      "device_info": "string",
      "platform_id": "Anon",
      "custom_data": {},
      "machine_class": "string"
    }
  ],
  "cursor": "string",
  "filters": {
    "to_datetime": "2023-01-23T21:07:02.000000+00:00",
    "from_datetime": "2023-01-23T21:07:02.000000+00:00",
    "match_id": "string",
    "region_id": "string",
    "server_id": "string",
    "allocation_id": "string",
    "datacenter_provider": "string",
    "datacenter_location": "string",
    "machine_class": "string",
    "address_ip": "string",
    "map_name": "string",
    "game_mode": "string",
    "matchmaking_profile_id": "string",
    "expected_team_size": 0,
    "expected_player_count": 0,
    "host_player_uuid": "string",
    "owning_player_uuid": "string",
    "version": "string",
    "platform_id": "Anon"
  }
}

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