These docs are for v0.0.1. Click to read the latest docs for v1.0.63.

Request Metrics

Create a callback 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 make a one-time callback to the URL provided 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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 6 and 6
^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account

Body Params
string
required
length ≤ 256

The unique id for the request. This id will be included in the callback and should be used to correlate the callback with the original request.

string
required
length ≤ 2048

The public (https) callback url to send the metrics.

matchQueue
object
required

The Match Queue defines the properties that are used in the matching of engagements against a pool of contact center agents.

Responses
202

Accepted a new metrics request.

Callback
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/problem+json