Class: Aws::Connect::Types::GetMetricDataV2Request

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-connect/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ Time

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be later than the start time timestamp. It cannot be later than the current timestamp.

Returns:

  • (Time) 


11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
 
# File 'lib/aws-sdk-connect/types.rb', line 11669

class GetMetricDataV2Request < Struct.new(
  :resource_arn,
  :start_time,
  :end_time,
  :interval,
  :filters,
  :groupings,
  :metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::FilterV2>

The filters to apply to returned metrics. You can filter on the following resources:

  • Agents

  • Campaigns

  • Channels

  • Feature

  • Queues

  • Routing profiles

  • Routing step expression

  • User hierarchy groups

At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.

For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement.

To filter by phone number, see [Create a historical metrics report] in the *Amazon Connect Administrator Guide*.

Note the following limits:

  • **Filter keys**: A maximum of 5 filter keys are supported in a single request. Valid filter keys: ‘AGENT` | `AGENT_HIERARCHY_LEVEL_ONE` | `AGENT_HIERARCHY_LEVEL_TWO` | `AGENT_HIERARCHY_LEVEL_THREE` | `AGENT_HIERARCHY_LEVEL_FOUR` | `AGENT_HIERARCHY_LEVEL_FIVE` | `ANSWERING_MACHINE_DETECTION_STATUS` | ` BOT_ID` | `BOT_ALIAS` | `BOT_VERSION` | `BOT_LOCALE` | `BOT_INTENT_NAME` | `CAMPAIGN` | `CAMPAIGN_DELIVERY_EVENT_TYPE` |`CASE_TEMPLATE_ARN` | `CASE_STATUS` | `CHANNEL` | `contact/segmentAttributes/connect:Subtype` | `DISCONNECT_REASON` | `FEATURE` | `FLOW_ACTION_ID` | `FLOW_TYPE` | `FLOWS_MODULE_RESOURCE_ID` | `FLOWS_NEXT_RESOURCE_ID` | `FLOWS_NEXT_RESOURCE_QUEUE_ID` | `FLOWS_OUTCOME_TYPE` | `FLOWS_RESOURCE_ID` | `INITIATION_METHOD` | `INVOKING_RESOURCE_PUBLISHED_TIMESTAMP` | `INVOKING_RESOURCE_TYPE` | `PARENT_FLOWS_RESOURCE_ID` | `RESOURCE_PUBLISHED_TIMESTAMP` | `ROUTING_PROFILE` | `ROUTING_STEP_EXPRESSION` | `QUEUE` | `Q_CONNECT_ENABLED` |

  • **Filter values**: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid ‘filterValue` for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.

    ‘contact_lens_conversational_analytics` is a valid filterValue for the `FEATURE` filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.

    ‘connect:Chat`, `connect:SMS`, `connect:Telephony`, and `connect:WebRTC` are valid `filterValue` examples (not exhaustive) for the `contact/segmentAttributes/connect:Subtype filter` key.

    ‘ROUTING_STEP_EXPRESSION` is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.

    ‘Q_CONNECT_ENABLED`. TRUE and FALSE are the only valid filterValues for the `Q_CONNECT_ENABLED` filter key.

    • TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.

    • FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow

    This filter is available only for contact record-driven metrics.

    Campaign][2

    ARNs are valid ‘filterValues` for the `CAMPAIGN`

    filter key.

[1]: docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html [2]: docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns_Campaign.html

Returns:



11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
 
# File 'lib/aws-sdk-connect/types.rb', line 11669

class GetMetricDataV2Request < Struct.new(
  :resource_arn,
  :start_time,
  :end_time,
  :interval,
  :filters,
  :groupings,
  :metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#groupings ⇒ Array<String>

The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.

If no grouping is specified, a summary of all metrics is returned.

Valid grouping keys: ‘AGENT` | `AGENT_HIERARCHY_LEVEL_ONE` | `AGENT_HIERARCHY_LEVEL_TWO` | `AGENT_HIERARCHY_LEVEL_THREE` | `AGENT_HIERARCHY_LEVEL_FOUR` | `AGENT_HIERARCHY_LEVEL_FIVE` | `ANSWERING_MACHINE_DETECTION_STATUS` | `BOT_ID` | `BOT_ALIAS` | `BOT_VERSION` | `BOT_LOCALE` | `BOT_INTENT_NAME` | `CAMPAIGN` | `CAMPAIGN_DELIVERY_EVENT_TYPE` | `CASE_TEMPLATE_ARN` | `CASE_STATUS` | `CHANNEL` | `contact/segmentAttributes/connect:Subtype` | `DISCONNECT_REASON` | `FLOWS_RESOURCE_ID` | `FLOWS_MODULE_RESOURCE_ID` | `FLOW_ACTION_ID` | `FLOW_TYPE` | `FLOWS_OUTCOME_TYPE` | `INITIATION_METHOD` | `INVOKING_RESOURCE_PUBLISHED_TIMESTAMP` | `INVOKING_RESOURCE_TYPE` | `PARENT_FLOWS_RESOURCE_ID` | `Q_CONNECT_ENABLED` | `QUEUE` | `RESOURCE_PUBLISHED_TIMESTAMP` | `ROUTING_PROFILE` | `ROUTING_STEP_EXPRESSION`

Returns:

  • (Array<String>) 


11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
 
# File 'lib/aws-sdk-connect/types.rb', line 11669

class GetMetricDataV2Request < Struct.new(
  :resource_arn,
  :start_time,
  :end_time,
  :interval,
  :filters,
  :groupings,
  :metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#interval ⇒ Types::IntervalDetails

The interval period and timezone to apply to returned metrics.

  • ‘IntervalPeriod`: An aggregated grouping applied to request metrics. Valid `IntervalPeriod` values are: `FIFTEEN_MIN` | `THIRTY_MIN` | `HOUR` | `DAY` | `WEEK` | `TOTAL`.

    For example, if ‘IntervalPeriod` is selected `THIRTY_MIN`, `StartTime` and `EndTime` differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the `TOTAL` interval period.

    The following list describes restrictions on ‘StartTime` and `EndTime` based on which `IntervalPeriod` is requested.

    • ‘FIFTEEN_MIN`: The difference between `StartTime` and `EndTime` must be less than 3 days.

    • ‘THIRTY_MIN`: The difference between `StartTime` and `EndTime` must be less than 3 days.

    • ‘HOUR`: The difference between `StartTime` and `EndTime` must be less than 3 days.

    • ‘DAY`: The difference between `StartTime` and `EndTime` must be less than 35 days.

    • ‘WEEK`: The difference between `StartTime` and `EndTime` must be less than 35 days.

    • ‘TOTAL`: The difference between `StartTime` and `EndTime` must be less than 35 days.

  • ‘TimeZone`: The timezone applied to requested metrics.

Returns:



11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
 
# File 'lib/aws-sdk-connect/types.rb', line 11669

class GetMetricDataV2Request < Struct.new(
  :resource_arn,
  :start_time,
  :end_time,
  :interval,
  :filters,
  :groupings,
  :metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return per page.

Returns:

  • (Integer) 


11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
 
# File 'lib/aws-sdk-connect/types.rb', line 11669

class GetMetricDataV2Request < Struct.new(
  :resource_arn,
  :start_time,
  :end_time,
  :interval,
  :filters,
  :groupings,
  :metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#metrics ⇒ Array<Types::MetricV2>

The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see [Historical metrics definitions] in the *Amazon Connect Administrator Guide*.

ABANDONMENT_RATE

: Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Feature,
contact/segmentAttributes/connect:Subtype, Q in Connect

UI name: [Abandonment rate][2]

AGENT_ADHERENT_TIME

: This metric is available only in Amazon Web Services Regions where

[Forecasting, capacity planning, and scheduling][3] is available.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy

UI name: [Adherent time][4]

AGENT_ANSWER_RATE

: Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy

UI name: [Agent answer rate][5]

AGENT_NON_ADHERENT_TIME

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy

UI name: [Non-adherent time][6]

AGENT_NON_RESPONSE

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy

UI name: [Agent non-response][7]

AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy

Data for this metric is available starting from October 1, 2023
0:00:00 GMT.

UI name: [Agent non-response without customer abandons][8]

AGENT_OCCUPANCY

: Unit: Percentage

Valid groupings and filters: Routing Profile, Agent, Agent
Hierarchy

UI name: [Occupancy][9]

AGENT_SCHEDULE_ADHERENCE

: This metric is available only in Amazon Web Services Regions where

[Forecasting, capacity planning, and scheduling][3] is available.

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy

UI name: [Adherence][10]

AGENT_SCHEDULED_TIME

: This metric is available only in Amazon Web Services Regions where

[Forecasting, capacity planning, and scheduling][3] is available.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy

UI name: [Scheduled time][11]

AVG_ABANDON_TIME

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Feature,
contact/segmentAttributes/connect:Subtype, Q in Connect

UI name: [Average queue abandon time][12]

AVG_ACTIVE_TIME

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Q in Connect

UI name: [Average active time][13]

AVG_AFTER_CONTACT_WORK_TIME

: Unit: Seconds

Valid metric filter key: `INITIATION_METHOD`

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Feature,
contact/segmentAttributes/connect:Subtype, Q in Connect

UI name: [Average after contact work time][14]

<note markdown="1"> Feature is a valid filter but not a valid grouping.

 </note>

AVG_AGENT_CONNECTING_TIME

: Unit: Seconds

Valid metric filter key: `INITIATION_METHOD`. For now, this metric
only supports the following as `INITIATION_METHOD`: `INBOUND` \|
`OUTBOUND` \| `CALLBACK` \| `API`

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy

UI name: [Average agent API connecting time][15]

<note markdown="1"> The `Negate` key in metric-level filters is not applicable for
this metric.

 </note>

AVG_AGENT_PAUSE_TIME

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Q in Connect

UI name: [Average agent pause time][16]

AVG_BOT_CONVERSATION_TIME

: Unit: Seconds

Valid groupings and filters: Channel,
contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
version, Bot locale, Flows resource ID, Flows module resource ID,
Flow type, Flow action ID, Invoking resource published timestamp,
Initiation method, Invoking resource type, Parent flows resource
ID

UI name: [Average bot conversation time][17]

AVG_BOT_CONVERSATION_TURNS

: Unit: Count

Valid groupings and filters: Channel,
contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
version, Bot locale, Flows resource ID, Flows module resource ID,
Flow type, Flow action ID, Invoking resource published timestamp,
Initiation method, Invoking resource type, Parent flows resource
ID

UI name: [Average bot conversation turns][18]

AVG_CASE_RELATED_CONTACTS

: Unit: Count

Required filter key: CASE\_TEMPLATE\_ARN

Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS

UI name: [Average contacts per case][19]

AVG_CASE_RESOLUTION_TIME

: Unit: Seconds

Required filter key: CASE\_TEMPLATE\_ARN

Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS

UI name: [Average case resolution time][20]

AVG_CONTACT_DURATION

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Feature,
contact/segmentAttributes/connect:Subtype, Q in Connect

UI name: [Average contact duration][21]

<note markdown="1"> Feature is a valid filter but not a valid grouping.

 </note>

AVG_CONVERSATION_DURATION

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Feature,
contact/segmentAttributes/connect:Subtype, Q in Connect

UI name: [Average conversation duration][22]

AVG_DIALS_PER_MINUTE

: This metric is available only for outbound campaigns that use the

agent assisted voice and automated voice delivery modes.

Unit: Count

Valid groupings and filters: Agent, Campaign, Queue, Routing
Profile

UI name: [Average dials per minute][23]

AVG_FLOW_TIME

: Unit: Seconds

Valid groupings and filters: Channel,
contact/segmentAttributes/connect:Subtype, Flow type, Flows module
resource ID, Flows next resource ID, Flows next resource queue ID,
Flows outcome type, Flows resource ID, Initiation method, Resource
published timestamp

UI name: [Average flow time][24]

AVG_GREETING_TIME_AGENT

: This metric is available only for contacts analyzed by Contact

Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Average agent greeting time][25]

AVG_HANDLE_TIME

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Feature,
contact/segmentAttributes/connect:Subtype, RoutingStepExpression

UI name: [Average handle time][26]

<note markdown="1"> Feature is a valid filter but not a valid grouping.

 </note>

AVG_HOLD_TIME

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Feature,
contact/segmentAttributes/connect:Subtype, Q in Connect

UI name: [Average customer hold time][27]

<note markdown="1"> Feature is a valid filter but not a valid grouping.

 </note>

AVG_HOLD_TIME_ALL_CONTACTS

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Average customer hold time all contacts][28]

AVG_HOLDS

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Feature,
contact/segmentAttributes/connect:Subtype, Q in Connect

UI name: [Average holds][29]

<note markdown="1"> Feature is a valid filter but not a valid grouping.

 </note>

AVG_INTERACTION_AND_HOLD_TIME

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Average agent interaction and customer hold time][30]

AVG_INTERACTION_TIME

: Unit: Seconds

Valid metric filter key: `INITIATION_METHOD`

Valid groupings and filters: Queue, Channel, Routing Profile,
Feature, contact/segmentAttributes/connect:Subtype, Q in Connect

UI name: [Average agent interaction time][31]

<note markdown="1"> Feature is a valid filter but not a valid grouping.

 </note>

AVG_INTERRUPTIONS_AGENT

: This metric is available only for contacts analyzed by Contact

Lens conversational analytics.

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Average agent interruptions][32]

