Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Connect.GetMetricData

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

This operation returns paginated results.

Synopsis

data GetMetricData = GetMetricData' {
- nextToken :: Maybe Text
- groupings :: Maybe [Grouping]
- maxResults :: Maybe Natural
- instanceId :: Text
- startTime :: POSIX
- endTime :: POSIX
- filters :: Filters
- historicalMetrics :: [HistoricalMetric]
}
newGetMetricData :: Text -> UTCTime -> UTCTime -> Filters -> GetMetricData
getMetricData_nextToken :: Lens' GetMetricData (Maybe Text)
getMetricData_groupings :: Lens' GetMetricData (Maybe [Grouping])
getMetricData_maxResults :: Lens' GetMetricData (Maybe Natural)
getMetricData_instanceId :: Lens' GetMetricData Text
getMetricData_startTime :: Lens' GetMetricData UTCTime
getMetricData_endTime :: Lens' GetMetricData UTCTime
getMetricData_filters :: Lens' GetMetricData Filters
getMetricData_historicalMetrics :: Lens' GetMetricData [HistoricalMetric]
data GetMetricDataResponse = GetMetricDataResponse' {
- metricResults :: Maybe [HistoricalMetricResult]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetMetricDataResponse :: Int -> GetMetricDataResponse
getMetricDataResponse_metricResults :: Lens' GetMetricDataResponse (Maybe [HistoricalMetricResult])
getMetricDataResponse_nextToken :: Lens' GetMetricDataResponse (Maybe Text)
getMetricDataResponse_httpStatus :: Lens' GetMetricDataResponse Int

Creating a Request

data GetMetricData Source #

See: newGetMetricData smart constructor.

Constructors

GetMetricData'

Fields

nextToken :: Maybe Text
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.
groupings :: Maybe [Grouping]
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.
maxResults :: Maybe Natural
The maximum number of results to return per page.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
startTime :: POSIX
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 :: POSIX
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 :: 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.
To filter by Queues, enter the queue ID/ARN, not the name of the queue.
historicalMetrics :: [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 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").

Instances

Instances details

Eq GetMetricData Source #
Instance details Defined in Amazonka.Connect.GetMetricData Methods (==) :: GetMetricData -> GetMetricData -> Bool # (/=) :: GetMetricData -> GetMetricData -> Bool #
Read GetMetricData Source #
Instance details Defined in Amazonka.Connect.GetMetricData Methods readsPrec :: Int -> ReadS GetMetricData # readList :: ReadS [GetMetricData] # readPrec :: ReadPrec GetMetricData # readListPrec :: ReadPrec [GetMetricData] #
Show GetMetricData Source #
Instance details Defined in Amazonka.Connect.GetMetricData Methods showsPrec :: Int -> GetMetricData -> ShowS # show :: GetMetricData -> String # showList :: [GetMetricData] -> ShowS #
Generic GetMetricData Source #
Instance details Defined in Amazonka.Connect.GetMetricData Associated Types type Rep GetMetricData :: Type -> Type # Methods from :: GetMetricData -> Rep GetMetricData x # to :: Rep GetMetricData x -> GetMetricData #
NFData GetMetricData Source #
Instance details Defined in Amazonka.Connect.GetMetricData Methods rnf :: GetMetricData -> () #
Hashable GetMetricData Source #
Instance details Defined in Amazonka.Connect.GetMetricData Methods hashWithSalt :: Int -> GetMetricData -> Int # hash :: GetMetricData -> Int #
ToJSON GetMetricData Source #
Instance details Defined in Amazonka.Connect.GetMetricData Methods toJSON :: GetMetricData -> Value # toEncoding :: GetMetricData -> Encoding # toJSONList :: [GetMetricData] -> Value # toEncodingList :: [GetMetricData] -> Encoding #
AWSPager GetMetricData Source #
Instance details Defined in Amazonka.Connect.GetMetricData Methods page :: GetMetricData -> AWSResponse GetMetricData -> Maybe GetMetricData #
AWSRequest GetMetricData Source #
Instance details Defined in Amazonka.Connect.GetMetricData Associated Types type AWSResponse GetMetricData # Methods request :: GetMetricData -> Request GetMetricData # response :: MonadResource m => Logger -> Service -> Proxy GetMetricData -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetMetricData))) #
ToHeaders GetMetricData Source #
Instance details Defined in Amazonka.Connect.GetMetricData Methods toHeaders :: GetMetricData -> [Header] #
ToPath GetMetricData Source #
Instance details Defined in Amazonka.Connect.GetMetricData Methods toPath :: GetMetricData -> ByteString #
ToQuery GetMetricData Source #
Instance details Defined in Amazonka.Connect.GetMetricData Methods toQuery :: GetMetricData -> QueryString #
type Rep GetMetricData Source #
Instance details Defined in Amazonka.Connect.GetMetricData type Rep GetMetricData = D1 ('MetaData "GetMetricData" "Amazonka.Connect.GetMetricData" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "GetMetricData'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "groupings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Grouping]))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Filters) :*: S1 ('MetaSel ('Just "historicalMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [HistoricalMetric])))))
type AWSResponse GetMetricData Source #
Instance details Defined in Amazonka.Connect.GetMetricData type AWSResponse GetMetricData = GetMetricDataResponse

