GetMetricDataV2
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2
offers more features than GetMetricData, the previous
version of this API. It has new metrics, offers filtering at a metric level, and offers the
ability to filter and group data by channels, queues, routing profiles, agents, and agent
hierarchy levels. It can retrieve historical data for the last 35 days, in 24-hour
intervals.
For a description of the historical metrics that are supported by
GetMetricDataV2
and GetMetricData
, see Historical metrics
definitions in the Amazon Connect Administrator's Guide.
This API is not available in the AWS GovCloud (US) Regions.
Request Syntax
POST /metrics/data HTTP/1.1
Content-type: application/json
{
"EndTime": number
,
"Filters": [
{
"FilterKey": "string
",
"FilterValues": [ "string
" ]
}
],
"Groupings": [ "string
" ],
"MaxResults": number
,
"Metrics": [
{
"MetricFilters": [
{
"MetricFilterKey": "string
",
"MetricFilterValues": [ "string
" ]
}
],
"Name": "string
",
"Threshold": [
{
"Comparison": "string
",
"ThresholdValue": number
}
]
}
],
"NextToken": "string
",
"ResourceArn": "string
",
"StartTime": number
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- 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.
The time range between the start and end time must be less than 24 hours.
Type: Timestamp
Required: Yes
- Filters
-
The filters to apply to returned metrics. You can filter on the following resources:
-
Queues
-
Routing profiles
-
Agents
-
Channels
-
User hierarchy groups
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
-
Filter values: A maximum of 100 filter values are supported in a single request. For example, a
GetMetricDataV2
request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values.VOICE
,CHAT
, andTASK
are validfilterValue
for theCHANNEL
filter key.
Type: Array of FilterV2 objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
-
- 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
Type: Array of strings
Array Members: Maximum number of 2 items.
Required: No
- MaxResults
-
The maximum number of results to return per page.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- 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.
- AGENT_ADHERENT_TIME
-
This metric is available only in AWS Regions where Forecasting, capacity planning, and scheduling is available.
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_OCCUPANCY
-
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
- AGENT_SCHEDULE_ADHERENCE
-
This metric is available only in AWS 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 AWS 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
- AVG_AFTER_CONTACT_WORK_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- 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
|API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AVG_HANDLE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AVG_HOLD_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AVG_INTERACTION_AND_HOLD_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- AVG_INTERACTION_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile
- AVG_QUEUE_ANSWER_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile
- CONTACTS_ABANDONED
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_CREATED
-
Unit: Count
Valid metric filter key:
INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile
- CONTACTS_HANDLED
-
Unit: Count
Valid metric filter key:
INITIATION_METHOD
,DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_HOLD_ABANDONS
-
Unit: Count
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
- CONTACTS_TRANSFERRED_OUT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_TRANSFERRED_OUT_BY_AGENT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- MAX_QUEUED_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
- 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"). - SUM_CONTACTS_ANSWERED_IN_X
-
Unit: Count
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"). - SUM_CONTACTS_ABANDONED_IN_X
-
Unit: Count
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"). - SUM_CONTACTS_DISCONNECTED
-
Valid metric filter key:
DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile
- SUM_RETRY_CALLBACK_ATTEMPTS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile
Type: Array of MetricV2 objects
Required: Yes
- 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2500.
Required: No
- ResourceArn
-
The Amazon Resource Name (ARN) of the resource. This includes the
instanceId
an Amazon Connect instance.Type: String
Required: Yes
- 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 time range between the start and end time must be less than 24 hours. The start time cannot be earlier than 35 days before the time of the request. Historical metrics are available for 35 days.
Type: Timestamp
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"MetricResults": [
{
"Collections": [
{
"Metric": {
"MetricFilters": [
{
"MetricFilterKey": "string",
"MetricFilterValues": [ "string" ]
}
],
"Name": "string",
"Threshold": [
{
"Comparison": "string",
"ThresholdValue": number
}
]
},
"Value": number
}
],
"Dimensions": {
"string" : "string"
}
}
],
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- MetricResults
-
Information about the metrics requested in the API request If no grouping is specified, a summary of metric data is returned.
Type: Array of MetricResultV2 objects
- NextToken
-
If there are additional results, this is the token for the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2500.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
HTTP Status Code: 400
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: