Job Router Operations - Get Queue Statistics
Retrieves a queue's statistics.
GET {endpoint}/routing/queues/{queueId}/statistics?api-version=2023-11-01URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
Uri of your Communication resource |
|
queue
|
path | True |
string |
Id of the queue to retrieve statistics. |
|
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
The request has succeeded. |
|
| Other Status Codes |
An unexpected error response. Headers x-ms-error-code: string |
Examples
Retrieves a queue's statistics
Sample request
GET https://contoso.westus.communications.azure.com/routing/queues/MainQueue/statistics?api-version=2023-11-01
Sample response
{
"queueId": "MainQueue",
"length": 5
}Definitions
| Name | Description |
|---|---|
|
Azure. |
The error object. |
|
Azure. |
A response containing error details. |
|
Azure. |
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
|
Router |
Statistics for the queue. |
Azure.Core.Foundations.Error
The error object.
| Name | Type | Description |
|---|---|---|
| code |
string |
One of a server-defined set of error codes. |
| details |
An array of details about specific errors that led to this reported error. |
|
| innererror |
An object containing more specific information than the current object about the error. |
|
| message |
string |
A human-readable representation of the error. |
| target |
string |
The target of the error. |
Azure.Core.Foundations.ErrorResponse
A response containing error details.
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
Azure.Core.Foundations.InnerError
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
| Name | Type | Description |
|---|---|---|
| code |
string |
One of a server-defined set of error codes. |
| innererror |
Inner error. |
RouterQueueStatistics
Statistics for the queue.
| Name | Type | Description |
|---|---|---|
| estimatedWaitTimeMinutes |
object |
The estimated wait time of this queue rounded up to the nearest minute, grouped by job priority. |
| length |
integer |
Length of the queue: total number of enqueued jobs. |
| longestJobWaitTimeMinutes |
number |
The wait time of the job that has been enqueued in this queue for the longest. |
| queueId |
string |
Id of the queue these details are about. |