AVG_INTERRUPTION_TIME_AGENT

: This metric is available only for contacts analyzed by Contact

Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Average agent interruption time][33]

AVG_NON_TALK_TIME

: This metric is available only for contacts analyzed by Contact

Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Average non-talk time][34]

AVG_QUEUE_ANSWER_TIME

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Feature, contact/segmentAttributes/connect:Subtype, Q in Connect

UI name: [Average queue answer time][35]

<note markdown="1"> Feature is a valid filter but not a valid grouping.

 </note>

AVG_RESOLUTION_TIME

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
contact/segmentAttributes/connect:Subtype, Q in Connect

UI name: [Average resolution time][36]

AVG_TALK_TIME

: This metric is available only for contacts analyzed by Contact

Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Average talk time][37]

AVG_TALK_TIME_AGENT

: This metric is available only for contacts analyzed by Contact

Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Average agent talk time][38]

AVG_TALK_TIME_CUSTOMER

: This metric is available only for contacts analyzed by Contact

Lens conversational analytics.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Average customer talk time][39]

AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION

: This metric is available only for outbound campaigns that use the

agent assisted voice and automated voice delivery modes.

Unit: Seconds

Valid groupings and filters: Campaign

UI name: [Average wait time after customer connection][40]

BOT_CONVERSATIONS_COMPLETED

