AWSConnectGetCurrentMetricDataRequest
Objective-C
@interface AWSConnectGetCurrentMetricDataRequest
Swift
class AWSConnectGetCurrentMetricDataRequest
-
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
- AGENTS_AFTER_CONTACT_WORK
Unit: COUNT
Name in real-time metrics report: ACW
- AGENTS_AVAILABLE
Unit: COUNT
Name in real-time metrics report: Available
- AGENTS_ERROR
Unit: COUNT
Name in real-time metrics report: Error
- AGENTS_NON_PRODUCTIVE
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
- AGENTS_ON_CALL
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ON_CONTACT
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ONLINE
Unit: COUNT
Name in real-time metrics report: Online
- AGENTS_STAFFED
Unit: COUNT
Name in real-time metrics report: Staffed
- CONTACTS_IN_QUEUE
Unit: COUNT
Name in real-time metrics report: In queue
- CONTACTS_SCHEDULED
Unit: COUNT
Name in real-time metrics report: Scheduled
- OLDEST_CONTACT_AGE
Unit: SECONDS
When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
}The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
- SLOTS_ACTIVE
Unit: COUNT
Name in real-time metrics report: Active
- SLOTS_AVAILABLE
Unit: COUNT
Name in real-time metrics report: Availability
Declaration
Objective-C
@property (nonatomic, strong) NSArray<AWSConnectCurrentMetric *> *_Nullable currentMetrics;
Swift
var currentMetrics: [AWSConnectCurrentMetric]? { get set }
-
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.
Declaration
Objective-C
@property (nonatomic, strong) AWSConnectFilters *_Nullable filters;
Swift
var filters: AWSConnectFilters? { get set }
-
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 byCHANNEL
, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.If no
Grouping
is included in the request, a summary of metrics is returned.Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable groupings;
Swift
var groupings: [String]? { get set }
-
The identifier of the Amazon Connect instance.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable instanceId;
Swift
var instanceId: String? { get set }
-
The maximum number of results to return per page.
Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable maxResults;
Swift
var maxResults: NSNumber? { get set }
-
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 token must use the same request parameters as the request that generated the token.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable nextToken;
Swift
var nextToken: String? { get set }