AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::JourneyExecutionActivityMetricsResponse

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#activity_typeString

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.

Returns:

  • (String)

    The type of activity that the metric applies to.

#application_idString

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

Returns:

  • (String)

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

#journey_activity_idString

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

Returns:

  • (String)

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

#journey_idString

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

Returns:

  • (String)

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

#last_evaluated_timeString

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.

Returns:

  • (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.

#metricsHash<String,String>

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.

Returns:

  • (Hash<String,String>)

    A JSON object that contains the results of the query.