GET /api/admin/queues Returns job count statistics for the background processing queues. Use this to monitor the health and backlog of the campaign delivery system.

Headers

appid
string
required
Your CometChat App ID.
apikey
string
required
Your CometChat API Key.

Example request

curl https://{appId}.api-{region}.cometchat.io/v3/business-messaging/api/admin/queues \
  -H "appid: YOUR_APP_ID" \
  -H "apikey: YOUR_API_KEY"

Example response

{
  "queues": [
    {
      "name": "campaign-orchestrator",
      "waiting": 2,
      "active": 1,
      "completed": 150,
      "failed": 3
    },
    {
      "name": "campaign-batch",
      "waiting": 10,
      "active": 5,
      "completed": 1200,
      "failed": 8
    }
  ]
}

Response fields

queues
object[]
Array of queue statistics.
queues[].name
string
Queue name: campaign-orchestrator or campaign-batch.
queues[].waiting
integer
Number of jobs waiting to be processed.
queues[].active
integer
Number of jobs currently being processed.
queues[].completed
integer
Number of successfully completed jobs.
queues[].failed
integer
Number of failed jobs.
The campaign-orchestrator queue handles campaign-level coordination (splitting into batches), while campaign-batch handles individual batch delivery jobs.