software.amazon.awssdk.services.connect.model.GetMetricDataV2Request

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetMetricDataV2Request.Builder,GetMetricDataV2Request>

@Generated("software.amazon.awssdk:codegen") public final class GetMetricDataV2Request extends ConnectRequest implements ToCopyableBuilder<GetMetricDataV2Request.Builder,GetMetricDataV2Request>

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static interface

GetMetricDataV2Request.Builder
Method Summary

Modifier and Type

Method

Description

static GetMetricDataV2Request.Builder

builder()

final Instant

endTime()

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

final boolean

equals(Object obj)

final boolean

equalsBySdkFields(Object obj)

Indicates whether some other object is "equal to" this one by SDK fields.

final List<FilterV2>

filters()

The filters to apply to returned metrics.

final <T> Optional<T>

getValueForField(String fieldName, Class<T> clazz)

Used to retrieve the value of a field from any class that extends SdkRequest.

final List<String>

groupings()

The grouping applied to the metrics that are returned.

final boolean

hasFilters()

For responses, this returns true if the service returned a value for the Filters property.

final boolean

hasGroupings()

For responses, this returns true if the service returned a value for the Groupings property.

final int

hashCode()

final boolean

hasMetrics()

For responses, this returns true if the service returned a value for the Metrics property.

final IntervalDetails

interval()

The interval period and timezone to apply to returned metrics.

final Integer

maxResults()

The maximum number of results to return per page.

final List<MetricV2>

metrics()

The metrics to retrieve.

final String

nextToken()

The token for the next set of results.

final String

resourceArn()

The Amazon Resource Name (ARN) of the resource.

final Map<String,SdkField<?>>

sdkFieldNameToField()

final List<SdkField<?>>

sdkFields()

static Class<? extends GetMetricDataV2Request.Builder>

serializableBuilderClass()

final Instant

startTime()

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

GetMetricDataV2Request.Builder

toBuilder()

Take this object and create a builder that contains all of the current property values of this object.

final String

toString()

Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

Method Details
- resourceArn
  
  public final String resourceArn()
  
  The Amazon Resource Name (ARN) of the resource. This includes the instanceId an Amazon Connect instance.
  
  Returns:
  
  The Amazon Resource Name (ARN) of the resource. This includes the instanceId an Amazon Connect instance.
- startTime
  
  public final Instant startTime()
  
  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:
  
  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.
- endTime
  
  public final Instant endTime()
  
  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:
  
  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.
- interval
  public final IntervalDetails interval()
  
  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:
  
  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.
- hasFilters
  
  public final boolean hasFilters()
  
  For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
- filters
  public final List<FilterV2> filters()
  
  The filters to apply to returned metrics. You can filter on the following resources:
  
  Agents
  
  Campaigns
  
  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.
  
  For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement.
  
  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 | ANSWERING_MACHINE_DETECTION_STATUS | BOT_ID | BOT_ALIAS | BOT_VERSION | BOT_LOCALE | BOT_INTENT_NAME | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE | CAMPAIGN_EXCLUDED_EVENT_TYPE | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | EVALUATION_FORM | EVALUATION_SECTION | EVALUATION_QUESTION | EVALUATION_SOURCE | FEATURE | FLOW_ACTION_ID | FLOW_TYPE | FLOWS_MODULE_RESOURCE_ID | FLOWS_NEXT_RESOURCE_ID | FLOWS_NEXT_RESOURCE_QUEUE_ID | FLOWS_OUTCOME_TYPE | FLOWS_RESOURCE_ID | FORM_VERSION | INITIATION_METHOD | INVOKING_RESOURCE_PUBLISHED_TIMESTAMP | INVOKING_RESOURCE_TYPE | PARENT_FLOWS_RESOURCE_ID | 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.
  
  Campaign ARNs are valid filterValues for the CAMPAIGN filter key.
  
  Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
  
  This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.
  
  Returns:
  
  The filters to apply to returned metrics. You can filter on the following resources:
  
  Agents
  
  Campaigns
  
  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.
  
  For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement.
  
  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 | ANSWERING_MACHINE_DETECTION_STATUS | BOT_ID | BOT_ALIAS | BOT_VERSION | BOT_LOCALE | BOT_INTENT_NAME | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE | CAMPAIGN_EXCLUDED_EVENT_TYPE | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | EVALUATION_FORM | EVALUATION_SECTION | EVALUATION_QUESTION | EVALUATION_SOURCE | FEATURE | FLOW_ACTION_ID | FLOW_TYPE | FLOWS_MODULE_RESOURCE_ID | FLOWS_NEXT_RESOURCE_ID | FLOWS_NEXT_RESOURCE_QUEUE_ID | FLOWS_OUTCOME_TYPE | FLOWS_RESOURCE_ID | FORM_VERSION | INITIATION_METHOD | INVOKING_RESOURCE_PUBLISHED_TIMESTAMP | INVOKING_RESOURCE_TYPE | PARENT_FLOWS_RESOURCE_ID | 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.
  
  Campaign ARNs are valid filterValues for the CAMPAIGN filter key.
