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

******************************************
get_journey_run_execution_activity_metrics
******************************************



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

  

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

  

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


  **Request Syntax**
  ::

    response = client.get_journey_run_execution_activity_metrics(
        ApplicationId='string',
        JourneyActivityId='string',
        JourneyId='string',
        NextToken='string',
        PageSize='string',
        RunId='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 JourneyActivityId: string
  :param JourneyActivityId: **[REQUIRED]** 

    The unique identifier for the journey activity.

    

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

    

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

    The unique identifier for the journey run.

    

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

    
    ::

      {
          'JourneyRunExecutionActivityMetricsResponse': {
              'ActivityType': 'string',
              'ApplicationId': 'string',
              'JourneyActivityId': 'string',
              'JourneyId': 'string',
              'LastEvaluatedTime': 'string',
              'Metrics': {
                  'string': 'string'
              },
              'RunId': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The request succeeded.

      
      

      - **JourneyRunExecutionActivityMetricsResponse** *(dict) --* 

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

        
        

        - **ActivityType** *(string) --* 

          The type of activity that the metric applies to. Possible values are:

           

          
          * CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.
           
          * HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.
           
          * MESSAGE – For an email activity, which is an activity that sends an email message to participants.
           
          * MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.
           
          * RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.
           
          * WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
          

          
        

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

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

          
        

        - **JourneyActivityId** *(string) --* 

          The unique identifier for the activity 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 execution status of the activity for this journey run 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 see `Standard Amazon Pinpoint analytics metrics <https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html>`__ in the *Amazon Pinpoint Developer Guide*.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
        

        - **RunId** *(string) --* 

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

          
    
  
  **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`

  