:doc:`kendra <../../kendra>` / Client / get_snapshots

*************
get_snapshots
*************



.. py:method:: kendra.Client.get_snapshots(**kwargs)

  

  Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetSnapshots>`_  


  **Request Syntax**
  ::

    response = client.get_snapshots(
        IndexId='string',
        Interval='THIS_MONTH'|'THIS_WEEK'|'ONE_WEEK_AGO'|'TWO_WEEKS_AGO'|'ONE_MONTH_AGO'|'TWO_MONTHS_AGO',
        MetricType='QUERIES_BY_COUNT'|'QUERIES_BY_ZERO_CLICK_RATE'|'QUERIES_BY_ZERO_RESULT_RATE'|'DOCS_BY_CLICK_COUNT'|'AGG_QUERY_DOC_METRICS'|'TREND_QUERY_DOC_METRICS',
        NextToken='string',
        MaxResults=123
    )
    
  :type IndexId: string
  :param IndexId: **[REQUIRED]** 

    The identifier of the index to get search metrics data.

    

  
  :type Interval: string
  :param Interval: **[REQUIRED]** 

    The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:

     

    
    * ``THIS_WEEK``: The current week, starting on the Sunday and ending on the day before the current date.
     
    * ``ONE_WEEK_AGO``: The previous week, starting on the Sunday and ending on the following Saturday.
     
    * ``TWO_WEEKS_AGO``: The week before the previous week, starting on the Sunday and ending on the following Saturday.
     
    * ``THIS_MONTH``: The current month, starting on the first day of the month and ending on the day before the current date.
     
    * ``ONE_MONTH_AGO``: The previous month, starting on the first day of the month and ending on the last day of the month.
     
    * ``TWO_MONTHS_AGO``: The month before the previous month, starting on the first day of the month and ending on last day of the month.
    

    

  
  :type MetricType: string
  :param MetricType: **[REQUIRED]** 

    The metric you want to retrieve. You can specify only one metric per call.

     

    For more information about the metrics you can view, see `Gaining insights with search analytics <https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html>`__.

    

  
  :type NextToken: string
  :param NextToken: 

    If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of returned data for the metric.

    

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

    
    ::

      {
          'SnapShotTimeFilter': {
              'StartTime': datetime(2015, 1, 1),
              'EndTime': datetime(2015, 1, 1)
          },
          'SnapshotsDataHeader': [
              'string',
          ],
          'SnapshotsData': [
              [
                  'string',
              ],
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **SnapShotTimeFilter** *(dict) --* 

        The Unix timestamp for the beginning and end of the time window for the search metrics data.

        
        

        - **StartTime** *(datetime) --* 

          The Unix timestamp for the beginning of the time range.

          
        

        - **EndTime** *(datetime) --* 

          The Unix timestamp for the end of the time range.

          
    
      

      - **SnapshotsDataHeader** *(list) --* 

        The column headers for the search metrics data.

        
        

        - *(string) --* 
    
      

      - **SnapshotsData** *(list) --* 

        The search metrics data. The data returned depends on the metric type you requested.

        
        

        - *(list) --* 
          

          - *(string) --* 
      
    
      

      - **NextToken** *(string) --* 

        If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of search metrics data.

        
  
  **Exceptions**
  
  *   :py:class:`kendra.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`kendra.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`kendra.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`kendra.Client.exceptions.InternalServerException`

  