---
title: "Retrieve engine queue statistics"
method: GET
path: "/api/v1/engines/{engineID}/queue_stats"
tags: ["Engine"]
---

# Retrieve engine queue statistics

`GET /api/v1/engines/{engineID}/queue_stats`

Get queue statistics for an engine. Related queues may be sideloaded.

## Path parameters

- `engineID` integer, required

## Query parameters

- `page_size` integer
- `cursor` string
- `sideload` 'queues'

## Response `200`

OK

- object
  - `pagination` Pagination, required
    - `next` string, uri, nullable — URL for the next page of results. Contains an opaque signed `cursor` query parameter. Use this URL directly to fetch the next page — do not attempt to construct or modify the cursor value.
    - `previous` string, uri, nullable — URL for the previous page of results. Contains an opaque signed `cursor` query parameter. Use this URL directly to fetch the previous page — do not attempt to construct or modify the cursor value.
  - `results` QueueStats[], required
    - `url` string, uri — URL of the queue.
    - `number_of_used_engine_fields` integer — Number of engine fields used in the queue schema overlapping with engine fields of given engine.
    - `prediction_queue` boolean — Queue is using given engine for its predictions.
    - `training_queue` boolean — Queue is used for training of the given engine.

## Other responses

- `400` — Invalid input data.
- `401` — The username/password is invalid or token is invalid (e.g. expired).
- `403` — Insufficient permission, missing authentication, invalid CSRF token and similar issue.
- `404` — The specified resource was not found.
- `409` — Conflict
- `429` — Request rate is too high, wait before sending more requests. See [Rate Limiting](/guides/overview#rate-limiting) for more details.
- `500` — Server failure while processing the request.
- `502` — Invalid response from the upstream server.
- `503` — We're temporarily offline for maintenance. Please try again later.
- `504` — Upstream server could not complete the request in time.

---

[API](https://skmtc.dev/rossum/apis/rossum-api.md) · [All operations](https://skmtc.dev/rossum/apis/rossum-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rossum/rossum-api/revisions/f1b5a910991d/schema)