newGetMetricData Source #

Arguments

:: Text	`$sel:instanceId:GetMetricData'`
-> UTCTime	`$sel:startTime:GetMetricData'`
-> UTCTime	`$sel:endTime:GetMetricData'`
-> Filters	`$sel:filters:GetMetricData'`
-> GetMetricData

Create a value of GetMetricData with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:GetMetricData', getMetricData_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.

$sel:groupings:GetMetricData', getMetricData_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.

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

$sel:maxResults:GetMetricData', getMetricData_maxResults - The maximum number of results to return per page.

$sel:instanceId:GetMetricData', getMetricData_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

$sel:startTime:GetMetricData', getMetricData_startTime - 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.

$sel:endTime:GetMetricData', getMetricData_endTime - 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.

$sel:filters:GetMetricData', getMetricData_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.

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

$sel:historicalMetrics:GetMetricData', getMetricData_historicalMetrics - 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").

Request Lenses

getMetricData_nextToken :: Lens' GetMetricData (Maybe Text) Source #

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.

getMetricData_groupings :: Lens' GetMetricData (Maybe [Grouping]) Source #

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.

getMetricData_maxResults :: Lens' GetMetricData (Maybe Natural) Source #

The maximum number of results to return per page.

getMetricData_instanceId :: Lens' GetMetricData Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

getMetricData_startTime :: Lens' GetMetricData UTCTime Source #

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.

getMetricData_endTime :: Lens' GetMetricData UTCTime Source #

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.

getMetricData_filters :: Lens' GetMetricData Filters Source #

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.

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

getMetricData_historicalMetrics :: Lens' GetMetricData [HistoricalMetric] Source #

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

Destructuring the Response

data GetMetricDataResponse Source #

See: newGetMetricDataResponse smart constructor.

Constructors

GetMetricDataResponse'

Fields

metricResults :: Maybe [HistoricalMetricResult]
Information about the historical metrics.
If no grouping is specified, a summary of metric data is returned.
nextToken :: Maybe Text
If there are additional results, this is the token for 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetMetricDataResponse Source #
Instance details Defined in Amazonka.Connect.GetMetricData Methods (==) :: GetMetricDataResponse -> GetMetricDataResponse -> Bool # (/=) :: GetMetricDataResponse -> GetMetricDataResponse -> Bool #
Read GetMetricDataResponse Source #
Instance details Defined in Amazonka.Connect.GetMetricData Methods readsPrec :: Int -> ReadS GetMetricDataResponse # readList :: ReadS [GetMetricDataResponse] # readPrec :: ReadPrec GetMetricDataResponse # readListPrec :: ReadPrec [GetMetricDataResponse] #
Show GetMetricDataResponse Source #
Instance details Defined in Amazonka.Connect.GetMetricData Methods showsPrec :: Int -> GetMetricDataResponse -> ShowS # show :: GetMetricDataResponse -> String # showList :: [GetMetricDataResponse] -> ShowS #
Generic GetMetricDataResponse Source #
Instance details Defined in Amazonka.Connect.GetMetricData Associated Types type Rep GetMetricDataResponse :: Type -> Type # Methods from :: GetMetricDataResponse -> Rep GetMetricDataResponse x # to :: Rep GetMetricDataResponse x -> GetMetricDataResponse #
NFData GetMetricDataResponse Source #
Instance details Defined in Amazonka.Connect.GetMetricData Methods rnf :: GetMetricDataResponse -> () #
type Rep GetMetricDataResponse Source #
Instance details Defined in Amazonka.Connect.GetMetricData type Rep GetMetricDataResponse = D1 ('MetaData "GetMetricDataResponse" "Amazonka.Connect.GetMetricData" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "GetMetricDataResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HistoricalMetricResult])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetMetricDataResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetMetricDataResponse'`
-> GetMetricDataResponse

Create a value of GetMetricDataResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:metricResults:GetMetricDataResponse', getMetricDataResponse_metricResults - Information about the historical metrics.

If no grouping is specified, a summary of metric data is returned.

$sel:nextToken:GetMetricData', getMetricDataResponse_nextToken - If there are additional results, this is the token for 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.

$sel:httpStatus:GetMetricDataResponse', getMetricDataResponse_httpStatus - The response's http status code.

Response Lenses

getMetricDataResponse_metricResults :: Lens' GetMetricDataResponse (Maybe [HistoricalMetricResult]) Source #

Information about the historical metrics.

If no grouping is specified, a summary of metric data is returned.

getMetricDataResponse_nextToken :: Lens' GetMetricDataResponse (Maybe Text) Source #

If there are additional results, this is the token for 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.

getMetricDataResponse_httpStatus :: Lens' GetMetricDataResponse Int Source #

The response's http status code.