Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse

Description

Synopsis

Documentation

data JourneyExecutionActivityMetricsResponse Source #

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.

See: newJourneyExecutionActivityMetricsResponse smart constructor.

Constructors

JourneyExecutionActivityMetricsResponse'

Fields

metrics :: HashMap Text Text
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.
journeyId :: Text
The unique identifier for the journey that the metric applies to.
lastEvaluatedTime :: Text
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.
journeyActivityId :: Text
The unique identifier for the activity that the metric applies to.
activityType :: Text
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 :: Text
The unique identifier for the application that the metric applies to.

Instances

Instances details

Eq JourneyExecutionActivityMetricsResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse Methods (==) :: JourneyExecutionActivityMetricsResponse -> JourneyExecutionActivityMetricsResponse -> Bool # (/=) :: JourneyExecutionActivityMetricsResponse -> JourneyExecutionActivityMetricsResponse -> Bool #
Read JourneyExecutionActivityMetricsResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse Methods readsPrec :: Int -> ReadS JourneyExecutionActivityMetricsResponse # readList :: ReadS [JourneyExecutionActivityMetricsResponse] # readPrec :: ReadPrec JourneyExecutionActivityMetricsResponse # readListPrec :: ReadPrec [JourneyExecutionActivityMetricsResponse] #
Show JourneyExecutionActivityMetricsResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse Methods showsPrec :: Int -> JourneyExecutionActivityMetricsResponse -> ShowS # show :: JourneyExecutionActivityMetricsResponse -> String # showList :: [JourneyExecutionActivityMetricsResponse] -> ShowS #
Generic JourneyExecutionActivityMetricsResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse Associated Types type Rep JourneyExecutionActivityMetricsResponse :: Type -> Type # Methods from :: JourneyExecutionActivityMetricsResponse -> Rep JourneyExecutionActivityMetricsResponse x # to :: Rep JourneyExecutionActivityMetricsResponse x -> JourneyExecutionActivityMetricsResponse #
NFData JourneyExecutionActivityMetricsResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse Methods rnf :: JourneyExecutionActivityMetricsResponse -> () #
Hashable JourneyExecutionActivityMetricsResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse Methods hashWithSalt :: Int -> JourneyExecutionActivityMetricsResponse -> Int # hash :: JourneyExecutionActivityMetricsResponse -> Int #
FromJSON JourneyExecutionActivityMetricsResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse Methods parseJSON :: Value -> Parser JourneyExecutionActivityMetricsResponse # parseJSONList :: Value -> Parser [JourneyExecutionActivityMetricsResponse] #
type Rep JourneyExecutionActivityMetricsResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse type Rep JourneyExecutionActivityMetricsResponse = D1 ('MetaData "JourneyExecutionActivityMetricsResponse" "Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneyExecutionActivityMetricsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)) :: (S1 ('MetaSel ('Just "journeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "lastEvaluatedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "journeyActivityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "activityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newJourneyExecutionActivityMetricsResponse Source #

Arguments

:: Text	`$sel:journeyId:JourneyExecutionActivityMetricsResponse'`
-> Text	`$sel:lastEvaluatedTime:JourneyExecutionActivityMetricsResponse'`
-> Text	`$sel:journeyActivityId:JourneyExecutionActivityMetricsResponse'`
-> Text	`$sel:activityType:JourneyExecutionActivityMetricsResponse'`
-> Text	`$sel:applicationId:JourneyExecutionActivityMetricsResponse'`
-> JourneyExecutionActivityMetricsResponse

Create a value of JourneyExecutionActivityMetricsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:metrics:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_metrics - 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.

$sel:journeyId:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_journeyId - The unique identifier for the journey that the metric applies to.

$sel:lastEvaluatedTime:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_lastEvaluatedTime - 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.

$sel:journeyActivityId:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_journeyActivityId - The unique identifier for the activity that the metric applies to.

$sel:activityType:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_activityType - 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.

$sel:applicationId:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_applicationId - The unique identifier for the application that the metric applies to.

journeyExecutionActivityMetricsResponse_metrics :: Lens' JourneyExecutionActivityMetricsResponse (HashMap Text Text) Source #

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.

journeyExecutionActivityMetricsResponse_journeyId :: Lens' JourneyExecutionActivityMetricsResponse Text Source #

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

journeyExecutionActivityMetricsResponse_lastEvaluatedTime :: Lens' JourneyExecutionActivityMetricsResponse Text Source #

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.

journeyExecutionActivityMetricsResponse_journeyActivityId :: Lens' JourneyExecutionActivityMetricsResponse Text Source #

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

journeyExecutionActivityMetricsResponse_activityType :: Lens' JourneyExecutionActivityMetricsResponse Text Source #

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.

journeyExecutionActivityMetricsResponse_applicationId :: Lens' JourneyExecutionActivityMetricsResponse Text Source #

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