Amazon Pinpoint
Developer Guide

Standard Amazon Pinpoint Analytics Metrics

You can use Amazon Pinpoint Analytics APIs to query analytics data for a subset of standard metrics that apply to Amazon Pinpoint projects, campaigns, and journeys. These metrics, also referred to as a key performance indicators (KPIs), are measurable values that can help you monitor and assess the performance of projects, campaigns, and journeys.

Amazon Pinpoint provides programmatic access to analytics data for several types of standard metrics:

  • Application metrics – These metrics provide insight into trends for all the campaigns and transactional messages that are associated with a project, also referred to as an application. For example, you can use an application metric to get a breakdown of the number of messages that were opened by recipients for each campaign that's associated with a project.

  • Campaign metrics – These metrics provide insight into the performance of individual campaigns. For example, you can use a campaign metric to determine how many endpoints a campaign message was sent to or how many of those messages were delivered to endpoints.

  • Journey engagement metrics – These metrics provide insight into the performance of individual journeys. For example, you can use a journey engagement metric to get a breakdown of the number of messages that were opened by participants in each activity of a journey.

  • Journey execution metrics – These metrics provide insight into participation trends for individual journeys. For example, you can use a journey execution metric to determine how many participants started a journey.

  • Journey activity execution metrics – These metrics provide insight into participation trends for individual activities in a journey. For example, you can use a journey activity execution metric to determine how many participants started an activity and how many participants completed each path in an activity.

The topics in this section list and describe the individual metrics that you can query for each type of metric.

Application Metrics for Campaigns

The following table lists and describes standard application metrics that you can query to assess the performance of all the campaigns that are associated with an Amazon Pinpoint project. To query data for these metrics, use the Application Metrics resource of the Amazon Pinpoint API. The kpi-name column in the table indicates the value to use for the kpi-name parameter in a query.

Metric kpi-name Description

Delivery rate

successful-delivery-rate

For all the campaigns that are associated with a project, the percentage of messages that were delivered to recipients.

This metric is calculated as the number of messages that were sent by all the campaigns for a project and delivered to recipients, divided by the number of messages that were sent by all of those campaigns.

Delivery rate, grouped by date

successful-delivery-rate-grouped-by-date

For all the campaigns that are associated with a project, the percentage of messages that were delivered to recipients, for each day in the specified date range.

This metric is calculated as the number of messages that were sent by all the campaigns for a project and delivered to recipients, divided by the number of messages that were sent by all of those campaigns, for each day in the specified date range.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Email open rate

email-open-rate

For all the campaigns that are associated with a project, the percentage of email messages that were opened by recipients.

This metric is calculated as the number of email messages that were sent by all the campaigns for a project and opened by recipients, divided by the number of email messages that were sent by all of those campaigns and delivered to recipients.

Email open rate, grouped by campaign

email-open-rate-grouped-by-campaign

For each campaign that's associated with a project, the percentage of email messages that were opened by recipients.

This metric is calculated as the number of email messages that were sent by a campaign and opened by recipients, divided by the number of email messages that were sent by the campaign and delivered to recipients.

The query results for this metric are grouped by campaign ID (CampaignId), which is a string that uniquely identifies a campaign.

Endpoint deliveries

unique-deliveries

For all the campaigns that are associated with a project, the number of unique endpoints that messages were delivered to.

Endpoint deliveries, grouped by campaign

unique-deliveries-grouped-by-campaign

For each campaign that's associated with a project, the number of unique endpoints that messages were delivered to.

The query results for this metric are grouped by campaign ID (CampaignId), which is a string that uniquely identifies a campaign.

Endpoint deliveries, grouped by date

unique-deliveries-grouped-by-date

For all the campaigns that are associated with a project, the number of unique endpoints that messages were delivered to, for each day in the specified date range.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Messages delivered, grouped by campaign

successful-deliveries-grouped-by-campaign

For each campaign that's associated with a project, the number of messages that were delivered to recipients.

This metric is calculated as the number of messages that were sent by a campaign, minus the number of messages that were sent by the campaign and couldn't be delivered to recipients due to a hard bounce.

