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>] : docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-attempts [102]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#online-time [101]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-productive-time [100]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-interaction-time [99]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-interaction-and-hold-time [98]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-idle-time [97]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#customer-hold-time [96]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-handle-time [95]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#error-status-time [94]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-disconnected [93]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-on-contact-time [92]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-flow-time [91]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-answered-in-x-seconds [90]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned-in-x-seconds [89]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned [88]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-api-connecting-time [87]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#service-level [86]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-resolved [85]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-reopened [84]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#customer-talk-time-percent [83]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-talk-time-percent [82]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#talk-time-percent [81]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#non-talk-time-percent [80]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-outcome-percentage [79]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-resolved-on-first-contact [78]: docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-intents-outcome [77]: docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-conversations-outcome [76]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#automatic-fails-percent [75]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time [74]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#maximum-queued-time [73]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#maximum-flow-time [72]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#human-answered [71]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-started [70]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-outcome [69]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#evaluations-performed [68]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#delivery-attempt-disposition-rate [67]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#delivery-attempts [66]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#current-cases [65]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue [64]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-by-agent [63]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out [62]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-resolved [61]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-removed-from-queue [60]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued-by-enqueue [59]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued [58]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-internal [57]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-external [56]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-put-on-hold [55]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-customer-disconnect [54]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-agent-disconnect [53]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect [52]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-by-connected-to-agent-timestamp [51]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled [50]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-created [49]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-created [48]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-send-attempts [47]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-interactions [46]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-contacts-abandoned-after-x-rate [45]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-contacts-abandoned-after-x [44]: docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed [43]: docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed [42]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-weighted-evaluation-score [41]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-wait-time-after-customer-connection [40]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-talk-time [39]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-talk-time [38]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-talk-time [37]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-resolution-time [36]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-answer-time [35]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-non-talk-time [34]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interruption-time [33]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interruptions [32]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-time [31]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time [30]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-holds [29]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time-all-contacts [28]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time [27]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time [26]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-greeting-time [25]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-flow-time [24]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-evaluation-score [23]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-dials-per-minute [22]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-conversation-duration [21]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-contact-duration [20]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-case-resolution-time [19]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-contacts-per-case [18]: docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-turns [17]: docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-time [16]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-pause-time [15]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-api-connecting-time [14]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time [13]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-active-time [12]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time [11]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#scheduled-time [10]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#adherence [9]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy [8]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response-without-customer-abandons [7]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response [6]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#non-adherent-time [5]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-answer-rate [4]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#adherent-time [3]: docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region [2]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#abandonment-rate [1]: docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html UI name: [Callback attempts][103]

contact/segmentAttributes/connect:Subtype, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
SUM_RETRY_CALLBACK_ATTEMPTS
UI name: [Online time][102]

Hierarchy
Valid groupings and filters: Routing Profile, Agent, Agent
: Unit: Seconds
SUM_ONLINE_TIME_AGENT
UI name: [Agent non-productive time][101]

Hierarchy
Valid groupings and filters: Routing Profile, Agent, Agent
: Unit: Seconds
SUM_NON_PRODUCTIVE_TIME_AGENT
UI name: [Agent interaction time][100]

Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
SUM_INTERACTION_TIME
UI name: [Agent interaction and hold time][99]

Agent, Agent Hierarchy, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
SUM_INTERACTION_AND_HOLD_TIME
UI name: [Agent idle time][98]

Hierarchy
Valid groupings and filters: Routing Profile, Agent, Agent
: Unit: Seconds
SUM_IDLE_TIME_AGENT
UI name: [Customer hold time][97]

Agent, Agent Hierarchy, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
SUM_HOLD_TIME
UI name: [Contact handle time][96]

Agent, Agent Hierarchy, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
SUM_HANDLE_TIME
UI name: [Error status time][95]

