Skip to content
AWS for Query.Farm

aws.connect.get_metric_data

Example SQL Queries

SELECT * FROM
aws.connect.get_metric_data
WHERE
"instance_id" = 'VALUE'
AND "start_time" = 'VALUE'
AND "end_time" = 'VALUE'
AND "filters" = 'VALUE'
AND "historical_metrics" = 'VALUE';

Description

Gets historical metric data from the specified Amazon Connect instance.

For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.

Table Definition

Column NameColumn Data Type
end_time Required Input Column

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.

TIMESTAMP_S
filters Required Input Column

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. VOICE, CHAT, and TASK channels are supported.

RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

To filter by Queues, enter the queue ID/ARN, not the name of the queue.

STRUCT(
    "queues" VARCHAR[],
    "channels" VARCHAR[],
    "routing_profiles" VARCHAR[],
    "routing_step_expressions" VARCHAR[]
)
Show child fields
filters.channels[]
filters.queues[]
filters.routing_profiles[]
filters.routing_step_expressions[]
historical_metrics Required Input Column

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

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

You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: PERCENT

Statistic: AVG

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). 

STRUCT(
    "name" VARCHAR,
    "threshold" STRUCT(
        "comparison" VARCHAR,
        "threshold_value" DOUBLE
    ),
    "statistic" VARCHAR,
    "unit" VARCHAR
)[]
Show child fields
historical_metrics[]
Show child fields
historical_metrics[].name

The name of the metric.

historical_metrics[].statistic

The statistic for the metric.

historical_metrics[].threshold

The threshold for the metric, used with service level metrics.

Show child fields
historical_metrics[].threshold.comparison

The type of comparison. Only "less than" (LT) comparisons are supported.

historical_metrics[].threshold.threshold_value

The threshold value to compare.

historical_metrics[].unit

The unit for the metric.

instance_id Required Input Column

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

VARCHAR
start_time Required Input Column

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.

TIMESTAMP_S
groupings Input Column

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.

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

RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

VARCHAR[]
Show child fields
groupings[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
collections

The set of metrics.

STRUCT(
    "metric" STRUCT(
        "name" VARCHAR,
        "threshold" STRUCT(
            "comparison" VARCHAR,
            "threshold_value" DOUBLE
        ),
        "statistic" VARCHAR,
        "unit" VARCHAR
    ),
    "value" DOUBLE
)[]
Show child fields
collections[]
Show child fields
collections[].metric

Information about the metric.

Show child fields
collections[].metric.name

The name of the metric.

collections[].metric.statistic

The statistic for the metric.

collections[].metric.threshold

The threshold for the metric, used with service level metrics.

Show child fields
collections[].metric.threshold.comparison

The type of comparison. Only "less than" (LT) comparisons are supported.

collections[].metric.threshold.threshold_value

The threshold value to compare.

collections[].metric.unit

The unit for the metric.

collections[].value

The value of the metric.

dimensions

The dimension for the metrics.

STRUCT(
    "queue" STRUCT(
        "id" VARCHAR,
        "arn" VARCHAR
    ),
    "channel" VARCHAR,
    "routing_profile" STRUCT(
        "id" VARCHAR,
        "arn" VARCHAR
    ),
    "routing_step_expression" VARCHAR
)
Show child fields
dimensions.channel

The channel used for grouping and filters.

dimensions.queue

Information about the queue for which metrics are returned.

Show child fields
dimensions.queue.arn

The Amazon Resource Name (ARN) of the queue.

dimensions.queue.id

The identifier of the queue.

dimensions.routing_profile

Information about the routing profile assigned to the user.

Show child fields
dimensions.routing_profile.arn

The Amazon Resource Name (ARN) of the routing profile.

dimensions.routing_profile.id

The identifier of the routing profile.

dimensions.routing_step_expression

The expression of a step in a routing criteria.