GET /grid/queue-depth
One number: how many capture items the whole grid has queued or in progress.
Syntax
GET https://grid-lab.zyxio.xyz/grid/queue-depth
x-api-key: <key>Request
| Name | Where | Required | Meaning |
|---|---|---|---|
x-api-key | header | yes, or Authorization | Your API key, or Authorization: Bearer <token> from Zyxio sign-in. |
Response
200 OK
| Field | Meaning |
|---|---|
depth | Capture items waiting, prioritised, delayed, active or paused, across the whole grid. |
The grid scales its capture workers on this number. It is useful to pace a large submission: wait while it is high.
Errors
| Status | Body | When | What to do |
|---|---|---|---|
401 | {"error": "unauthorized"} | No credential, or a key that is revoked, expired, wrong, or of a suspended account. | Send a valid key. |
503 | {"error": "accounting_unavailable"} | Your key or Zyxio sign-in could not be checked because the account database did not answer in time. Nothing was done. | Retry shortly; the same request is safe to resend. |
403 | {"error": "forbidden"} | A valid Zyxio sign-in token whose identity has no account here, or whose account is suspended. | Accept your invitation first, or use a key. |
Example
curl -s https://grid-lab.zyxio.xyz/grid/queue-depth -H "x-api-key: $BROWSERGRID_API_KEY"{"depth": 0}Billing
Free.