Skip to content
RallyHere Docs

Create Session Audit

POST
/session/v1/audit

Create an audit event in the log for this session. Internal session operations will create new events that are accessible from the get request.

Player clients and instances are expected to create events here when something occurs on their clients that is relevant. Customer created events will be prepended with ‘customer.’

Required Permissions:

  • For any player (including themselves) any of: session-audit:update:all, session:*

Required Permissions:

  • For any player (including themselves) any of: session-audit:update:self, session:*

for sessions you are a member of

Required Permissions:

  • For any player (including themselves) any of: session-player-audit:update:all, session:*

to read audit information about any player

Required Permissions:

  • For any player (including themselves) any of: session-player-audit:update:self, session:*

to read audit information about yourself

Authorizations

Request Body required

object
event_name
required

Name of the audit event you are creating. Customer created events will be prepended with ‘customer.’

string
>= 1 characters <= 128 characters
session_id
required

ID of the session this event occurred in

string
>= 1 characters <= 128 characters
custom_data

Custom data for this audit request

object
key
additional properties
string
>= 1 characters <= 4096 characters
session_type

Type of the session this event occurred in

string
region_id

Region ID for this event

string
>= 1 characters <= 128 characters
joinable

Whether or not the session is publicly joinable

boolean
updated_teams

Updated team numbers and sizes

Array<object>
<= 50 items

An update to a specific team’s number of max players

object
max_size

Maximum number of players for this team

integer
>= 1 <= 100
custom_data

Custom data about this team

object
key
additional properties
string
>= 1 characters <= 4096 characters
source

The source of an invite

string
Allowed values: BACKFILL MATCHMAKING PLAYER
player_uuid

UUID of a specific player being effected in this event

string format: uuid
team_id

ID of the team being effected in this event

integer
invited_session_id

ID of the session being invited in this event

string
>= 1 characters <= 128 characters
removed_session_id

ID of the session being removed in this event

string
>= 1 characters <= 128 characters
version

Version updated in this event

string
client_settings

Client settings updated as part of this event

object
platform_id

DEPRECATED. Use ‘platform’ instead. Id for which platform this client is on. ID will be ignored if ‘platform’ is given. At least one of the two is required

integer
platform

Which platform this client is on. If one is not provided, will get the platform from the ‘platform_id’. At least one of the two is required

string
Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch RallyHere LegacyName
input
required

Which input type this client is using

string
Allowed values: keyboardandmouse gamepad touch
crossplay_preferences

Crossplay preferences updated as part of this event

object
permitted_platform
required

The platform type that the client is allowed to play with (any, xbox-like only, playstation-like only etc.)

string
Allowed values: desired_platforms_any desired_platforms_xboxlike desired_platforms_playstationlike
permitted_input
required

The input type that the client is allowed to play with (keyboard and mouse, gamepad, touch input etc.)

string
Allowed values: desired_inputs_any desired_inputs_keyboardandmouse desired_inputs_gamepad desired_inputs_touch
player_status

Player’s status updated as part of this event

string
Allowed values: leader member invited reserved
platform

Platform updated as part of this event

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

ID of the platform session being effected in this event

string
>= 1 characters <= 4096 characters
instance_id

ID of the instance being effected in this event

string
>= 1 characters <= 128 characters
host_type

Type of the host being effected in this event

string
Allowed values: dedicated player preallocated
host_player_uuid

UUID of the player hosting during this event

string format: uuid
instance_request_template

ID of the instance request template being used in this event

string format: uuid
map

Map being used in this event

string
mode

Mode being used in this event

string
allocation_id

Allocation ID of instance in this event

string
>= 1 characters <= 128 characters
join_status

Instance’s joinability status

string
Allowed values: requested allocated pending joinable unjoinable closed
join_params

Instance’s join parameters for this event

object
public_conn_str
required

Public connection string for instance

string
private_conn_str
required

Private connection string for instance

string
custom_data

Custom data to join a instance

object
key
additional properties
string
>= 1 characters <= 4096 characters
instance_health

Instance’s health status for this event

string
Allowed values: healthy unhealthy degraded unknown
queue_id

ID for the queue in this event

string
>= 1 characters <= 128 characters
ticket_id

Matchmaking ticket id in this event

string
additional_params

Additional matchmaking parameters in this event

object
double_args

Additional double arguments to add to the matchmaking ticket

object
key
additional properties
number
string_args

Additional string arguments to add to the matchmaking ticket

object
key
additional properties
string
>= 1 characters <= 4096 characters
tags

Additional tags to add to the matchmaking ticket

Array<string>
default:
extensions

Additional extensions to add to the matchmaking ticket. Value is a base64 string representation of the protobuf binary data. The data will be converted back to binary before being put on the ticket

object
key
additional properties
string
>= 1 characters <= 4096 characters
map_preferences

Map preferences in this event

Array<string>
queued_session_id

ID of the session that was/is in a matchmaking queue for this event

string
>= 1 characters <= 128 characters
match_id

ID of a match that was associated with this session

string
>= 1 characters <= 128 characters
players

List of players uuids that were effected in this event. Each player will get a unique event

Array<string>

Responses

200

Successful Response

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Session doesn’t exist. See error code for more info

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