- hasGroupings
  
  public final boolean hasGroupings()
  
  For responses, this returns true if the service returned a value for the Groupings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
- groupings
  
  public final List<String> groupings()
  
  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.
  
  Valid grouping keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS | BOT_ID | BOT_ALIAS | BOT_VERSION | BOT_LOCALE | BOT_INTENT_NAME | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE | CAMPAIGN_EXCLUDED_EVENT_TYPE | CAMPAIGN_EXECUTION_TIMESTAMP | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | EVALUATION_FORM | EVALUATION_SECTION | EVALUATION_QUESTION | EVALUATION_SOURCE | FLOWS_RESOURCE_ID | FLOWS_MODULE_RESOURCE_ID | FLOW_ACTION_ID | FLOW_TYPE | FLOWS_OUTCOME_TYPE | FORM_VERSION | INITIATION_METHOD | INVOKING_RESOURCE_PUBLISHED_TIMESTAMP | INVOKING_RESOURCE_TYPE | PARENT_FLOWS_RESOURCE_ID | Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION
  
  Type: Array of strings
  
  Array Members: Maximum number of 4 items
  
  Required: No
  
  Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
  
  This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupings() method.
  
  Returns:
  
  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.
  
  Valid grouping keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS | BOT_ID | BOT_ALIAS | BOT_VERSION | BOT_LOCALE | BOT_INTENT_NAME | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE | CAMPAIGN_EXCLUDED_EVENT_TYPE | CAMPAIGN_EXECUTION_TIMESTAMP | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | EVALUATION_FORM | EVALUATION_SECTION | EVALUATION_QUESTION | EVALUATION_SOURCE | FLOWS_RESOURCE_ID | FLOWS_MODULE_RESOURCE_ID | FLOW_ACTION_ID | FLOW_TYPE | FLOWS_OUTCOME_TYPE | FORM_VERSION | INITIATION_METHOD | INVOKING_RESOURCE_PUBLISHED_TIMESTAMP | INVOKING_RESOURCE_TYPE | PARENT_FLOWS_RESOURCE_ID | Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION
  
  Type: Array of strings
  
  Array Members: Maximum number of 4 items
  
  Required: No
- hasMetrics
  
  public final boolean hasMetrics()
  
  For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