The query results for this metric are grouped by campaign ID (CampaignId), which is a string that uniquely identifies a campaign.

Push open rate

push-open-rate

For all the campaigns that are associated with a project, the percentage of push notifications that were opened by recipients.

This metric is calculated as the number of push notifications that were sent by all the campaigns for a project and opened by recipients, divided by the number of push notifications that were sent by all of those campaigns and delivered to recipients.

Push open rate, grouped by campaign

push-open-rate-grouped-by-campaign

For each campaign that's associated with a project, the percentage of push notifications that were opened by recipients.

This metric is calculated as the number of push notifications that were sent by a campaign and opened by recipients, divided by the number of push notifications that were sent by the campaign and delivered to recipients.

The query results for this metric are grouped by campaign ID (CampaignId), which is a string that uniquely identifies a campaign.

Application Metrics for Transactional Email Messages

The following table lists and describes standard application metrics that you can query to monitor trends for all the transactional email messages that are associated with an Amazon Pinpoint project. To query data for these metrics, use the Application Metrics resource of the Amazon Pinpoint API. The kpi-name column in the table indicates the value to use for the kpi-name parameter in a query.

Note that these metrics don't provide data about email messages that were sent by campaigns. They provide data about transactional email messages only. To query data for messages that were sent by one or more campaigns, use a campaign metric or an application metric for campaigns.

Metric kpi-name Description

Clicks

txn-emails-clicked

The number of times that recipients clicked links in the messages. If a single recipient clicked multiple links in a message, or clicked the same link more than once, each click is included in the count.

Clicks, grouped by date

txn-emails-clicked-grouped-by-date

The number of times that recipients clicked links in the messages, for each day in the specified date range. If a single recipient clicked multiple links in a message, or clicked the same link more than once, each click is included in the count.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Complaint rate

txn-emails-complaint-rate

The percentage of messages that were reported by recipients as unsolicited or unwanted email.

This metric is calculated as the number of messages that were reported by recipients as unsolicited or unwanted email, divided by the number of messages that were sent.

Complaint rate, grouped by date

txn-emails-complaint-rate-grouped-by-date

The percentage of messages that were reported by recipients as unsolicited or unwanted email, for each day in the specified date range.

This metric is calculated as the number of messages that were reported by recipients as unsolicited or unwanted email, divided by the number of messages that were sent, for each day in the specified date range.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Complaints

txn-emails-with-complaints

The number of messages that were reported by recipients as unsolicited or unwanted email.

Complaints, grouped by date

txn-emails-with-complaints-grouped-by-date

The number of messages that were reported by recipients as unsolicited or unwanted email, for each day in the specified date range.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Deliveries

txn-emails-delivered

The number of messages that were delivered to recipients.

This metric is calculated as the number of messages that were sent, minus the number of messages that couldn't be delivered due to a soft or hard bounce or because they were rejected. A message is rejected if Amazon Pinpoint determines that the message contains malware. Amazon Pinpoint doesn't attempt to send rejected messages.

Deliveries, grouped by date

txn-emails-delivered-grouped-by-date

The number of messages that were delivered to recipients, for each day in the specified date range.

This metric is calculated as the number of messages that were sent, minus the number of messages that couldn't be delivered due to a soft or hard bounce or because they were rejected, for each day in the specified date range. A message is rejected if Amazon Pinpoint determines that the message contains malware. Amazon Pinpoint doesn't attempt to send rejected messages.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Delivery rate

txn-emails-delivery-rate

The percentage of messages that were delivered to recipients.

This metric is calculated as the number of messages that were sent and delivered to recipients, divided by the number of messages that were sent.

Delivery rate, grouped by date

txn-emails-delivery-rate-grouped-by-date

The percentage of messages that were delivered to recipients, for each day in the specified date range.

This metric is calculated as the number of messages that were sent and delivered to recipients, divided by the number of messages that were sent, for each day in the specified date range.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Hard bounces

txn-emails-hard-bounced

The number of messages that couldn't be delivered to recipients due to a hard bounce. A hard bounce occurs if a persistent issue prevents a message from being delivered—for example, if a recipient's email address doesn't exist.

