MetricFilterV2

PDF

Contains information about the filter used when retrieving metrics. MetricFiltersV2 can be used on the following metrics: AVG_AGENT_CONNECTING_TIME, CONTACTS_CREATED, CONTACTS_HANDLED, SUM_CONTACTS_DISCONNECTED.

Contents

MetricFilterKey

The key to use for filtering data.

Valid metric filter keys:

• ANSWERING_MACHINE_DETECTION_STATUS

• CASE_STATUS

• DISCONNECT_REASON

• FLOWS_ACTION_IDENTIFIER

• FLOWS_NEXT_ACTION_IDENTIFIER

• FLOWS_OUTCOME_TYPE

• FLOWS_RESOURCE_TYPE

• INITIATION_METHOD

Type: String

Required: No

MetricFilterValues

The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a customized list, depending on the use case.

For valid values of metric-level filters INITIATION_METHOD, DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Amazon Connect Administrator Guide.

For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the description for the Flow outcome metric in the Amazon Connect Administrator Guide.

For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE, see the description for the Bot conversations completed in the Amazon Connect Administrator Guide.

For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE, see the description for the Bot intents completed metric in the Amazon Connect Administrator Guide.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

Negate

If set to true, the API response contains results that filter out the results matched by the metric-level filters condition. By default, Negate is set to false.

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3