games.namespaces.analytics.getAnalyticsMatchmakerLive
Description
Returns live information about all active lobbies for a given namespace.
Code Examples
Request
GET
https://api.rivet.gg/cloud/games/{game_id}/namespaces/{namespace_id}/analytics/matchmaker/livecurl -X GET 'https://api.rivet.gg/cloud/games/{game_id}/namespaces/{namespace_id}/analytics/matchmaker/live'
Request Parameters
game_id
required path parameternamespace_id
required path parameterResponse Body
lobbies
required array<object>A list of analytics lobby summaries.
lobbies[*]
objectAnalytical information about a lobby.
create_ts
required stringRFC3339 timestamp
is_closed
required booleanWhether or not this lobby is in a closed state.
is_idle
required booleanWhether or not this lobby is idle.
is_outdated
required booleanWhether or not this lobby is outdated.
is_ready
required booleanWhether or not this lobby is ready.
lobby_group_id
required stringlobby_group_name_id
required stringA 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.
lobby_id
required stringmax_players_direct
required integerUnsigned 32 bit integer.
max_players_normal
required integerUnsigned 32 bit integer.
max_players_party
required integerUnsigned 32 bit integer.
region_id
required stringregistered_player_count
required integerUnsigned 32 bit integer.
total_player_count
required integerUnsigned 32 bit integer.