Hard bounces, grouped by date

txn-emails-hard-bounced-grouped-by-date

The number of messages that couldn't be delivered to recipients due to a hard bounce, for each day in the specified date range. A hard bounce occurs if a persistent issue prevents a message from being delivered—for example, if a recipient's email address doesn't exist.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Opens

txn-emails-opened

The number of messages that were opened by recipients.

Opens, grouped by date

txn-emails-opened-grouped-by-date

The number of messages that were opened by recipients, for each day in the specified date range.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Sends

txn-emails-sent

The number of messages that were sent.

Sends, grouped by date

txn-emails-sent-grouped-by-date

The number of messages that were sent, for each day in the specified date range.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Soft bounces

txn-emails-soft-bounced

The number of messages that couldn't be delivered to recipients due to a soft bounce. A soft bounce occurs if a temporary issue prevents a message from being delivered—for example, if a recipient's inbox is full or the receiving server is temporarily unavailable.

Soft bounces, grouped by date

txn-emails-soft-bounced-grouped-by-date

The number of messages that couldn't be delivered to recipients due to a soft bounce, for each day in the specified date range. A soft bounce occurs if a temporary issue prevents a message from being delivered—for example, if a recipient's inbox is full or the receiving server is temporarily unavailable.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Unique user click events

txn-emails-unique-clicks

The number of unique recipients (endpoints) who clicked links in messages.

Unlike the Clicks metric, this metric reports the number of unique recipients who clicked links, not the number of click events that occurred. For example, if a single recipient clicked multiple links in the same message, or clicked the same link more than once, this metric reports only one click event for that recipient.

Unique user click events, grouped by date

txn-emails-unique-clicks-grouped-by-date

The number of unique recipients (endpoints) who clicked links in messages, for each day in the specified date range.

Unlike the Clicks, grouped by date metric, this metric reports the number of unique recipients who clicked links, not the number of click events that occurred. For example, if a single recipient clicked multiple links in the same message, or clicked the same link more than once, this metric reports only one click event for that recipient.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Unique user open events

txn-emails-unique-opens

The number of unique recipients (endpoints) who opened messages.

Unlike the Opens metric, this metric reports the number of unique recipients who opened messages, not the number of open events that occurred. For example, if a single recipient opens the same message multiple times, this metric reports only one open event for that recipient.

Unique user open events, grouped by date

txn-emails-unique-opens-grouped-by-date

The number of unique recipients (endpoints) who opened messages, for each day in the specified date range.

Unlike the Opens, grouped by date metric, this metric reports the number of unique recipients who opened messages, not the number of open events that occurred. For example, if a single recipient opens the same message multiple times, this metric reports only one open event for that recipient.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Application Metrics for Transactional SMS Messages

The following table lists and describes standard application metrics that you can query to monitor trends for all the transactional SMS messages that are associated with an Amazon Pinpoint project. To query data for these metrics, use the Application Metrics resource of the Amazon Pinpoint API. The kpi-name column in the table indicates the value to use for the kpi-name parameter in a query.

Note that these metrics don't provide data about SMS messages that were sent by campaigns. They provide data about transactional SMS messages only. To query data for messages that were sent by one or more campaigns, use a campaign metric or an application metric for campaigns.

Metric kpi-name Description

Average price, grouped by country

txn-sms-average-price-grouped-by-country

The average cost, in US Dollars, of sending each message, for each country or region that messages were sent to.

This metric is calculated as the total cost of all the messages that were sent to recipients in each country or region, divided by the number of messages that were sent to recipients in each of those countries and regions.

The query results for this metric are grouped by country or region, in ISO 3166-1 alpha-2 format.

Deliveries

txn-sms-delivered

The number of messages that were delivered to recipients.

Deliveries, grouped by country

txn-sms-delivered-grouped-by-country

The number of messages that were delivered to recipients, for each country or region that messages were sent to.

The query results for this metric are grouped by country or region, in ISO 3166-1 alpha-2 format.

Deliveries, grouped by date