- metrics
  public final List<MetricV2> metrics()
  
  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 Metrics definition 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
  
  AGENT_ADHERENT_TIME
  
  This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
  
  Unit: Seconds
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
  
  UI name: Adherent time
  
  AGENT_ANSWER_RATE
  
  Unit: Percent
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
  
  UI name: Agent answer rate
  
  AGENT_NON_ADHERENT_TIME
  
  Unit: Seconds
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
  
  UI name: Non-adherent time
  
  AGENT_NON_RESPONSE
  
  Unit: Count
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
  
  UI name: Agent non-response
  
  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
  
  AGENT_OCCUPANCY
  
  Unit: Percentage
  
  Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
  
  UI name: Occupancy
  
  AGENT_SCHEDULE_ADHERENCE
  
  This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
  
  Unit: Percent
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
  
  UI name: Adherence
  
  AGENT_SCHEDULED_TIME
  
  This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
  
  Unit: Seconds
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
  
  UI name: Scheduled time
  
  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
  
  AVG_ACTIVE_TIME
  
  Unit: Seconds
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
  
  UI name: Average active time
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  The Negate key in metric-level filters is not applicable for this metric.
  
  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
  
  AVG_BOT_CONVERSATION_TIME
  
  Unit: Seconds
  
  Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
  
  UI name: Average bot conversation time
  
  AVG_BOT_CONVERSATION_TURNS
  
  Unit: Count
  
  Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
  
  UI name: Average bot conversation turns
  
  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
  
  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
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  AVG_DIALS_PER_MINUTE
  
  This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
  
  Unit: Count
  
  Valid groupings and filters: Agent, Campaign, Queue, Routing Profile
  
  UI name: Average dials per minute
  
  AVG_EVALUATION_SCORE
  
  Unit: Percent
  
  Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
  
  UI name: Average evaluation score
  
  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
  
  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
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  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
  
  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
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  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
  
  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
  
  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
  
  AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION
  
  This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
  
  Unit: Seconds
  
  Valid groupings and filters: Campaign
  
  UI name: Average wait time after customer connection
  
  AVG_WEIGHTED_EVALUATION_SCORE
  
  Unit: Percent
  
  Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
  
  UI name: Average weighted evaluation score
  
  BOT_CONVERSATIONS_COMPLETED
  
  Unit: Count
  
  Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
  
  UI name: Bot conversations completed
  
  BOT_INTENTS_COMPLETED
  
  Unit: Count
  
  Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
  
  UI name: Bot intents completed
  
  CAMPAIGN_CONTACTS_ABANDONED_AFTER_X
  
  This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
  
  Unit: Count
  
  Valid groupings and filters: Agent, Campaign
  
  Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
  
  UI name: Campaign contacts abandoned after X
  
  CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE
  
  This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
  
  Unit: Percent
  
  Valid groupings and filters: Agent, Campaign
  
  Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
  
  UI name: Campaign contacts abandoned after X rate
  
  CAMPAIGN_INTERACTIONS
  
  This metric is available only for outbound campaigns using the email delivery mode.
  
  Unit: Count
  
  Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
  
  Valid groupings and filters: Campaign
  
  UI name: Campaign interactions
  
  CAMPAIGN_PROGRESS_RATE
  
  This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
  
  Unit: Percent
  
  Valid groupings and filters: Campaign, Campaign Execution Timestamp
  
  UI name: Campaign progress rate
  
  CAMPAIGN_SEND_ATTEMPTS
  
  This metric is available only for outbound campaigns.
  
  Unit: Count
  
  Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype
  
  UI name: Campaign send attempts
  
  CAMPAIGN_SEND_EXCLUSIONS
  
  This metric is available only for outbound campaigns.
  
  Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPE
  
  Unit: Count
  
  Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution Timestamp
  
  UI name: Campaign send exclusions
  
  CASES_CREATED
  
  Unit: Count
  
  Required filter key: CASE_TEMPLATE_ARN
  
  Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
  
  UI name: Cases created
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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)
  
  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
  
  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
  
  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
  
  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
  
  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
  
  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
  
  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
  
  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)
  
  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 can use LT (for "Less than") or LTE (for "Less than equal").
  
  UI name: Contacts removed from queue in X seconds
  
  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 can use LT (for "Less than") or LTE (for "Less than equal").
  
  UI name: Contacts resolved in X
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  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
  
  CURRENT_CASES
  
  Unit: Count
  
  Required filter key: CASE_TEMPLATE_ARN
  
  Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
  
  UI name: Current cases
  
  DELIVERY_ATTEMPTS
  
  This metric is available only for outbound campaigns.
  
  Unit: Count
  
  Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
  
  Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
  
  UI name: Delivery attempts
  
  Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
  
  DELIVERY_ATTEMPT_DISPOSITION_RATE
  
  This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
  
  Unit: Percent
  
  Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
  
  Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
  
  UI name: Delivery attempt disposition rate
  
  Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
  
  EVALUATIONS_PERFORMED
  
  Unit: Count
  
  Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
  
  UI name: Evaluations performed
  
  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
  
  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
  
  HUMAN_ANSWERED_CALLS
  
  This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
  
  Unit: Count
  
  Valid groupings and filters: Agent, Campaign
  
  UI name: Human answered
  
  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
  
  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
  
  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
  
  PERCENT_AUTOMATIC_FAILS
  
  Unit: Percent
  
  Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
  
  UI name: Automatic fails percent
  
  PERCENT_BOT_CONVERSATIONS_OUTCOME
  
  Unit: Percent
  
  Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
  
  UI name: Percent bot conversations outcome
  
  PERCENT_BOT_INTENTS_OUTCOME
  
  Unit: Percent
  
  Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
  
  UI name: Percent bot intents outcome
  
  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
  
  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.
  
  The FLOWS_OUTCOME_TYPE is not a valid grouping.
  
  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
  
  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
  
  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
  
  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
  
  RECIPIENTS_ATTEMPTED
  
  This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
  
  Unit: Count
  
  Valid groupings and filters: Campaign, Campaign Execution Timestamp
  
  UI name: Recipients attempted
  
  RECIPIENTS_INTERACTED
  
  This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
  
  Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
  
  Unit: Count
  
  Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype, Campaign Execution Timestamp
  
  UI name: Recipients interacted
  
  RECIPIENTS_TARGETED
  
  This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
  
  Unit: Count
  
  Valid groupings and filters: Campaign, Campaign Execution Timestamp
  
  UI name: Recipients targeted
  
  REOPENED_CASE_ACTIONS
  
  Unit: Count
  
  Required filter key: CASE_TEMPLATE_ARN
  
  Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
  
  UI name: Cases reopened
  
  RESOLVED_CASE_ACTIONS
  
  Unit: Count
  
  Required filter key: CASE_TEMPLATE_ARN
  
  Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
  
  UI name: Cases resolved
  
  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 can use LT (for "Less than") or LTE (for "Less than equal").
  
  UI name: Service level X
  
  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
  
  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
  
  The Negate key in metric-level filters is not applicable for this metric.
  
  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
  
  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 can use LT (for "Less than") or LTE (for "Less than equal").
  
  UI name: Contacts abandoned in X seconds
  
  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 can use LT (for "Less than") or LTE (for "Less than equal").
  
  UI name: Contacts answered in X seconds
  
  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
  
  SUM_CONTACT_TIME_AGENT
  
  Unit: Seconds
  
  Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
  
  UI name: Agent on contact time
  
  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
  
  SUM_ERROR_STATUS_TIME_AGENT
  
  Unit: Seconds
  
  Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
  
  UI name: Error status time
  
  SUM_HANDLE_TIME
  
  Unit: Seconds
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
  
  UI name: Contact handle time
  
  SUM_HOLD_TIME
  
  Unit: Count
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
  
  UI name: Customer hold time
  
  SUM_IDLE_TIME_AGENT
  
  Unit: Seconds
  
  Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
  
  UI name: Agent idle time
  
  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
  
  SUM_INTERACTION_TIME
  
  Unit: Seconds
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
  
  UI name: Agent interaction time
  
  SUM_NON_PRODUCTIVE_TIME_AGENT
  
  Unit: Seconds
  
  Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
  
  UI name: Agent non-productive time
  
  SUM_ONLINE_TIME_AGENT
  
  Unit: Seconds
  
  Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
  
  UI name: Online time
  
  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
  
  Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
  
  This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetrics() method.
  
  Returns:
  
  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 Metrics definition 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
  
  AGENT_ADHERENT_TIME
  
  This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
  
  Unit: Seconds
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
  
  UI name: Adherent time
  
  AGENT_ANSWER_RATE
  
  Unit: Percent
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
  
  UI name: Agent answer rate
  
  AGENT_NON_ADHERENT_TIME
  
  Unit: Seconds
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
  
  UI name: Non-adherent time
  
  AGENT_NON_RESPONSE
  
  Unit: Count
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
  
  UI name: Agent non-response
  
  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
  
  AGENT_OCCUPANCY
  
  Unit: Percentage
  
  Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
  
  UI name: Occupancy
  
  AGENT_SCHEDULE_ADHERENCE
  
  This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
  
  Unit: Percent
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
  
  UI name: Adherence
  
  AGENT_SCHEDULED_TIME
  
  This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
  
  Unit: Seconds
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
  
  UI name: Scheduled time
  
  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
  
  AVG_ACTIVE_TIME
  
  Unit: Seconds
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
  
  UI name: Average active time
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  The Negate key in metric-level filters is not applicable for this metric.
  
  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
  
  AVG_BOT_CONVERSATION_TIME
  
  Unit: Seconds
  
  Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
  
  UI name: Average bot conversation time
  
  AVG_BOT_CONVERSATION_TURNS
  
  Unit: Count
  
  Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
  
  UI name: Average bot conversation turns
  
  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
  
  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
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  AVG_DIALS_PER_MINUTE
  
  This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
  
  Unit: Count
  
  Valid groupings and filters: Agent, Campaign, Queue, Routing Profile
  
  UI name: Average dials per minute
  
  AVG_EVALUATION_SCORE
  
  Unit: Percent
  
  Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
  
  UI name: Average evaluation score
  
  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
  
  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
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  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
  
  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
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  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
  
  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
  
  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
  
  AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION
  
  This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
  
  Unit: Seconds
  
  Valid groupings and filters: Campaign
  
  UI name: Average wait time after customer connection
  
  AVG_WEIGHTED_EVALUATION_SCORE
  
  Unit: Percent
  
  Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
  
  UI name: Average weighted evaluation score
  
  BOT_CONVERSATIONS_COMPLETED
  
  Unit: Count
  
  Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
  
  UI name: Bot conversations completed
  
  BOT_INTENTS_COMPLETED
  
  Unit: Count
  
  Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
  
  UI name: Bot intents completed
  
  CAMPAIGN_CONTACTS_ABANDONED_AFTER_X
  
  This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
  
  Unit: Count
  
  Valid groupings and filters: Agent, Campaign
  
  Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
  
  UI name: Campaign contacts abandoned after X
  
  CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE
  
  This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
  
  Unit: Percent
  
  Valid groupings and filters: Agent, Campaign
  
  Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
  
  UI name: Campaign contacts abandoned after X rate
  
  CAMPAIGN_INTERACTIONS
  
  This metric is available only for outbound campaigns using the email delivery mode.
  
  Unit: Count
  
  Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
  
  Valid groupings and filters: Campaign
  
  UI name: Campaign interactions
  
  CAMPAIGN_PROGRESS_RATE
  
  This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
  
  Unit: Percent
  
  Valid groupings and filters: Campaign, Campaign Execution Timestamp
  
  UI name: Campaign progress rate
  
  CAMPAIGN_SEND_ATTEMPTS
  
  This metric is available only for outbound campaigns.
  
  Unit: Count
  
  Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype
  
  UI name: Campaign send attempts
  
  CAMPAIGN_SEND_EXCLUSIONS
  
  This metric is available only for outbound campaigns.
  
  Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPE
  
  Unit: Count
  
  Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution Timestamp
  
  UI name: Campaign send exclusions
  
  CASES_CREATED
  
  Unit: Count
  
  Required filter key: CASE_TEMPLATE_ARN
  
  Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
  
  UI name: Cases created
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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)
  
  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
  
  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
  
  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
  
  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
  
  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
  
  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
  
  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
  
  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)
  
  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 can use LT (for "Less than") or LTE (for "Less than equal").
  
  UI name: Contacts removed from queue in X seconds
  
  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 can use LT (for "Less than") or LTE (for "Less than equal").
  
  UI name: Contacts resolved in X
  
  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
  
  Feature is a valid filter but not a valid grouping.
  
  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
  
  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
  
  CURRENT_CASES
  
  Unit: Count
  
  Required filter key: CASE_TEMPLATE_ARN
  
  Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
  
  UI name: Current cases
  
  DELIVERY_ATTEMPTS
  
  This metric is available only for outbound campaigns.
  
  Unit: Count
  
  Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
  
  Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
  
  UI name: Delivery attempts
  
  Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
  
  DELIVERY_ATTEMPT_DISPOSITION_RATE
  
  This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
  
  Unit: Percent
  
  Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
  
  Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
  
  UI name: Delivery attempt disposition rate
  
  Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
  
  EVALUATIONS_PERFORMED
  
  Unit: Count
  
  Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
  
  UI name: Evaluations performed
  
  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
  
  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
  
  HUMAN_ANSWERED_CALLS
  
  This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
  
  Unit: Count
  
  Valid groupings and filters: Agent, Campaign
  
  UI name: Human answered
  
  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
  
  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
  
  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
  
  PERCENT_AUTOMATIC_FAILS
  
  Unit: Percent
  
  Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
  
  UI name: Automatic fails percent
  
  PERCENT_BOT_CONVERSATIONS_OUTCOME
  
  Unit: Percent
  
  Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
  
  UI name: Percent bot conversations outcome
  
  PERCENT_BOT_INTENTS_OUTCOME
  
  Unit: Percent
  
  Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
  
  UI name: Percent bot intents outcome
  
  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
  
  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.
  
  The FLOWS_OUTCOME_TYPE is not a valid grouping.
  
  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
  
  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
  
  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
  
  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
  
  RECIPIENTS_ATTEMPTED
  
  This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
  
  Unit: Count
  
  Valid groupings and filters: Campaign, Campaign Execution Timestamp
  
  UI name: Recipients attempted
  
  RECIPIENTS_INTERACTED
  
  This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
  
  Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
  
  Unit: Count
  
  Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype, Campaign Execution Timestamp
  
  UI name: Recipients interacted
  
  RECIPIENTS_TARGETED
  
  This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
  
  Unit: Count
  
  Valid groupings and filters: Campaign, Campaign Execution Timestamp
  
  UI name: Recipients targeted
  
  REOPENED_CASE_ACTIONS
  
  Unit: Count
  
  Required filter key: CASE_TEMPLATE_ARN
  
  Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
  
  UI name: Cases reopened
  
  RESOLVED_CASE_ACTIONS
  
  Unit: Count
  
  Required filter key: CASE_TEMPLATE_ARN
  
  Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
  
  UI name: Cases resolved
  
  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 can use LT (for "Less than") or LTE (for "Less than equal").
  
  UI name: Service level X
  
  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
  
  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
  
  The Negate key in metric-level filters is not applicable for this metric.
  
  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
  
  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 can use LT (for "Less than") or LTE (for "Less than equal").
  
  UI name: Contacts abandoned in X seconds
  
  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 can use LT (for "Less than") or LTE (for "Less than equal").
  
  UI name: Contacts answered in X seconds
  
  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
  
  SUM_CONTACT_TIME_AGENT
  
  Unit: Seconds
  
  Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
  
  UI name: Agent on contact time
  
  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
  
  SUM_ERROR_STATUS_TIME_AGENT
  
  Unit: Seconds
  
  Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
  
  UI name: Error status time
  
  SUM_HANDLE_TIME
  
  Unit: Seconds
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
  
  UI name: Contact handle time
  
  SUM_HOLD_TIME
  
  Unit: Count
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
  
  UI name: Customer hold time
  
  SUM_IDLE_TIME_AGENT
  
  Unit: Seconds
  
  Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
  
  UI name: Agent idle time
  
  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
  
  SUM_INTERACTION_TIME
  
  Unit: Seconds
  
  Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
  
  UI name: Agent interaction time
  
  SUM_NON_PRODUCTIVE_TIME_AGENT
  
  Unit: Seconds
  
  Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
  
  UI name: Agent non-productive time
  
  SUM_ONLINE_TIME_AGENT
  
  Unit: Seconds
  
  Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
  
  UI name: Online time
  
  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
