connect_get_metric_data: Gets historical metric data from the specified Amazon Connect instance

Description

Gets historical metric data from the specified Amazon Connect instance.

Usage

connect_get_metric_data(InstanceId, StartTime, EndTime, Filters,
  Groupings, HistoricalMetrics, NextToken, MaxResults)

Arguments

InstanceId

[required] The identifier of the Amazon Connect instance.

StartTime

[required] 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 specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

EndTime

[required] 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 specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

The time range between the start and end time must be less than 24 hours.

Filters

[required] 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.

Groupings

The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

The only supported grouping is QUEUE.

If no grouping is specified, a summary of metrics for all queues is returned.

HistoricalMetrics

[required] The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available:

ABANDON\_TIME

: Unit: SECONDS

Statistic: AVG

AFTER\_CONTACT\_WORK\_TIME

: Unit: SECONDS

Statistic: AVG

API\_CONTACTS\_HANDLED

: Unit: COUNT

Statistic: SUM

CALLBACK\_CONTACTS\_HANDLED

: Unit: COUNT

Statistic: SUM

CONTACTS\_ABANDONED

: Unit: COUNT

Statistic: SUM

CONTACTS\_AGENT\_HUNG\_UP\_FIRST

: Unit: COUNT

Statistic: SUM

CONTACTS\_CONSULTED

: Unit: COUNT

Statistic: SUM

CONTACTS\_HANDLED

: Unit: COUNT

Statistic: SUM

CONTACTS\_HANDLED\_INCOMING

: Unit: COUNT

Statistic: SUM

CONTACTS\_HANDLED\_OUTBOUND

: Unit: COUNT

Statistic: SUM

CONTACTS\_HOLD\_ABANDONS

: Unit: COUNT

Statistic: SUM

CONTACTS\_MISSED

: Unit: COUNT

Statistic: SUM

CONTACTS\_QUEUED

: Unit: COUNT

Statistic: SUM

CONTACTS\_TRANSFERRED\_IN

: Unit: COUNT

Statistic: SUM

CONTACTS\_TRANSFERRED\_IN\_FROM\_QUEUE

: Unit: COUNT

Statistic: SUM

CONTACTS\_TRANSFERRED\_OUT

: Unit: COUNT

Statistic: SUM

CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE

: Unit: COUNT

Statistic: SUM

HANDLE\_TIME

: Unit: SECONDS

Statistic: AVG

HOLD\_TIME

: Unit: SECONDS

Statistic: AVG

INTERACTION\_AND\_HOLD\_TIME

: Unit: SECONDS

Statistic: AVG

INTERACTION\_TIME

: Unit: SECONDS

Statistic: AVG

OCCUPANCY

: Unit: PERCENT

Statistic: AVG

QUEUE\_ANSWER\_TIME

: Unit: SECONDS

Statistic: AVG

QUEUED\_TIME

: Unit: SECONDS

Statistic: MAX

SERVICE\_LEVEL

: Unit: PERCENT

Statistic: AVG

Threshold: Only \"Less than\" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600

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.

MaxResults

The maximimum number of results to return per page.

Request syntax

svc$get_metric_data(
  InstanceId = "string",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  Filters = list(
    Queues = list(
      "string"
    ),
    Channels = list(
      "VOICE"|"CHAT"
    )
  ),
  Groupings = list(
    "QUEUE"|"CHANNEL"
  ),
  HistoricalMetrics = list(
    list(
      Name = "CONTACTS_QUEUED"|"CONTACTS_HANDLED"|"CONTACTS_ABANDONED"|"CONTACTS_CONSULTED"|"CONTACTS_AGENT_HUNG_UP_FIRST"|"CONTACTS_HANDLED_INCOMING"|"CONTACTS_HANDLED_OUTBOUND"|"CONTACTS_HOLD_ABANDONS"|"CONTACTS_TRANSFERRED_IN"|"CONTACTS_TRANSFERRED_OUT"|"CONTACTS_TRANSFERRED_IN_FROM_QUEUE"|"CONTACTS_TRANSFERRED_OUT_FROM_QUEUE"|"CONTACTS_MISSED"|"CALLBACK_CONTACTS_HANDLED"|"API_CONTACTS_HANDLED"|"OCCUPANCY"|"HANDLE_TIME"|"AFTER_CONTACT_WORK_TIME"|"QUEUED_TIME"|"ABANDON_TIME"|"QUEUE_ANSWER_TIME"|"HOLD_TIME"|"INTERACTION_TIME"|"INTERACTION_AND_HOLD_TIME"|"SERVICE_LEVEL",
      Threshold = list(
        Comparison = "LT",
        ThresholdValue = 123.0
      ),
      Statistic = "SUM"|"MAX"|"AVG",
      Unit = "SECONDS"|"COUNT"|"PERCENT"
    )
  ),
  NextToken = "string",
  MaxResults = 123
)

Details

For more information, see Historical Metrics Reports in the Amazon Connect Administrator Guide.