Pinpoint / Client / get_journey_execution_metrics

get_journey_execution_metrics#

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

Request Syntax

response = client.get_journey_execution_metrics(
    ApplicationId='string',
    JourneyId='string',
    NextToken='string',
    PageSize='string'
)
Parameters:

  • ApplicationId (string) –

    [REQUIRED]

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

  • JourneyId (string) –

    [REQUIRED]

    The unique identifier for the journey.

  • NextToken (string) – 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.

  • PageSize (string) – 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.

Return type:

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.

        • (string) –

          • (string) –

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException

  • Pinpoint.Client.exceptions.InternalServerErrorException

  • Pinpoint.Client.exceptions.PayloadTooLargeException

  • Pinpoint.Client.exceptions.ForbiddenException

  • Pinpoint.Client.exceptions.NotFoundException

  • Pinpoint.Client.exceptions.MethodNotAllowedException

  • Pinpoint.Client.exceptions.TooManyRequestsException