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

GetCurrentMetricData

The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action.

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 for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

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

Request Body

The request accepts the following data in JSON format.

CurrentMetrics

A list of CurrentMetric objects for the metrics to retrieve. Each CurrentMetric includes a name of a metric to retrieve and the unit to use for it. You must list each metric to retrieve data for in the request.

The following metrics are available:

AGENTS_AVAILABLE

Unit: COUNT

AGENTS_ONLINE

Unit: COUNT

AGENTS_ON_CALL

Unit: COUNT

AGENTS_STAFFED

Unit: COUNT

AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

AGENTS_NON_PRODUCTIVE

Unit: COUNT

AGENTS_ERROR

Unit: COUNT

CONTACTS_IN_QUEUE

Unit: COUNT

OLDEST_CONTACT_AGE

Unit: SECONDS

CONTACTS_SCHEDULED

Unit: COUNT

Type: Array of CurrentMetric objects

Required: Yes

Filters

A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the queue IDs, ARNs, or Channels included in the filter. You can include both IDs and ARNs in the same request. To retrieve metrics for all queues, add the queue ID or ARN for each queue in your instance. Only VOICE is supported for Channels.

To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61. The queue ID is also included in the URL, and is the string after 'queue/'.

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 CurrentMetrics is returned.

Type: Array of strings

Array Members: Maximum number of 2 items.

Valid Values: QUEUE | CHANNEL

Required: No

MaxResults

MaxResults indicates the maximum number of results to return per page in the response, between 1 and 100.

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 NextToken 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 CurrentMetricData was retrieved and cached for pagination.

Type: Timestamp

MetricResults

A list of CurrentMetricResult objects organized by Dimensions combining with CurrentMetricDataCollections.

Dimensions is the resourceId specified in the Filters of the request.

Collections is a list of CurrentMetricData objects with corresponding values to the CurrentMetrics specified in the request.

If no Grouping is specified in the request, Collections is a summary for the CurrentMetric returned.

Type: Array of CurrentMetricResult objects

NextToken

A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent 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 NextToken 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 parameters provided to the operation 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

Example granting Allow access to this operation

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "connect:GetCurrentMetricData" ], "Resource": "arn:aws:connect:us-west-2:432047966757:instance/0c7d681d-5546-4f93-97f8-0976e896dae9/queue/28915e20-4592-4f7c-8a53-a24ce6950cb5" } ] }

See Also

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