AWS connect documentation change
Summary
Restructured metric documentation with improved formatting, added calculation logic sections, API access details, and standardized presentation of metric properties (type/category/notes). No functional changes to metric definitions.
Security assessment
Changes are purely documentation improvements for metric definitions and API usage patterns. No security controls, vulnerabilities, or security features are mentioned or modified in the documentation updates.
Diff
diff --git a/connect/latest/adminguide/bot-metrics.md b/connect/latest/adminguide/bot-metrics.md index 4ff98048e..1efd31fa9 100644 --- a//connect/latest/adminguide/bot-metrics.md +++ b//connect/latest/adminguide/bot-metrics.md @@ -13 +13 @@ The following flow driven metrics are available on the [Flows and conversational -The average duration of completed conversations for which the invoking resource (flow or flow module) started between the specified start and end time. It can be filtered on specific conversation outcomes with `BOT_CONVERSATION_OUTCOME_TYPE` metric level filter. +This metric measures the average duration of completed conversations for which the invoking resource (flow or flow module) started between the specified start and end time. @@ -15 +15 @@ The average duration of completed conversations for which the invoking resource -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `AVG_BOT_CONVERSATION_TIME`. +**Metric type** : String (_hh:mm:ss_) @@ -17 +17,21 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -Data for this metric is available starting from December 2, 2024 00:00:00 GMT. +**Metric category** : Flow driven metric + +**How to access using the Amazon Connect API** : + + * [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API metric identifier: `AVG_BOT_CONVERSATION_TIME` + +It can be filtered on specific conversation outcomes with `BOT_CONVERSATION_OUTCOME_TYPE` metric level filter. + + + + +**Calculation logic** : + + * Sum(Conversation Start Time - Conversation End Time of all filtered conversations) / (Count of all filtered conversations) + + + + +**Notes** : + + * Data for this metric is available starting from December 2, 2024 00:00:00 GMT. @@ -19 +38,0 @@ Data for this metric is available starting from December 2, 2024 00:00:00 GMT. -Type: String (_hh:mm:ss_) @@ -21 +39,0 @@ Type: String (_hh:mm:ss_) -Category: Flow driven metric @@ -23 +40,0 @@ Category: Flow driven metric -Calculation logic: Sum(Conversation Start Time - Conversation End Time of all filtered conversations) / (Count of all filtered conversations) @@ -27 +44 @@ Calculation logic: Sum(Conversation Start Time - Conversation End Time of all fi -The average number of turns for completed conversations for which the invoking resource (flow or flow module) started between the specified start and end time. It can be filtered on specific conversation outcomes with `BOT_CONVERSATION_OUTCOME_TYPE` metric level filter. +This metric provides the average number of turns for completed conversations for which the invoking resource (flow or flow module) started between the specified start and end time. @@ -31 +48,9 @@ A single turn is a request from the client application and a response from the b -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `AVG_BOT_CONVERSATION_TURNS`. +**Metric type** : Double + +**Metric category** : Flow driven metric + +**How to access using the Amazon Connect API** : + + * [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API metric identifier: `AVG_BOT_CONVERSATION_TURNS` + +It can be filtered on specific conversation outcomes with `BOT_CONVERSATION_OUTCOME_TYPE` metric level filter. @@ -33 +57,0 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -Data for this metric is available starting from December 2, 2024 00:00:00 GMT. @@ -35 +58,0 @@ Data for this metric is available starting from December 2, 2024 00:00:00 GMT. -Type: Double @@ -37 +59,0 @@ Type: Double -Category: Flow driven metric @@ -39 +61,13 @@ Category: Flow driven metric -Calculation logic: Sum(Conversation Turn of all filtered conversations) / (Count of all filtered conversations) +**Calculation logic** : + + * Sum(Conversation Turn of all filtered conversations) / (Count of all filtered conversations) + + + + +**Notes** : + + * Data for this metric is available starting from December 2, 2024 00:00:00 GMT. + + + @@ -43 +77 @@ Calculation logic: Sum(Conversation Turn of all filtered conversations) / (Count -The count of completed conversations for which the invoking resource (flow or flow module) started between the specified start and end time. The conversation end time can be beyond the specified end time. +This metric provides the count of completed conversations for which the invoking resource (flow or flow module) started between the specified start and end time. The conversation end time can be beyond the specified end time. @@ -61 +95 @@ but will exclude conversations for which the invoking resource (flow or flow mod -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `BOT_CONVERSATIONS_COMPLETED`. +**Metric type** : Integer @@ -63 +97,5 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -Data for this metric is available starting from December 2, 2024 00:00:00 GMT. +**Metric category** : Flow driven metric + +**How to access using the Amazon Connect API** : + + * [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API metric identifier: `BOT_CONVERSATIONS_COMPLETED` @@ -76 +114,11 @@ It can be filtered on the following conversation outcomes using metric level fil -Type: Integer +**Calculation logic** : + + * Total count of conversations. + + + + +**Notes** : + + * Data for this metric is available starting from December 2, 2024 00:00:00 GMT. + @@ -78 +125,0 @@ Type: Integer -Category: Flow driven metric @@ -80 +126,0 @@ Category: Flow driven metric -Calculation logic: Total count of conversations @@ -84 +130,5 @@ Calculation logic: Total count of conversations -The count of completed intents. It includes intents for completed conversations where the invoking resource (flow or flow module) started between the specified start and end time. +This metric provides the count of completed intents. It includes intents for completed conversations where the invoking resource (flow or flow module) started between the specified start and end time. + +**Metric type** : Integer + +**Metric category** : Flow driven metric @@ -86 +136 @@ The count of completed intents. It includes intents for completed conversations -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `BOT_INTENTS_COMPLETED`. +**How to access using the Amazon Connect API** : @@ -88 +138,3 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -Data for this metric is available starting from December 2, 2024 00:00:00 GMT. + * [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API metric identifier: `BOT_INTENTS_COMPLETED` + +It can be filtered on the following conversation outcomes using metric level filter `BOT_CONVERSATION_OUTCOME_TYPE`. @@ -111 +163,11 @@ It can be filtered on the following intent outcomes using metric level filter `B -Type: Integer +**Calculation logic** : + + * Total count of intents. + + + + +**Notes** : + + * Data for this metric is available starting from December 2, 2024 00:00:00 GMT. + @@ -113 +174,0 @@ Type: Integer -Category: Flow driven metric @@ -115 +175,0 @@ Category: Flow driven metric -Calculation logic: Total count of intents @@ -119 +179,10 @@ Calculation logic: Total count of intents -The percentage of total conversations that ended in the specific outcome type specified in the metric level filter (`BOT_CONVERSATION_OUTCOME_TYPE`). It only includes completed conversations for which the invoking resource (flow or flow module) started between the specified start and end time. +This metric provides the percentage of total conversations that ended in the specific outcome type specified in the metric level filter (`BOT_CONVERSATION_OUTCOME_TYPE`). It only includes completed conversations for which the invoking resource (flow or flow module) started between the specified start and end time. + +**Metric type** : Percent + +**Metric category** : Flow driven metric + +**How to access using the Amazon Connect API** : + + * [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API metric identifier: `PERCENT_BOT_CONVERSATIONS_OUTCOME` + @@ -121 +189,0 @@ The percentage of total conversations that ended in the specific outcome type sp -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `PERCENT_BOT_CONVERSATIONS_OUTCOME`. @@ -123 +190,0 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -Data for this metric is available starting from December 2, 2024 00:00:00 GMT. @@ -125 +192,13 @@ Data for this metric is available starting from December 2, 2024 00:00:00 GMT. -Type: Percent +**How to access using the Amazon Connect admin website** : + +**Calculation logic** : + + * (Count of conversations with BOT_CONVERSATION_OUTCOME_TYPE)/(Total count of conversations) * 100 + + + + +**Notes** : + + * Data for this metric is available starting from December 2, 2024 00:00:00 GMT. + @@ -127 +205,0 @@ Type: Percent -Category: Flow driven metric @@ -129 +206,0 @@ Category: Flow driven metric -Calculation logic: (Count of conversations with BOT_CONVERSATION_OUTCOME_TYPE)/(Total count of conversations) * 100 @@ -133 +210,14 @@ Calculation logic: (Count of conversations with BOT_CONVERSATION_OUTCOME_TYPE)/( -The percentage of intents that ended in the specific outcome type specified in the metric level filter (`BOT_INTENT_OUTCOME_TYPE`). It includes intents in completed conversations where the invoking resource (flow or flow module) started between the specified start and end time. +This metric provides the percentage of intents that ended in the specific outcome type specified in the metric level filter (`BOT_INTENT_OUTCOME_TYPE`). It includes intents in completed conversations where the invoking resource (flow or flow module) started between the specified start and end time. + +**Metric type** : Percent + +**Metric category** : Flow driven metric + +**How to access using the Amazon Connect API** : + + * [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API metric identifier: `PERCENT_BOT_INTENTS_OUTCOME` + + + + +**How to access using the Amazon Connect admin website** : @@ -135 +225 @@ The percentage of intents that ended in the specific outcome type specified in t -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `PERCENT_BOT_INTENTS_OUTCOME`. +**Calculation logic** : @@ -137 +227 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -Data for this metric is available starting from December 2, 2024 00:00:00 GMT. + * (Count of intents with BOT_INTENT_OUTCOME_TYPE)/(Total count of intents) * 100 @@ -139 +228,0 @@ Data for this metric is available starting from December 2, 2024 00:00:00 GMT. -Type: Percent @@ -141 +229,0 @@ Type: Percent -Category: Flow driven metric @@ -143 +230,0 @@ Category: Flow driven metric -Calculation logic: (Count of intents with BOT_INTENT_OUTCOME_TYPE)/(Total count of intents) * 100