Lobby Population

POST

/server/v1/lobby/population

const url = 'https://example.com/server/v1/lobby/population';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"players":0,"queueing":1,"held":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/server/v1/lobby/population \
  --header 'Content-Type: application/json' \
  --data '{ "players": 0, "queueing": 1, "held": 1 }'

How many are in this lobby right now, once per heartbeat.

Body: players connected to the lobby and not on a match. queueing how many of those want a match. Optional. held how many the lobby is keeping out of the queue. Optional.

Optional counts are stored as absent rather than zero, so an older lobby that does not report them never reads as nobody wanting a match.

Request Body^required

application/json

LobbyPopulationReport

POST /lobby/population, once per lobby heartbeat.

queueing and held stay None when the lobby does not report them, rather than becoming zero: an older lobby that has never sent them must not read as nobody wanting a match.

object

players

Players

integer

queueing

Any of:

integer
null

integer

held

Any of:

integer
null

integer

Responses

200

Successful Response

application/json

Status

What a write answers. status says which of the two things happened, so a retried write can be told apart from a first one.

object

status

required

Status

string

matchId

Any of:

integer
null

integer

Example^generated

{
  "status": "example",
  "matchId": 1
}

Lobby Population

Request Bodyrequired

Responses

200

Examplegenerated

Request Body^required

Example^generated