:doc:`Connect <../../connect>` / Paginator / GetMetricData

*************
GetMetricData
*************



.. py:class:: Connect.Paginator.GetMetricData

  ::

    
    paginator = client.get_paginator('get_metric_data')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Connect.Client.get_metric_data`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricData>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          InstanceId='string',
          StartTime=datetime(2015, 1, 1),
          EndTime=datetime(2015, 1, 1),
          Filters={
              'Queues': [
                  'string',
              ],
              'Channels': [
                  'VOICE'|'CHAT'|'TASK'|'EMAIL',
              ],
              'RoutingProfiles': [
                  'string',
              ],
              'RoutingStepExpressions': [
                  'string',
              ],
              'AgentStatuses': [
                  'string',
              ],
              'Subtypes': [
                  'string',
              ],
              'ValidationTestTypes': [
                  'string',
              ]
          },
          Groupings=[
              'QUEUE'|'CHANNEL'|'ROUTING_PROFILE'|'ROUTING_STEP_EXPRESSION'|'AGENT_STATUS'|'SUBTYPE'|'VALIDATION_TEST_TYPE',
          ],
          HistoricalMetrics=[
              {
                  'Name': 'CONTACTS_QUEUED'|'CONTACTS_HANDLED'|'CONTACTS_ABANDONED'|'CONTACTS_CONSULTED'|'CONTACTS_AGENT_HUNG_UP_FIRST'|'CONTACTS_HANDLED_INCOMING'|'CONTACTS_HANDLED_OUTBOUND'|'CONTACTS_HOLD_ABANDONS'|'CONTACTS_TRANSFERRED_IN'|'CONTACTS_TRANSFERRED_OUT'|'CONTACTS_TRANSFERRED_IN_FROM_QUEUE'|'CONTACTS_TRANSFERRED_OUT_FROM_QUEUE'|'CONTACTS_MISSED'|'CALLBACK_CONTACTS_HANDLED'|'API_CONTACTS_HANDLED'|'OCCUPANCY'|'HANDLE_TIME'|'AFTER_CONTACT_WORK_TIME'|'QUEUED_TIME'|'ABANDON_TIME'|'QUEUE_ANSWER_TIME'|'HOLD_TIME'|'INTERACTION_TIME'|'INTERACTION_AND_HOLD_TIME'|'SERVICE_LEVEL',
                  'Threshold': {
                      'Comparison': 'LT',
                      'ThresholdValue': 123.0
                  },
                  'Statistic': 'SUM'|'MAX'|'AVG',
                  'Unit': 'SECONDS'|'COUNT'|'PERCENT'
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type InstanceId: string
    :param InstanceId: **[REQUIRED]** 

      The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

      

    
    :type StartTime: datetime
    :param StartTime: **[REQUIRED]** 

      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.

      

    
    :type EndTime: datetime
    :param EndTime: **[REQUIRED]** 

      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.

      

    
    :type Filters: dict
    :param Filters: **[REQUIRED]** 

      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::

        

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

        

      

    
      - **Queues** *(list) --* 

        The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The ``GetCurrentMetricsData`` API in particular requires a queue when you include a ``Filter`` in your request.

        

      
        - *(string) --* 

        
    
      - **Channels** *(list) --* 

        The channel to use to filter the metrics.

        

      
        - *(string) --* 

        
    
      - **RoutingProfiles** *(list) --* 

        A list of up to 100 routing profile IDs or ARNs.

        

      
        - *(string) --* 

        
    
      - **RoutingStepExpressions** *(list) --* 

        A list of expressions as a filter, in which an expression is an object of a step in a routing criteria.

        

      
        - *(string) --* 

        
    
      - **AgentStatuses** *(list) --* 

        A list of up to 50 agent status IDs or ARNs.

        

      
        - *(string) --* 

        
    
      - **Subtypes** *(list) --* 

        A list of up to 10 subtypes can be provided.

        

      
        - *(string) --* 

        
    
      - **ValidationTestTypes** *(list) --* 

        A list of up to 10 validationTestTypes can be provided.

        

      
        - *(string) --* 

        
    
    
    :type Groupings: list
    :param 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.

       

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

      

    
      - *(string) --* 

      
  
    :type HistoricalMetrics: list
    :param HistoricalMetrics: **[REQUIRED]** 

      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 <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html>`__ in the *Amazon Connect Administrator Guide*.

       

      .. note::

        

        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

       

      UI name: `Average queue abandon time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time>`__

        AFTER_CONTACT_WORK_TIME  

      Unit: SECONDS

       

      Statistic: AVG

       

      UI name: `After contact work time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time>`__

        API_CONTACTS_HANDLED  

      Unit: COUNT

       

      Statistic: SUM

       

      UI name: `API contacts handled <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled>`__

        AVG_HOLD_TIME  

      Unit: SECONDS

       

      Statistic: AVG

       

      UI name: `Average customer hold time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time>`__

        CALLBACK_CONTACTS_HANDLED  

      Unit: COUNT

       

      Statistic: SUM

       

      UI name: `Callback contacts handled <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled>`__

        CONTACTS_ABANDONED  

      Unit: COUNT

       

      Statistic: SUM

       

      UI name: `Contacts abandoned <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned>`__

        CONTACTS_AGENT_HUNG_UP_FIRST  

      Unit: COUNT

       

      Statistic: SUM

       

      UI name: `Contacts agent hung up first <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-agent-hung-up-first>`__

        CONTACTS_CONSULTED  

      Unit: COUNT

       

      Statistic: SUM

       

      UI name: `Contacts consulted <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted>`__

        CONTACTS_HANDLED  

      Unit: COUNT

       

      Statistic: SUM

       

      UI name: `Contacts handled <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled>`__

        CONTACTS_HANDLED_INCOMING  

      Unit: COUNT

       

      Statistic: SUM

       

      UI name: `Contacts handled incoming <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming>`__

        CONTACTS_HANDLED_OUTBOUND  

      Unit: COUNT

       

      Statistic: SUM

       

      UI name: `Contacts handled outbound <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound>`__

        CONTACTS_HOLD_ABANDONS  

      Unit: COUNT

       

      Statistic: SUM

       

      UI name: `Contacts hold disconnect <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect>`__

        CONTACTS_MISSED  

      Unit: COUNT

       

      Statistic: SUM

       

      UI name: `AGENT_NON_RESPONSE <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response>`__

        CONTACTS_QUEUED  

      Unit: COUNT

       

      Statistic: SUM

       

      UI name: `Contacts queued <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued>`__

        CONTACTS_TRANSFERRED_IN  

      Unit: COUNT

       

      Statistic: SUM

       

      UI name: `Contacts transferred in <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-in>`__

        CONTACTS_TRANSFERRED_IN_FROM_QUEUE  

      Unit: COUNT

       

      Statistic: SUM

       

      UI name: `Contacts transferred out queue <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue>`__

        CONTACTS_TRANSFERRED_OUT  

      Unit: COUNT

       

      Statistic: SUM

       

      UI name: `Contacts transferred out <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out>`__

        CONTACTS_TRANSFERRED_OUT_FROM_QUEUE  

      Unit: COUNT

       

      Statistic: SUM

       

      UI name: `Contacts transferred out queue <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue>`__

        HANDLE_TIME  

      Unit: SECONDS

       

      Statistic: AVG

       

      UI name: `Average handle time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time>`__

        INTERACTION_AND_HOLD_TIME  

      Unit: SECONDS

       

      Statistic: AVG

       

      UI name: `Average agent interaction and customer hold time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time>`__

        INTERACTION_TIME  

      Unit: SECONDS

       

      Statistic: AVG

       

      UI name: `Average agent interaction time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aaverage-agent-interaction-time>`__

        OCCUPANCY  

      Unit: PERCENT

       

      Statistic: AVG

       

      UI name: `Occupancy <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy>`__

        QUEUE_ANSWER_TIME  

      Unit: SECONDS

       

      Statistic: AVG

       

      UI name: `Average queue answer time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html##average-queue-answer-time>`__

        QUEUED_TIME  

      Unit: SECONDS

       

      Statistic: MAX

       

      UI name: `Minimum flow time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time>`__

        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 <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time>`__

      

    
      - *(dict) --* 

        Contains information about a historical metric.

        

      
        - **Name** *(string) --* 

          The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed description in the *Amazon Connect Administrator Guide*.

            ABANDON_TIME  

          Unit: SECONDS

           

          Statistic: AVG

           

          UI name: `Average queue abandon time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time>`__

            AFTER_CONTACT_WORK_TIME  

          Unit: SECONDS

           

          Statistic: AVG

           

          UI name: `After contact work time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time>`__

            API_CONTACTS_HANDLED  

          Unit: COUNT

           

          Statistic: SUM

           

          UI name: `API contacts handled <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled>`__

            AVG_HOLD_TIME  

          Unit: SECONDS

           

          Statistic: AVG

           

          UI name: `Average customer hold time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time>`__

            CALLBACK_CONTACTS_HANDLED  

          Unit: COUNT

           

          Statistic: SUM

           

          UI name: `Callback contacts handled <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled>`__

            CONTACTS_ABANDONED  

          Unit: COUNT

           

          Statistic: SUM

           

          UI name: `Contacts abandoned <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned>`__

            CONTACTS_AGENT_HUNG_UP_FIRST  

          Unit: COUNT

           

          Statistic: SUM

           

          UI name: `Contacts agent hung up first <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-agent-hung-up-first>`__

            CONTACTS_CONSULTED  

          Unit: COUNT

           

          Statistic: SUM

           

          UI name: `Contacts consulted <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted>`__

            CONTACTS_HANDLED  

          Unit: COUNT

           

          Statistic: SUM

           

          UI name: `Contacts handled <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled>`__

            CONTACTS_HANDLED_INCOMING  

          Unit: COUNT

           

          Statistic: SUM

           

          UI name: `Contacts handled incoming <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming>`__

            CONTACTS_HANDLED_OUTBOUND  

          Unit: COUNT

           

          Statistic: SUM

           

          UI name: `Contacts handled outbound <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound>`__

            CONTACTS_HOLD_ABANDONS  

          Unit: COUNT

           

          Statistic: SUM

           

          UI name: `Contacts hold disconnect <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect>`__

            CONTACTS_MISSED  

          Unit: COUNT

           

          Statistic: SUM

           

          UI name: `AGENT_NON_RESPONSE <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response>`__

            CONTACTS_QUEUED  

          Unit: COUNT

           

          Statistic: SUM

           

          UI name: `Contacts queued <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued>`__

            CONTACTS_TRANSFERRED_IN  

          Unit: COUNT

           

          Statistic: SUM

           

          UI name: `Contacts transferred in <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-in>`__

            CONTACTS_TRANSFERRED_IN_FROM_QUEUE  

          Unit: COUNT

           

          Statistic: SUM

           

          UI name: `Contacts transferred out queue <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue>`__

            CONTACTS_TRANSFERRED_OUT  

          Unit: COUNT

           

          Statistic: SUM

           

          UI name: `Contacts transferred out <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out>`__

            CONTACTS_TRANSFERRED_OUT_FROM_QUEUE  

          Unit: COUNT

           

          Statistic: SUM

           

          UI name: `Contacts transferred out queue <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue>`__

            HANDLE_TIME  

          Unit: SECONDS

           

          Statistic: AVG

           

          UI name: `Average handle time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time>`__

            INTERACTION_AND_HOLD_TIME  

          Unit: SECONDS

           

          Statistic: AVG

           

          UI name: `Average agent interaction and customer hold time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time>`__

            INTERACTION_TIME  

          Unit: SECONDS

           

          Statistic: AVG

           

          UI name: `Average agent interaction time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aaverage-agent-interaction-time>`__

            OCCUPANCY  

          Unit: PERCENT

           

          Statistic: AVG

           

          UI name: `Occupancy <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy>`__

            QUEUE_ANSWER_TIME  

          Unit: SECONDS

           

          Statistic: AVG

           

          UI name: `Average queue answer time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html##average-queue-answer-time>`__

            QUEUED_TIME  

          Unit: SECONDS

           

          Statistic: MAX

           

          UI name: `Minimum flow time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time>`__

            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: `Service level X <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#service-level>`__

          

        
        - **Threshold** *(dict) --* 

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

          

        
          - **Comparison** *(string) --* 

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

            

          
          - **ThresholdValue** *(float) --* 

            The threshold value to compare.

            

          
        
        - **Statistic** *(string) --* 

          The statistic for the metric.

          

        
        - **Unit** *(string) --* 

          The unit for the metric.

          

        
      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'MetricResults': [
                {
                    'Dimensions': {
                        'Queue': {
                            'Id': 'string',
                            'Arn': 'string'
                        },
                        'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL',
                        'RoutingProfile': {
                            'Id': 'string',
                            'Arn': 'string'
                        },
                        'RoutingStepExpression': 'string',
                        'AgentStatus': {
                            'Arn': 'string',
                            'Id': 'string'
                        },
                        'Subtype': 'string',
                        'ValidationTestType': 'string'
                    },
                    'Collections': [
                        {
                            'Metric': {
                                'Name': 'CONTACTS_QUEUED'|'CONTACTS_HANDLED'|'CONTACTS_ABANDONED'|'CONTACTS_CONSULTED'|'CONTACTS_AGENT_HUNG_UP_FIRST'|'CONTACTS_HANDLED_INCOMING'|'CONTACTS_HANDLED_OUTBOUND'|'CONTACTS_HOLD_ABANDONS'|'CONTACTS_TRANSFERRED_IN'|'CONTACTS_TRANSFERRED_OUT'|'CONTACTS_TRANSFERRED_IN_FROM_QUEUE'|'CONTACTS_TRANSFERRED_OUT_FROM_QUEUE'|'CONTACTS_MISSED'|'CALLBACK_CONTACTS_HANDLED'|'API_CONTACTS_HANDLED'|'OCCUPANCY'|'HANDLE_TIME'|'AFTER_CONTACT_WORK_TIME'|'QUEUED_TIME'|'ABANDON_TIME'|'QUEUE_ANSWER_TIME'|'HOLD_TIME'|'INTERACTION_TIME'|'INTERACTION_AND_HOLD_TIME'|'SERVICE_LEVEL',
                                'Threshold': {
                                    'Comparison': 'LT',
                                    'ThresholdValue': 123.0
                                },
                                'Statistic': 'SUM'|'MAX'|'AVG',
                                'Unit': 'SECONDS'|'COUNT'|'PERCENT'
                            },
                            'Value': 123.0
                        },
                    ]
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **MetricResults** *(list) --* 

          Information about the historical metrics.

           

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

          
          

          - *(dict) --* 

            Contains information about the historical metrics retrieved.

            
            

            - **Dimensions** *(dict) --* 

              The dimension for the metrics.

              
              

              - **Queue** *(dict) --* 

                Information about the queue for which metrics are returned.

                
                

                - **Id** *(string) --* 

                  The identifier of the queue.

                  
                

                - **Arn** *(string) --* 

                  The Amazon Resource Name (ARN) of the queue.

                  
            
              

              - **Channel** *(string) --* 

                The channel used for grouping and filters.

                
              

              - **RoutingProfile** *(dict) --* 

                Information about the routing profile assigned to the user.

                
                

                - **Id** *(string) --* 

                  The identifier of the routing profile.

                  
                

                - **Arn** *(string) --* 

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

                  
            
              

              - **RoutingStepExpression** *(string) --* 

                The expression of a step in a routing criteria.

                
              

              - **AgentStatus** *(dict) --* 

                Information about the agent status assigned to the user.

                
                

                - **Arn** *(string) --* 

                  The Amazon Resource Name (ARN) of the agent status.

                  
                

                - **Id** *(string) --* 

                  The identifier of the agent status.

                  
            
              

              - **Subtype** *(string) --* 

                The subtype of the channel used for the contact.

                
              

              - **ValidationTestType** *(string) --* 

                The testing and simulation type

                
          
            

            - **Collections** *(list) --* 

              The set of metrics.

              
              

              - *(dict) --* 

                Contains the data for a historical metric.

                
                

                - **Metric** *(dict) --* 

                  Information about the metric.

                  
                  

                  - **Name** *(string) --* 

                    The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed description in the *Amazon Connect Administrator Guide*.

                      ABANDON_TIME  

                    Unit: SECONDS

                     

                    Statistic: AVG

                     

                    UI name: `Average queue abandon time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time>`__

                      AFTER_CONTACT_WORK_TIME  

                    Unit: SECONDS

                     

                    Statistic: AVG

                     

                    UI name: `After contact work time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time>`__

                      API_CONTACTS_HANDLED  

                    Unit: COUNT

                     

                    Statistic: SUM

                     

                    UI name: `API contacts handled <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled>`__

                      AVG_HOLD_TIME  

                    Unit: SECONDS

                     

                    Statistic: AVG

                     

                    UI name: `Average customer hold time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time>`__

                      CALLBACK_CONTACTS_HANDLED  

                    Unit: COUNT

                     

                    Statistic: SUM

                     

                    UI name: `Callback contacts handled <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled>`__

                      CONTACTS_ABANDONED  

                    Unit: COUNT

                     

                    Statistic: SUM

                     

                    UI name: `Contacts abandoned <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned>`__

                      CONTACTS_AGENT_HUNG_UP_FIRST  

                    Unit: COUNT

                     

                    Statistic: SUM

                     

                    UI name: `Contacts agent hung up first <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-agent-hung-up-first>`__

                      CONTACTS_CONSULTED  

                    Unit: COUNT

                     

                    Statistic: SUM

                     

                    UI name: `Contacts consulted <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted>`__

                      CONTACTS_HANDLED  

                    Unit: COUNT

                     

                    Statistic: SUM

                     

                    UI name: `Contacts handled <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled>`__

                      CONTACTS_HANDLED_INCOMING  

                    Unit: COUNT

                     

                    Statistic: SUM

                     

                    UI name: `Contacts handled incoming <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming>`__

                      CONTACTS_HANDLED_OUTBOUND  

                    Unit: COUNT

                     

                    Statistic: SUM

                     

                    UI name: `Contacts handled outbound <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound>`__

                      CONTACTS_HOLD_ABANDONS  

                    Unit: COUNT

                     

                    Statistic: SUM

                     

                    UI name: `Contacts hold disconnect <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect>`__

                      CONTACTS_MISSED  

                    Unit: COUNT

                     

                    Statistic: SUM

                     

                    UI name: `AGENT_NON_RESPONSE <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response>`__

                      CONTACTS_QUEUED  

                    Unit: COUNT

                     

                    Statistic: SUM

                     

                    UI name: `Contacts queued <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued>`__

                      CONTACTS_TRANSFERRED_IN  

                    Unit: COUNT

                     

                    Statistic: SUM

                     

                    UI name: `Contacts transferred in <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-in>`__

                      CONTACTS_TRANSFERRED_IN_FROM_QUEUE  

                    Unit: COUNT

                     

                    Statistic: SUM

                     

                    UI name: `Contacts transferred out queue <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue>`__

                      CONTACTS_TRANSFERRED_OUT  

                    Unit: COUNT

                     

                    Statistic: SUM

                     

                    UI name: `Contacts transferred out <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out>`__

                      CONTACTS_TRANSFERRED_OUT_FROM_QUEUE  

                    Unit: COUNT

                     

                    Statistic: SUM

                     

                    UI name: `Contacts transferred out queue <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue>`__

                      HANDLE_TIME  

                    Unit: SECONDS

                     

                    Statistic: AVG

                     

                    UI name: `Average handle time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time>`__

                      INTERACTION_AND_HOLD_TIME  

                    Unit: SECONDS

                     

                    Statistic: AVG

                     

                    UI name: `Average agent interaction and customer hold time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time>`__

                      INTERACTION_TIME  

                    Unit: SECONDS

                     

                    Statistic: AVG

                     

                    UI name: `Average agent interaction time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aaverage-agent-interaction-time>`__

                      OCCUPANCY  

                    Unit: PERCENT

                     

                    Statistic: AVG

                     

                    UI name: `Occupancy <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy>`__

                      QUEUE_ANSWER_TIME  

                    Unit: SECONDS

                     

                    Statistic: AVG

                     

                    UI name: `Average queue answer time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html##average-queue-answer-time>`__

                      QUEUED_TIME  

                    Unit: SECONDS

                     

                    Statistic: MAX

                     

                    UI name: `Minimum flow time <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time>`__

                      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: `Service level X <https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#service-level>`__

                    
                  

                  - **Threshold** *(dict) --* 

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

                    
                    

                    - **Comparison** *(string) --* 

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

                      
                    

                    - **ThresholdValue** *(float) --* 

                      The threshold value to compare.

                      
                
                  

                  - **Statistic** *(string) --* 

                    The statistic for the metric.

                    
                  

                  - **Unit** *(string) --* 

                    The unit for the metric.

                    
              
                

                - **Value** *(float) --* 

                  The value of the metric.

                  
            
          
        
      
    