txn-sms-delivered-grouped-by-date

The number of messages that were delivered to recipients, for each day in the specified date range.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Delivery errors

txn-sms-error-distribution

The number of times that an error occurred while attempting to deliver the messages, for each type of error that occurred.

The query results for this metric are grouped by error code, for each type of error that occurred.

Delivery rate

txn-sms-delivery-rate

The percentage of messages that were delivered to recipients.

This metric is calculated as the number of messages that were sent and delivered to recipients, divided by the number of messages that were sent.

Delivery rate, grouped by date

txn-sms-delivery-rate-grouped-by-date

The percentage of messages that were delivered to recipients, for each day in the specified date range.

This metric is calculated as the number of messages that were sent and delivered to recipients, divided by the number of messages that were sent, for each day in the specified date range.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Sends

txn-sms-sent

The number of messages that were sent.

Sends, grouped by country

txn-sms-sent-grouped-by-country

The number of messages that were sent, for each country or region that messages were sent to.

The query results for this metric are grouped by country or region, in ISO 3166-1 alpha-2 format.

Sends, grouped by date

txn-sms-sent-grouped-by-date

The number of messages that were sent, for each day in the specified date range.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Total price, grouped by country

txn-sms-total-price-grouped-by-country

The total cost, in US Dollars, of sending the messages, for each country or region that messages were sent to.

The query results for this metric are grouped by country or region, in ISO 3166-1 alpha-2 format.

Campaign Metrics

The following table lists and describes standard campaign metrics that you can query to assess the performance of an individual campaign. To query data for these metrics, use the Campaign Metrics resource of the Amazon Pinpoint API. The kpi-name column in the table indicates the value to use for the kpi-name parameter in your query.

Metric kpi-name Description

Bounce rate

hard-bounce-rate

For all campaign runs, the percentage of email messages that couldn't be delivered to recipients. This metric measures only hard bounces—that is, messages in which the recipient's email address had a permanent issue that prevented the message from being delivered.

This metric is calculated as the number of bounced email messages that were sent by all the campaign runs, divided by the number of email messages that were sent by all of those campaign runs.

Bounce rate, grouped by campaign run

hard-bounce-rate-grouped-by-campaign-activity

For each campaign run, the percentage of email messages that couldn't be delivered to recipients. This metric measures only hard bounces—that is, messages in which the recipient's email address had a permanent issue that prevented the message from being delivered.

This metric is calculated as the number of bounced email messages that were sent by a campaign run, divided by the number of email messages that were sent by the campaign run.

The query results for this metric are grouped by campaign activity ID (CampaignActivityId), which is a string that uniquely identifies a campaign run.

Delivery rate

successful-delivery-rate

For all campaign runs, the percentage of messages that were delivered to recipients.

This metric is calculated as the number of messages that were sent by all the campaign runs and delivered to recipients, divided by the number of messages that were sent by all of those campaign runs.

Delivery rate, grouped by campaign run

successful-delivery-rate-grouped-by-campaign-activity

For each campaign run, the percentage of messages that were delivered to recipients.

This metric is calculated as the number of messages that were sent by a campaign run and delivered to recipients, divided by the number of messages that were sent by the campaign run.

The query results for this metric are grouped by campaign activity ID (CampaignActivityId), which is a string that uniquely identifies a campaign run.

Delivery rate, grouped by date

successful-delivery-rate-grouped-by-date

For all campaign runs, the percentage of messages that were delivered to recipients during each day in the specified date range.

This metric is calculated as the number of messages that were sent by all the campaign runs and delivered to recipients, divided by the number of messages that were sent by all of those campaign runs, for each day in the specified date range.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Email open rate

email-open-rate

For all campaign runs, the percentage of email messages that were opened by recipients.

This metric is calculated as the number of email messages that were sent by all the campaign runs and opened by recipients, divided by the number of email messages that were sent by all of those campaign runs and delivered to recipients.

Email open rate, grouped by campaign run

email-open-rate-grouped-by-campaign-activity

For each campaign run, the percentage of email messages that were opened by recipients.

This metric is calculated as the number of email messages that were sent by a campaign run and opened by recipients, divided by the number of email messages that were sent by the campaign run and delivered to recipients.

The query results for this metric are grouped by campaign activity ID (CampaignActivityId), which is a string that uniquely identifies a campaign run.

Emails opened, grouped by campaign run

direct-email-opens-grouped-by-campaign-activity

For each campaign run, the number of email messages that were opened by recipients.

The query results for this metric are grouped by campaign activity ID (CampaignActivityId), which is a string that uniquely identifies a campaign run.

Endpoint deliveries

unique-deliveries

For all campaign runs, the number of unique endpoints that messages were delivered to.

Endpoint deliveries, grouped by campaign run

unique-deliveries-grouped-by-campaign-activity

For each campaign run, the number of unique endpoints that messages were delivered to.

The query results for this metric are grouped by campaign activity ID (CampaignActivityId), which is a string that uniquely identifies a campaign run.

Endpoint deliveries, grouped by date

unique-deliveries-grouped-by-date

For all campaign runs, the number of unique endpoints that messages were delivered to, for each day in the specified date range.

The query results for this metric are grouped by calendar day, in extended ISO 8601 format.

Links clicked, grouped by campaign run

clicks-grouped-by-campaign-activity

For each campaign run, the number of times that recipients clicked links in the email message. If a single recipient clicked multiple links in the message, or clicked the same link more than once, each click is included in the count.

The query results for this metric are grouped by campaign activity ID (CampaignActivityId), which is a string that uniquely identifies a campaign run.

Messages delivered, grouped by campaign run

successful-deliveries-grouped-by-campaign-activity

For each campaign run, the number of messages that were delivered to recipients.

This metric is calculated as the number of messages that were sent by a campaign run, minus the number of messages that couldn't be delivered to recipients of the run due to a hard bounce.

The query results for this metric are grouped by campaign activity ID (CampaignActivityId), which is a string that uniquely identifies a campaign run.

Messages sent, grouped by campaign run

attempted-deliveries-grouped-by-campaign-activity

For each campaign run, the number of messages that were sent.

The query results for this metric are grouped by campaign activity ID (CampaignActivityId), which is a string that uniquely identifies a campaign run.

Push open rate

push-open-rate

For all campaign runs, the percentage of push notifications that were opened by recipients.

This metric is calculated as the number of push notifications that were sent by all the campaign runs and opened by recipients, divided by the number of push notifications that were sent by all of those campaign runs and delivered to recipients.

Push open rate, grouped by campaign run

push-open-rate-grouped-by-campaign-activity

For each campaign run, the percentage of push notifications that were opened by recipients.

This metric is calculated as the number of push notifications that were sent by a campaign run and opened by recipients, divided by the number of push notifications that were sent by the campaign run and delivered to recipients.

The query results for this metric are grouped by campaign activity ID (CampaignActivityId), which is a string that uniquely identifies a campaign run.

Total push opened, grouped by campaign run

direct-push-opens-grouped-by-campaign-activity

For each campaign run, the number of push notifications that were opened by recipients.

The query results for this metric are grouped by campaign activity ID (CampaignActivityId), which is a string that uniquely identifies a campaign run.

Journey Engagement Metrics

The following table lists and describes standard journey engagement metrics that you can query to monitor trends for all the email messages that were sent by an Amazon Pinpoint journey. To query data for these metrics, use the Journey Engagement Metrics resource of the Amazon Pinpoint API. The kpi-name column in the table indicates the value to use for the kpi-name parameter in a query.

Metric kpi-name Description

Clicks

journey-emails-clicked

The number of times that participants clicked links in the messages. If a single participant clicked multiple links in a message, or clicked the same link more than once, each click is included in the count.

Clicks, grouped by activity

emails-clicked-grouped-by-journey-activity

For each activity in the journey, the number of times that participants clicked links in the messages. If a single participant clicked multiple links in a message, or clicked the same link more than once, each click is included in the count.

The query results for this metric are grouped by activity ID (JourneyActivityId), which is a string that uniquely identifies an activity.

