Request Metrics

get

{protocol}://{server}{basePath}/accounts/{accountId}/queues/{queueId}/channels/{channelId}/metrics

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account

queueId

string

required

length between 36 and 36

^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

The unique uuid of the queue. Only valid Contact Center Queue Id's are accepted

channelId

string

required

length between 3 and 256

The id representing the Contact Center Channel. Only valid Contact Center Channel Id's are accepted. See Channel page in CCaaS Fundamentals section of Developer Guides for a list of supported Channel Id's.

Query Params

attributes

array of strings

length between 0 and 10

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.

attributes

priority

int32

1 to 10

The priority of this queue request. The smaller the number meaning the higher the priority.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses