This article describes the RPA Queue functionality to get statistics for a queue.
For a full list of available functions, please read QUEUE functions.
Description
The Get queue statistics function returns metrics for a queue: the count of items grouped by status (new, inprogress, successful, failed). This is useful for monitoring queue health, building dashboards, or making decisions based on queue state.
Setting it up
To use the Get queue statistics function, follow these instructions:
{{popups:rpas/add:action=queue-stats}}
Once on a process map:
- Navigate to the process where you would like to add the function
- Click on the green button’s drop-down (right side of the green button labelled “Process”)
- On the menu that appears, click on the “+ Activity” item
- From here you can select the QUEUE Get queue statistics option
- Click "Add" once you are done
Input parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| Queue ID | Yes | Text | - | The ID of the queue, or a variable such as {queue_id} |
| Variable | Yes | Text | - | Variable to store the statistics |
Output variables
| Variable | Type | Description |
|---|---|---|
| Variable | Array | Array of {status, count} records showing item counts per status |
Tips
- Use this to check if a queue has pending items before starting a performer process
- Monitor queue health by checking the ratio of successful to failed items