Skip to main content
GET
Get Queue

Permissions

Requires a service user or personal access token with the ViewAccountMetrics permission at the enterprise level.

Queue Size

queue_size counts sessions across all active organizations in your enterprise that are in a queued state (new, resuming, or claimed) and were created in the last 30 days.
Queued sessions created more than 30 days ago are not included in queue_size, so they do not affect status. Don’t rely on this endpoint alone to detect sessions that have been stuck in the queue for longer than 30 days.

Status Thresholds

The status field indicates the current queue pressure based on queue_size:

Authorizations

Authorization
string
header
required

Service User credential (prefix: cog_)

Response

Successful Response

Response model for queue endpoint.

queue_size
integer
required
status
enum<string>
required
Available options:
normal,
elevated,
high