: Unit: Count

Valid groupings and filters: Channel,
contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
version, Bot locale, Flows resource ID, Flows module resource ID,
Flow type, Flow action ID, Invoking resource published timestamp,
Initiation method, Invoking resource type, Parent flows resource
ID

UI name: [Bot conversations][41]

BOT_INTENTS_COMPLETED

: Unit: Count

Valid groupings and filters: Channel,
contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
version, Bot locale, Bot intent name, Flows resource ID, Flows
module resource ID, Flow type, Flow action ID, Invoking resource
published timestamp, Initiation method, Invoking resource type,
Parent flows resource ID

UI name: [Bot intents completed][42]

CAMPAIGN_CONTACTS_ABANDONED_AFTER_X

: This metric is available only for outbound campaigns using the

agent assisted voice and automated voice delivery modes.

Unit: Count

Valid groupings and filters: Agent, Campaign

Threshold: For `ThresholdValue`, enter any whole number from 1 to
604800 (inclusive), in seconds. For `Comparison`, you must enter
`GT` (for *Greater than*).

UI name: [Campaign contacts abandoned after X][43]

CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE

: This metric is available only for outbound campaigns using the

agent assisted voice and automated voice delivery modes.

Unit: Percent

Valid groupings and filters: Agent, Campaign

