Class: Aws::Connect::Types::GetMetricDataRequest

Inherits:

Struct

Object
Struct
Aws::Connect::Types::GetMetricDataRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-connect/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#end_time ⇒ Time

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data.
#filters ⇒ Types::Filters

The queues, up to 100, or channels, to use to filter the metrics returned.
#groupings ⇒ Array<String>

The grouping applied to the metrics returned.
#historical_metrics ⇒ Array<Types::HistoricalMetric>

The metrics to retrieve.
#instance_id ⇒ String

The identifier of the Amazon Connect instance.
#max_results ⇒ Integer

The maximum number of results to return per page.
#next_token ⇒ String

The token for the next set of results.
#start_time ⇒ Time

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data.

Instance Attribute Details

#end_time ⇒ `Time`

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.

Returns:

(Time)

# File 'lib/aws-sdk-connect/types.rb', line 11009

class GetMetricDataRequest < Struct.new(
  :instance_id,
  :start_time,
  :end_time,
  :filters,
  :groupings,
  :historical_metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ `Types::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. 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.

<note markdown=“1”> To filter by ‘Queues`, enter the queue ID/ARN, not the name of the queue.

</note>

Returns:

(Types::Filters)

# File 'lib/aws-sdk-connect/types.rb', line 11009

class GetMetricDataRequest < Struct.new(
  :instance_id,
  :start_time,
  :end_time,
  :filters,
  :groupings,
  :historical_metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#groupings ⇒ `Array<String>`

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.

Returns:

(Array<String>)

# File 'lib/aws-sdk-connect/types.rb', line 11009

class GetMetricDataRequest < Struct.new(
  :instance_id,
  :start_time,
  :end_time,
  :filters,
  :groupings,
  :historical_metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#historical_metrics ⇒ `Array<Types::HistoricalMetric>`

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 [Metrics definition] in the *Amazon Connect Administrator Guide*.

<note markdown=“1”> This API does not support a contacts incoming metric (there’s no CONTACTS_INCOMING metric missing from the documented list).

</note>

ABANDON_TIME

: Unit: SECONDS

Statistic: AVG

UI name: [Average queue abandon time][2]

AFTER_CONTACT_WORK_TIME

: Unit: SECONDS

Statistic: AVG

UI name: [After contact work time][3]

API_CONTACTS_HANDLED

: Unit: COUNT

Statistic: SUM

UI name: [API contacts handled][4]

AVG_HOLD_TIME

: Unit: SECONDS

Statistic: AVG

UI name: [Average customer hold time][5]

CALLBACK_CONTACTS_HANDLED

: Unit: COUNT

Statistic: SUM

UI name: [Callback contacts handled][6]

CONTACTS_ABANDONED

: Unit: COUNT

Statistic: SUM

UI name: [Contacts abandoned][7]

CONTACTS_AGENT_HUNG_UP_FIRST

: Unit: COUNT

Statistic: SUM

UI name: [Contacts agent hung up first][8]

CONTACTS_CONSULTED

: Unit: COUNT

Statistic: SUM

UI name: [Contacts consulted][9]

CONTACTS_HANDLED

: Unit: COUNT

Statistic: SUM

UI name: [Contacts handled][10]

CONTACTS_HANDLED_INCOMING

: Unit: COUNT

Statistic: SUM

UI name: [Contacts handled incoming][11]

CONTACTS_HANDLED_OUTBOUND

: Unit: COUNT

Statistic: SUM

UI name: [Contacts handled outbound][12]

CONTACTS_HOLD_ABANDONS

: Unit: COUNT

Statistic: SUM

UI name: [Contacts hold disconnect][13]

CONTACTS_MISSED

: Unit: COUNT

Statistic: SUM

UI name: [AGENT\_NON\_RESPONSE][14]

CONTACTS_QUEUED

: Unit: COUNT

Statistic: SUM

UI name: [Contacts queued][15]

CONTACTS_TRANSFERRED_IN

: Unit: COUNT

Statistic: SUM

UI name: [Contacts transferred in][16]

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

: Unit: COUNT

Statistic: SUM

UI name: [Contacts transferred out queue][17]

CONTACTS_TRANSFERRED_OUT

: Unit: COUNT

Statistic: SUM

UI name: [Contacts transferred out][18]

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

: Unit: COUNT

Statistic: SUM

UI name: [Contacts transferred out queue][17]

HANDLE_TIME

: Unit: SECONDS

Statistic: AVG

UI name: [Average handle time][19]

INTERACTION_AND_HOLD_TIME

: Unit: SECONDS

Statistic: AVG

UI name: [Average agent interaction and customer hold time][20]

INTERACTION_TIME

: Unit: SECONDS

Statistic: AVG

UI name: [Average agent interaction time][21]

OCCUPANCY

: Unit: PERCENT

Statistic: AVG

UI name: [Occupancy][22]

QUEUE_ANSWER_TIME

: Unit: SECONDS

Statistic: AVG

UI name: [Average queue answer time][23]

QUEUED_TIME

: Unit: SECONDS

Statistic: MAX

UI name: [Minimum flow time][24]

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").

UI name: [Average queue abandon time][2]

Returns:

(Array<Types::HistoricalMetric>)

# File 'lib/aws-sdk-connect/types.rb', line 11009

class GetMetricDataRequest < Struct.new(
  :instance_id,
  :start_time,
  :end_time,
  :filters,
  :groupings,
  :historical_metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ `String`

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

[1]: docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html

Returns:

(String)

# File 'lib/aws-sdk-connect/types.rb', line 11009

class GetMetricDataRequest < Struct.new(
  :instance_id,
  :start_time,
  :end_time,
  :filters,
  :groupings,
  :historical_metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ `Integer`

The maximum number of results to return per page.

Returns:

(Integer)

# File 'lib/aws-sdk-connect/types.rb', line 11009

class GetMetricDataRequest < Struct.new(
  :instance_id,
  :start_time,
  :end_time,
  :filters,
  :groupings,
  :historical_metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-connect/types.rb', line 11009

class GetMetricDataRequest < Struct.new(
  :instance_id,
  :start_time,
  :end_time,
  :filters,
  :groupings,
  :historical_metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ `Time`

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.

Returns:

(Time)

# File 'lib/aws-sdk-connect/types.rb', line 11009

class GetMetricDataRequest < Struct.new(
  :instance_id,
  :start_time,
  :end_time,
  :filters,
  :groupings,
  :historical_metrics,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Connect::Types::GetMetricDataRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ Time

#filters ⇒ Types::Filters

#groupings ⇒ Array<String>

#historical_metrics ⇒ Array<Types::HistoricalMetric>

#instance_id ⇒ String

#max_results ⇒ Integer

#next_token ⇒ String

#start_time ⇒ Time

#end_time ⇒ `Time`

#filters ⇒ `Types::Filters`

#groupings ⇒ `Array<String>`

#historical_metrics ⇒ `Array<Types::HistoricalMetric>`

#instance_id ⇒ `String`

#max_results ⇒ `Integer`

#next_token ⇒ `String`

#start_time ⇒ `Time`