:doc:`SESV2 <../../sesv2>` / Client / get_domain_statistics_report

****************************
get_domain_statistics_report
****************************



.. py:method:: SESV2.Client.get_domain_statistics_report(**kwargs)

  

  Retrieve inbox placement and engagement rates for the domains that you use to send email.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetDomainStatisticsReport>`_  


  **Request Syntax**
  ::

    response = client.get_domain_statistics_report(
        Domain='string',
        StartDate=datetime(2015, 1, 1),
        EndDate=datetime(2015, 1, 1)
    )
    
  :type Domain: string
  :param Domain: **[REQUIRED]** 

    The domain that you want to obtain deliverability metrics for.

    

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

    The first day (in Unix time) that you want to obtain domain deliverability metrics for.

    

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

    The last day (in Unix time) that you want to obtain domain deliverability metrics for. The ``EndDate`` that you specify has to be less than or equal to 30 days after the ``StartDate``.

    

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

    
    ::

      {
          'OverallVolume': {
              'VolumeStatistics': {
                  'InboxRawCount': 123,
                  'SpamRawCount': 123,
                  'ProjectedInbox': 123,
                  'ProjectedSpam': 123
              },
              'ReadRatePercent': 123.0,
              'DomainIspPlacements': [
                  {
                      'IspName': 'string',
                      'InboxRawCount': 123,
                      'SpamRawCount': 123,
                      'InboxPercentage': 123.0,
                      'SpamPercentage': 123.0
                  },
              ]
          },
          'DailyVolumes': [
              {
                  'StartDate': datetime(2015, 1, 1),
                  'VolumeStatistics': {
                      'InboxRawCount': 123,
                      'SpamRawCount': 123,
                      'ProjectedInbox': 123,
                      'ProjectedSpam': 123
                  },
                  'DomainIspPlacements': [
                      {
                          'IspName': 'string',
                          'InboxRawCount': 123,
                          'SpamRawCount': 123,
                          'InboxPercentage': 123.0,
                          'SpamPercentage': 123.0
                      },
                  ]
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 

      An object that includes statistics that are related to the domain that you specified.

      
      

      - **OverallVolume** *(dict) --* 

        An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the ``StartDate`` to the ``EndDate``.

        
        

        - **VolumeStatistics** *(dict) --* 

          An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.

          
          

          - **InboxRawCount** *(integer) --* 

            The total number of emails that arrived in recipients' inboxes.

            
          

          - **SpamRawCount** *(integer) --* 

            The total number of emails that arrived in recipients' spam or junk mail folders.

            
          

          - **ProjectedInbox** *(integer) --* 

            An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.

            
          

          - **ProjectedSpam** *(integer) --* 

            An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.

            
      
        

        - **ReadRatePercent** *(float) --* 

          The percentage of emails that were sent from the domain that were read by their recipients.

          
        

        - **DomainIspPlacements** *(list) --* 

          An object that contains inbox and junk mail placement metrics for individual email providers.

          
          

          - *(dict) --* 

            An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.

            
            

            - **IspName** *(string) --* 

              The name of the email provider that the inbox placement data applies to.

              
            

            - **InboxRawCount** *(integer) --* 

              The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.

              
            

            - **SpamRawCount** *(integer) --* 

              The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.

              
            

            - **InboxPercentage** *(float) --* 

              The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.

              
            

            - **SpamPercentage** *(float) --* 

              The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.

              
        
      
    
      

      - **DailyVolumes** *(list) --* 

        An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the ``StartDate`` and ending on the ``EndDate``.

        
        

        - *(dict) --* 

          An object that contains information about the volume of email sent on each day of the analysis period.

          
          

          - **StartDate** *(datetime) --* 

            The date that the DailyVolume metrics apply to, in Unix time.

            
          

          - **VolumeStatistics** *(dict) --* 

            An object that contains inbox placement metrics for a specific day in the analysis period.

            
            

            - **InboxRawCount** *(integer) --* 

              The total number of emails that arrived in recipients' inboxes.

              
            

            - **SpamRawCount** *(integer) --* 

              The total number of emails that arrived in recipients' spam or junk mail folders.

              
            

            - **ProjectedInbox** *(integer) --* 

              An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.

              
            

            - **ProjectedSpam** *(integer) --* 

              An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.

              
        
          

          - **DomainIspPlacements** *(list) --* 

            An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient's email provider.

            
            

            - *(dict) --* 

              An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.

              
              

              - **IspName** *(string) --* 

                The name of the email provider that the inbox placement data applies to.

                
              

              - **InboxRawCount** *(integer) --* 

                The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.

                
              

              - **SpamRawCount** *(integer) --* 

                The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.

                
              

              - **InboxPercentage** *(float) --* 

                The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.

                
              

              - **SpamPercentage** *(float) --* 

                The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.

                
          
        
      
    
  
  **Exceptions**
  
  *   :py:class:`SESV2.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`SESV2.Client.exceptions.NotFoundException`

  
  *   :py:class:`SESV2.Client.exceptions.BadRequestException`

  