Threshold: For `ThresholdValue`, enter any whole number from 1 to
604800 (inclusive), in seconds. For `Comparison`, you must enter
`GT` (for *Greater than*).

UI name: [Campaign contacts abandoned after X rate][44]

CAMPAIGN_INTERACTIONS

: This metric is available only for outbound campaigns using the

email delivery mode.

Unit: Count

Valid metric filter key: CAMPAIGN\_INTERACTION\_EVENT\_TYPE

Valid groupings and filters: Campaign

UI name: [Campaign interactions][45]

CAMPAIGN_SEND_ATTEMPTS

: This metric is available only for outbound campaigns.

Unit: Count

Valid groupings and filters: Campaign, Channel,
contact/segmentAttributes/connect:Subtype

UI name: [Campaign send attempts][46]

CASES_CREATED

: Unit: Count

Required filter key: CASE\_TEMPLATE\_ARN

Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS

UI name: [Cases created][47]

CONTACTS_CREATED

: Unit: Count

Valid metric filter key: `INITIATION_METHOD`

Valid groupings and filters: Queue, Channel, Routing Profile,
Feature, contact/segmentAttributes/connect:Subtype, Q in Connect

UI name: [Contacts created][48]

<note markdown="1"> Feature is a valid filter but not a valid grouping.

 </note>

