Skip to content

JourneyExecutionActivityMetricsResponse

Source code in docs_src/capo_pinpoint/types/journey_execution_activity_metrics_response.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
class JourneyExecutionActivityMetricsResponse(TypedDict, closed=True):
    activity_type: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The type of activity that the metric applies to. Possible values are:</p> <ul><li><p>CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.</p></li> <li><p>HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.</p></li> <li><p>MESSAGE – For an email activity, which is an activity that sends an email message to participants.</p></li> <li><p>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.</p></li> <li><p>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.</p></li> <li><p>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.</p></li></ul>"""
    application_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the application that the metric applies to.</p>"""
    journey_activity_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the activity that the metric applies to.</p>"""
    journey_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the journey that the metric applies to.</p>"""
    last_evaluated_time: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>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.</p>"""
    metrics: NotRequired["capo_pinpoint.types.map_of__string.MapOf__string"]
    """<p>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 <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>"""

activity_type instance-attribute 

activity_type: NotRequired[__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.

application_id instance-attribute 

application_id: NotRequired[__string]

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

journey_activity_id instance-attribute 

journey_activity_id: NotRequired[__string]

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

journey_id instance-attribute 

journey_id: NotRequired[__string]

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

last_evaluated_time instance-attribute 

last_evaluated_time: NotRequired[__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 instance-attribute 

metrics: NotRequired[MapOf__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.