- nextToken
  
  public final String nextToken()
  
  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:
  
  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.
- maxResults
  
  public final Integer maxResults()
  
  The maximum number of results to return per page.
  
  Returns:
  
  The maximum number of results to return per page.
- toBuilder
  
  public GetMetricDataV2Request.Builder toBuilder()
  
  Description copied from interface: ToCopyableBuilder
  
  Take this object and create a builder that contains all of the current property values of this object.
  
  Specified by:
  
  toBuilder in interface ToCopyableBuilder<GetMetricDataV2Request.Builder,GetMetricDataV2Request>
  
  Specified by:
  
  toBuilder in class ConnectRequest
  
  Returns:
  
  a builder for type T
- builder
  
  public static GetMetricDataV2Request.Builder builder()
- serializableBuilderClass
  
  public static Class<? extends GetMetricDataV2Request.Builder> serializableBuilderClass()
- hashCode
  
  public final int hashCode()
  
  Overrides:
  
  hashCode in class AwsRequest
- equals
  
  public final boolean equals(Object obj)
  
  Overrides:
  
  equals in class AwsRequest
- equalsBySdkFields
  
  public final boolean equalsBySdkFields(Object obj)
  
  Description copied from interface: SdkPojo
  
  Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
  If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
  
  Specified by:
  
  equalsBySdkFields in interface SdkPojo
  
  Parameters:
  
  obj - the object to be compared with
  
  Returns:
  
  true if the other object equals to this object by sdk fields, false otherwise.
- toString
  
  public final String toString()
  
  Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
  
  Overrides:
  
  toString in class Object
- getValueForField
  
  public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
  
  Description copied from class: SdkRequest
  
  Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
  
  Overrides:
  
  getValueForField in class SdkRequest
  
  Parameters:
  
  fieldName - The name of the member to be retrieved.
  
  clazz - The class to cast the returned object to.
  
  Returns:
  
  Optional containing the casted return value
- sdkFields
  
  public final List<SdkField<?>> sdkFields()
  
  Specified by:
  
  sdkFields in interface SdkPojo
  
  Returns:
  
  List of SdkField in this POJO. May be empty list but should never be null.
- sdkFieldNameToField
  
  public final Map<String,SdkField<?>> sdkFieldNameToField()
  
  Specified by:
  
  sdkFieldNameToField in interface SdkPojo
  
  Returns:
  
  The mapping between the field name and its corresponding field.

Class GetMetricDataV2Request

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Details

resourceArn

startTime

endTime

interval

hasFilters

filters

hasGroupings

groupings

hasMetrics

metrics

nextToken

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField