Skip to content

Commit bd7756b

Browse files
author
awstools
committed
docs(client-connect): Adding Contact Flow metrics to the GetMetricDataV2 API
1 parent 12647db commit bd7756b

File tree

5 files changed

+128
-56
lines changed

5 files changed

+128
-56
lines changed

‎clients/client-connect/src/commands/CreatePromptCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface CreatePromptCommandOutput extends CreatePromptResponse, __Metad
2828

2929
/**
3030
* <p>Creates a prompt. For more information about prompts, such as supported file types and
31-
* maximum length, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html">Create prompts</a> in the <i>Amazon Connect Administrator's
31+
* maximum length, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html">Create prompts</a> in the <i>Amazon Connect Administrator
3232
* Guide</i>.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-connect/src/commands/GetMetricDataV2Command.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export interface GetMetricDataV2CommandOutput extends GetMetricDataV2Response, _
3535
* hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. </p>
3636
* <p>For a description of the historical metrics that are supported by
3737
* <code>GetMetricDataV2</code> and <code>GetMetricData</code>, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical metrics
38-
* definitions</a> in the <i>Amazon Connect Administrator's Guide</i>.</p>
38+
* definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
3939
* @example
4040
* Use a bare-bones client and the command you need to make an API call.
4141
* ```javascript

‎clients/client-connect/src/models/models_0.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2474,7 +2474,7 @@ export interface CreateContactFlowRequest {
24742474

24752475
/**
24762476
* <p>Indicates the flow status as either <code>SAVED</code> or <code>PUBLISHED</code>. The
2477-
* <code>PUBLISHED</code> status will initiate validation on the content. the <code>SAVED</code>
2477+
* <code>PUBLISHED</code> status will initiate validation on the content. the <code>SAVED</code>
24782478
* status does not initiate validation of the content. <code>SAVED</code> |
24792479
* <code>PUBLISHED</code>.</p>
24802480
* @public

‎clients/client-connect/src/models/models_1.ts

Lines changed: 118 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -3942,8 +3942,8 @@ export interface MetricFilterV2 {
39423942
* <p>The key to use for filtering data. </p>
39433943
* <p>Valid metric filter keys: <code>INITIATION_METHOD</code>, <code>DISCONNECT_REASON</code>.
39443944
* These are the same values as the <code>InitiationMethod</code> and <code>DisconnectReason</code>
3945-
* in the contact record. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the <i>Amazon Connect Administrator's
3946-
* Guide</i>. </p>
3945+
* in the contact record. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the <i>Amazon Connect Administrator Guide</i>.
3946+
* </p>
39473947
* @public
39483948
*/
39493949
MetricFilterKey?: string;
@@ -4106,45 +4106,49 @@ export interface GetMetricDataV2Request {
41064106
* <p>The filters to apply to returned metrics. You can filter on the following resources:</p>
41074107
* <ul>
41084108
* <li>
4109-
* <p>Queues</p>
4109+
* <p>Agents</p>
41104110
* </li>
41114111
* <li>
4112-
* <p>Routing profiles</p>
4112+
* <p>Channels</p>
41134113
* </li>
41144114
* <li>
4115-
* <p>Agents</p>
4115+
* <p>Feature</p>
41164116
* </li>
41174117
* <li>
4118-
* <p>Channels</p>
4118+
* <p>Queues</p>
41194119
* </li>
41204120
* <li>
4121-
* <p>User hierarchy groups</p>
4121+
* <p>Routing profiles</p>
41224122
* </li>
41234123
* <li>
4124-
* <p>Feature</p>
4124+
* <p>Routing step expression</p>
41254125
* </li>
41264126
* <li>
4127-
* <p>Routing step expression</p>
4127+
* <p>User hierarchy groups</p>
41284128
* </li>
41294129
* </ul>
41304130
* <p>At least one filter must be passed from queues, routing profiles, agents, or user hierarchy
41314131
* groups.</p>
41324132
* <p>To filter by phone number, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html">Create a historical
4133-
* metrics report</a> in the <i>Amazon Connect Administrator's
4133+
* metrics report</a> in the <i>Amazon Connect Administrator
41344134
* Guide</i>.</p>
41354135
* <p>Note the following limits:</p>
41364136
* <ul>
41374137
* <li>
41384138
* <p>
41394139
* <b>Filter keys</b>: A maximum of 5 filter keys are supported in
4140-
* a single request. Valid filter keys: <code>QUEUE</code> | <code>ROUTING_PROFILE</code> |
4141-
* <code>AGENT</code> | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
4142-
* <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
4143-
* <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> |
4144-
* <code>FEATURE</code> | <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> |
4145-
* <code>contact/segmentAttributes/connect:Subtype</code> | <code>ROUTING_STEP_EXPRESSION</code>
4146-
* | <code>Q_CONNECT_ENABLED</code>
4147-
* </p>
4140+
* a single request. Valid filter keys: <code>AGENT</code> |
4141+
* <code>AGENT_HIERARCHY_LEVEL_ONE</code> | <code>AGENT_HIERARCHY_LEVEL_TWO</code> |
4142+
* <code>AGENT_HIERARCHY_LEVEL_THREE</code> | <code>AGENT_HIERARCHY_LEVEL_FOUR</code> |
4143+
* <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>CASE_TEMPLATE_ARN</code> |
4144+
* <code>CASE_STATUS</code> | <code>CHANNEL</code> |
4145+
* <code>contact/segmentAttributes/connect:Subtype</code> | <code>FEATURE</code> |
4146+
* <code>FLOW_TYPE</code> | <code>FLOWS_NEXT_RESOURCE_ID</code> |
4147+
* <code>FLOWS_NEXT_RESOURCE_QUEUE_ID</code> | <code>FLOWS_OUTCOME_TYPE</code> |
4148+
* <code>FLOWS_RESOURCE_ID</code> | <code>INITIATION_METHOD</code> |
4149+
* <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> |
4150+
* <code>ROUTING_STEP_EXPRESSION</code> | <code>QUEUE</code> | <code>Q_CONNECT_ENABLED</code> |
4151+
* </p>
41484152
* </li>
41494153
* <li>
41504154
* <p>
@@ -4188,21 +4192,23 @@ export interface GetMetricDataV2Request {
41884192
* by queue, the metrics returned are grouped by queue. The values that are returned apply to the
41894193
* metrics for each queue. They are not aggregated for all queues.</p>
41904194
* <p>If no grouping is specified, a summary of all metrics is returned.</p>
4191-
* <p>Valid grouping keys: <code>QUEUE</code> | <code>ROUTING_PROFILE</code> | <code>AGENT</code>
4192-
* | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
4195+
* <p>Valid grouping keys: <code>AGENT</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
41934196
* <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
41944197
* <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> |
4195-
* <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> |
4196-
* <code>contact/segmentAttributes/connect:Subtype</code> | <code>ROUTING_STEP_EXPRESSION</code> |
4197-
* <code>Q_CONNECT_ENABLED</code>
4198+
* <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> |
4199+
* <code>contact/segmentAttributes/connect:Subtype</code> | <code>FLOWS_RESOURCE_ID</code> |
4200+
* <code>FLOWS_MODULE_RESOURCE_ID</code> | <code>FLOW_TYPE</code> | <code>FLOWS_OUTCOME_TYPE</code>
4201+
* | <code>INITIATION_METHOD</code> | <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> |
4202+
* <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> |
4203+
* <code>ROUTING_STEP_EXPRESSION</code>
41984204
* </p>
41994205
* @public
42004206
*/
42014207
Groupings?: string[];
42024208

42034209
/**
42044210
* <p>The metrics to retrieve. Specify the name, groupings, and filters for each metric. The
4205-
* following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical metrics definitions</a> in the <i>Amazon Connect Administrator's
4211+
* following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical metrics definitions</a> in the <i>Amazon Connect Administrator
42064212
* Guide</i>.</p>
42074213
* <dl>
42084214
* <dt>ABANDONMENT_RATE</dt>
@@ -4359,6 +4365,15 @@ export interface GetMetricDataV2Request {
43594365
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-conversation-duration-historical">Average conversation duration</a>
43604366
* </p>
43614367
* </dd>
4368+
* <dt>AVG_FLOW_TIME</dt>
4369+
* <dd>
4370+
* <p>Unit: Seconds</p>
4371+
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
4372+
* resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
4373+
* resource ID, Initiation method, Resource published timestamp</p>
4374+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-flow-time-historical">Average flow time</a>
4375+
* </p>
4376+
* </dd>
43624377
* <dt>AVG_GREETING_TIME_AGENT</dt>
43634378
* <dd>
43644379
* <p>This metric is available only for contacts analyzed by Contact Lens conversational
@@ -4521,11 +4536,42 @@ export interface GetMetricDataV2Request {
45214536
* <dt>CONTACTS_ABANDONED</dt>
45224537
* <dd>
45234538
* <p>Unit: Count</p>
4539+
* <p>Metric filter: </p>
4540+
* <ul>
4541+
* <li>
4542+
* <p>Valid values: <code>API</code>| <code>Incoming</code> | <code>Outbound</code> |
4543+
* <code>Transfer</code> | <code>Callback</code> | <code>Queue_Transfer</code>|
4544+
* <code>Disconnect</code>
4545+
* </p>
4546+
* </li>
4547+
* </ul>
45244548
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
45254549
* contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect</p>
45264550
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical">Contact abandoned</a>
45274551
* </p>
45284552
* </dd>
4553+
* <dt>CONTACTS_ABANDONED_IN_X</dt>
4554+
* <dd>
4555+
* <p>Unit: Count</p>
4556+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
4557+
* Q in Connect</p>
4558+
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
4559+
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
4560+
* "Less than"). </p>
4561+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical">Contacts abandoned in X seconds</a>
4562+
* </p>
4563+
* </dd>
4564+
* <dt>CONTACTS_ANSWERED_IN_X</dt>
4565+
* <dd>
4566+
* <p>Unit: Count</p>
4567+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
4568+
* Q in Connect</p>
4569+
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
4570+
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
4571+
* "Less than"). </p>
4572+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical">Contacts answered in X seconds</a>
4573+
* </p>
4574+
* </dd>
45294575
* <dt>CONTACTS_CREATED</dt>
45304576
* <dd>
45314577
* <p>Unit: Count</p>
@@ -4668,6 +4714,32 @@ export interface GetMetricDataV2Request {
46684714
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#current-cases-historical">Current cases</a>
46694715
* </p>
46704716
* </dd>
4717+
* <dt>FLOWS_OUTCOME</dt>
4718+
* <dd>
4719+
* <p>Unit: Count</p>
4720+
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
4721+
* resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
4722+
* resource ID, Initiation method, Resource published timestamp</p>
4723+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-historical">Flows outcome</a>
4724+
* </p>
4725+
* </dd>
4726+
* <dt>FLOWS_STARTED</dt>
4727+
* <dd>
4728+
* <p>Unit: Count</p>
4729+
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
4730+
* resource ID, Flows resource ID, Initiation method, Resource published timestamp</p>
4731+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-started-historical">Flows started</a>
4732+
* </p>
4733+
* </dd>
4734+
* <dt>MAX_FLOW_TIME</dt>
4735+
* <dd>
4736+
* <p>Unit: Seconds</p>
4737+
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
4738+
* resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
4739+
* resource ID, Initiation method, Resource published timestamp</p>
4740+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-flow-time-historical">Maximum flow time</a>
4741+
* </p>
4742+
* </dd>
46714743
* <dt>MAX_QUEUED_TIME</dt>
46724744
* <dd>
46734745
* <p>Unit: Seconds</p>
@@ -4676,6 +4748,15 @@ export interface GetMetricDataV2Request {
46764748
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-queued-time-historical">Maximum queued time</a>
46774749
* </p>
46784750
* </dd>
4751+
* <dt>MIN_FLOW_TIME</dt>
4752+
* <dd>
4753+
* <p>Unit: Seconds</p>
4754+
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
4755+
* resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
4756+
* resource ID, Initiation method, Resource published timestamp</p>
4757+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#minimum-flow-time-historical">Minimum flow time</a>
4758+
* </p>
4759+
* </dd>
46794760
* <dt>PERCENT_CASES_FIRST_CONTACT_RESOLVED</dt>
46804761
* <dd>
46814762
* <p>Unit: Percent</p>
@@ -4696,6 +4777,19 @@ export interface GetMetricDataV2Request {
46964777
* <p>Valid groupings and filters: Queue, RoutingStepExpression</p>
46974778
* <p>UI name: Not available </p>
46984779
* </dd>
4780+
* <dt>PERCENT_FLOWS_OUTCOME</dt>
4781+
* <dd>
4782+
* <p>Unit: Percent</p>
4783+
* <p>Valid metric filter key: <code>FLOWS_OUTCOME_TYPE</code>
4784+
* </p>
4785+
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
4786+
* resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
4787+
* resource ID, Initiation method, Resource published timestamp</p>
4788+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-percentage-historical">Flows outcome percentage</a>.</p>
4789+
* <note>
4790+
* <p>The <code>FLOWS_OUTCOME_TYPE</code> is not a valid grouping.</p>
4791+
* </note>
4792+
* </dd>
46994793
* <dt>PERCENT_NON_TALK_TIME</dt>
47004794
* <dd>
47014795
* <p>This metric is available only for contacts analyzed by Contact Lens conversational
@@ -4809,28 +4903,6 @@ export interface GetMetricDataV2Request {
48094903
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-on-contact-time-historical">Agent on contact time</a>
48104904
* </p>
48114905
* </dd>
4812-
* <dt>SUM_CONTACTS_ANSWERED_IN_X</dt>
4813-
* <dd>
4814-
* <p>Unit: Count</p>
4815-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
4816-
* Q in Connect</p>
4817-
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
4818-
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
4819-
* "Less than"). </p>
4820-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical">Contacts answered in X seconds</a>
4821-
* </p>
4822-
* </dd>
4823-
* <dt>SUM_CONTACTS_ABANDONED_IN_X</dt>
4824-
* <dd>
4825-
* <p>Unit: Count</p>
4826-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
4827-
* Q in Connect</p>
4828-
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
4829-
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
4830-
* "Less than"). </p>
4831-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical">Contacts abandoned in X seconds</a>
4832-
* </p>
4833-
* </dd>
48344906
* <dt>SUM_CONTACTS_DISCONNECTED </dt>
48354907
* <dd>
48364908
* <p>Valid metric filter key: <code>DISCONNECT_REASON</code>

0 commit comments

Comments
 (0)