get_journey_execution_activity_metrics

get_journey_execution_activity_metrics(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_journey_execution_activity_metrics(
    ApplicationId='string',
    JourneyActivityId='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.

• JourneyActivityId (string) --

  [REQUIRED]

  The unique identifier for the journey activity.

• 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

{
    'JourneyExecutionActivityMetricsResponse': {
        'ActivityType': 'string',
        'ApplicationId': 'string',
        'JourneyActivityId': 'string',
        'JourneyId': 'string',
        'LastEvaluatedTime': 'string',
        'Metrics': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) --

  The request succeeded.

  • JourneyExecutionActivityMetricsResponse (dict) --

    Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, 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 and updated the data for the metric.

    • Metrics (dict) --

      A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). 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