class Aws::Connect::Types::GetMetricDataV2Request

@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataV2Request AWS API Documentation
@return [Integer]
The maximum 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::MetricV2>]<br>: docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region<br>[1]: docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html<br><br><br><br>Valid groupings and filters: Queue, Channel, Routing Profile
: Unit: Count
SUM_RETRY_CALLBACK_ATTEMPTS
Valid groupings and filters: Queue, Channel, Routing Profile
Unit: Count
: Valid metric filter key: ‘DISCONNECT_REASON`
SUM_CONTACTS_DISCONNECTED
`LT` (for “Less than”).
604800 (inclusive), in seconds. For `Comparison`, you must enter
Threshold: For `ThresholdValue`, enter any whole number from 1 to
Valid groupings and filters: Queue, Channel, Routing Profile
: Unit: Count
SUM_CONTACTS_ABANDONED_IN_X
`LT` (for “Less than”).
604800 (inclusive), in seconds. For `Comparison`, you must enter
Threshold: For `ThresholdValue`, enter any whole number from 1 to
Valid groupings and filters: Queue, Channel, Routing Profile
: Unit: Count
SUM_CONTACTS_ANSWERED_IN_X
`LT` (for “Less than”).
604800 (inclusive), in seconds. For `Comparison`, you must enter
Threshold: For `ThresholdValue`, enter any whole number from 1 to
Valid groupings and filters: Queue, Channel, Routing Profile
Unit: Percent
: You can include up to 20 SERVICE_LEVEL metrics in a request.
SERVICE_LEVEL
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
MAX_QUEUED_TIME
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
CONTACTS_TRANSFERRED_OUT_BY_AGENT
</note>
<note markdown=“1”> Feature is a valid filter but not a valid grouping.
Agent, Agent Hierarchy, Feature
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
CONTACTS_TRANSFERRED_OUT
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
CONTACTS_QUEUED
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
CONTACTS_HOLD_ABANDONS
</note>
<note markdown=“1”> Feature is a valid filter but not a valid grouping.
Agent, Agent Hierarchy, Feature
Valid groupings and filters: Queue, Channel, Routing Profile,
Valid metric filter key: `INITIATION_METHOD`, `DISCONNECT_REASON`
: Unit: Count
CONTACTS_HANDLED
</note>
<note markdown=“1”> Feature is a valid filter but not a valid grouping.
Feature
Valid groupings and filters: Queue, Channel, Routing Profile,
Valid metric filter key: `INITIATION_METHOD`
: Unit: Count
CONTACTS_CREATED
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
CONTACTS_ABANDONED
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
Unit: Seconds
Lens conversational analytics.
: This metric is available only for contacts analyzed by Contact
AVG_TALK_TIME_CUSTOMER
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
Unit: Seconds
Lens conversational analytics.
: This metric is available only for contacts analyzed by Contact
AVG_TALK_TIME_AGENT
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
Unit: Seconds
Lens conversational analytics.
: This metric is available only for contacts analyzed by Contact
AVG_TALK_TIME
</note>
<note markdown=“1”> Feature is a valid filter but not a valid grouping.
Feature
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_QUEUE_ANSWER_TIME
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
Unit: Seconds
Lens conversational analytics.
: This metric is available only for contacts analyzed by Contact
AVG_NON_TALK_TIME
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
Unit: Seconds
Lens conversational analytics.
: This metric is available only for contacts analyzed by Contact
AVG_INTERRUPTION_TIME_AGENT
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
Unit: Count
Lens conversational analytics.
: This metric is available only for contacts analyzed by Contact
AVG_INTERRUPTIONS_AGENT
</note>
<note markdown=“1”> Feature is a valid filter but not a valid grouping.
Feature
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_INTERACTION_TIME
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_INTERACTION_AND_HOLD_TIME
</note>
<note markdown=“1”> Feature is a valid filter but not a valid grouping.
Agent, Agent Hierarchy, Feature
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
AVG_HOLDS
</note>
<note markdown=“1”> Feature is a valid filter but not a valid grouping.
Agent, Agent Hierarchy, Feature
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_HOLD_TIME
</note>
<note markdown=“1”> Feature is a valid filter but not a valid grouping.
Agent, Agent Hierarchy, Feature
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_HANDLE_TIME
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
Unit: Seconds
Lens conversational analytics.
: This metric is available only for contacts analyzed by Contact
AVG_GREETING_TIME_AGENT
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_CONVERSATION_DURATION
</note>
<note markdown=“1”> Feature is a valid filter but not a valid grouping.
Agent, Agent Hierarchy, Feature
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_CONTACT_DURATION
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
`OUTBOUND` | `CALLBACK` | `API`
only supports the following as `INITIATION_METHOD`: `INBOUND` |
Valid metric filter key: `INITIATION_METHOD`. For now, this metric
: Unit: Seconds
AVG_AGENT_CONNECTING_TIME
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
`OUTBOUND` | `CALLBACK` | `API`
only supports the following as `INITIATION_METHOD`: `INBOUND` |
Valid metric filter key: `INITIATION_METHOD`. For now, this metric
: Unit: Seconds
AVG_AGENT_CONNECTING_TIME
</note>
<note markdown=“1”> Feature is a valid filter but not a valid grouping.
Agent, Agent Hierarchy, Feature
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_AFTER_CONTACT_WORK_TIME
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_ABANDON_TIME
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
Unit: Seconds
[Forecasting, capacity planning, and scheduling] is available.
: This metric is available only in Amazon Web Services Regions where
AGENT_SCHEDULED_TIME
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
Unit: Percent
[Forecasting, capacity planning, and scheduling] is available.
: This metric is available only in Amazon Web Services Regions where
AGENT_SCHEDULE_ADHERENCE
Hierarchy
Valid groupings and filters: Routing Profile, Agent, Agent
: Unit: Percentage
AGENT_OCCUPANCY
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
AGENT_NON_RESPONSE
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
Unit: Seconds
[Forecasting, capacity planning, and scheduling] is available.
: This metric is available only in Amazon Web Services Regions where<br><br>AGENT_ADHERENT_TIME<br><br>definitions] in the *Amazon Connect Administrator’s Guide*.
a description of each metric, see [Historical metrics
for each metric. The following historical metrics are available. For
The metrics to retrieve. Specify the name, groupings, and filters
@!attribute [rw] metrics
@return [Array<String>]
‘AGENT_HIERARCHY_LEVEL_FOUR` | `AGENT_HIERARCHY_LEVEL_FIVE`
`AGENT_HIERARCHY_LEVEL_TWO` | `AGENT_HIERARCHY_LEVEL_THREE` |
`CHANNEL` | `AGENT_HIERARCHY_LEVEL_ONE` |
Valid grouping keys: `QUEUE` | `ROUTING_PROFILE` | `AGENT` |
If no grouping is specified, a summary of all metrics is returned.
queue. They are not aggregated for all queues.
by queue. The values that are returned apply to the metrics for each
when results are grouped by queue, the metrics returned are grouped
The grouping applied to the metrics that are returned. For example,
@!attribute [rw] groupings
@return [Array<Types::FilterV2>]<br>: docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html<br><br><br><br>analyzed by Contact Lens conversational analytics.
the `FEATURE` filter key. It is available only to contacts
`contact_lens_conversational_analytics` is a valid filterValue for
total of 100 filter values, along with 3 channel filters.
filter by 50 queues, 35 agents, and 15 routing profiles for a
of 100 filter values. For example, a GetMetricDataV2 request can
for the CHANNEL filter key. They do not count towards limitation
a single request. VOICE, CHAT, and TASK are valid `filterValue`
* **Filter values**: A maximum of 100 filter values are supported in
`FEATURE`
`AGENT_HIERARCHY_LEVEL_FOUR` | `AGENT_HIERARCHY_LEVEL_FIVE` |
`AGENT_HIERARCHY_LEVEL_TWO` | `AGENT_HIERARCHY_LEVEL_THREE` |
`AGENT` | `CHANNEL` | `AGENT_HIERARCHY_LEVEL_ONE` |
single request. Valid filter keys: `QUEUE` | `ROUTING_PROFILE` |
* **Filter keys**: A maximum of 5 filter keys are supported in a
Note the following limits:<br><br>report] in the *Amazon Connect Administrator’s Guide*.
To filter by phone number, see [Create a historical metrics
agents, or user hierarchy groups.
At least one filter must be passed from queues, routing profiles,
* Feature
* User hierarchy groups
* Channels
* Agents
* Routing profiles
* Queues
following resources:
The filters to apply to returned metrics. You can filter on the
@!attribute [rw] filters
@return [Time]
hours.
The time range between the start and end time must be less than 24
than the current timestamp.
time must be later than the start time timestamp. It cannot be later
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]
Historical metrics are available for 35 days.
cannot be earlier than 35 days before the time of the request.
the start and end time must be less than 24 hours. The start time
time must be before the end time timestamp. The time range between
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]
‘instanceId` an Amazon Connect instance.
The Amazon Resource Name (ARN) of the resource. This includes the
@!attribute [rw] resource_arn