Get online users count

Get online users count returns the current online users metric for the application. This operation is available only after successful Initialize.

Request

Get online users count uses packet type = 10.

{
  "type": 10,
  "id": 11
}

Prop

Type

{
  "id": 11,
  "online_users_count": 100,
  "status": 1
}

Prop

Type

Request and response are regular text JSON websocket frames.
This operation does not require an authorized user/license session; initialized session is enough.
If application currently has no connected sessions, server returns online_users_count = 0 with Ok.
On non-OK statuses, online_users_count is omitted.

Status	Constant	Returned when
`1`	`Ok`	Count returned successfully.
`6`	`InternalServerError`	Server failed to read connected sessions count due to an internal error.

Get online users count itself returns regular JSON responses, but session can still be closed by protocol/session guards:

Close code	Error	When it happens
`4200`	`connection is not initialized`	Request was sent before successful `Initialize`.
`4201`	`rate limit hit`	Global per-session packet rate limit was exceeded.
`4302`	`invalid request body`	Packet body does not match the required schema for this operation.
`4304`	`received unsupported data`	Client sent unsupported frame type (request packets must be text JSON).