Hierarchy
Valid groupings and filters: Routing Profile, Agent, Agent
: Unit: Seconds
SUM_ERROR_STATUS_TIME_AGENT
UI name: [Contact disconnected][94]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Valid groupings and filters: Queue, Channel, Routing Profile,
Unit: Count
: Valid metric filter key: ‘DISCONNECT_REASON`
SUM_CONTACTS_DISCONNECTED
UI name: [Agent on contact time][93]

Hierarchy
Valid groupings and filters: Routing Profile, Agent, Agent
: Unit: Seconds
SUM_CONTACT_TIME_AGENT
UI name: [Contact flow time][92]

Agent, Agent Hierarchy, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
SUM_CONTACT_FLOW_TIME
UI name: [Contacts answered in X seconds][91]

(for “Less than”) or `LTE` (for “Less than equal”).
604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
Threshold: For `ThresholdValue`, enter any whole number from 1 to
contact/segmentAttributes/connect:Subtype, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
SUM_CONTACTS_ANSWERED_IN_X
UI name: [Contacts abandoned in X seconds][90]

(for “Less than”) or `LTE` (for “Less than equal”).
604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
Threshold: For `ThresholdValue`, enter any whole number from 1 to
contact/segmentAttributes/connect:Subtype, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
SUM_CONTACTS_ABANDONED_IN_X
UI name: [Contact abandoned][89]

RoutingStepExpression, Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Valid groupings and filters: Queue, Channel, Routing Profile,
^
`Callback` | `Queue_Transfer`| `Disconnect`
* Valid values: `API`| `Incoming` | `Outbound` | `Transfer` |
Metric filter:
: Unit: Count
CONTACTS_ABANDONED
</note>
this metric.
<note markdown=“1”> The `Negate` key in metric-level filters is not applicable for
UI name: [Agent API connecting time][88]

Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
`INBOUND` | `OUTBOUND` | `CALLBACK` | `API`
supports the following filter keys as `INITIATION_METHOD`:
Valid metric filter key: `INITIATION_METHOD`. This metric only
: Unit: Seconds
SUM_CONNECTING_TIME_AGENT
UI name: [After contact work time][14]

Agent, Agent Hierarchy, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
SUM_AFTER_CONTACT_WORK_TIME
on the Historical Metrics UI.
UI name: This metric is available in Real-time Metrics UI but not
Valid groupings and filters: Queue, RoutingStepExpression
: Unit: Count
STEP_CONTACTS_QUEUED
UI name: [Service level X][87]

(for “Less than”) or `LTE` (for “Less than equal”).
604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
Threshold: For `ThresholdValue`, enter any whole number from 1 to
Connect
Valid groupings and filters: Queue, Channel, Routing Profile, Q in
Unit: Percent
: You can include up to 20 SERVICE_LEVEL metrics in a request.
SERVICE_LEVEL
UI name: [Cases resolved][86]

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
Required filter key: CASE_TEMPLATE_ARN
: Unit: Count
RESOLVED_CASE_ACTIONS
UI name: [Cases reopened][85]

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
Required filter key: CASE_TEMPLATE_ARN
: Unit: Count
REOPENED_CASE_ACTIONS
UI name: [Customer talk time percent][84]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Valid groupings and filters: Queue, Channel, Routing Profile,
Unit: Percentage
Lens conversational analytics.
: This metric is available only for contacts analyzed by Contact
PERCENT_TALK_TIME_CUSTOMER
UI name: [Agent talk time percent][83]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Valid groupings and filters: Queue, Channel, Routing Profile,
Unit: Percentage
Lens conversational analytics.
: This metric is available only for contacts analyzed by Contact
PERCENT_TALK_TIME_AGENT
UI name: [Talk time percent][82]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Valid groupings and filters: Queue, Channel, Routing Profile,
Unit: Percentage
Lens conversational analytics.
: This metric is available only for contacts analyzed by Contact
PERCENT_TALK_TIME
UI name: [Non-talk time percent][81]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Valid groupings and filters: Queue, Channel, Routing Profile,
Unit: Percentage
Lens conversational analytics.
: This metric is available only for contacts analyzed by Contact
PERCENT_NON_TALK_TIME
</note>
<note markdown=“1”> The `FLOWS_OUTCOME_TYPE` is not a valid grouping.
UI name: [Flows outcome percentage].
published timestamp
Flows outcome type, Flows resource ID, Initiation method, Resource
resource ID, Flows next resource ID, Flows next resource queue ID,
contact/segmentAttributes/connect:Subtype, Flow type, Flows module
Valid groupings and filters: Channel,
Valid metric filter key: `FLOWS_OUTCOME_TYPE`
: Unit: Percent
PERCENT_FLOWS_OUTCOME
on the Historical Metrics UI.
UI name: This metric is available in Real-time Metrics UI but not
Valid groupings and filters: Queue, RoutingStepExpression
: Unit: Percent
PERCENT_CONTACTS_STEP_JOINED
on the Historical Metrics UI.
UI name: This metric is available in Real-time Metrics UI but not
Valid groupings and filters: Queue, RoutingStepExpression
: Unit: Percent
PERCENT_CONTACTS_STEP_EXPIRED
UI name: [Cases resolved on first contact][79]

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
Required filter key: CASE_TEMPLATE_ARN
: Unit: Percent
PERCENT_CASES_FIRST_CONTACT_RESOLVED
UI name: [Percent bot intents outcome][78]

Parent flows resource ID
published timestamp, Initiation method, Invoking resource type,
module resource ID, Flow type, Flow action ID, Invoking resource
version, Bot locale, Bot intent name, Flows resource ID, Flows
contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
Valid groupings and filters: Channel,
: Unit: Percent
PERCENT_BOT_INTENTS_OUTCOME
UI name: [Percent bot conversations outcome][77]

ID
Initiation method, Invoking resource type, Parent flows resource
Flow type, Flow action ID, Invoking resource published timestamp,
version, Bot locale, Flows resource ID, Flows module resource ID,
contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
Valid groupings and filters: Channel,
: Unit: Percent
PERCENT_BOT_CONVERSATIONS_OUTCOME
UI name: [Automatic fails percent][76]

Routing Profile
Evaluation Form ID, Evaluation Source, Form Version, Queue,
Valid groupings and filters: Agent, Agent Hierarchy, Channel,
: Unit: Percent
PERCENT_AUTOMATIC_FAILS
UI name: [Minimum flow time][75]

published timestamp
Flows outcome type, Flows resource ID, Initiation method, Resource
resource ID, Flows next resource ID, Flows next resource queue ID,
contact/segmentAttributes/connect:Subtype, Flow type, Flows module
Valid groupings and filters: Channel,
: Unit: Seconds
MIN_FLOW_TIME
UI name: [Maximum queued time][74]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
MAX_QUEUED_TIME
UI name: [Maximum flow time][73]

published timestamp
Flows outcome type, Flows resource ID, Initiation method, Resource
resource ID, Flows next resource ID, Flows next resource queue ID,
contact/segmentAttributes/connect:Subtype, Flow type, Flows module
Valid groupings and filters: Channel,
: Unit: Seconds
MAX_FLOW_TIME
UI name: [Human answered][72]

Valid groupings and filters: Agent, Campaign
Unit: Count
are only available with answering machine detection enabled.
for the agent assisted voice and automated voice delivery modes
: This metric is available only for outbound campaigns. Dispositions
HUMAN_ANSWERED_CALLS
UI name: [Flows started][71]

published timestamp
resource ID, Flows resource ID, Initiation method, Resource
contact/segmentAttributes/connect:Subtype, Flow type, Flows module
Valid groupings and filters: Channel,
: Unit: Count
FLOWS_STARTED
UI name: [Flows outcome][70]

published timestamp
Flows outcome type, Flows resource ID, Initiation method, Resource
resource ID, Flows next resource ID, Flows next resource queue ID,
contact/segmentAttributes/connect:Subtype, Flow type, Flows module
Valid groupings and filters: Channel,
: Unit: Count
FLOWS_OUTCOME
UI name: [Evaluations performed][69]

Routing Profile
Evaluation Form ID, Evaluation Source, Form Version, Queue,
Valid groupings and filters: Agent, Agent Hierarchy, Channel,
: Unit: Count
EVALUATIONS_PERFORMED
</note>
voice delivery modes.
Reason are only available for agent assisted voice and automated
Routing Profile, Answering Machine Detection Status and Disconnect
available for SMS and Email campaign delivery modes. Agent, Queue,
<note markdown=“1”> Campaign Delivery Event Type filter and grouping are only
UI name: [Delivery attempt disposition rate][68]

Queue, Routing Profile
contact/segmentAttributes/connect:Subtype, Disconnect Reason,
Status, Campaign, Channel,
Valid groupings and filters: Agent, Answering Machine Detection
`CAMPAIGN_DELIVERY_EVENT_TYPE`, `DISCONNECT_REASON`
Valid metric filter key: `ANSWERING_MACHINE_DETECTION_STATUS`,
Unit: Percent
are only available with answering machine detection enabled.
for the agent assisted voice and automated voice delivery modes
: This metric is available only for outbound campaigns. Dispositions
DELIVERY_ATTEMPT_DISPOSITION_RATE
</note>
delivery modes.
are only available for agent assisted voice and automated voice
Profile, Answering Machine Detection Status and Disconnect Reason
for SMS and Email campaign delivery modes. Agent, Queue, Routing
<note markdown=“1”> Campaign Delivery EventType filter and grouping are only available
UI name: [Delivery attempts][67]

Queue, Routing Profile
contact/segmentAttributes/connect:Subtype, Disconnect Reason,
Status, Campaign, Campaign Delivery EventType, Channel,
Valid groupings and filters: Agent, Answering Machine Detection
`CAMPAIGN_DELIVERY_EVENT_TYPE`, `DISCONNECT_REASON`
Valid metric filter key: `ANSWERING_MACHINE_DETECTION_STATUS`,
Unit: Count
: This metric is available only for outbound campaigns.
DELIVERY_ATTEMPTS
UI name: [Current cases][66]

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
Required filter key: CASE_TEMPLATE_ARN
: Unit: Count
CURRENT_CASES
UI name: [Contacts transferred out queue][65]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
UI name: [Contacts transferred out by agent][64]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
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.
UI name: [Contacts transferred out][63]

contact/segmentAttributes/connect:Subtype, Q in Connect
Agent, Agent Hierarchy, Feature,
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
CONTACTS_TRANSFERRED_OUT
UI name: [Contacts resolved in X][62]

(for “Less than”) or `LTE` (for “Less than equal”).
604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
Threshold: For `ThresholdValue`, enter any whole number from 1 to
contact/segmentAttributes/connect:Subtype, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
CONTACTS_RESOLVED_IN_X
UI name: [Contacts removed from queue in X seconds][61]

(for “Less than”) or `LTE` (for “Less than equal”).
604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
Threshold: For `ThresholdValue`, enter any whole number from 1 to
Connect
Valid groupings and filters: Queue, Channel, Routing Profile, Q in
: Unit: Count
CONTACTS_REMOVED_FROM_QUEUE_IN_X
UI name: [Contacts queued (enqueue timestamp)][60]

Hierarchy, contact/segmentAttributes/connect:Subtype
Valid groupings and filters: Queue, Channel, Agent, Agent
: Unit: Count
CONTACTS_QUEUED_BY_ENQUEUE
UI name: [Contacts queued][59]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
CONTACTS_QUEUED
UI name: [Contacts transferred out internal][58]

Agent, Agent Hierarchy, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Percent
CONTACTS_TRANSFERRED_OUT_INTERNAL
UI name: [Contacts transferred out external][57]

Agent, Agent Hierarchy, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
CONTACTS_TRANSFERRED_OUT_EXTERNAL
UI name: [Contacts put on hold][56]

Agent, Agent Hierarchy, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
CONTACTS_PUT_ON_HOLD
UI name: [Contacts hold customer disconnect][55]

Agent, Agent Hierarchy, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
UI name: [Contacts hold agent disconnect][54]

Agent, Agent Hierarchy, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
CONTACTS_ON_HOLD_AGENT_DISCONNECT
UI name: [Contacts hold disconnect][53]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
CONTACTS_HOLD_ABANDONS
UI name: [Contacts handled (connected to agent timestamp)][52]

Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Valid groupings and filters: Queue, Channel, Agent, Agent
Valid metric filter key: `INITIATION_METHOD`
: Unit: Count
CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
</note>
<note markdown=“1”> Feature is a valid filter but not a valid grouping.
UI name: [API contacts handled][51]

Q in Connect
contact/segmentAttributes/connect:Subtype, RoutingStepExpression,
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.
UI name: [Contacts created][50]

Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
Valid metric filter key: `INITIATION_METHOD`
: Unit: Count
CONTACTS_CREATED
UI name: [Cases created][49]

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
Required filter key: CASE_TEMPLATE_ARN
: Unit: Count
CASES_CREATED
UI name: [Campaign send attempts][48]

contact/segmentAttributes/connect:Subtype
Valid groupings and filters: Campaign, Channel,
Unit: Count
: This metric is available only for outbound campaigns.
CAMPAIGN_SEND_ATTEMPTS
UI name: [Campaign interactions][47]

Valid groupings and filters: Campaign
Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
Unit: Count
email delivery mode.
: This metric is available only for outbound campaigns using the
CAMPAIGN_INTERACTIONS
UI name: [Campaign contacts abandoned after X rate][46]

`GT` (for *Greater than*).
604800 (inclusive), in seconds. For `Comparison`, you must enter
Threshold: For `ThresholdValue`, enter any whole number from 1 to
Valid groupings and filters: Agent, Campaign
Unit: Percent
agent assisted voice and automated voice delivery modes.
: This metric is available only for outbound campaigns using the
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE
UI name: [Campaign contacts abandoned after X][45]

`GT` (for *Greater than*).
604800 (inclusive), in seconds. For `Comparison`, you must enter
Threshold: For `ThresholdValue`, enter any whole number from 1 to
Valid groupings and filters: Agent, Campaign
Unit: Count
agent assisted voice and automated voice delivery modes.
: This metric is available only for outbound campaigns using the
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X
UI name: [Bot intents completed][44]

Parent flows resource ID
published timestamp, Initiation method, Invoking resource type,
module resource ID, Flow type, Flow action ID, Invoking resource
version, Bot locale, Bot intent name, Flows resource ID, Flows
contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
Valid groupings and filters: Channel,
: Unit: Count
BOT_INTENTS_COMPLETED
UI name: [Bot conversations completed][43]

ID
Initiation method, Invoking resource type, Parent flows resource
Flow type, Flow action ID, Invoking resource published timestamp,
version, Bot locale, Flows resource ID, Flows module resource ID,
contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
Valid groupings and filters: Channel,
: Unit: Count
BOT_CONVERSATIONS_COMPLETED
UI name: [Average weighted evaluation score][42]

Evaluation Source, Form Version, Queue, Routing Profile
Evaluation Form Id, Evaluation Section ID, Evaluation Question ID,
Valid groupings and filters: Agent, Agent Hierarchy, Channel,
: Unit: Percent
AVG_WEIGHTED_EVALUATION_SCORE
UI name: [Average wait time after customer connection][41]

Valid groupings and filters: Campaign
Unit: Seconds
agent assisted voice and automated voice delivery modes.
: This metric is available only for outbound campaigns that use the
AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION
UI name: [Average customer talk time][40]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
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
UI name: [Average agent talk time][39]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
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
UI name: [Average talk time][38]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
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
UI name: [Average resolution time][37]

contact/segmentAttributes/connect:Subtype, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_RESOLUTION_TIME
</note>
<note markdown=“1”> Feature is a valid filter but not a valid grouping.
UI name: [Average queue answer time][36]

Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_QUEUE_ANSWER_TIME
UI name: [Average non-talk time][35]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
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
UI name: [Average agent interruption time][34]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
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
UI name: [Average agent interruptions][33]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
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.
UI name: [Average agent interaction time][32]

Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
Valid metric filter key: `INITIATION_METHOD`
: Unit: Seconds
AVG_INTERACTION_TIME
UI name: [Average agent interaction and customer hold time][31]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
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.
UI name: [Average holds][30]

contact/segmentAttributes/connect:Subtype, Q in Connect
Agent, Agent Hierarchy, Feature,
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
AVG_HOLDS
UI name: [Average customer hold time all contacts][29]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_HOLD_TIME_ALL_CONTACTS
</note>
<note markdown=“1”> Feature is a valid filter but not a valid grouping.
UI name: [Average customer hold time][28]

contact/segmentAttributes/connect:Subtype, Q in Connect
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.
UI name: [Average handle time][27]

contact/segmentAttributes/connect:Subtype, RoutingStepExpression
Agent, Agent Hierarchy, Feature,
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_HANDLE_TIME
UI name: [Average agent greeting time][26]

Q in Connect
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
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
UI name: [Average flow time][25]

published timestamp
Flows outcome type, Flows resource ID, Initiation method, Resource
resource ID, Flows next resource ID, Flows next resource queue ID,
contact/segmentAttributes/connect:Subtype, Flow type, Flows module
Valid groupings and filters: Channel,
: Unit: Seconds
AVG_FLOW_TIME
UI name: [Average evaluation score][24]

Evaluation Source, Form Version, Queue, Routing Profile
Evaluation Form ID, Evaluation Section ID, Evaluation Question ID,
Valid groupings and filters: Agent, Agent Hierarchy, Channel,
: Unit: Percent
AVG_EVALUATION_SCORE
UI name: [Average dials per minute][23]

Profile
Valid groupings and filters: Agent, Campaign, Queue, Routing
Unit: Count
agent assisted voice and automated voice delivery modes.
: This metric is available only for outbound campaigns that use the
AVG_DIALS_PER_MINUTE
UI name: [Average conversation duration][22]

contact/segmentAttributes/connect:Subtype, Q in Connect
Agent, Agent Hierarchy, Feature,
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.
UI name: [Average contact duration][21]

contact/segmentAttributes/connect:Subtype, Q in Connect
Agent, Agent Hierarchy, Feature,
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_CONTACT_DURATION
UI name: [Average case resolution time][20]

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
Required filter key: CASE_TEMPLATE_ARN
: Unit: Seconds
AVG_CASE_RESOLUTION_TIME
UI name: [Average contacts per case][19]

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
Required filter key: CASE_TEMPLATE_ARN
: Unit: Count
AVG_CASE_RELATED_CONTACTS
UI name: [Average bot conversation turns][18]

ID
Initiation method, Invoking resource type, Parent flows resource
Flow type, Flow action ID, Invoking resource published timestamp,
version, Bot locale, Flows resource ID, Flows module resource ID,
contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
Valid groupings and filters: Channel,
: Unit: Count
AVG_BOT_CONVERSATION_TURNS
UI name: [Average bot conversation time][17]

ID
Initiation method, Invoking resource type, Parent flows resource
Flow type, Flow action ID, Invoking resource published timestamp,
version, Bot locale, Flows resource ID, Flows module resource ID,
contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
Valid groupings and filters: Channel,
: Unit: Seconds
AVG_BOT_CONVERSATION_TIME
UI name: [Average agent pause time][16]

Agent, Agent Hierarchy, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_AGENT_PAUSE_TIME
</note>
this metric.
<note markdown=“1”> The `Negate` key in metric-level filters is not applicable for
UI name: [Average agent API connecting time][15]

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.
UI name: [Average after contact work time][14]

contact/segmentAttributes/connect:Subtype, Q in Connect
Agent, Agent Hierarchy, Feature,
Valid groupings and filters: Queue, Channel, Routing Profile,
Valid metric filter key: `INITIATION_METHOD`
: Unit: Seconds
AVG_AFTER_CONTACT_WORK_TIME
UI name: [Average active time][13]

Agent, Agent Hierarchy, Q in Connect
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_ACTIVE_TIME
UI name: [Average queue abandon time][12]

contact/segmentAttributes/connect:Subtype, Q in Connect
Agent, Agent Hierarchy, Feature,
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AVG_ABANDON_TIME
UI name: [Scheduled time][11]

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
UI name: [Adherence][10]

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
UI name: [Occupancy][9]

Hierarchy
Valid groupings and filters: Routing Profile, Agent, Agent
: Unit: Percentage
AGENT_OCCUPANCY
UI name: [Agent non-response without customer abandons][8]

0:00:00 GMT.
Data for this metric is available starting from October 1, 2023
Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
UI name: [Agent non-response][7]

Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Count
AGENT_NON_RESPONSE
UI name: [Non-adherent time][6]

Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Seconds
AGENT_NON_ADHERENT_TIME
UI name: [Agent answer rate][5]

Agent, Agent Hierarchy
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Percent
AGENT_ANSWER_RATE
UI name: [Adherent time][4]

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_ADHERENT_TIME
UI name: [Abandonment rate][2]

contact/segmentAttributes/connect:Subtype, Q in Connect
Agent, Agent Hierarchy, Feature,
Valid groupings and filters: Queue, Channel, Routing Profile,
: Unit: Percent
ABANDONMENT_RATE
*Amazon Connect Administrator Guide*.
a description of each metric, see [Metrics definition] in the
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>]
Required: No
Array Members: Maximum number of 4 items
Type: Array of strings
`ROUTING_STEP_EXPRESSION`
`RESOURCE_PUBLISHED_TIMESTAMP` | `ROUTING_PROFILE` |
| `PARENT_FLOWS_RESOURCE_ID` | `Q_CONNECT_ENABLED` | `QUEUE` |
`INVOKING_RESOURCE_PUBLISHED_TIMESTAMP` | `INVOKING_RESOURCE_TYPE`
`FLOWS_OUTCOME_TYPE` | `FORM_VERSION` | `INITIATION_METHOD` |
| `FLOWS_MODULE_RESOURCE_ID` | `FLOW_ACTION_ID` | `FLOW_TYPE` |
`EVALUATION_QUESTION` | `EVALUATION_SOURCE` | `FLOWS_RESOURCE_ID`
| `EVALUATION_FORM` | `EVALUATION_SECTION` |
`contact/segmentAttributes/connect:Subtype` | `DISCONNECT_REASON`
`CASE_STATUS` | `CHANNEL` |
`CAMPAIGN_DELIVERY_EVENT_TYPE` | `CASE_TEMPLATE_ARN` |
`BOT_VERSION` | `BOT_LOCALE` | `BOT_INTENT_NAME` | `CAMPAIGN` |
`ANSWERING_MACHINE_DETECTION_STATUS` | `BOT_ID` | `BOT_ALIAS` |
`AGENT_HIERARCHY_LEVEL_FOUR` | `AGENT_HIERARCHY_LEVEL_FIVE` |
`AGENT_HIERARCHY_LEVEL_TWO` | `AGENT_HIERARCHY_LEVEL_THREE` |
Valid grouping keys: `AGENT` | `AGENT_HIERARCHY_LEVEL_ONE` |
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>] : docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns_Campaign.html [1]: docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html filter key. [2] ARNs are valid `filterValues` for the `CAMPAIGN`
This filter is available only for contact record-driven metrics.
Connect enabled as part of the flow
* FALSE includes all contacts that did not have Amazon Q in
as part of the flow.
* TRUE includes all contacts that had Amazon Q in Connect enabled
filterValues for the `Q_CONNECT_ENABLED` filter key.
`Q_CONNECT_ENABLED`. TRUE and FALSE are the only valid
array order should be kept as is.
JSON string fields must be sorted in ascending order and JSON
value up to 3000 length. This filter is case and order sensitive.
`ROUTING_STEP_EXPRESSION` is a valid filter key with a filter
for the `contact/segmentAttributes/connect:Subtype filter` key.
`connect:WebRTC` are valid `filterValue` examples (not exhaustive)
`connect:Chat`, `connect:SMS`, `connect:Telephony`, and
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
`ROUTING_STEP_EXPRESSION` | `QUEUE` | `Q_CONNECT_ENABLED` |
`RESOURCE_PUBLISHED_TIMESTAMP` | `ROUTING_PROFILE` |
`INVOKING_RESOURCE_TYPE` | `PARENT_FLOWS_RESOURCE_ID` |
`INITIATION_METHOD` | `INVOKING_RESOURCE_PUBLISHED_TIMESTAMP` |
`FLOWS_OUTCOME_TYPE` | `FLOWS_RESOURCE_ID` | `FORM_VERSION` |
`FLOWS_NEXT_RESOURCE_ID` | `FLOWS_NEXT_RESOURCE_QUEUE_ID` |
`FLOW_ACTION_ID` | `FLOW_TYPE` | `FLOWS_MODULE_RESOURCE_ID` |
`EVALUATION_QUESTION` | `EVALUATION_SOURCE` | `FEATURE` |
| `EVALUATION_FORM` | `EVALUATION_SECTION` |
`contact/segmentAttributes/connect:Subtype` | `DISCONNECT_REASON`
| `CASE_STATUS` | `CHANNEL` |
`CAMPAIGN` | `CAMPAIGN_DELIVERY_EVENT_TYPE` |`CASE_TEMPLATE_ARN`
| `BOT_VERSION` | `BOT_LOCALE` | `BOT_INTENT_NAME` |
`ANSWERING_MACHINE_DETECTION_STATUS` | ` BOT_ID` | `BOT_ALIAS`
`AGENT_HIERARCHY_LEVEL_FIVE` |
`AGENT_HIERARCHY_LEVEL_THREE` | `AGENT_HIERARCHY_LEVEL_FOUR` |
`AGENT_HIERARCHY_LEVEL_ONE` | `AGENT_HIERARCHY_LEVEL_TWO` |
single request. Valid filter keys: `AGENT` |
* **Filter keys**: A maximum of 5 filter keys are supported in a
Note the following limits: report] in the *Amazon Connect Administrator Guide*.
To filter by phone number, see [Create a historical metrics
campaigns to satisfy at least one filter requirement.
For metrics for outbound campaigns analytics, you can also use
agents, or user hierarchy groups.
At least one filter must be passed from queues, routing profiles,
* User hierarchy groups
* Routing step expression
* Routing profiles
* Queues
* Feature
* Channels
* Campaigns
* Agents
following resources:
The filters to apply to returned metrics. You can filter on the
@!attribute [rw] filters
@return [Types::IntervalDetails]
* `TimeZone`: The timezone applied to requested metrics.
be less than 35 days.
* `TOTAL`: The difference between `StartTime` and `EndTime` must
less than 35 days.
* `WEEK`: The difference between `StartTime` and `EndTime` must be
less than 35 days.
* `DAY`: The difference between `StartTime` and `EndTime` must be
less than 3 days.
* `HOUR`: The difference between `StartTime` and `EndTime` must be
must be less than 3 days.
* `THIRTY_MIN`: The difference between `StartTime` and `EndTime`
must be less than 3 days.
* `FIFTEEN_MIN`: The difference between `StartTime` and `EndTime`
`EndTime` based on which `IntervalPeriod` is requested.
The following list describes restrictions on `StartTime` and
results based on the `TOTAL` interval period.
the THIRTY_MIN period. By default Amazon Connect aggregates
returns 48 results in the response. Each result is aggregated by
`StartTime` and `EndTime` differs by 1 day, then Amazon Connect
For example, if `IntervalPeriod` is selected `THIRTY_MIN`,
`THIRTY_MIN` | `HOUR` | `DAY` | `WEEK` | `TOTAL`.
metrics. Valid `IntervalPeriod` values are: `FIFTEEN_MIN` |
* `IntervalPeriod`: An aggregated grouping applied to request
The interval period and timezone to apply to returned metrics.
@!attribute [rw] interval
@return [Time]
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]
available for 3 months.
between start and end time is 35 days. Historical metrics are
depends on the `IntervalPeriod` selected. By default the time range
time must be before the end time timestamp. The start and end time
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

class Aws::Connect::Types::GetMetricDataV2Request

Namespace

Included Modules

Defined in