Amazon Connect Service
API Reference (API Version 2017-08-08)

GetCurrentMetricData

Gets the real-time metric data from the specified Amazon Connect instance.

For more information, see Real-time Metrics Reports in the Amazon Connect Administrator Guide.

Request Syntax

POST /metrics/current/InstanceId HTTP/1.1 Content-type: application/json { "CurrentMetrics": [ { "Name": "string", "Unit": "string" } ], "Filters": { "Channels": [ "string" ], "Queues": [ "string" ] }, "Groupings": [ "string" ], "MaxResults": number, "NextToken": "string" }

URI Request Parameters

The request requires the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Request Body

The request accepts the following data in JSON format.

CurrentMetrics

The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available:

AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

AGENTS_AVAILABLE

Unit: COUNT

AGENTS_ERROR

Unit: COUNT

AGENTS_NON_PRODUCTIVE

Unit: COUNT

AGENTS_ON_CALL

Unit: COUNT

AGENTS_ONLINE

Unit: COUNT

AGENTS_STAFFED

Unit: COUNT

CONTACTS_IN_QUEUE

Unit: COUNT

CONTACTS_SCHEDULED

Unit: COUNT

OLDEST_CONTACT_AGE

Unit: SECONDS

Type: Array of CurrentMetric objects

Required: Yes

Filters

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. The only supported channel is VOICE.

Type: Filters object

Required: Yes

Groupings

The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. The only supported channel is VOICE.

If no Grouping is included in the request, a summary of metrics is returned.

Type: Array of strings

Array Members: Maximum number of 2 items.

Valid Values: QUEUE | CHANNEL

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

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.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "DataSnapshotTime": number, "MetricResults": [ { "Collections": [ { "Metric": { "Name": "string", "Unit": "string" }, "Value": number } ], "Dimensions": { "Channel": "string", "Queue": { "Arn": "string", "Id": "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.

DataSnapshotTime

The time at which the metrics were retrieved and cached for pagination.

Type: Timestamp

MetricResults

Information about the real-time metrics.

Type: Array of CurrentMetricResult objects

NextToken

If there are additional results, this is the token for the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

Request processing failed due to 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

Example

The following example retrieves the specified real-time metrics.

Sample Request

{ "InstanceId" : "12345678-1234-5678-aabb-123456abcdef", "Filters" : { "Queues" : [ "11111111-2222-fcfc-abab-333333333333", "arn:aws:connect:us-east-1:123456789012:instance/12345678-1234-5678-aabb-123456abcdef/queue/11111111-2222-fcfc-abab-333333333333" ], "Channels" : ["VOICE"] }, "Groupings" : [ "CHANNEL", "QUEUE" ], "CurrentMetrics" : [ { "Name" : "AGENTS_ONLINE", "Unit" : "COUNT" }, { "Name" : "AGENTS_AVAILABLE", "Unit" : "COUNT" }, { "Name" : "OLDEST_CONTACT_AGE", "Unit" : "SECONDS" }, { "Name": "AGENTS_ERROR", "Unit": "COUNT" } ] }

Sample Response

{ "DataSnapshotTime": 1549059604.884, "MetricResults": [ { "Collections": [ { "Metric": { "Name": "AGENTS_ONLINE", "Unit": "COUNT" }, "Value": 1 }, { "Metric": { "Name": "AGENTS_AVAILABLE", "Unit": "COUNT" }, "Value": 1 }, { "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 0 }, { "Metric": { "Name": "AGENTS_ERROR", "Unit": "COUNT" }, "Value": 0 } ], "Dimensions": { "Channel": "VOICE" "Queue": { "Arn": "arn:aws:connect:us-east-1:123456789012:instance/12345678-1234-5678-aabb-123456abcdef/queue/11111111-2222-fcfc-abab-333333333333", "Id": "11111111-2222-fcfc-abab-333333333333" }, } } ] }

See Also

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