Complaints

journey-emails-complained

The number of messages that were reported by participants as unsolicited or unwanted email.

Complaints, grouped by activity

emails-complained-grouped-by-journey-activity

For each activity in the journey, the number of messages that were reported by participants as unsolicited or unwanted email.

The query results for this metric are grouped by activity ID (JourneyActivityId), which is a string that uniquely identifies an activity.

Deliveries

journey-emails-delivered

The number of messages that were delivered to participants.

This metric is calculated as the number of messages that were sent, minus the number of messages that couldn't be delivered due to a soft or hard bounce, or because they were rejected.

Deliveries, grouped by activity

emails-delivered-grouped-by-journey-activity

For each activity in the journey, the number of messages that were delivered to participants.

This metric is calculated as the number of messages that were sent, minus the number of messages that couldn't be delivered due to a soft or hard bounce, or because they were rejected, for each activity in the journey.

The query results for this metric are grouped by activity ID (JourneyActivityId), which is a string that uniquely identifies an activity.

Hard bounces

journey-emails-hardbounced

The number of messages that couldn't be delivered to participants due to a hard bounce. A hard bounce occurs if a persistent issue prevents a message from being delivered—for example, if a participant's email address doesn't exist.

Hard bounces, grouped by activity

emails-hardbounced-grouped-by-journey-activity

For each activity in the journey, the number of messages that couldn't be delivered to participants due to a hard bounce. A hard bounce occurs if a persistent issue prevents a message from being delivered—for example, if a participant's email address doesn't exist.

The query results for this metric are grouped by activity ID (JourneyActivityId), which is a string that uniquely identifies an activity.

Opens

journey-emails-opened

The number of messages that were opened by participants.

Opens, grouped by activity

emails-opened-grouped-by-journey-activity

For each activity in the journey, the number of messages that were opened by participants.

The query results for this metric are grouped by activity ID (JourneyActivityId), which is a string that uniquely identifies an activity.

Rejections

journey-emails-rejected

The number of messages that weren't sent to participants because they were rejected. A message is rejected if Amazon Pinpoint determines that the message contains malware. Amazon Pinpoint doesn't attempt to send rejected messages.

Rejections, grouped by activity

emails-rejected-grouped-by-journey-activity

For each activity in the journey, the number of messages that weren't sent to participants because they were rejected. A message is rejected if Amazon Pinpoint determines that the message contains malware. Amazon Pinpoint doesn't attempt to send rejected messages.

The query results for this metric are grouped by activity ID (JourneyActivityId), which is a string that uniquely identifies an activity.

Sends

journey-emails-sent

The number of messages that were sent.

Sends, grouped by activity

emails-sent-grouped-by-journey-activity

For each activity in the journey, the number of messages that were sent.

The query results for this metric are grouped by activity ID (JourneyActivityId), which is a string that uniquely identifies an activity.

Soft bounces

journey-emails-softbounced

The number of messages that couldn't be delivered to participants due to a soft bounce. A soft bounce occurs if a temporary issue prevents a message from being delivered—for example, if a participant's inbox is full or the receiving server is temporarily unavailable.

Soft bounces, grouped by activity

emails-softbounced-grouped-by-journey-activity

For each activity in the journey, the number of messages that couldn't be delivered to participants due to a soft bounce. A soft bounce occurs if a temporary issue prevents a message from being delivered—for example, if a participant's inbox is full or the receiving server is temporarily unavailable.

The query results for this metric are grouped by activity ID (JourneyActivityId), which is a string that uniquely identifies an activity.

Unsubscribes

journey-emails-unsubscribed

The number of times that participants clicked unsubscribe links in the messages. If a single participant clicked the same unsubscribe link more than once, each click is included in the count.

Unsubscribes, grouped by activity

emails-unsubscribed-grouped-by-journey-activity

For each activity in the journey, the number of times that participants clicked unsubscribe links in the messages. If a single participant clicked the same unsubscribe link more than once, each click is included in the count.

The query results for this metric are grouped by activity ID (JourneyActivityId), which is a string that uniquely identifies an activity.

