:doc:`Pinpoint <../../pinpoint>` / Client / get_journey_execution_metrics

*****************************
get_journey_execution_metrics
*****************************



.. py:method:: Pinpoint.Client.get_journey_execution_metrics(**kwargs)

  

  Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyExecutionMetrics>`_  


  **Request Syntax**
  ::

    response = client.get_journey_execution_metrics(
        ApplicationId='string',
        JourneyId='string',
        NextToken='string',
        PageSize='string'
    )
    
  :type ApplicationId: string
  :param ApplicationId: **[REQUIRED]** 

    The unique identifier for the application. This identifier is displayed as the **Project ID** on the Amazon Pinpoint console.

    

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

    The unique identifier for the journey.

    

  
  :type NextToken: string
  :param NextToken: 

    The  string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    

  
  :type PageSize: string
  :param PageSize: 

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    

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

    
    ::

      {
          'JourneyExecutionMetricsResponse': {
              'ApplicationId': 'string',
              'JourneyId': 'string',
              'LastEvaluatedTime': 'string',
              'Metrics': {
                  'string': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The request succeeded.

      
      

      - **JourneyExecutionMetricsResponse** *(dict) --* 

        Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.

        
        

        - **ApplicationId** *(string) --* 

          The unique identifier for the application that the metric applies to.

          
        

        - **JourneyId** *(string) --* 

          The unique identifier for the journey that the metric applies to.

          
        

        - **LastEvaluatedTime** *(string) --* 

          The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.

          
        

        - **Metrics** *(dict) --* 

          A JSON object that contains the results of the query. For information about the structure and contents of the results, see the `Amazon Pinpoint Developer Guide <https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html>`__.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
    
  
  **Exceptions**
  
  *   :py:class:`Pinpoint.Client.exceptions.BadRequestException`

  
  *   :py:class:`Pinpoint.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`Pinpoint.Client.exceptions.PayloadTooLargeException`

  
  *   :py:class:`Pinpoint.Client.exceptions.ForbiddenException`

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

  
  *   :py:class:`Pinpoint.Client.exceptions.MethodNotAllowedException`

  
  *   :py:class:`Pinpoint.Client.exceptions.TooManyRequestsException`

  