class Aws::Connect::Types::GetMetricDataRequest

@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataRequest AWS API Documentation
@return [Integer]
The maximimum number of results to return per page.
@!attribute [rw] max_results
@return [String]
results.
previous response in the next request to retrieve the next set of
The token for the next set of results. Use the value returned in the
@!attribute [rw] next_token
@return [Array<Types::HistoricalMetric>]
120, 180, 240, 300, 600
following service level thresholds: 15, 20, 25, 30, 45, 60, 90,
Threshold: Only “Less than” comparisons are supported, with the
Statistic: AVG
: Unit: PERCENT
SERVICE_LEVEL
Statistic: MAX
: Unit: SECONDS
QUEUED_TIME
Statistic: AVG
: Unit: SECONDS
QUEUE_ANSWER_TIME
Statistic: AVG
: Unit: PERCENT
OCCUPANCY
Statistic: AVG
: Unit: SECONDS
INTERACTION_TIME
Statistic: AVG
: Unit: SECONDS
INTERACTION_AND_HOLD_TIME
Statistic: AVG
: Unit: SECONDS
HOLD_TIME
Statistic: AVG
: Unit: SECONDS
HANDLE_TIME
Statistic: SUM
: Unit: COUNT
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
Statistic: SUM
: Unit: COUNT
CONTACTS_TRANSFERRED_OUT
Statistic: SUM
: Unit: COUNT
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
Statistic: SUM
: Unit: COUNT
CONTACTS_TRANSFERRED_IN
Statistic: SUM
: Unit: COUNT
CONTACTS_QUEUED
Statistic: SUM
: Unit: COUNT
CONTACTS_MISSED
Statistic: SUM
: Unit: COUNT
CONTACTS_HOLD_ABANDONS
Statistic: SUM
: Unit: COUNT
CONTACTS_HANDLED_OUTBOUND
Statistic: SUM
: Unit: COUNT
CONTACTS_HANDLED_INCOMING
Statistic: SUM
: Unit: COUNT
CONTACTS_HANDLED
Statistic: SUM
: Unit: COUNT
CONTACTS_CONSULTED
Statistic: SUM
: Unit: COUNT
CONTACTS_AGENT_HUNG_UP_FIRST
Statistic: SUM
: Unit: COUNT
CONTACTS_ABANDONED
Statistic: SUM
: Unit: COUNT
CALLBACK_CONTACTS_HANDLED
Statistic: SUM
: Unit: COUNT
API_CONTACTS_HANDLED
Statistic: AVG
: Unit: SECONDS
AFTER_CONTACT_WORK_TIME
Statistic: AVG
: Unit: SECONDS
ABANDON_TIME
each metric. The following historical metrics are available:
The metrics to retrieve. Specify the name, unit, and statistic for
@!attribute [rw] historical_metrics
@return [Array<String>]
returned.
If no grouping is specified, a summary of metrics for all queues is
The only supported grouping is ‘QUEUE`.
rather than aggregated for all queues.
queue. The values returned apply to the metrics for each queue
results are grouped by queue, the metrics returned are grouped by
The grouping applied to the metrics returned. For example, when
@!attribute [rw] groupings
@return [Types::Filters]
supported channel is `VOICE`.
both queue IDs and queue ARNs in the same request. The only
with the queues or channels included in the filter. You can include
returned. Metric data is retrieved only for the resources associated
The queues, up to 100, or channels, to use to filter the metrics
@!attribute [rw] filters
@return [Time]
hours.
The time range between the start and end time must be less than 24
timestamp.
11:00, 11:05, 11:10, and must be later than the start time
time must be specified using an interval of 5 minutes, such as
reporting interval for the retrieval of historical metrics data. The
The timestamp, in UNIX Epoch time format, at which to end the
@!attribute [rw] end_time
@return [Time]
the request. Historical metrics are available only for 24 hours.
The start time cannot be earlier than 24 hours before the time of
10:10, 10:15.
time must be specified using a multiple of 5 minutes, such as 10:05,
reporting interval for the retrieval of historical metrics data. The
The timestamp, in UNIX Epoch time format, at which to start the
@!attribute [rw] start_time
@return [String]
The identifier of the Amazon Connect instance.
@!attribute [rw] instance_id
}
max_results: 1,
next_token: “NextToken”,
],
},
unit: “SECONDS”, # accepts SECONDS, COUNT, PERCENT
statistic: “SUM”, # accepts SUM, MAX, AVG
},
threshold_value: 1.0,
comparison: “LT”, # accepts LT
threshold: {
name: “CONTACTS_QUEUED”, # accepts CONTACTS_QUEUED, CONTACTS_HANDLED, CONTACTS_ABANDONED, CONTACTS_CONSULTED, CONTACTS_AGENT_HUNG_UP_FIRST, CONTACTS_HANDLED_INCOMING, CONTACTS_HANDLED_OUTBOUND, CONTACTS_HOLD_ABANDONS, CONTACTS_TRANSFERRED_IN, CONTACTS_TRANSFERRED_OUT, CONTACTS_TRANSFERRED_IN_FROM_QUEUE, CONTACTS_TRANSFERRED_OUT_FROM_QUEUE, CONTACTS_MISSED, CALLBACK_CONTACTS_HANDLED, API_CONTACTS_HANDLED, OCCUPANCY, HANDLE_TIME, AFTER_CONTACT_WORK_TIME, QUEUED_TIME, ABANDON_TIME, QUEUE_ANSWER_TIME, HOLD_TIME, INTERACTION_TIME, INTERACTION_AND_HOLD_TIME, SERVICE_LEVEL
{
historical_metrics: [ # required
groupings: [“QUEUE”], # accepts QUEUE, CHANNEL
},
channels: [“VOICE”], # accepts VOICE
queues: [“QueueId”],
filters: { # required
end_time: Time.now, # required
start_time: Time.now, # required
instance_id: “InstanceId”, # required
{
data as a hash:
@note When making an API call, you may pass GetMetricDataRequest