Journey Execution Metrics

The following table lists and describes standard execution metrics that you can query to assess the status of participants in an Amazon Pinpoint journey. To query data for these metrics, use the Journey Execution Metrics resource of the Amazon Pinpoint API. The Field column in the table identifies the name of the field that appears in the query results for each metric.

Metric Field Description

Active participants

ENDPOINT_ACTIVE

The number of participants who are actively proceeding through the activities in the journey.

This metric is calculated as the number of participants who have entered the journey, minus the number of participants who left the journey and the number of participants who were removed from the journey.

Participant departures

ENDPOINT_LEFT

The number of participants who left the journey before completing the journey.

Participant entries

ENDPOINT_ENTERED

The number of participants who started the journey.

Participant exceptions, re-entry limits

REENTRY_CAP_EXCEEDED

The number of participants who didn't complete the journey because they would have exceeded the maximum number of times that a single participant can re-enter the journey.

Journey Activity Execution Metrics

The following table lists and describes standard execution metrics that you can query to assess the status of participants in each type of individual activity for an Amazon Pinpoint journey. To query data for these metrics, use the Journey Activity Execution Metrics resource of the Amazon Pinpoint API. The Metrics column in the table lists the fields that appear in the query results for each type of activity. It also provides a brief description of each field.

Activity Type Metrics

Yes/No split (CONDITIONAL_SPLIT)

The metrics for the overall activity are:

  • TOTAL_ENTERED – The number of participants who started either path in the activity.

  • TOTAL_LEFT – The number of participants who completed either path in the activity.

Additional metrics are available for each path in the activity. For information about those metrics, see the row in this table for that type of activity.

Holdout (HOLDOUT)

The metrics are:

  • HOLDOUT – The number of participants who were removed from the journey as part of the holdout percentage for the activity.

  • PASSED – The number of participants who moved to the next activity in the journey.

  • TOTAL – The number of participants who completed the activity. These participants were either removed from the journey, as part of the holdout percentage, or moved to the next activity.

Email (MESSAGE)

The metrics are:

  • DAILY_CAP_EXCEEDED – The number of messages that weren't sent because they would have exceeded the maximum number of messages that a single participant can receive during a 24-hour period.

  • FAILURE_PERMANENT – The number of messages that weren't sent due to a permanent issue.

  • QUIET_TIME – The number of messages that weren't sent because they would have been delivered during quiet time for the participant's time zone.

  • SERVICE_FAILURE – The number of messages that weren't sent due to an issue with Amazon Pinpoint.

  • SUCCESS – The number of messages that were successfully delivered to participants.

  • THROTTLED – The number of messages that weren't sent because sending them would exceed the sending limits for your Amazon Pinpoint account.

  • TOTAL – The number of messages that were sent.

  • TRANSIENT_FAILURE – The number of messages that weren't sent due to a temporary issue.

  • UNKNOWN – The number of messages that weren't sent due to an unknown issue.

Multivariate split (MULTI_CONDITIONAL_SPLIT)

The metrics for the overall activity are:

  • TOTAL_ENTERED – The number of participants who started any path in the activity.

  • TOTAL_LEFT – The number of participants who completed any path in the activity.

Additional metrics are available for each path in the activity. For information about those metrics, see the row in this table for that type of activity.

Random split (RANDOM_SPLIT)

The metric for the overall activity is TOTAL, which is the number of participants who started any path in the activity.

Additional metrics are available for each path in the activity. For information about those metrics, see the row in this table for that type of activity.

Wait (WAIT)

The metrics are:

  • TOTAL_ENTERED – The number of participants who started the activity.

  • TOTAL_LEFT – The number of participants who completed the activity.

  • WAIT_FINISHED – The number of participants who finished waiting for the specified amount of time.

  • WAIT_SKIPPED – The number of participants who didn't wait for the specified amount of time, typically because they started the activity or journey after the scheduled end time for the activity.

  • WAIT_STARTED – The number of participants who started waiting, and haven't skipped or finished waiting for the specified amount of time.

  • WAITING – The number of participants who are currently waiting for the specified amount of time.