Sign In

games.namespaces.analytics.getAnalyticsMatchmakerLive

Description

Returns live information about all active lobbies for a given namespace.

Code Examples

curl -X GET 'https://api.rivet.gg/cloud/games/{game_id}/namespaces/{namespace_id}/analytics/matchmaker/live'

Request Parameters

game_id

required path parameter

namespace_id

required path parameter

Response Body

  • lobbies
    array of objects

    A list of analytics lobby summaries.

    • lobbies.lobby_id
      string
    • lobbies.lobby_group_id
      string
    • lobbies.lobby_group_name_id
      string

      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.region_id
      string
    • lobbies.create_ts
      string

      RFC3339 timestamp

    • lobbies.is_ready
      boolean

      Whether or not this lobby is ready.

    • lobbies.is_idle
      boolean

      Whether or not this lobby is idle.

    • lobbies.is_closed
      boolean

      Whether or not this lobby is in a closed state.

    • lobbies.is_outdated
      boolean

      Whether or not this lobby is outdated.

    • lobbies.max_players_normal
      number

      Unsigned 32 bit integer.

    • lobbies.max_players_direct
      number

      Unsigned 32 bit integer.

    • lobbies.max_players_party
      number

      Unsigned 32 bit integer.

    • lobbies.total_player_count
      number

      Unsigned 32 bit integer.

    • lobbies.registered_player_count
      number

      Unsigned 32 bit integer.