CheckMetricData

A shortcut single action to avoid using GetMetricData and Compare for a set of simple metrics. This action loads the specified metric data for the specified queue, and allows comparisons to the loaded value. For example, it loads number of contacts in queue, age of oldest contact in queue, number of agents staffed on the queue, number of agents available on the queue, or number of agents online on the queue.

Parameter object

{
  "MetricType": One of [NumberOfAgentsAvailable, NumberOfAgentsStaffed, NumberOfAgentsOnline, OldestContactInQueueAgeSeconds, NumberOfContactsInQueue]. **Dynamic values are not supported**,
  "QueueId": [Optional] A queue ID or queue ARN. If AgentId is specified, this may not be specified. *Dynamic values are supported*,
  "AgentId": [Optional] An agent ID or agent ARN, representing an agent queue. If QueueId is specified, this may not be specified. *Dynamic values are supported*. If neither this nor QueueId are specified, the contact TargetQueue is used
} 

Execution results and conditions

A number, representing the value of the metric that was requested. This can be used for conditions. If the MetricType is NumberOfAgents* then the only supported condition is "NumberGreaterThan 0", otherwise Equals and any Number* Operands are allowed.

Errors

Restrictions

This action is only usable in flows, queue and agent transfers, and customer queue flows. It is not available in any type of whisper or hold flows.

Corresponding block in the UI