class Aws::Connect::Types::GetCurrentMetricDataRequest
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricDataRequest AWS API Documentation
@return [Integer]
The maximum number of results to return per page.
@!attribute [rw] max_results
@return [String]
parameters as the request that generated the token.
Subsequent requests that use the token must use the same request
The token expires after 5 minutes from the time it is created.
results.
previous response in the next request to retrieve the next set of
The token for the next set of results. Use the value returned in the
@!attribute [rw] next_token
@return [Array<Types::CurrentMetric>]<br>: docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time<br>[12]: docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time<br>[11]: docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time<br>[10]: docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time<br>[9]: docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time<br>[8]: docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time<br>[7]: docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time<br>[6]: docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time<br>[5]: docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time<br>[4]: docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time<br>[3]: docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time<br>[2]: docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time<br>[1]: docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html<br><br><br><br>Name in real-time metrics report: [Availability][13]
: Unit: COUNT
SLOTS_AVAILABLE
Name in real-time metrics report: [Active][12]
: Unit: COUNT
SLOTS_ACTIVE
Name in real-time metrics report: [Oldest][11]
The actual OLDEST_CONTACT_AGE is 24 seconds.
}, “Value”: 24113.0 ‘\}
`{ “Metric”: { “Name”: “OLDEST_CONTACT_AGE”, “Unit”: “SECONDS”
this:
returned in MILLISECONDS. For example, if you get a response like
When you do not use groupings, Unit says SECONDS but the Value is
returned in SECONDS.
When you use groupings, Unit says SECONDS and the Value is
: Unit: SECONDS
OLDEST_CONTACT_AGE
Name in real-time metrics report: [Scheduled][10]
: Unit: COUNT
CONTACTS_SCHEDULED
Name in real-time metrics report: [In queue][9]
: Unit: COUNT
CONTACTS_IN_QUEUE
Name in real-time metrics report: [Staffed][8]
: Unit: COUNT
AGENTS_STAFFED
Name in real-time metrics report: [Online][7]
: Unit: COUNT
AGENTS_ONLINE
Name in real-time metrics report: [On contact][6]
: Unit: COUNT
AGENTS_ON_CONTACT
Name in real-time metrics report: [On contact][6]
: Unit: COUNT
AGENTS_ON_CALL
Name in real-time metrics report: [NPT (Non-Productive Time)][5]
: Unit: COUNT
AGENTS_NON_PRODUCTIVE
Name in real-time metrics report: [Error][4]
: Unit: COUNT
AGENTS_ERROR
Name in real-time metrics report: [Available][3]
: Unit: COUNT
AGENTS_AVAILABLE
Name in real-time metrics report: [ACW][2]
: Unit: COUNT
AGENTS_AFTER_CONTACT_WORK
Connect Administrator Guide*.
metrics, see [Real-time Metrics Definitions] in the *Amazon
The following metrics are available. For a description of all the
The metrics to retrieve. Specify the name and unit for each metric.
@!attribute [rw] current_metrics
@return [Array<String>]
returned.
If no `Grouping` is included in the request, a summary of metrics is
supported.
should include a Channels filter. VOICE, CHAT, and TASK channels are
than aggregated for all queues. If you group by `CHANNEL`, you
grouped by `QUEUE`, the metrics returned apply to each queue rather
The grouping applied to the metrics returned. For example, when
@!attribute [rw] groupings
@return [Types::Filters]
TASK channels are supported.
both queue IDs and queue ARNs in the same request. VOICE, CHAT, and
with the queues or channels included in the filter. You can include
returned. Metric data is retrieved only for the resources associated
The queues, up to 100, or channels, to use to filter the metrics
@!attribute [rw] filters
@return [String]
instanceId in the ARN of the instance.
The identifier of the Amazon Connect instance. You can find the
@!attribute [rw] instance_id
}
max_results: 1,
next_token: “NextToken”,
],
},
unit: “SECONDS”, # accepts SECONDS, COUNT, PERCENT
name: “AGENTS_ONLINE”, # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
{
current_metrics: [ # required
groupings: [“QUEUE”], # accepts QUEUE, CHANNEL
},
channels: [“VOICE”], # accepts VOICE, CHAT, TASK
queues: [“QueueId”],
filters: { # required
instance_id: “InstanceId”, # required
{
data as a hash:
@note When making an API call, you may pass GetCurrentMetricDataRequest