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

Inherits:

Struct

Object
Struct
Aws::Connect::Types::GetMetricDataV2Request

show all

Includes:: Structure

Defined in:: lib/aws-sdk-connect/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#end_time ⇒ Time

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data.
#filters ⇒ Array<Types::FilterV2>

The filters to apply to returned metrics.
#groupings ⇒ Array<String>

The grouping applied to the metrics that are returned.
#interval ⇒ Types::IntervalDetails

The interval period and timezone to apply to returned metrics.
#max_results ⇒ Integer

The maximum number of results to return per page.
#metrics ⇒ Array<Types::MetricV2>

The metrics to retrieve.
#next_token ⇒ String

The token for the next set of results.
#resource_arn ⇒ String

The Amazon Resource Name (ARN) of the resource.
#start_time ⇒ Time

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data.

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)

# File 'lib/aws-sdk-connect/types.rb', line 10134

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
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.

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` | `CASE_TEMPLATE_ARN` | `CASE_STATUS` | `CHANNEL` | `contact/segmentAttributes/connect:Subtype` | `FEATURE` | `FLOW_TYPE` | `FLOWS_NEXT_RESOURCE_ID` | `FLOWS_NEXT_RESOURCE_QUEUE_ID` | `FLOWS_OUTCOME_TYPE` | `FLOWS_RESOURCE_ID` | `INITIATION_METHOD` | `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.

[1]: docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html

Returns:

(Array<Types::FilterV2>)

# File 'lib/aws-sdk-connect/types.rb', line 10134

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.

Returns:

(Array<String>)

# File 'lib/aws-sdk-connect/types.rb', line 10134

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:

(Types::IntervalDetails)

# File 'lib/aws-sdk-connect/types.rb', line 10134

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)

# File 'lib/aws-sdk-connect/types.rb', line 10134

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_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][17]

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][18]

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][19]

<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][20]

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][21]

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][22]

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][23]

<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][24]

<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][25]

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][26]

<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][27]

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][28]

<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][29]

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][30]

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][31]

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][32]

<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][33]

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][34]

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][35]

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][36]

CASES_CREATED

: Unit: Count

Required filter key: CASE\_TEMPLATE\_ARN

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

UI name: [Cases created][37]

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][38]

<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][39]

<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)][40]

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][40]

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][41]

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][42]

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][42]

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][43]

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][44]

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][45]

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)][46]

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 must enter
`LT` (for "Less than").

UI name: This metric is not available in Amazon Connect admin
website.

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 must enter
`LT` (for "Less than").

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

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][48]

<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][49]

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][49]

CURRENT_CASES

: Unit: Count

Required filter key: CASE\_TEMPLATE\_ARN

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

UI name: [Current cases][50]

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][51]

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][52]

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][53]

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][54]

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][55]

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][56]

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][57].

<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][58]

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][59]

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][60]

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][61]

REOPENED_CASE_ACTIONS

: Unit: Count

Required filter key: CASE\_TEMPLATE\_ARN

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

UI name: [Cases reopened][62]

RESOLVED_CASE_ACTIONS

: Unit: Count

Required filter key: CASE\_TEMPLATE\_ARN

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

UI name: [Cases resolved][63]

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 must enter
`LT` (for "Less than").

UI name: [Service level X][64]

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][65]

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][66]

<note markdown="1"> The `Negate` key in Metric Level Filters is not applicable for
this metric.

 </note>

SUM_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][67]

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 must enter
`LT` (for "Less than").

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

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 must enter
`LT` (for "Less than").

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

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][70]

SUM_CONTACT_TIME_AGENT

: Unit: Seconds

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

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

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][72]

SUM_ERROR_STATUS_TIME_AGENT

: Unit: Seconds

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

UI name: [Error status time][73]

SUM_HANDLE_TIME

: Unit: Seconds

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

UI name: [Contact handle time][74]

SUM_HOLD_TIME

: Unit: Count

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

UI name: [Customer hold time][75]

SUM_IDLE_TIME_AGENT

: Unit: Seconds

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

UI name: [Agent idle time][76]

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][77]

SUM_INTERACTION_TIME

: Unit: Seconds

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

UI name: [Agent interaction time][78]

SUM_NON_PRODUCTIVE_TIME_AGENT

: Unit: Seconds

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

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

SUM_ONLINE_TIME_AGENT

: Unit: Seconds

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

UI name: [Online time][80]

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][81]

Returns:

(Array<Types::MetricV2>)

# File 'lib/aws-sdk-connect/types.rb', line 10134

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)

# File 'lib/aws-sdk-connect/types.rb', line 10134

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)

# File 'lib/aws-sdk-connect/types.rb', line 10134

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)

# File 'lib/aws-sdk-connect/types.rb', line 10134

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ Time

#filters ⇒ Array<Types::FilterV2>

#groupings ⇒ Array<String>

#interval ⇒ Types::IntervalDetails

#max_results ⇒ Integer

#metrics ⇒ Array<Types::MetricV2>

#next_token ⇒ String

#resource_arn ⇒ String

#start_time ⇒ Time

#end_time ⇒ `Time`

#filters ⇒ `Array<Types::FilterV2>`

#groupings ⇒ `Array<String>`

#interval ⇒ `Types::IntervalDetails`

#max_results ⇒ `Integer`

#metrics ⇒ `Array<Types::MetricV2>`

#next_token ⇒ `String`

#resource_arn ⇒ `String`

#start_time ⇒ `Time`