CONTACTS_HANDLED

: Unit: Count

Valid metric filter key: `INITIATION_METHOD`, `DISCONNECT_REASON`

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Feature,
contact/segmentAttributes/connect:Subtype, RoutingStepExpression,
Q in Connect

UI name: [API contacts handled][49]

<note markdown="1"> Feature is a valid filter but not a valid grouping.

 </note>

CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT

: Unit: Count

Valid metric filter key: `INITIATION_METHOD`

Valid groupings and filters: Queue, Channel, Agent, Agent
Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

UI name: [Contacts handled (connected to agent timestamp)][50]

CONTACTS_HOLD_ABANDONS

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Contacts hold disconnect][50]

CONTACTS_ON_HOLD_AGENT_DISCONNECT

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Q in Connect

UI name: [Contacts hold agent disconnect][51]

CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Q in Connect

UI name: [Contacts hold customer disconnect][52]

CONTACTS_PUT_ON_HOLD

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Q in Connect

UI name: [Contacts put on hold][52]

CONTACTS_TRANSFERRED_OUT_EXTERNAL

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Q in Connect

UI name: [Contacts transferred out external][53]

CONTACTS_TRANSFERRED_OUT_INTERNAL

: Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Q in Connect

UI name: [Contacts transferred out internal][54]

CONTACTS_QUEUED

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Contacts queued][55]

CONTACTS_QUEUED_BY_ENQUEUE

: Unit: Count

Valid groupings and filters: Queue, Channel, Agent, Agent
Hierarchy, contact/segmentAttributes/connect:Subtype

UI name: [Contacts queued (enqueue timestamp)][56]

CONTACTS_REMOVED_FROM_QUEUE_IN_X

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Q in
Connect

Threshold: For `ThresholdValue`, enter any whole number from 1 to
604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
(for "Less than") or `LTE` (for "Less than equal").

UI name: [Contacts removed from queue in X seconds][57]

CONTACTS_RESOLVED_IN_X

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
contact/segmentAttributes/connect:Subtype, Q in Connect

Threshold: For `ThresholdValue`, enter any whole number from 1 to
604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
(for "Less than") or `LTE` (for "Less than equal").

UI name: [Contacts resolved in X][58]

CONTACTS_TRANSFERRED_OUT

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Feature,
contact/segmentAttributes/connect:Subtype, Q in Connect

UI name: [Contacts transferred out][59]

