Skip to content

Get spool stats

Last updated 

GET /spools/{spool}/stats

The spool-level rollup: queue count and message counts summed across every queue, with total being the cap-enforced count. Counts are a snapshot, not a live read.

Sample

sh
curl -X GET "$SPOOLER_API/spools/<spool>/stats" \
  -H "Authorization: Bearer $SPOOLER_KEY"

Parameters

NameInTypeRequiredDescription
spoolpathIdentName, 1–64 chars, ^[A-Za-z0-9_:-]+$yesThe spool name.

Responses

StatusDescription
200The spool's rollup.
400The request is malformed; the kind names the problem.
401The API key is missing or not recognized.
402The account is suspended.
403A plan limit refuses the operation; the kind names it.
404The spool or queue does not exist; the kind says which.
429The per-account request rate cap is exceeded; retry after the Retry-After delay.
503The spool is momentarily unavailable.

429 headers

HeaderDescription
Retry-AfterSeconds until the next request is admitted.