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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

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.

Constant Summary collapse

SENSITIVE =
[]

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)


10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10654

class JourneyExecutionActivityMetricsResponse < Struct.new(
  :activity_type,
  :application_id,
  :journey_activity_id,
  :journey_id,
  :last_evaluated_time,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#application_idString

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

Returns:

  • (String)


10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10654

class JourneyExecutionActivityMetricsResponse < Struct.new(
  :activity_type,
  :application_id,
  :journey_activity_id,
  :journey_id,
  :last_evaluated_time,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#journey_activity_idString

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

Returns:

  • (String)


10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10654

class JourneyExecutionActivityMetricsResponse < Struct.new(
  :activity_type,
  :application_id,
  :journey_activity_id,
  :journey_id,
  :last_evaluated_time,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#journey_idString

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

Returns:

  • (String)


10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10654

class JourneyExecutionActivityMetricsResponse < Struct.new(
  :activity_type,
  :application_id,
  :journey_activity_id,
  :journey_id,
  :last_evaluated_time,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#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)


10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10654

class JourneyExecutionActivityMetricsResponse < Struct.new(
  :activity_type,
  :application_id,
  :journey_activity_id,
  :journey_id,
  :last_evaluated_time,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#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>)


10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10654

class JourneyExecutionActivityMetricsResponse < Struct.new(
  :activity_type,
  :application_id,
  :journey_activity_id,
  :journey_id,
  :last_evaluated_time,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end