<note markdown="1"> Feature is a valid filter but not a valid grouping.

 </note>

CONTACTS_TRANSFERRED_OUT_BY_AGENT

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Contacts transferred out by agent][60]

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Contacts transferred out queue][60]

CURRENT_CASES

: Unit: Count

Required filter key: CASE\_TEMPLATE\_ARN

Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS

UI name: [Current cases][61]

DELIVERY_ATTEMPTS

: This metric is available only for outbound campaigns.

Unit: Count

Valid metric filter key: `ANSWERING_MACHINE_DETECTION_STATUS`,
`CAMPAIGN_DELIVERY_EVENT_TYPE`, `DISCONNECT_REASON`

Valid groupings and filters: Agent, Answering Machine Detection
Status, Campaign, Campaign Delivery EventType, Channel,
contact/segmentAttributes/connect:Subtype, Disconnect Reason,
Queue, Routing Profile

UI name: [Delivery attempts][62]

<note markdown="1"> Campaign Delivery EventType filter and grouping are only available
for SMS and Email campaign delivery modes. Agent, Queue, Routing
Profile, Answering Machine Detection Status and Disconnect Reason
are only available for agent assisted voice and automated voice
delivery modes.

 </note>

DELIVERY_ATTEMPT_DISPOSITION_RATE

: This metric is available only for outbound campaigns. Dispositions

for the agent assisted voice and automated voice delivery modes
are only available with answering machine detection enabled.

Unit: Percent

Valid metric filter key: `ANSWERING_MACHINE_DETECTION_STATUS`,
`CAMPAIGN_DELIVERY_EVENT_TYPE`, `DISCONNECT_REASON`

Valid groupings and filters: Agent, Answering Machine Detection
Status, Campaign, Channel,
contact/segmentAttributes/connect:Subtype, Disconnect Reason,
Queue, Routing Profile

UI name: [Delivery attempt disposition rate][63]

<note markdown="1"> Campaign Delivery Event Type filter and grouping are only
available for SMS and Email campaign delivery modes. Agent, Queue,
Routing Profile, Answering Machine Detection Status and Disconnect
Reason are only available for agent assisted voice and automated
voice delivery modes.

 </note>

FLOWS_OUTCOME

: Unit: Count

Valid groupings and filters: Channel,
contact/segmentAttributes/connect:Subtype, Flow type, Flows module
resource ID, Flows next resource ID, Flows next resource queue ID,
Flows outcome type, Flows resource ID, Initiation method, Resource
published timestamp

UI name: [Flows outcome][64]

FLOWS_STARTED

: Unit: Count

Valid groupings and filters: Channel,
contact/segmentAttributes/connect:Subtype, Flow type, Flows module
resource ID, Flows resource ID, Initiation method, Resource
published timestamp

UI name: [Flows started][65]

HUMAN_ANSWERED_CALLS

: This metric is available only for outbound campaigns. Dispositions

for the agent assisted voice and automated voice delivery modes
are only available with answering machine detection enabled.

Unit: Count

Valid groupings and filters: Agent, Campaign

UI name: [Human answered][66]

MAX_FLOW_TIME

: Unit: Seconds

Valid groupings and filters: Channel,
contact/segmentAttributes/connect:Subtype, Flow type, Flows module
resource ID, Flows next resource ID, Flows next resource queue ID,
Flows outcome type, Flows resource ID, Initiation method, Resource
published timestamp

UI name: [Maximum flow time][67]

MAX_QUEUED_TIME

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Maximum queued time][68]

MIN_FLOW_TIME

: Unit: Seconds

Valid groupings and filters: Channel,
contact/segmentAttributes/connect:Subtype, Flow type, Flows module
resource ID, Flows next resource ID, Flows next resource queue ID,
Flows outcome type, Flows resource ID, Initiation method, Resource
published timestamp

UI name: [Minimum flow time][69]

PERCENT_BOT_CONVERSATIONS_OUTCOME

: Unit: Percent

