Skip to content

Get Session Events

GET
/session/v1/session/{session_id}/event

Get all events for the session. Empty list means there is no event history for it.

Required Permissions:

  • For any player (including themselves) any of: session:read-player:any, session:read:event, session:*

Required Session Permissions: None

Authorizations

Parameters

Path Parameters

session_id
required
string
>= 1 characters <= 128 characters

Query Parameters

page_num
integer
page_size
integer
default: 50 >= 1 <= 50

Responses

200

Successful Response

A list of events that occurred in a session

object
events

A list of the events that have occurred in a given session

Array<object>
default:

Information about an event that occurred in a session

object
event_code
required

Code that identifies this type of event. See CommonEventCode for common examples.

string
>= 1 characters <= 256 characters
description

Description metadata about the event

string
"" <= 4096 characters
source_player_id

Player who triggered the event

integer
source_player_uuid

Player who triggered the event

string format: uuid
target_player_id

Player who the event was targetted toward, if relevant

integer
target_player_uuid

Player who the event was targetted toward, if relevant

string format: uuid
instance

Instance that was active at the time of the event

string
>= 1 characters <= 128 characters
match

Match that was active at the time of the event

string
platform

Relevant platform

string
Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch
platform_session_id_base64

Relevant platform session id

string
>= 1 characters <= 4096 characters
custom_data

Custom data about this event

object
key
additional properties
string
>= 1 characters <= 4096 characters
timestamp
required

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

string format: date-time

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