Get waiting room status

Fetches the status of a configured waiting room. Response fields include:

status: String indicating the status of the waiting room. The possible status are:

not_queueing indicates that the configured thresholds have not been met and all users are going through to the origin.

queueing indicates that the thresholds have been met and some users are held in the waiting room.

event_prequeueing indicates that an event is active and is currently prequeueing users before it starts.

event_id: String of the current event's id if an event is active, otherwise an empty string.

estimated_queued_users: Integer of the estimated number of users currently waiting in the queue.

estimated_total_active_users: Integer of the estimated number of users currently active on the origin.

max_estimated_time_minutes: Integer of the maximum estimated time currently presented to the users.

Responses

🟢200Get waiting room status response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "estimated_queued_users": 0,
        "estimated_total_active_users": 0,
        "event_id": "25756b2dfe6e378a06b033b670413757",
        "max_estimated_time_minutes": 0,
        "status": "queueing"
    },
    "success": true
}

🟢200Get waiting room status response failure

Get waiting room status

Request

Request samples

Responses