Valid groupings and filters: Channel,
contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
version, Bot locale, Flows resource ID, Flows module resource ID,
Flow type, Flow action ID, Invoking resource published timestamp,
Initiation method, Invoking resource type, Parent flows resource
ID

UI name: [Percent bot conversations outcome][70]

PERCENT_BOT_INTENTS_OUTCOME

: Unit: Percent

Valid groupings and filters: Channel,
contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
version, Bot locale, Bot intent name, Flows resource ID, Flows
module resource ID, Flow type, Flow action ID, Invoking resource
published timestamp, Initiation method, Invoking resource type,
Parent flows resource ID

UI name: [Percent bot intents outcome][71]

PERCENT_CASES_FIRST_CONTACT_RESOLVED

: Unit: Percent

Required filter key: CASE\_TEMPLATE\_ARN

Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS

UI name: [Cases resolved on first contact][72]

PERCENT_CONTACTS_STEP_EXPIRED

: Unit: Percent

Valid groupings and filters: Queue, RoutingStepExpression

UI name: This metric is available in Real-time Metrics UI but not
on the Historical Metrics UI.

PERCENT_CONTACTS_STEP_JOINED

: Unit: Percent

Valid groupings and filters: Queue, RoutingStepExpression

UI name: This metric is available in Real-time Metrics UI but not
on the Historical Metrics UI.

PERCENT_FLOWS_OUTCOME

: Unit: Percent

Valid metric filter key: `FLOWS_OUTCOME_TYPE`

Valid groupings and filters: Channel,
contact/segmentAttributes/connect:Subtype, Flow type, Flows module
resource ID, Flows next resource ID, Flows next resource queue ID,
Flows outcome type, Flows resource ID, Initiation method, Resource
published timestamp

UI name: [Flows outcome percentage][73].

<note markdown="1"> The `FLOWS_OUTCOME_TYPE` is not a valid grouping.

 </note>

PERCENT_NON_TALK_TIME

: This metric is available only for contacts analyzed by Contact

Lens conversational analytics.

Unit: Percentage

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Non-talk time percent][74]

PERCENT_TALK_TIME

: This metric is available only for contacts analyzed by Contact

Lens conversational analytics.

Unit: Percentage

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Talk time percent][75]

PERCENT_TALK_TIME_AGENT

: This metric is available only for contacts analyzed by Contact

Lens conversational analytics.

Unit: Percentage

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Agent talk time percent][76]

PERCENT_TALK_TIME_CUSTOMER

: This metric is available only for contacts analyzed by Contact

Lens conversational analytics.

Unit: Percentage

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Customer talk time percent][77]

REOPENED_CASE_ACTIONS

: Unit: Count

Required filter key: CASE\_TEMPLATE\_ARN

Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS

UI name: [Cases reopened][78]

RESOLVED_CASE_ACTIONS

: Unit: Count

Required filter key: CASE\_TEMPLATE\_ARN

Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS

UI name: [Cases resolved][79]

SERVICE_LEVEL

: You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile, Q in
Connect

Threshold: For `ThresholdValue`, enter any whole number from 1 to
604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
(for "Less than") or `LTE` (for "Less than equal").

UI name: [Service level X][80]

STEP_CONTACTS_QUEUED

: Unit: Count

Valid groupings and filters: Queue, RoutingStepExpression

UI name: This metric is available in Real-time Metrics UI but not
on the Historical Metrics UI.

SUM_AFTER_CONTACT_WORK_TIME

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Q in Connect

UI name: [After contact work time][81]

SUM_CONNECTING_TIME_AGENT

: Unit: Seconds

Valid metric filter key: `INITIATION_METHOD`. This metric only
supports the following filter keys as `INITIATION_METHOD`:
`INBOUND` \| `OUTBOUND` \| `CALLBACK` \| `API`

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy

UI name: [Agent API connecting time][82]

<note markdown="1"> The `Negate` key in metric-level filters is not applicable for
this metric.

 </note>

CONTACTS_ABANDONED

: Unit: Count

Metric filter:

