Skip to main content
GET
/
api
/
queues
GET /api/queues
curl --request GET \
  --url https://app.sluice.sh/api/api/queues

Documentation Index

Fetch the complete documentation index at: https://docs.sluice.sh/llms.txt

Use this file to discover all available pages before exploring further.

Returns a paginated list of queues with real-time metrics and health bar data.

Authentication

Session cookie (dashboard).

Query parameters

ParameterTypeDefaultDescription
pageinteger1Page number (1-indexed).
limitinteger50Results per page (1–100).
connectionIdstringFilter by connection UUID.
frameworkstringFilter by framework: celery, bullmq, sidekiq.
sortBystringnameSort field: name, depth, consumers, throughput, failureRate.
sortOrderstringascSort direction: asc or desc.
timeRangestring24hTime range for metrics: 1h, 6h, 24h, 7d.

Response

{
  "data": [
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "name": "default",
      "framework": "celery",
      "connectionId": "550e8400-e29b-41d4-a716-446655440000",
      "depth": 42,
      "consumers": 4,
      "throughput": 12.5,
      "avgLatencyMs": 340.0,
      "failureRate": 0.02,
      "healthBar": {
        "timeRange": "24h",
        "buckets": [
          {
            "start": "2026-02-26T10:00:00.000Z",
            "end": "2026-02-26T11:00:00.000Z",
            "succeeded": 450,
            "failed": 3
          }
        ]
      },
      "extensions": {},
      "createdAt": "2026-02-20T08:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 3,
    "totalPages": 1
  }
}

Queue fields

FieldTypeDescription
idstringSluice-generated UUID.
namestringQueue name (e.g., default, payments, notifications).
frameworkstringAlways celery in V0.
connectionIdstringConnection this queue belongs to.
depthintegerCurrent number of pending jobs in the queue.
consumersintegerNumber of workers consuming from this queue.
throughputnumber?Jobs per second over the selected time range.
avgLatencyMsnumber?Average time a job waits in the queue before execution, in milliseconds.
failureRatenumber?Ratio of failed jobs to total jobs (0.0–1.0) over the selected time range.
healthBarobject?Time-bucketed success/failure counts for the health bar visualization.
extensionsobjectFramework-specific data.
createdAtstringISO 8601 — when this queue was first seen.