games.namespaces.analytics.getAnalyticsMatchmakerLive
Description
Returns live information about all active lobbies for a given namespace.
Code Examples
Request
curl -X GET 'https://api.rivet.gg/cloud/games/{game_id}/namespaces/{namespace_id}/analytics/matchmaker/live'
Request Parameters
game_id
Path parameter, required
namespace_id
Path parameter, required
Response Body
lobbies
array<object> (required)
A list of analytics lobby summaries.
lobbies[*].create_ts
string (required)
RFC3339 timestamp.
lobbies[*].is_closed
boolean (required)
Whether or not this lobby is in a closed state.
lobbies[*].is_idle
boolean (required)
Whether or not this lobby is idle.
lobbies[*].is_outdated
boolean (required)
Whether or not this lobby is outdated.
lobbies[*].is_ready
boolean (required)
Whether or not this lobby is ready.
lobbies[*].lobby_group_id
string (required)
lobbies[*].lobby_group_name_id
string (required)
A human readable short identifier used to references resources. Different than a rivet.common#Uuid because this is intended to be human readable. Different than rivet.common#DisplayName because this should not include special characters and be short.
lobbies[*].lobby_id
string (required)
lobbies[*].max_players_direct
integer (required)
Unsigned 32 bit integer.
lobbies[*].max_players_normal
integer (required)
Unsigned 32 bit integer.
lobbies[*].max_players_party
integer (required)
Unsigned 32 bit integer.
lobbies[*].region_id
string (required)
lobbies[*].registered_player_count
integer (required)
Unsigned 32 bit integer.
lobbies[*].total_player_count
integer (required)
Unsigned 32 bit integer.