* Valid values: `API`\| `Incoming` \| `Outbound` \| `Transfer` \|
  `Callback` \| `Queue_Transfer`\| `Disconnect`

^

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
RoutingStepExpression, Q in Connect

UI name: [Contact abandoned][83]

SUM_CONTACTS_ABANDONED_IN_X

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
contact/segmentAttributes/connect:Subtype, Q in Connect

Threshold: For `ThresholdValue`, enter any whole number from 1 to
604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
(for "Less than") or `LTE` (for "Less than equal").

UI name: [Contacts abandoned in X seconds][84]

SUM_CONTACTS_ANSWERED_IN_X

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
contact/segmentAttributes/connect:Subtype, Q in Connect

Threshold: For `ThresholdValue`, enter any whole number from 1 to
604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
(for "Less than") or `LTE` (for "Less than equal").

UI name: [Contacts answered in X seconds][85]

SUM_CONTACT_FLOW_TIME

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Q in Connect

UI name: [Contact flow time][86]

SUM_CONTACT_TIME_AGENT

: Unit: Seconds

Valid groupings and filters: Routing Profile, Agent, Agent
Hierarchy

UI name: [Agent on contact time][87]

SUM_CONTACTS_DISCONNECTED

: Valid metric filter key: ‘DISCONNECT_REASON`

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
Q in Connect

UI name: [Contact disconnected][88]

SUM_ERROR_STATUS_TIME_AGENT

: Unit: Seconds

Valid groupings and filters: Routing Profile, Agent, Agent
Hierarchy

UI name: [Error status time][89]

SUM_HANDLE_TIME

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Q in Connect

UI name: [Contact handle time][90]

SUM_HOLD_TIME

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Q in Connect

UI name: [Customer hold time][91]

SUM_IDLE_TIME_AGENT

: Unit: Seconds

Valid groupings and filters: Routing Profile, Agent, Agent
Hierarchy

UI name: [Agent idle time][92]

SUM_INTERACTION_AND_HOLD_TIME

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy, Q in Connect

UI name: [Agent interaction and hold time][93]

SUM_INTERACTION_TIME

: Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy

UI name: [Agent interaction time][94]

SUM_NON_PRODUCTIVE_TIME_AGENT

: Unit: Seconds

Valid groupings and filters: Routing Profile, Agent, Agent
Hierarchy

UI name: [Non-Productive Time][95]

SUM_ONLINE_TIME_AGENT

: Unit: Seconds

Valid groupings and filters: Routing Profile, Agent, Agent
Hierarchy

UI name: [Online time][96]

SUM_RETRY_CALLBACK_ATTEMPTS

: Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile,
contact/segmentAttributes/connect:Subtype, Q in Connect

UI name: [Callback attempts][97]

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

Returns:



11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
 
# File 'lib/aws-sdk-connect/types.rb', line 11669

class GetMetricDataV2Request < Struct.new(
  :resource_arn,
  :start_time,
  :end_time,
  :interval,
  :filters,
  :groupings,
  :metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

  • (String) 


11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
 
# File 'lib/aws-sdk-connect/types.rb', line 11669

class GetMetricDataV2Request < Struct.new(
  :resource_arn,
  :start_time,
  :end_time,
  :interval,
  :filters,
  :groupings,
  :metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

The Amazon Resource Name (ARN) of the resource. This includes the ‘instanceId` an Amazon Connect instance.

Returns:

  • (String) 


11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
 
# File 'lib/aws-sdk-connect/types.rb', line 11669

class GetMetricDataV2Request < Struct.new(
  :resource_arn,
  :start_time,
  :end_time,
  :interval,
  :filters,
  :groupings,
  :metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be before the end time timestamp. The start and end time depends on the ‘IntervalPeriod` selected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.

Returns:

  • (Time) 


11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
 
# File 'lib/aws-sdk-connect/types.rb', line 11669

class GetMetricDataV2Request < Struct.new(
  :resource_arn,
  :start_time,
  :end_time,
  :interval,
  :filters,
  :groupings,
  :metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end