Interface GetMetricDataV2Request.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,ConnectRequest.Builder,CopyableBuilder<GetMetricDataV2Request.Builder,GetMetricDataV2Request>,SdkBuilder<GetMetricDataV2Request.Builder,GetMetricDataV2Request>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- GetMetricDataV2Request
public static interface GetMetricDataV2Request.Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<GetMetricDataV2Request.Builder,GetMetricDataV2Request>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description GetMetricDataV2Request.BuilderendTime(Instant endTime)The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data.GetMetricDataV2Request.Builderfilters(Collection<FilterV2> filters)The filters to apply to returned metrics.GetMetricDataV2Request.Builderfilters(Consumer<FilterV2.Builder>... filters)The filters to apply to returned metrics.GetMetricDataV2Request.Builderfilters(FilterV2... filters)The filters to apply to returned metrics.GetMetricDataV2Request.Buildergroupings(String... groupings)The grouping applied to the metrics that are returned.GetMetricDataV2Request.Buildergroupings(Collection<String> groupings)The grouping applied to the metrics that are returned.default GetMetricDataV2Request.Builderinterval(Consumer<IntervalDetails.Builder> interval)The interval period and timezone to apply to returned metrics.GetMetricDataV2Request.Builderinterval(IntervalDetails interval)The interval period and timezone to apply to returned metrics.GetMetricDataV2Request.BuildermaxResults(Integer maxResults)The maximum number of results to return per page.GetMetricDataV2Request.Buildermetrics(Collection<MetricV2> metrics)The metrics to retrieve.GetMetricDataV2Request.Buildermetrics(Consumer<MetricV2.Builder>... metrics)The metrics to retrieve.GetMetricDataV2Request.Buildermetrics(MetricV2... metrics)The metrics to retrieve.GetMetricDataV2Request.BuildernextToken(String nextToken)The token for the next set of results.GetMetricDataV2Request.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)GetMetricDataV2Request.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)GetMetricDataV2Request.BuilderresourceArn(String resourceArn)The Amazon Resource Name (ARN) of the resource.GetMetricDataV2Request.BuilderstartTime(Instant startTime)The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
resourceArn
GetMetricDataV2Request.Builder resourceArn(String resourceArn)
The Amazon Resource Name (ARN) of the resource. This includes the
instanceIdan Amazon Connect instance.- Parameters:
resourceArn- The Amazon Resource Name (ARN) of the resource. This includes theinstanceIdan Amazon Connect instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startTime
GetMetricDataV2Request.Builder startTime(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
IntervalPeriodselected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.- Parameters:
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 theIntervalPeriodselected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endTime
GetMetricDataV2Request.Builder endTime(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
interval
GetMetricDataV2Request.Builder interval(IntervalDetails interval)
The interval period and timezone to apply to returned metrics.
-
IntervalPeriod: An aggregated grouping applied to request metrics. ValidIntervalPeriodvalues are:FIFTEEN_MIN|THIRTY_MIN|HOUR|DAY|WEEK|TOTAL.For example, if
IntervalPeriodis selectedTHIRTY_MIN,StartTimeandEndTimediffers 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 theTOTALinterval period.The following list describes restrictions on
StartTimeandEndTimebased on whichIntervalPeriodis requested.-
FIFTEEN_MIN: The difference betweenStartTimeandEndTimemust be less than 3 days. -
THIRTY_MIN: The difference betweenStartTimeandEndTimemust be less than 3 days. -
HOUR: The difference betweenStartTimeandEndTimemust be less than 3 days. -
DAY: The difference betweenStartTimeandEndTimemust be less than 35 days. -
WEEK: The difference betweenStartTimeandEndTimemust be less than 35 days. -
TOTAL: The difference betweenStartTimeandEndTimemust be less than 35 days.
-
-
TimeZone: The timezone applied to requested metrics.
- Parameters:
interval- The interval period and timezone to apply to returned metrics.-
IntervalPeriod: An aggregated grouping applied to request metrics. ValidIntervalPeriodvalues are:FIFTEEN_MIN|THIRTY_MIN|HOUR|DAY|WEEK|TOTAL.For example, if
IntervalPeriodis selectedTHIRTY_MIN,StartTimeandEndTimediffers 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 theTOTALinterval period.The following list describes restrictions on
StartTimeandEndTimebased on whichIntervalPeriodis requested.-
FIFTEEN_MIN: The difference betweenStartTimeandEndTimemust be less than 3 days. -
THIRTY_MIN: The difference betweenStartTimeandEndTimemust be less than 3 days. -
HOUR: The difference betweenStartTimeandEndTimemust be less than 3 days. -
DAY: The difference betweenStartTimeandEndTimemust be less than 35 days. -
WEEK: The difference betweenStartTimeandEndTimemust be less than 35 days. -
TOTAL: The difference betweenStartTimeandEndTimemust be less than 35 days.
-
-
TimeZone: The timezone applied to requested metrics.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
interval
default GetMetricDataV2Request.Builder interval(Consumer<IntervalDetails.Builder> interval)
The interval period and timezone to apply to returned metrics.
-
IntervalPeriod: An aggregated grouping applied to request metrics. ValidIntervalPeriodvalues are:FIFTEEN_MIN|THIRTY_MIN|HOUR|DAY|WEEK|TOTAL.For example, if
IntervalPeriodis selectedTHIRTY_MIN,StartTimeandEndTimediffers 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 theTOTALinterval period.The following list describes restrictions on
StartTimeandEndTimebased on whichIntervalPeriodis requested.-
FIFTEEN_MIN: The difference betweenStartTimeandEndTimemust be less than 3 days. -
THIRTY_MIN: The difference betweenStartTimeandEndTimemust be less than 3 days. -
HOUR: The difference betweenStartTimeandEndTimemust be less than 3 days. -
DAY: The difference betweenStartTimeandEndTimemust be less than 35 days. -
WEEK: The difference betweenStartTimeandEndTimemust be less than 35 days. -
TOTAL: The difference betweenStartTimeandEndTimemust be less than 35 days.
-
-
TimeZone: The timezone applied to requested metrics.
IntervalDetails.Builderavoiding the need to create one manually viaIntervalDetails.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tointerval(IntervalDetails).- Parameters:
interval- a consumer that will call methods onIntervalDetails.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
interval(IntervalDetails)
-
-
filters
GetMetricDataV2Request.Builder filters(Collection<FilterV2> filters)
The filters to apply to returned metrics. You can filter on the following resources:
-
Queues
-
Routing profiles
-
Agents
-
Channels
-
User hierarchy groups
-
Feature
-
Routing step expression
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.
Note the following limits:
-
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys:
QUEUE|ROUTING_PROFILE|AGENT|CHANNEL|AGENT_HIERARCHY_LEVEL_ONE|AGENT_HIERARCHY_LEVEL_TWO|AGENT_HIERARCHY_LEVEL_THREE|AGENT_HIERARCHY_LEVEL_FOUR|AGENT_HIERARCHY_LEVEL_FIVE|FEATURE|contact/segmentAttributes/connect:Subtype|ROUTING_STEP_EXPRESSION -
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid
filterValuefor 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_analyticsis a valid filterValue for theFEATUREfilter key. It is available only to contacts analyzed by Contact Lens conversational analytics.connect:Chat,connect:SMS,connect:Telephony, andconnect:WebRTCare validfilterValueexamples (not exhaustive) for thecontact/segmentAttributes/connect:Subtype filterkey.ROUTING_STEP_EXPRESSIONis 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.
- Parameters:
filters- The filters to apply to returned metrics. You can filter on the following resources:-
Queues
-
Routing profiles
-
Agents
-
Channels
-
User hierarchy groups
-
Feature
-
Routing step expression
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.
Note the following limits:
-
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys:
QUEUE|ROUTING_PROFILE|AGENT|CHANNEL|AGENT_HIERARCHY_LEVEL_ONE|AGENT_HIERARCHY_LEVEL_TWO|AGENT_HIERARCHY_LEVEL_THREE|AGENT_HIERARCHY_LEVEL_FOUR|AGENT_HIERARCHY_LEVEL_FIVE|FEATURE|contact/segmentAttributes/connect:Subtype|ROUTING_STEP_EXPRESSION -
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid
filterValuefor 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_analyticsis a valid filterValue for theFEATUREfilter key. It is available only to contacts analyzed by Contact Lens conversational analytics.connect:Chat,connect:SMS,connect:Telephony, andconnect:WebRTCare validfilterValueexamples (not exhaustive) for thecontact/segmentAttributes/connect:Subtype filterkey.ROUTING_STEP_EXPRESSIONis 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
GetMetricDataV2Request.Builder filters(FilterV2... filters)
The filters to apply to returned metrics. You can filter on the following resources:
-
Queues
-
Routing profiles
-
Agents
-
Channels
-
User hierarchy groups
-
Feature
-
Routing step expression
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.
Note the following limits:
-
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys:
QUEUE|ROUTING_PROFILE|AGENT|CHANNEL|AGENT_HIERARCHY_LEVEL_ONE|AGENT_HIERARCHY_LEVEL_TWO|AGENT_HIERARCHY_LEVEL_THREE|AGENT_HIERARCHY_LEVEL_FOUR|AGENT_HIERARCHY_LEVEL_FIVE|FEATURE|contact/segmentAttributes/connect:Subtype|ROUTING_STEP_EXPRESSION -
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid
filterValuefor 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_analyticsis a valid filterValue for theFEATUREfilter key. It is available only to contacts analyzed by Contact Lens conversational analytics.connect:Chat,connect:SMS,connect:Telephony, andconnect:WebRTCare validfilterValueexamples (not exhaustive) for thecontact/segmentAttributes/connect:Subtype filterkey.ROUTING_STEP_EXPRESSIONis 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.
- Parameters:
filters- The filters to apply to returned metrics. You can filter on the following resources:-
Queues
-
Routing profiles
-
Agents
-
Channels
-
User hierarchy groups
-
Feature
-
Routing step expression
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.
Note the following limits:
-
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys:
QUEUE|ROUTING_PROFILE|AGENT|CHANNEL|AGENT_HIERARCHY_LEVEL_ONE|AGENT_HIERARCHY_LEVEL_TWO|AGENT_HIERARCHY_LEVEL_THREE|AGENT_HIERARCHY_LEVEL_FOUR|AGENT_HIERARCHY_LEVEL_FIVE|FEATURE|contact/segmentAttributes/connect:Subtype|ROUTING_STEP_EXPRESSION -
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid
filterValuefor 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_analyticsis a valid filterValue for theFEATUREfilter key. It is available only to contacts analyzed by Contact Lens conversational analytics.connect:Chat,connect:SMS,connect:Telephony, andconnect:WebRTCare validfilterValueexamples (not exhaustive) for thecontact/segmentAttributes/connect:Subtype filterkey.ROUTING_STEP_EXPRESSIONis 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
GetMetricDataV2Request.Builder filters(Consumer<FilterV2.Builder>... filters)
The filters to apply to returned metrics. You can filter on the following resources:
-
Queues
-
Routing profiles
-
Agents
-
Channels
-
User hierarchy groups
-
Feature
-
Routing step expression
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.
Note the following limits:
-
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys:
QUEUE|ROUTING_PROFILE|AGENT|CHANNEL|AGENT_HIERARCHY_LEVEL_ONE|AGENT_HIERARCHY_LEVEL_TWO|AGENT_HIERARCHY_LEVEL_THREE|AGENT_HIERARCHY_LEVEL_FOUR|AGENT_HIERARCHY_LEVEL_FIVE|FEATURE|contact/segmentAttributes/connect:Subtype|ROUTING_STEP_EXPRESSION -
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid
filterValuefor 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_analyticsis a valid filterValue for theFEATUREfilter key. It is available only to contacts analyzed by Contact Lens conversational analytics.connect:Chat,connect:SMS,connect:Telephony, andconnect:WebRTCare validfilterValueexamples (not exhaustive) for thecontact/segmentAttributes/connect:Subtype filterkey.ROUTING_STEP_EXPRESSIONis 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.
FilterV2.Builderavoiding the need to create one manually viaFilterV2.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#filters(List.) - Parameters:
filters- a consumer that will call methods onFilterV2.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#filters(java.util.Collection)
-
-
groupings
GetMetricDataV2Request.Builder groupings(Collection<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:
QUEUE|ROUTING_PROFILE|AGENT|CHANNEL|AGENT_HIERARCHY_LEVEL_ONE|AGENT_HIERARCHY_LEVEL_TWO|AGENT_HIERARCHY_LEVEL_THREE|AGENT_HIERARCHY_LEVEL_FOUR|AGENT_HIERARCHY_LEVEL_FIVE,contact/segmentAttributes/connect:Subtype|ROUTING_STEP_EXPRESSION- Parameters:
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:
QUEUE|ROUTING_PROFILE|AGENT|CHANNEL|AGENT_HIERARCHY_LEVEL_ONE|AGENT_HIERARCHY_LEVEL_TWO|AGENT_HIERARCHY_LEVEL_THREE|AGENT_HIERARCHY_LEVEL_FOUR|AGENT_HIERARCHY_LEVEL_FIVE,contact/segmentAttributes/connect:Subtype|ROUTING_STEP_EXPRESSION- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
groupings
GetMetricDataV2Request.Builder groupings(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:
QUEUE|ROUTING_PROFILE|AGENT|CHANNEL|AGENT_HIERARCHY_LEVEL_ONE|AGENT_HIERARCHY_LEVEL_TWO|AGENT_HIERARCHY_LEVEL_THREE|AGENT_HIERARCHY_LEVEL_FOUR|AGENT_HIERARCHY_LEVEL_FIVE,contact/segmentAttributes/connect:Subtype|ROUTING_STEP_EXPRESSION- Parameters:
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:
QUEUE|ROUTING_PROFILE|AGENT|CHANNEL|AGENT_HIERARCHY_LEVEL_ONE|AGENT_HIERARCHY_LEVEL_TWO|AGENT_HIERARCHY_LEVEL_THREE|AGENT_HIERARCHY_LEVEL_FOUR|AGENT_HIERARCHY_LEVEL_FIVE,contact/segmentAttributes/connect:Subtype|ROUTING_STEP_EXPRESSION- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metrics
GetMetricDataV2Request.Builder metrics(Collection<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 Historical metrics definitions in the Amazon Connect Administrator's Guide.
- ABANDONMENT_RATE
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
- 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
- AGENT_ANSWER_RATE
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AGENT_NON_ADHERENT_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AGENT_NON_RESPONSE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- 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.
- AGENT_OCCUPANCY
-
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- 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
- 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
- AVG_ABANDON_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
- AVG_ACTIVE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AVG_AFTER_CONTACT_WORK_TIME
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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 asINITIATION_METHOD:INBOUND|OUTBOUND|CALLBACK|APIValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
The
Negatekey 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
- AVG_CONTACT_DURATION
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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
- 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
- AVG_HANDLE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
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
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
- AVG_HOLDS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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
- AVG_INTERACTION_TIME
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
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
- 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
- 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
- AVG_QUEUE_ANSWER_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
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
- 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
- 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
- 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
- CONTACTS_ABANDONED
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
- CONTACTS_CREATED
-
Unit: Count
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
- CONTACTS_HANDLED
-
Unit: Count
Valid metric filter key:
INITIATION_METHOD,DISCONNECT_REASONValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
Feature is a valid filter but not a valid grouping.
- CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
-
Unit: Count
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_HOLD_ABANDONS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_ON_HOLD_AGENT_DISCONNECT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_PUT_ON_HOLD
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_TRANSFERRED_OUT_EXTERNAL
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_TRANSFERRED_OUT_INTERNAL
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_QUEUED
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_QUEUED_BY_ENQUEUE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_RESOLVED_IN_X
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For
ThresholdValueenter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - CONTACTS_TRANSFERRED_OUT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- MAX_QUEUED_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- PERCENT_CONTACTS_STEP_EXPIRED
-
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
- PERCENT_CONTACTS_STEP_JOINED
-
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
- 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
- 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
- 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
- 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
- SERVICE_LEVEL
-
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile
Threshold: For
ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - STEP_CONTACTS_QUEUED
-
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
- SUM_AFTER_CONTACT_WORK_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_CONNECTING_TIME_AGENT
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHOD. This metric only supports the following filter keys asINITIATION_METHOD:INBOUND|OUTBOUND|CALLBACK|APIValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
The
Negatekey in Metric Level Filters is not applicable for this metric. - SUM_CONTACT_FLOW_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_CONTACT_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_CONTACTS_ANSWERED_IN_X
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For
ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - SUM_CONTACTS_ABANDONED_IN_X
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For
ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - SUM_CONTACTS_DISCONNECTED
-
Valid metric filter key:
DISCONNECT_REASONUnit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- SUM_ERROR_STATUS_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_HANDLE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_HOLD_TIME
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_IDLE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- SUM_INTERACTION_AND_HOLD_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_INTERACTION_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_NON_PRODUCTIVE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- SUM_ONLINE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- SUM_RETRY_CALLBACK_ATTEMPTS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
- Parameters:
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 Historical metrics definitions in the Amazon Connect Administrator's Guide.- ABANDONMENT_RATE
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
- 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
- AGENT_ANSWER_RATE
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AGENT_NON_ADHERENT_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AGENT_NON_RESPONSE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- 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.
- AGENT_OCCUPANCY
-
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- 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
- 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
- AVG_ABANDON_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
- AVG_ACTIVE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AVG_AFTER_CONTACT_WORK_TIME
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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 asINITIATION_METHOD:INBOUND|OUTBOUND|CALLBACK|APIValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
The
Negatekey 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
- AVG_CONTACT_DURATION
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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
- 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
- AVG_HANDLE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
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
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
- AVG_HOLDS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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
- AVG_INTERACTION_TIME
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
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
- 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
- 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
- AVG_QUEUE_ANSWER_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
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
- 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
- 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
- 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
- CONTACTS_ABANDONED
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
- CONTACTS_CREATED
-
Unit: Count
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
- CONTACTS_HANDLED
-
Unit: Count
Valid metric filter key:
INITIATION_METHOD,DISCONNECT_REASONValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
Feature is a valid filter but not a valid grouping.
- CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
-
Unit: Count
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_HOLD_ABANDONS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_ON_HOLD_AGENT_DISCONNECT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_PUT_ON_HOLD
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_TRANSFERRED_OUT_EXTERNAL
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_TRANSFERRED_OUT_INTERNAL
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_QUEUED
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_QUEUED_BY_ENQUEUE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_RESOLVED_IN_X
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For
ThresholdValueenter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - CONTACTS_TRANSFERRED_OUT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- MAX_QUEUED_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- PERCENT_CONTACTS_STEP_EXPIRED
-
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
- PERCENT_CONTACTS_STEP_JOINED
-
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
- 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
- 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
- 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
- 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
- SERVICE_LEVEL
-
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile
Threshold: For
ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - STEP_CONTACTS_QUEUED
-
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
- SUM_AFTER_CONTACT_WORK_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_CONNECTING_TIME_AGENT
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHOD. This metric only supports the following filter keys asINITIATION_METHOD:INBOUND|OUTBOUND|CALLBACK|APIValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
The
Negatekey in Metric Level Filters is not applicable for this metric. - SUM_CONTACT_FLOW_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_CONTACT_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_CONTACTS_ANSWERED_IN_X
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For
ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - SUM_CONTACTS_ABANDONED_IN_X
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For
ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - SUM_CONTACTS_DISCONNECTED
-
Valid metric filter key:
DISCONNECT_REASONUnit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- SUM_ERROR_STATUS_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_HANDLE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_HOLD_TIME
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_IDLE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- SUM_INTERACTION_AND_HOLD_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_INTERACTION_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_NON_PRODUCTIVE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- SUM_ONLINE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- SUM_RETRY_CALLBACK_ATTEMPTS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metrics
GetMetricDataV2Request.Builder metrics(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 Historical metrics definitions in the Amazon Connect Administrator's Guide.
- ABANDONMENT_RATE
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
- 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
- AGENT_ANSWER_RATE
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AGENT_NON_ADHERENT_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AGENT_NON_RESPONSE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- 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.
- AGENT_OCCUPANCY
-
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- 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
- 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
- AVG_ABANDON_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
- AVG_ACTIVE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AVG_AFTER_CONTACT_WORK_TIME
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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 asINITIATION_METHOD:INBOUND|OUTBOUND|CALLBACK|APIValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
The
Negatekey 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
- AVG_CONTACT_DURATION
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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
- 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
- AVG_HANDLE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
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
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
- AVG_HOLDS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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
- AVG_INTERACTION_TIME
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
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
- 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
- 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
- AVG_QUEUE_ANSWER_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
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
- 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
- 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
- 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
- CONTACTS_ABANDONED
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
- CONTACTS_CREATED
-
Unit: Count
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
- CONTACTS_HANDLED
-
Unit: Count
Valid metric filter key:
INITIATION_METHOD,DISCONNECT_REASONValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
Feature is a valid filter but not a valid grouping.
- CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
-
Unit: Count
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_HOLD_ABANDONS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_ON_HOLD_AGENT_DISCONNECT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_PUT_ON_HOLD
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_TRANSFERRED_OUT_EXTERNAL
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_TRANSFERRED_OUT_INTERNAL
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_QUEUED
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_QUEUED_BY_ENQUEUE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_RESOLVED_IN_X
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For
ThresholdValueenter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - CONTACTS_TRANSFERRED_OUT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- MAX_QUEUED_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- PERCENT_CONTACTS_STEP_EXPIRED
-
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
- PERCENT_CONTACTS_STEP_JOINED
-
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
- 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
- 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
- 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
- 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
- SERVICE_LEVEL
-
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile
Threshold: For
ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - STEP_CONTACTS_QUEUED
-
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
- SUM_AFTER_CONTACT_WORK_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_CONNECTING_TIME_AGENT
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHOD. This metric only supports the following filter keys asINITIATION_METHOD:INBOUND|OUTBOUND|CALLBACK|APIValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
The
Negatekey in Metric Level Filters is not applicable for this metric. - SUM_CONTACT_FLOW_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_CONTACT_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_CONTACTS_ANSWERED_IN_X
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For
ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - SUM_CONTACTS_ABANDONED_IN_X
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For
ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - SUM_CONTACTS_DISCONNECTED
-
Valid metric filter key:
DISCONNECT_REASONUnit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- SUM_ERROR_STATUS_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_HANDLE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_HOLD_TIME
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_IDLE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- SUM_INTERACTION_AND_HOLD_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_INTERACTION_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_NON_PRODUCTIVE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- SUM_ONLINE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- SUM_RETRY_CALLBACK_ATTEMPTS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
- Parameters:
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 Historical metrics definitions in the Amazon Connect Administrator's Guide.- ABANDONMENT_RATE
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
- 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
- AGENT_ANSWER_RATE
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AGENT_NON_ADHERENT_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AGENT_NON_RESPONSE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- 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.
- AGENT_OCCUPANCY
-
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- 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
- 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
- AVG_ABANDON_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
- AVG_ACTIVE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AVG_AFTER_CONTACT_WORK_TIME
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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 asINITIATION_METHOD:INBOUND|OUTBOUND|CALLBACK|APIValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
The
Negatekey 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
- AVG_CONTACT_DURATION
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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
- 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
- AVG_HANDLE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
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
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
- AVG_HOLDS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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
- AVG_INTERACTION_TIME
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
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
- 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
- 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
- AVG_QUEUE_ANSWER_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
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
- 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
- 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
- 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
- CONTACTS_ABANDONED
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
- CONTACTS_CREATED
-
Unit: Count
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
- CONTACTS_HANDLED
-
Unit: Count
Valid metric filter key:
INITIATION_METHOD,DISCONNECT_REASONValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
Feature is a valid filter but not a valid grouping.
- CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
-
Unit: Count
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_HOLD_ABANDONS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_ON_HOLD_AGENT_DISCONNECT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_PUT_ON_HOLD
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_TRANSFERRED_OUT_EXTERNAL
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_TRANSFERRED_OUT_INTERNAL
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_QUEUED
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_QUEUED_BY_ENQUEUE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_RESOLVED_IN_X
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For
ThresholdValueenter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - CONTACTS_TRANSFERRED_OUT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- MAX_QUEUED_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- PERCENT_CONTACTS_STEP_EXPIRED
-
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
- PERCENT_CONTACTS_STEP_JOINED
-
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
- 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
- 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
- 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
- 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
- SERVICE_LEVEL
-
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile
Threshold: For
ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - STEP_CONTACTS_QUEUED
-
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
- SUM_AFTER_CONTACT_WORK_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_CONNECTING_TIME_AGENT
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHOD. This metric only supports the following filter keys asINITIATION_METHOD:INBOUND|OUTBOUND|CALLBACK|APIValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
The
Negatekey in Metric Level Filters is not applicable for this metric. - SUM_CONTACT_FLOW_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_CONTACT_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_CONTACTS_ANSWERED_IN_X
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For
ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - SUM_CONTACTS_ABANDONED_IN_X
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For
ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - SUM_CONTACTS_DISCONNECTED
-
Valid metric filter key:
DISCONNECT_REASONUnit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- SUM_ERROR_STATUS_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_HANDLE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_HOLD_TIME
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_IDLE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- SUM_INTERACTION_AND_HOLD_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_INTERACTION_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_NON_PRODUCTIVE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- SUM_ONLINE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- SUM_RETRY_CALLBACK_ATTEMPTS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metrics
GetMetricDataV2Request.Builder metrics(Consumer<MetricV2.Builder>... 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 Historical metrics definitions in the Amazon Connect Administrator's Guide.
- ABANDONMENT_RATE
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
- 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
- AGENT_ANSWER_RATE
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AGENT_NON_ADHERENT_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AGENT_NON_RESPONSE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- 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.
- AGENT_OCCUPANCY
-
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- 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
- 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
- AVG_ABANDON_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
- AVG_ACTIVE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AVG_AFTER_CONTACT_WORK_TIME
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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 asINITIATION_METHOD:INBOUND|OUTBOUND|CALLBACK|APIValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
The
Negatekey 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
- AVG_CONTACT_DURATION
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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
- 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
- AVG_HANDLE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
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
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
- AVG_HOLDS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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
- AVG_INTERACTION_TIME
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
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
- 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
- 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
- AVG_QUEUE_ANSWER_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
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
- 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
- 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
- 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
- CONTACTS_ABANDONED
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
- CONTACTS_CREATED
-
Unit: Count
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
- CONTACTS_HANDLED
-
Unit: Count
Valid metric filter key:
INITIATION_METHOD,DISCONNECT_REASONValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
Feature is a valid filter but not a valid grouping.
- CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
-
Unit: Count
Valid metric filter key:
INITIATION_METHODValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_HOLD_ABANDONS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_ON_HOLD_AGENT_DISCONNECT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_PUT_ON_HOLD
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_TRANSFERRED_OUT_EXTERNAL
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_TRANSFERRED_OUT_INTERNAL
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_QUEUED
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_QUEUED_BY_ENQUEUE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- CONTACTS_RESOLVED_IN_X
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For
ThresholdValueenter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - CONTACTS_TRANSFERRED_OUT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
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
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- MAX_QUEUED_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- PERCENT_CONTACTS_STEP_EXPIRED
-
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
- PERCENT_CONTACTS_STEP_JOINED
-
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
- 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
- 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
- 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
- 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
- SERVICE_LEVEL
-
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile
Threshold: For
ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - STEP_CONTACTS_QUEUED
-
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
- SUM_AFTER_CONTACT_WORK_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_CONNECTING_TIME_AGENT
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHOD. This metric only supports the following filter keys asINITIATION_METHOD:INBOUND|OUTBOUND|CALLBACK|APIValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
The
Negatekey in Metric Level Filters is not applicable for this metric. - SUM_CONTACT_FLOW_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_CONTACT_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_CONTACTS_ANSWERED_IN_X
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For
ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - SUM_CONTACTS_ABANDONED_IN_X
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For
ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison, you must enterLT(for "Less than"). - SUM_CONTACTS_DISCONNECTED
-
Valid metric filter key:
DISCONNECT_REASONUnit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
- SUM_ERROR_STATUS_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_HANDLE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_HOLD_TIME
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_IDLE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- SUM_INTERACTION_AND_HOLD_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_INTERACTION_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- SUM_NON_PRODUCTIVE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- SUM_ONLINE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- SUM_RETRY_CALLBACK_ATTEMPTS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
MetricV2.Builderavoiding the need to create one manually viaMetricV2.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#metrics(List.) - Parameters:
metrics- a consumer that will call methods onMetricV2.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#metrics(java.util.Collection)
-
nextToken
GetMetricDataV2Request.Builder nextToken(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
GetMetricDataV2Request.Builder maxResults(Integer maxResults)
The maximum number of results to return per page.
- Parameters:
maxResults- The maximum number of results to return per page.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetMetricDataV2Request.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
GetMetricDataV2Request.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-