Request Metrics
GET https://{{axpAPIDomain}}/api/queue-metrics/v1/accounts/:accountId/queues/:queueId/channels/:channelId/metrics?attributes=Language.English&priority=3
Request to obtain metrics for a match queue.
The client will send a request for metrics for the specified queue, channel, attributes and priority, upon successful calculation of the metrics the server will respond back with a list of the calculated queue metrics.
Queue metrics are statistical measures related to the operation of a contact center queue. These metrics include measures related to engagements that are queued, and to the agents that staff the queue.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
attributes | string | Attributes are used to describe the skills of the agents. A max of 10 attributes per queue are allowed, and the Attribute format must follow the 'X.X' style, for example 'CategoryName.AttributeName'. Engagements are typically routed to a suitable agent that shares the same attribute combination that make up a queue. Queue metrics results for queues with attributes may be less favorable than queue metrics without attributes, as only a subset of the agent pool may be configured to handle requests with the additional attributes. | |
priority | number | The priority of this queue request. The smaller the number meaning the higher the priority. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
appkey | string | ||
Accept | string |
RESPONSES
status: OK
{"accountId":"ABCDEF","matchQueue":{"queueId":"bea76b16-5aff-4cd6-8db0-5d8d649dd865","channelId":"Voice","attributes":["Language.English","Product.Landline"],"priority":3},"metricType":"DEFAULT","metrics":[{"metricName":"agentStaffedCount","metricValue":"0"},{"metricName":"agentReadyCount","metricValue":"0"},{"metricName":"agentBusyCount","metricValue":"0"},{"metricName":"waitingEngagementCount","metricValue":"0"},{"metricName":"processingEngagementCount","metricValue":"0"},{"metricName":"oldestEngagementWaiting","metricValue":"0"},{"metricName":"rollingASA","metricValue":"0"},{"metricName":"queueOccupancy","metricValue":"0"},{"metricName":"expectedWaitTime","metricValue":"9999"}]}