Skip to main content
GET
Get async queue status

Overview

This endpoint provides real-time visibility into your organization’s async task queue and processing capacity. Use it to:
  • Monitor queue health: Track how many tasks are waiting to be processed
  • Understand processing capacity: See current concurrency usage versus your plan limit
  • Debug delays: Identify if tasks are queued due to high volume or concurrency limits
  • Plan capacity: Decide whether to upgrade your plan based on actual usage
The response includes four key metrics:
  • queuedTasks: Number of tasks currently waiting in the queue (status: QUEUED)
  • processingTasks: Number of tasks actively being processed (status: PROCESSING)
  • priorityBreakdown: Queued task counts per priority level, so you can see how your queue is distributed across priorities
  • concurrency: Current concurrency slot usage compared to your plan’s maximum

Response fields

The concurrency object may be null if concurrency information cannot be retrieved at the time of the request. This is rare but can occur during system maintenance.

Example usage

Check current queue status

Monitor queue status programmatically

Use cases

Capacity planning

Monitor concurrency usage patterns to determine if you need to upgrade your plan:

Queue health monitoring

Track queue size to detect processing bottlenecks or high-volume periods:

Throttling task submission

Adjust your task submission rate based on current queue status:

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful response with queue metrics.

queuedTasks
integer
required

Number of tasks currently queued for this organization.

Example:

3

processingTasks
integer
required

Number of tasks currently being processed for this organization.

Example:

2

priorityBreakdown
object[]
required

Queued task counts per priority level, ordered by priority descending. Only includes priority levels that have queued tasks.

concurrency
object | null

Current concurrency usage. Null if unable to retrieve concurrency information.