class Aws::Connect::Types::GetMetricDataRequest

@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataRequest AWS API Documentation
@return [Integer]
response, between 1-100.
Indicates the maximum number of results to return per page in the
@!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
Statistics: AVG
: Unit: PERCENT
SERVICE_LEVEL
Statistics: AVG
: Unit: SECONDS
INTERACTION_AND_HOLD_TIME
Statistics: AVG
: Unit: SECONDS
INTERACTION_TIME
Statistics: AVG
: Unit: SECONDS
HOLD_TIME
Statistics: AVG
: Unit: SECONDS
QUEUE_ANSWER_TIME
Statistics: SUM
: Unit: COUNT
ABANDON_TIME
Statistics: MAX
: Unit: SECONDS
QUEUED_TIME
Statistics: AVG
: Unit: SECONDS
AFTER_CONTACT_WORK_TIME
Statistics: AVG
: Unit: SECONDS
HANDLE_TIME
Statistics: AVG
: Unit: PERCENT
OCCUPANCY
Statistics: SUM
: Unit: COUNT
CONTACTS_MISSED
Statistics: SUM
: Unit: COUNT
API_CONTACTS_HANDLED
Statistics: SUM
: Unit: COUNT
CALLBACK_CONTACTS_HANDLED
Statistics: SUM
: Unit: COUNT
CALLBACK_CONTACTS_HANDLED
Statistics: SUM
: Unit: COUNT
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
Statistics: SUM
: Unit: COUNT
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
Statistics: SUM
: Unit: COUNT
CONTACTS_TRANSFERRED_OUT
Statistics: SUM
: Unit: COUNT
CONTACTS_TRANSFERRED_IN
Statistics: SUM
: Unit: COUNT
CONTACTS_HOLD_ABANDONS
Statistics: SUM
: Unit: COUNT
CONTACTS_HANDLED_OUTBOUND
Statistics: SUM
: Unit: COUNT
CONTACTS_HANDLED_INCOMING
Statistics: SUM
: Unit: COUNT
CONTACTS_AGENT_HUNG_UP_FIRST
Statistics: SUM
: Unit: COUNT
CONTACTS_CONSULTED
Statistics: SUM
: Unit: COUNT
CONTACTS_ABANDONED
Statistics: SUM
: Unit: COUNT
CONTACTS_HANDLED
Statistic: SUM
: Unit: COUNT
CONTACTS_QUEUED
The following historical metrics are available:
a ‘Unit` and a `Statistic`.
each historical metric you include in the request, you must include
You must list each metric to retrieve data for in the request. For
`Statistic`, `Threshold`, and `Unit`.
A `HistoricalMetric` object contains: `HistoricalMetricName`,
retrieve with the request.
A list of `HistoricalMetric` objects that contain the metrics to
@!attribute [rw] historical_metrics
@return [Array<String>]
`HistoricalMetrics` for all queues is returned.
If no `Grouping` is included in the request, a summary of
The current version supports grouping by Queue
rather than aggregated for all queues.
queue. The values returned apply to the metrics for each queue
results are grouped by queueId, the metrics returned are grouped by
The grouping applied to the metrics returned. For example, when
@!attribute [rw] groupings
@return [Types::Filters]
’queue/‘.
The queue ID is also included in the URL, and is the string after
`arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61`.
the set of characters at the end of the URL, after ’id=‘ such as
the address bar as part of the URL. For example, the queue ARN is
Amazon Connect Queue editor. The ARN for the queue is displayed in
To find the ARN for a queue, open the queue you want to use in the
VOICE is supported for Channel.
filter. You can use both IDs and ARNs together in a request. Only
resources associated with the IDs, ARNs, or Channels included in the
returned in the response. Metric data is retrieved only for the
up to 100, or a list of Channels to use to filter the metrics
A `Filters` object that contains a list of queue IDs or queue ARNs,
@!attribute [rw] filters
@return [Time]
24 hours.
The time range between `StartTime` and `EndTime` must be less than
timestamp.
11:00, 11:05, 11:10, and must be later than the `StartTime`
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]
24 hours.
request. Historical metrics are available in Amazon Connect only for
`StartTime` cannot be earlier than 24 hours before the time of the
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]
10a4c4eb-f57e-4d4c-b602-bf39176ced07.
the end of the instance ARN, after instance/, such as
settings. For example, the instance ID is the set of characters at
instance ID is displayed in the Overview section of your instance
Select the alias of the instance in the Instance alias column. The
your instance, open the AWS console and select Amazon Connect.
The identifier for your Amazon Connect instance. To find the ID of
@!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