Fetches the status of a configured waiting room. Response fields include: 1. `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. 2. `event_id`: String of the current event's `id` if an event is active, otherwise an empty string. 3. `estimated_queued_users`: Integer of the estimated number of users currently waiting in the queue. 4. `estimated_total_active_users`: Integer of the estimated number of users currently active on the origin. 5. `max_estimated_time_minutes`: Integer of the maximum estimated time currently presented to the users.
/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/status
get
Waiting Room
waiting-room-get-waiting-room-status
{
"business": true,
"enterprise": true,
"free": false,
"pro": false
}null[
{
"in": "path",
"name": "waiting_room_id",
"required": true,
"schema": {
"example": "699d98642c564d2e855e9661899b7252"
}
},
{
"in": "path",
"name": "zone_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"oneOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"estimated_queued_users": {
"type": "integer"
},
"estimated_total_active_users": {
"type": "integer"
},
"event_id": {
"example": "25756b2dfe6e378a06b033b670413757",
"type": "string"
},
"max_estimated_time_minutes": {
"type": "integer"
},
"status": {
"enum": [
"event_prequeueing",
"not_queueing",
"queueing"
],
"example": "queueing",
"type": "string"
}
},
"type": "object"
}
}
}
]
}
}
},
"description": "Get waiting room status response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"oneOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"estimated_queued_users": {
"type": "integer"
},
"estimated_total_active_users": {
"type": "integer"
},
"event_id": {
"example": "25756b2dfe6e378a06b033b670413757",
"type": "string"
},
"max_estimated_time_minutes": {
"type": "integer"
},
"status": {
"enum": [
"event_prequeueing",
"not_queueing",
"queueing"
],
"example": "queueing",
"type": "string"
}
},
"type": "object"
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Get waiting room status response failure"
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
}
]