Skip to main content

GetNamespaceAnalyticsMatchmakerLive​

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

Path Parameters
  • game_id string required

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    A universally unique identifier.

  • namespace_id string required

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    A universally unique identifier.

Responses

GetNamespaceAnalyticsMatchmakerLive 200 response

Schema
  • lobbies object[] required

    A list of analytics lobby summaries.

    • lobby_id string required

      Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

      A universally unique identifier.

    • lobby_group_id string required

      Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

      A universally unique identifier.

    • lobby_group_name_id string required

      Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[a-zA-Z0-9](?:[a-zA-Z0-9]-?)+[a-zA-Z0-9]$

      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.

    • region_id string required

      Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

      A universally unique identifier.

    • create_ts date-time required

      RFC3339 timestamp.

    • is_ready boolean required

      Whether or not this lobby is ready.

    • is_idle boolean required

      Whether or not this lobby is idle.

    • is_closed boolean required

      Whether or not this lobby is in a closed state.

    • is_outdated boolean required

      Whether or not this lobby is outdated.

    • max_players_normal int32 required

      Unsigned 32 bit integer.

    • max_players_direct int32 required

      Unsigned 32 bit integer.

    • max_players_party int32 required

      Unsigned 32 bit integer.

    • total_player_count int32 required

      Unsigned 32 bit integer.

    • registered_player_count int32 required

      Unsigned 32 bit integer.