Skip to content

Commit

Permalink
docs(client-connect): GetMetricDataV2 API: Update to include Contact …
Browse files Browse the repository at this point in the history 
…Lens Conversational Analytics Metrics
  • Loading branch information
awstools committed Jul 18, 2023
1 parent 171254f commit 25ef531
Show file tree
Hide file tree
Showing 8 changed files with 143 additions and 34 deletions.
7 changes: 4 additions & 3 deletions clients/client-connect/src/commands/CreateEvaluationFormCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,10 @@ export interface CreateEvaluationFormCommandOutput extends CreateEvaluationFormR

/**
* @public
* <p>Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define
* questions related to agent performance, and create sections to organize such questions. Question and section identifiers
* cannot be duplicated within the same evaluation form.</p>
* <p>Creates an evaluation form in the specified Amazon Connect instance. The form can be
* used to define questions related to agent performance, and create sections to organize such
* questions. Question and section identifiers cannot be duplicated within the same evaluation
* form.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
2 changes: 1 addition & 1 deletion clients/client-connect/src/commands/CreateParticipantCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export interface CreateParticipantCommandOutput extends CreateParticipantRespons
/**
* @public
* <p>Adds a new participant into an on-going chat contact. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html">Customize chat
* flow experiences by integrating custom participants</a>.</p>
* flow experiences by integrating custom participants</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
4 changes: 3 additions & 1 deletion clients/client-connect/src/commands/CreatePromptCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ export interface CreatePromptCommandOutput extends CreatePromptResponse, __Metad

/**
* @public
* <p>Creates a prompt. For more information about prompts, such as supported file types and 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 Guide</i>.</p>
* <p>Creates a prompt. For more information about prompts, such as supported file types and
* 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
* Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
3 changes: 2 additions & 1 deletion clients/client-connect/src/commands/SearchHoursOfOperationsCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ export interface SearchHoursOfOperationsCommandOutput extends SearchHoursOfOpera

/**
* @public
* <p>Searches the hours of operation in an Amazon Connect instance, with optional filtering.</p>
* <p>Searches the hours of operation in an Amazon Connect instance, with optional
* filtering.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
7 changes: 4 additions & 3 deletions clients/client-connect/src/commands/UpdateEvaluationFormCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,10 @@ export interface UpdateEvaluationFormCommandOutput extends UpdateEvaluationFormR
/**
* @public
* <p>Updates details about a specific evaluation form version in the specified Amazon Connect
* instance. Question and section
* identifiers cannot be duplicated within the same evaluation form.</p>
* <p>This operation does not support partial updates. Instead it does a full update of evaluation form content.</p>
* instance. Question and section identifiers cannot be duplicated within the same evaluation
* form.</p>
* <p>This operation does not support partial updates. Instead it does a full update of evaluation
* form content.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
8 changes: 4 additions & 4 deletions clients/client-connect/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ export interface ActivateEvaluationFormRequest {
EvaluationFormId: string | undefined;

/**
* <p>The version of the evaluation form to activate. If the version property is not provided, the latest version of the
* evaluation form is activated.</p>
* <p>The version of the evaluation form to activate. If the version property is not provided, the
* latest version of the evaluation form is activated.</p>
*/
EvaluationFormVersion: number | undefined;
}
Expand Down Expand Up @@ -2188,8 +2188,8 @@ export interface ParticipantTokenCredentials {
*/
export interface CreateParticipantResponse {
/**
* <p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The participant
* token is valid for the lifetime of a chat participant.</p>
* <p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The
* participant token is valid for the lifetime of a chat participant.</p>
*/
ParticipantCredentials?: ParticipantTokenCredentials;

Expand Down
128 changes: 116 additions & 12 deletions clients/client-connect/src/models/models_1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1171,6 +1171,9 @@ export interface GetMetricDataV2Request {
* <li>
* <p>User hierarchy groups</p>
* </li>
* <li>
* <p>Feature</p>
* </li>
* </ul>
* <p>At least one filter must be passed from queues, routing profiles, agents, or user hierarchy
* groups.</p>
Expand All @@ -1185,16 +1188,21 @@ export interface GetMetricDataV2Request {
* a single request. Valid filter keys: <code>QUEUE</code> | <code>ROUTING_PROFILE</code> |
* <code>AGENT</code> | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
* <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
* <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code>
* <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> |
* <code>FEATURE</code>
* </p>
* </li>
* <li>
* <p>
* <b>Filter values</b>: A maximum of 100 filter values are
* supported in a single request. VOICE, CHAT, and TASK are valid <code>filterValue</code> for the CHANNEL
* filter key. They do not count towards limitation of 100 filter values. For example, a
* supported in a single request. VOICE, CHAT, and TASK are valid <code>filterValue</code> 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.</p>
* of 100 filter values, along with 3 channel filters. </p>
* <p>
* <code>contact_lens_conversational_analytics</code> is a valid filterValue for the
* <code>FEATURE</code> filter key. It is available only to contacts analyzed by Contact Lens
* conversational analytics.</p>
* </li>
* </ul>
*/
Expand Down Expand Up @@ -1254,7 +1262,10 @@ export interface GetMetricDataV2Request {
* <dt>AVG_AFTER_CONTACT_WORK_TIME</dt>
* <dd>
* <p>Unit: Seconds</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature</p>
* <note>
* <p>Feature is a valid filter but not a valid grouping.</p>
* </note>
* </dd>
* <dt>AVG_AGENT_CONNECTING_TIME</dt>
* <dd>
Expand All @@ -1265,16 +1276,58 @@ export interface GetMetricDataV2Request {
* </p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
* </dd>
* <dt>AVG_HANDLE_TIME</dt>
* <dt>AVG_AGENT_CONNECTING_TIME</dt>
* <dd>
* <p>Unit: Seconds</p>
* <p>Valid metric filter key: <code>INITIATION_METHOD</code>. For now, this metric only
* supports the following as <code>INITIATION_METHOD</code>: <code>INBOUND</code> |
* <code>OUTBOUND</code> | <code>CALLBACK</code> | <code>API</code>
* </p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
* </dd>
* <dt>AVG_HOLD_TIME</dt>
* <dt>AVG_CONTACT_DURATION</dt>
* <dd>
* <p>Unit: Seconds</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature</p>
* <note>
* <p>Feature is a valid filter but not a valid grouping.</p>
* </note>
* </dd>
* <dt>AVG_CONVERSATION_DURATION</dt>
* <dd>
* <p>Unit: Seconds</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
* </dd>
* <dt>AVG_GREETING_TIME_AGENT</dt>
* <dd>
* <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
* <p>Unit: Seconds</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
* </dd>
* <dt>AVG_HANDLE_TIME</dt>
* <dd>
* <p>Unit: Seconds</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature</p>
* <note>
* <p>Feature is a valid filter but not a valid grouping.</p>
* </note>
* </dd>
* <dt>AVG_HOLD_TIME</dt>
* <dd>
* <p>Unit: Seconds</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature</p>
* <note>
* <p>Feature is a valid filter but not a valid grouping.</p>
* </note>
* </dd>
* <dt>AVG_HOLDS</dt>
* <dd>
* <p>Unit: Count</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature</p>
* <note>
* <p>Feature is a valid filter but not a valid grouping.</p>
* </note>
* </dd>
* <dt>AVG_INTERACTION_AND_HOLD_TIME</dt>
* <dd>
* <p>Unit: Seconds</p>
Expand All @@ -1283,12 +1336,54 @@ export interface GetMetricDataV2Request {
* <dt>AVG_INTERACTION_TIME</dt>
* <dd>
* <p>Unit: Seconds</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature</p>
* <note>
* <p>Feature is a valid filter but not a valid grouping.</p>
* </note>
* </dd>
* <dt>AVG_INTERRUPTIONS_AGENT</dt>
* <dd>
* <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
* <p>Unit: Count</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
* </dd>
* <dt>AVG_INTERRUPTION_TIME_AGENT</dt>
* <dd>
* <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
* <p>Unit: Seconds</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
* </dd>
* <dt>AVG_NON_TALK_TIME</dt>
* <dd>
* <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
* <p>Unit: Seconds</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
* </dd>
* <dt>AVG_QUEUE_ANSWER_TIME</dt>
* <dd>
* <p>Unit: Seconds</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature</p>
* <note>
* <p>Feature is a valid filter but not a valid grouping.</p>
* </note>
* </dd>
* <dt>AVG_TALK_TIME</dt>
* <dd>
* <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
* <p>Unit: Seconds</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
* </dd>
* <dt>AVG_TALK_TIME_AGENT</dt>
* <dd>
* <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
* <p>Unit: Seconds</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
* </dd>
* <dt>AVG_TALK_TIME_CUSTOMER</dt>
* <dd>
* <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
* <p>Unit: Seconds</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
* </dd>
* <dt>CONTACTS_ABANDONED</dt>
* <dd>
Expand All @@ -1300,15 +1395,21 @@ export interface GetMetricDataV2Request {
* <p>Unit: Count</p>
* <p>Valid metric filter key: <code>INITIATION_METHOD</code>
* </p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature</p>
* <note>
* <p>Feature is a valid filter but not a valid grouping.</p>
* </note>
* </dd>
* <dt>CONTACTS_HANDLED</dt>
* <dd>
* <p>Unit: Count</p>
* <p>Valid metric filter key: <code>INITIATION_METHOD</code>,
* <code>DISCONNECT_REASON</code>
* </p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature</p>
* <note>
* <p>Feature is a valid filter but not a valid grouping.</p>
* </note>
* </dd>
* <dt>CONTACTS_HOLD_ABANDONS</dt>
* <dd>
Expand All @@ -1323,7 +1424,10 @@ export interface GetMetricDataV2Request {
* <dt>CONTACTS_TRANSFERRED_OUT</dt>
* <dd>
* <p>Unit: Count</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature</p>
* <note>
* <p>Feature is a valid filter but not a valid grouping.</p>
* </note>
* </dd>
* <dt>CONTACTS_TRANSFERRED_OUT_BY_AGENT</dt>
* <dd>
Expand Down
Loading

0 comments on commit 25ef531

Please sign in to comment.