From 9fb9383c1b34ff7da0f0de235454555b525a359d Mon Sep 17 00:00:00 2001 From: Gabriel Soga Date: Thu, 28 Apr 2022 17:46:28 -0300 Subject: [PATCH 1/3] SAA-527 adding nonprefetched documentations --- content/api/metrics.apib | 143 +++++++++++++++++++++++++++------------ package-lock.json | 14 ++-- 2 files changed, 108 insertions(+), 49 deletions(-) diff --git a/content/api/metrics.apib b/content/api/metrics.apib index 98c5d6c0..0bb32559 100644 --- a/content/api/metrics.apib +++ b/content/api/metrics.apib @@ -14,51 +14,56 @@ Metrics API data is retained for 6 months. Definitions for terms found in Metrics API -| Term | Definition | -|---------------------------------:|-----------------------------------------------------------------------------------------------------| -| `count_targeted` | Messages successfully injected into SparkPost as well as rejected by it | -| `count_injected` | Messages injected to or received by SparkPost | -| `count_sent` | Messages that SparkPost attempted to deliver, which includes both Deliveries and Bounces | -| `count_accepted` | Messages an ISP or other remote domain accepted (less Out-of-Band Bounces) | -| `count_delivered` | Messages delivered | -| `count_delivered_first` | Messages delivered on the first attempt | -| `count_delivered_subsequent` | Messages delivered that required more than one delivery attempt | -| `count_rendered` | Total renderings of a message | -| `count_initial_rendered` | Total initial renderings of a message | -| `count_unique_rendered` | Total number of messages that were rendered at least once | -| `count_unique_initial_rendered` | Total number of messages that were initally rendered at least once | -| `count_unique_confirmed_opened` | Total number of messages that were rendered or had at least one link selected | -| `count_clicked` | Total number of times that links were selected across all messages | -| `count_unique_clicked` | Total number of messages which had at least one link selected one or more times | -| `count_bounce` | Total number of bounced messages, which includes both In-Band and Out-of-Band bounces | -| `count_hard_bounce` | Total number of Bounced messages due to hard bounce classification reasons | -| `count_soft_bounce` | Total number of Bounced messages due to soft bounce classification reasons | -| `count_block_bounce` | Total number of Bounced messages due to an IP block | -| `count_admin_bounce` | Total number of Bounced messages due to admin bounce classification reasons, also includes Rejected | -| `count_undetermined_bounce` | Total number of Bounced messages due to undetermined bounce reasons | -| `count_rejected` | Messages rejected due to policy or that failed to generate | -| `count_policy_rejection` | Messages rejected by SparkPost due to policy | -| `count_generation_failed` | Message generation failed for an intended recipient | -| `count_generation_rejection` | Messages rejected by SparkPost due to policy | -| `count_inband_bounce` | Messages that bounced on delivery attempt during the SMTP session | -| `count_outofband_bounce` | Messages that the ISP bounced subsequent to a successful delivery | -| `count_delayed` | Total number of delays due to any temporary failure | -| `count_delayed_first` | Messages delayed on the first delivery attempt | -| `total_msg_volume` | Total size of delivered messages, in bytes (including attachments) | -| `count_spam_complaint` | Number of spam complaints received from an ISP | -| `total_delivery_time_first` | Total time taken to deliver messages on first attempt (milliseconds) | -| `total_delivery_time_subsequent` | Total time taken to delivery messages on subsequent attempts (milliseconds) | -| `count_unsubscribe` | Total number of unsubscribes as a result of clicked links and the ISP list unsubscribe feature | -| `count_inbox_panel` | Deliverability Add-On Panel messages delivered to the inbox. | -| `count_spam_panel` | Deliverability Add-On Panel messages delivered to the spam folder. | -| `count_inbox_seed` | Deliverability Add-On All Seed messages delivered to the inbox. | -| `count_spam_seed` | Deliverability Add-On All Seed messages delivered to the spam folder. -| `count_inbox_seed_private` | Deliverability Add-On Private Seed messages delivered to the inbox. | -| `count_spam_seed_private` | Deliverability Add-On Private Seed messages delivered to the spam folder. -| `count_inbox_seed_virtual` | Deliverability Add-On Virtual Seed messages delivered to the inbox. | -| `count_spam_seed_virtual` | Deliverability Add-On Virtual Seed messages delivered to the spam folder. -| `count_moved_to_inbox` | Deliverability Add-On Panel messages delivered to the spam folder then moved to the inbox. | -| `count_moved_to_spam` | Deliverability Add-On Panel messages delivered to the inbox then moved to the spam folder. | +| Term | Definition | +|----------------------------------------------:|-----------------------------------------------------------------------------------------------------| +| `count_targeted` | Messages successfully injected into SparkPost as well as rejected by it | +| `count_injected` | Messages injected to or received by SparkPost | +| `count_sent` | Messages that SparkPost attempted to deliver, which includes both Deliveries and Bounces | +| `count_accepted` | Messages an ISP or other remote domain accepted (less Out-of-Band Bounces) | +| `count_delivered` | Messages delivered | +| `count_delivered_first` | Messages delivered on the first attempt | +| `count_delivered_subsequent` | Messages delivered that required more than one delivery attempt | +| `count_rendered` | Total renderings of a message | +| `count_nonprefetched_rendered` | Total nonprefetched renderings of a message | +| `count_initial_rendered` | Total initial renderings of a message | +| `count_nonprefetched_initial_rendered` | Total initial nonprefetched renderings of a message | +| `count_unique_rendered` | Total number of messages that were rendered at least once | +| `count_nonprefetched_unique_rendered` | Total number of nonprefetched messages that were rendered at least once | +| `count_unique_initial_rendered` | Total number of messages that were initally rendered at least once | +| `count_nonprefetched_unique_initial_rendered` | Total number of nonprefetched messages that were initally rendered at least once | +| `count_unique_confirmed_opened` | Total number of messages that were rendered or had at least one link selected | +| `count_nonprefetched_unique_confirmed_opened` | Total number of nonprefetched messages that were rendered or had at least one link selected | +| `count_clicked` | Total number of times that links were selected across all messages | +| `count_unique_clicked` | Total number of messages which had at least one link selected one or more times | +| `count_bounce` | Total number of bounced messages, which includes both In-Band and Out-of-Band bounces | +| `count_hard_bounce` | Total number of Bounced messages due to hard bounce classification reasons | +| `count_soft_bounce` | Total number of Bounced messages due to soft bounce classification reasons | +| `count_block_bounce` | Total number of Bounced messages due to an IP block | +| `count_admin_bounce` | Total number of Bounced messages due to admin bounce classification reasons, also includes Rejected | +| `count_undetermined_bounce` | Total number of Bounced messages due to undetermined bounce reasons | +| `count_rejected` | Messages rejected due to policy or that failed to generate | +| `count_policy_rejection` | Messages rejected by SparkPost due to policy | +| `count_generation_failed` | Message generation failed for an intended recipient | +| `count_generation_rejection` | Messages rejected by SparkPost due to policy | +| `count_inband_bounce` | Messages that bounced on delivery attempt during the SMTP session | +| `count_outofband_bounce` | Messages that the ISP bounced subsequent to a successful delivery | +| `count_delayed` | Total number of delays due to any temporary failure | +| `count_delayed_first` | Messages delayed on the first delivery attempt | +| `total_msg_volume` | Total size of delivered messages, in bytes (including attachments) | +| `count_spam_complaint` | Number of spam complaints received from an ISP | +| `total_delivery_time_first` | Total time taken to deliver messages on first attempt (milliseconds) | +| `total_delivery_time_subsequent` | Total time taken to delivery messages on subsequent attempts (milliseconds) | +| `count_unsubscribe` | Total number of unsubscribes as a result of clicked links and the ISP list unsubscribe feature | +| `count_inbox_panel` | Deliverability Add-On Panel messages delivered to the inbox. | +| `count_spam_panel` | Deliverability Add-On Panel messages delivered to the spam folder. | +| `count_inbox_seed` | Deliverability Add-On All Seed messages delivered to the inbox. | +| `count_spam_seed` | Deliverability Add-On All Seed messages delivered to the spam folder. +| `count_inbox_seed_private` | Deliverability Add-On Private Seed messages delivered to the inbox. | +| `count_spam_seed_private` | Deliverability Add-On Private Seed messages delivered to the spam folder. +| `count_inbox_seed_virtual` | Deliverability Add-On Virtual Seed messages delivered to the inbox. | +| `count_spam_seed_virtual` | Deliverability Add-On Virtual Seed messages delivered to the spam folder. +| `count_moved_to_inbox` | Deliverability Add-On Panel messages delivered to the spam folder then moved to the inbox. | +| `count_moved_to_spam` | Deliverability Add-On Panel messages delivered to the inbox then moved to the spam folder. | Note: The metrics `count_inbox_panel`,`count_spam_panel`, `count_inbox_seed`, `count_spam_seed`,`count_inbox_seed_private`,`count_spam_seed_private`, @@ -420,8 +425,11 @@ aggregate data, which can be used as "group by" qualifiers. + `count_delayed` + `count_delayed_first` + `count_rendered` + + `count_nonprefetched_rendered` + `count_unique_rendered` + + `count_nonprefetched_unique_rendered` + `count_unique_confirmed_opened` + + `count_nonprefetched_unique_confirmed_opened` + `count_clicked` + `count_unique_clicked` + `count_targeted` @@ -527,8 +535,11 @@ Provides aggregate metrics grouped by domain over the time window specified. + `count_delayed` + `count_delayed_first` + `count_rendered` + + `count_nonprefetched_rendered` + `count_unique_rendered` + + `count_nonprefetched_unique_rendered` + `count_unique_confirmed_opened` + + `count_nonprefetched_unique_confirmed_opened` + `count_clicked` + `count_unique_clicked` + `count_targeted` @@ -638,8 +649,11 @@ Provides aggregate metrics grouped by sending IP over the time window specified. + `count_delayed` + `count_delayed_first` + `count_rendered` + + `count_nonprefetched_rendered` + `count_unique_rendered` + + `count_nonprefetched_unique_rendered` + `count_unique_confirmed_opened` + + `count_nonprefetched_unique_confirmed_opened` + `count_clicked` + `count_unique_clicked` + `count_targeted` @@ -749,8 +763,11 @@ Provides aggregate metrics grouped by IP pool over the time window specified. + `count_delayed` + `count_delayed_first` + `count_rendered` + + `count_nonprefetched_rendered` + `count_unique_rendered` + + `count_nonprefetched_unique_rendered` + `count_unique_confirmed_opened` + + `count_nonprefetched_unique_confirmed_opened` + `count_clicked` + `count_unique_clicked` + `count_targeted` @@ -858,8 +875,11 @@ Provides aggregate metrics grouped by sending domain over the time window specif + `count_delayed` + `count_delayed_first` + `count_rendered` + + `count_nonprefetched_rendered` + `count_unique_rendered` + + `count_nonprefetched_unique_rendered` + `count_unique_confirmed_opened` + + `count_nonprefetched_unique_confirmed_opened` + `count_clicked` + `count_unique_clicked` + `count_targeted` @@ -980,8 +1000,11 @@ Provides aggregate metrics grouped by subaccount over the time window specified. + `count_delayed` + `count_delayed_first` + `count_rendered` + + `count_nonprefetched_rendered` + `count_unique_rendered` + + `count_nonprefetched_unique_rendered` + `count_unique_confirmed_opened` + + `count_nonprefetched_unique_confirmed_opened` + `count_clicked` + `count_unique_clicked` + `count_targeted` @@ -1102,8 +1125,11 @@ Provides aggregate metrics grouped by campaign over the time window specified. + `count_delayed` + `count_delayed_first` + `count_rendered` + + `count_nonprefetched_rendered` + `count_unique_rendered` + + `count_nonprefetched_unique_rendered` + `count_unique_confirmed_opened` + + `count_nonprefetched_unique_confirmed_opened` + `count_clicked` + `count_unique_clicked` + `count_targeted` @@ -1212,8 +1238,11 @@ Provides aggregate metrics grouped by template over the time window specified. + `count_delayed` + `count_delayed_first` + `count_rendered` + + `count_nonprefetched_rendered` + `count_unique_rendered` + + `count_nonprefetched_unique_rendered` + `count_unique_confirmed_opened` + + `count_nonprefetched_unique_confirmed_opened` + `count_clicked` + `count_unique_clicked` + `count_targeted` @@ -1420,8 +1449,11 @@ in the world. + `count_delayed` + `count_delayed_first` + `count_rendered` + + `count_nonprefetched_rendered` + `count_unique_rendered` + + `count_nonprefetched_unique_rendered` + `count_unique_confirmed_opened` + + `count_nonprefetched_unique_confirmed_opened` + `count_clicked` + `count_unique_clicked` + `count_targeted` @@ -1527,8 +1559,11 @@ Provides aggregate metrics grouped by mailbox provider over the time window spec + `count_delayed` + `count_delayed_first` + `count_rendered` + + `count_nonprefetched_rendered` + `count_unique_rendered` + + `count_nonprefetched_unique_rendered` + `count_unique_confirmed_opened` + + `count_nonprefetched_unique_confirmed_opened` + `count_clicked` + `count_unique_clicked` + `count_targeted` @@ -1656,8 +1691,11 @@ Provides aggregate metrics grouped by mailbox provider region over the time wind + `count_delayed` + `count_delayed_first` + `count_rendered` + + `count_nonprefetched_rendered` + `count_unique_rendered` + + `count_nonprefetched_unique_rendered` + `count_unique_confirmed_opened` + + `count_nonprefetched_unique_confirmed_opened` + `count_clicked` + `count_unique_clicked` + `count_targeted` @@ -1776,6 +1814,8 @@ Provides aggregate metrics ordered by a precision of time. + `count_generation_rejection` + `count_generation_failed` + `count_inband_bounce` + + `count_initial_rendered` + + `count_nonprefetched_initial_rendered` + `count_outofband_bounce` + `count_soft_bounce` + `count_hard_bounce` @@ -1785,8 +1825,13 @@ Provides aggregate metrics ordered by a precision of time. + `count_delayed` + `count_delayed_first` + `count_rendered` + + `count_nonprefetched_rendered` + `count_unique_rendered` + + `count_nonprefetched_unique_rendered` + `count_unique_confirmed_opened` + + `count_nonprefetched_unique_confirmed_opened` + + `count_unique_initial_rendered` + + `count_nonprefetched_unique_initial_rendered` + `count_clicked` + `count_unique_clicked` + `count_targeted` @@ -1833,11 +1878,13 @@ Provides aggregate metrics ordered by a precision of time. "count_hard_bounce": 4296, "count_inband_bounce": 21777, "count_initial_rendered": 139690, + "count_nonprefetched_initial_rendered": 77213, "count_injected": 246682, "count_outofband_bounce": 2399, "count_policy_rejection": 1072, "count_rejected": 2316, "count_rendered": 128385, + "count_nonprefetched_rendered": 64192, "count_sent": 241693, "count_soft_bounce": 1961, "count_spam_complaint": 3, @@ -1846,7 +1893,9 @@ Provides aggregate metrics ordered by a precision of time. "count_unique_clicked": 9123, "count_unique_confirmed_opened": 81140, "count_unique_initial_rendered": 81140, + "count_nonprefetched_unique_initial_rendered": 40970, "count_unique_rendered": 69643, + "count_nonprefetched_unique_rendered": 33512, "count_unsubscribe": 1, "total_delivery_time_first": 90854824, "total_delivery_time_subsequent": 1008767467, @@ -1869,11 +1918,13 @@ Provides aggregate metrics ordered by a precision of time. "count_hard_bounce": 2817, "count_inband_bounce": 14501, "count_initial_rendered": 92769, + "count_nonprefetched_initial_rendered": 45612, "count_injected": 163372, "count_outofband_bounce": 1619, "count_policy_rejection": 728, "count_rejected": 1549, "count_rendered": 85483, + "count_nonprefetched_rendered": 42741, "count_sent": 160118, "count_soft_bounce": 1357, "count_spam_complaint": 2, @@ -1882,7 +1933,9 @@ Provides aggregate metrics ordered by a precision of time. "count_unique_clicked": 5999, "count_unique_confirmed_opened": 55592, "count_unique_initial_rendered": 55592, + "count_nonprefetched_unique_initial_rendered": 26913, "count_unique_rendered": 48206, + "count_nonprefetched_unique_rendered": 25712, "count_unsubscribe": 3, "total_delivery_time_first": 60928506, "total_delivery_time_subsequent": 665233402, diff --git a/package-lock.json b/package-lock.json index 9ebc8982..4a8701eb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -4193,6 +4193,7 @@ "version": "2.28.0", "resolved": "https://registry.npmjs.org/algoliasearch-helper/-/algoliasearch-helper-2.28.0.tgz", "integrity": "sha512-ZWczpkns2tw9sAtFL+1Cn3XAGkaunYS+ckldBrHHHQZj1/vw9n8SOGUO7lwpjuKXG9+TWgzx6XP3ZsG3iM+6hw==", + "deprecated": "3.7.3", "dependencies": { "events": "^1.1.1", "lodash": "^4.17.5", @@ -5022,6 +5023,7 @@ "version": "1.1.0", "resolved": "https://registry.npmjs.org/async-cache/-/async-cache-1.1.0.tgz", "integrity": "sha1-SppaidBl7F2OUlS9nulrp2xTK1o=", + "deprecated": "No longer maintained. Use [lru-cache](http://npm.im/lru-cache) version 7.6 or higher, and provide an asynchronous `fetchMethod` option.", "dependencies": { "lru-cache": "^4.0.0" } @@ -7572,7 +7574,7 @@ "version": "2.6.9", "resolved": "https://registry.npmjs.org/core-js/-/core-js-2.6.9.tgz", "integrity": "sha512-HOpZf6eXmnl7la+cUdMnLvUxKNqLUzJvgIziQ0DiF3JwSImNphIqdGqzj6hIKyX04MmV0poclQ7+wjWvxQyR2A==", - "deprecated": "core-js@<3.3 is no longer maintained and not recommended for usage due to the number of issues. Because of the V8 engine whims, feature detection in old core-js versions could cause a slowdown up to 100x even if nothing is polyfilled. Please, upgrade your dependencies to the actual version of core-js.", + "deprecated": "core-js@<3.4 is no longer maintained and not recommended for usage due to the number of issues. Because of the V8 engine whims, feature detection in old core-js versions could cause a slowdown up to 100x even if nothing is polyfilled. Please, upgrade your dependencies to the actual version of core-js.", "hasInstallScript": true }, "node_modules/core-js-compat": { @@ -12576,6 +12578,7 @@ "version": "0.9.3", "resolved": "https://registry.npmjs.org/gatsby-recipes/-/gatsby-recipes-0.9.3.tgz", "integrity": "sha512-ToYeGCica4390QFWsW6+3DM6hhkpKifUEFoKDUdsQGw4rmD8aYndj5oASKIsvPAU0GUbxe8IDsDnP3V5iMtyEQ==", + "deprecated": "gatsby-recipes has been removed from gatsby/gatsby-cli >=4.5.0. Update to gatsby@latest/gatsby-cli@latest to use versions without gatsby-recipes. This package will no longer receive updates.", "dependencies": { "@babel/core": "^7.12.3", "@babel/generator": "^7.12.5", @@ -26239,6 +26242,7 @@ "version": "0.5.2", "resolved": "https://registry.npmjs.org/source-map-resolve/-/source-map-resolve-0.5.2.tgz", "integrity": "sha1-cuLMNAlVQ+Q7LGKyxMENSpBU8lk=", + "deprecated": "See https://github.com/lydell/source-map-resolve#deprecated", "dependencies": { "atob": "^2.1.1", "decode-uri-component": "^0.2.0", @@ -26267,7 +26271,8 @@ "node_modules/source-map-url": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/source-map-url/-/source-map-url-0.4.0.tgz", - "integrity": "sha1-PpNdfd1zYxuXZZlW1VEo6HtQhKM=" + "integrity": "sha1-PpNdfd1zYxuXZZlW1VEo6HtQhKM=", + "deprecated": "See https://github.com/lydell/source-map-url#deprecated" }, "node_modules/space-separated-tokens": { "version": "1.1.4", @@ -27019,6 +27024,7 @@ "version": "0.9.19", "resolved": "https://registry.npmjs.org/subscriptions-transport-ws/-/subscriptions-transport-ws-0.9.19.tgz", "integrity": "sha512-dxdemxFFB0ppCLg10FTtRqH/31FNRL1y1BQv8209MK5I4CwALb7iihQg+7p65lFcIl8MHatINWBLOqpgU4Kyyw==", + "deprecated": "The `subscriptions-transport-ws` package is no longer maintained. We recommend you use `graphql-ws` instead. For help migrating Apollo software to `graphql-ws`, see https://www.apollographql.com/docs/apollo-server/data/subscriptions/#switching-from-subscriptions-transport-ws For general help using `graphql-ws`, see https://github.com/enisdenjo/graphql-ws/blob/master/README.md", "dependencies": { "backo2": "^1.0.2", "eventemitter3": "^3.1.0", @@ -28951,7 +28957,7 @@ "version": "2.1.8", "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-2.1.8.tgz", "integrity": "sha512-ZmZUazfOzf0Nve7duiCKD23PFSCs4JPoYyccjUFF3aQkQadqBhfzhjkwBH2mNOG9cTBwhamM37EIsIkZw3nRgg==", - "deprecated": "Chokidar 2 will break on node v14+. Upgrade to chokidar 3 with 15x less dependencies.", + "deprecated": "Chokidar 2 does not receive security updates since 2019. Upgrade to chokidar 3 with 15x fewer dependencies", "optional": true, "dependencies": { "anymatch": "^2.0.0", @@ -29211,7 +29217,7 @@ "version": "2.1.8", "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-2.1.8.tgz", "integrity": "sha512-ZmZUazfOzf0Nve7duiCKD23PFSCs4JPoYyccjUFF3aQkQadqBhfzhjkwBH2mNOG9cTBwhamM37EIsIkZw3nRgg==", - "deprecated": "Chokidar 2 will break on node v14+. Upgrade to chokidar 3 with 15x less dependencies.", + "deprecated": "Chokidar 2 does not receive security updates since 2019. Upgrade to chokidar 3 with 15x fewer dependencies", "dependencies": { "anymatch": "^2.0.0", "async-each": "^1.0.1", From 063e4ae6430125a6dffb61ca2d6ed1500172453e Mon Sep 17 00:00:00 2001 From: Gabriel Soga Date: Thu, 28 Apr 2022 18:49:11 -0300 Subject: [PATCH 2/3] SAA-527 adding nonprefetched hyperlink to blogpost --- content/api/metrics.apib | 80 ++++++++++++++++++++-------------------- 1 file changed, 40 insertions(+), 40 deletions(-) diff --git a/content/api/metrics.apib b/content/api/metrics.apib index 0bb32559..af4e2592 100644 --- a/content/api/metrics.apib +++ b/content/api/metrics.apib @@ -14,46 +14,46 @@ Metrics API data is retained for 6 months. Definitions for terms found in Metrics API -| Term | Definition | -|----------------------------------------------:|-----------------------------------------------------------------------------------------------------| -| `count_targeted` | Messages successfully injected into SparkPost as well as rejected by it | -| `count_injected` | Messages injected to or received by SparkPost | -| `count_sent` | Messages that SparkPost attempted to deliver, which includes both Deliveries and Bounces | -| `count_accepted` | Messages an ISP or other remote domain accepted (less Out-of-Band Bounces) | -| `count_delivered` | Messages delivered | -| `count_delivered_first` | Messages delivered on the first attempt | -| `count_delivered_subsequent` | Messages delivered that required more than one delivery attempt | -| `count_rendered` | Total renderings of a message | -| `count_nonprefetched_rendered` | Total nonprefetched renderings of a message | -| `count_initial_rendered` | Total initial renderings of a message | -| `count_nonprefetched_initial_rendered` | Total initial nonprefetched renderings of a message | -| `count_unique_rendered` | Total number of messages that were rendered at least once | -| `count_nonprefetched_unique_rendered` | Total number of nonprefetched messages that were rendered at least once | -| `count_unique_initial_rendered` | Total number of messages that were initally rendered at least once | -| `count_nonprefetched_unique_initial_rendered` | Total number of nonprefetched messages that were initally rendered at least once | -| `count_unique_confirmed_opened` | Total number of messages that were rendered or had at least one link selected | -| `count_nonprefetched_unique_confirmed_opened` | Total number of nonprefetched messages that were rendered or had at least one link selected | -| `count_clicked` | Total number of times that links were selected across all messages | -| `count_unique_clicked` | Total number of messages which had at least one link selected one or more times | -| `count_bounce` | Total number of bounced messages, which includes both In-Band and Out-of-Band bounces | -| `count_hard_bounce` | Total number of Bounced messages due to hard bounce classification reasons | -| `count_soft_bounce` | Total number of Bounced messages due to soft bounce classification reasons | -| `count_block_bounce` | Total number of Bounced messages due to an IP block | -| `count_admin_bounce` | Total number of Bounced messages due to admin bounce classification reasons, also includes Rejected | -| `count_undetermined_bounce` | Total number of Bounced messages due to undetermined bounce reasons | -| `count_rejected` | Messages rejected due to policy or that failed to generate | -| `count_policy_rejection` | Messages rejected by SparkPost due to policy | -| `count_generation_failed` | Message generation failed for an intended recipient | -| `count_generation_rejection` | Messages rejected by SparkPost due to policy | -| `count_inband_bounce` | Messages that bounced on delivery attempt during the SMTP session | -| `count_outofband_bounce` | Messages that the ISP bounced subsequent to a successful delivery | -| `count_delayed` | Total number of delays due to any temporary failure | -| `count_delayed_first` | Messages delayed on the first delivery attempt | -| `total_msg_volume` | Total size of delivered messages, in bytes (including attachments) | -| `count_spam_complaint` | Number of spam complaints received from an ISP | -| `total_delivery_time_first` | Total time taken to deliver messages on first attempt (milliseconds) | -| `total_delivery_time_subsequent` | Total time taken to delivery messages on subsequent attempts (milliseconds) | -| `count_unsubscribe` | Total number of unsubscribes as a result of clicked links and the ISP list unsubscribe feature | +| Term | Definition | +|----------------------------------------------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `count_targeted` | Messages successfully injected into SparkPost as well as rejected by it | +| `count_injected` | Messages injected to or received by SparkPost | +| `count_sent` | Messages that SparkPost attempted to deliver, which includes both Deliveries and Bounces | +| `count_accepted` | Messages an ISP or other remote domain accepted (less Out-of-Band Bounces) | +| `count_delivered` | Messages delivered | +| `count_delivered_first` | Messages delivered on the first attempt | +| `count_delivered_subsequent` | Messages delivered that required more than one delivery attempt | +| `count_rendered` | Total renderings of a message | +| `count_nonprefetched_rendered` | Total nonprefetched renderings of a message | +| `count_initial_rendered` | Total initial renderings of a message | +| `count_nonprefetched_initial_rendered` | Total initial nonprefetched renderings of a message | +| `count_unique_rendered` | Total number of messages that were rendered at least once | +| `count_nonprefetched_unique_rendered` | Total number of nonprefetched messages that were rendered at least once | +| `count_unique_initial_rendered` | Total number of messages that were initally rendered at least once | +| `count_nonprefetched_unique_initial_rendered` | Total number of nonprefetched messages that were initally rendered at least once | +| `count_unique_confirmed_opened` | Total number of messages that were rendered or had at least one link selected | +| `count_nonprefetched_unique_confirmed_opened` | Total number of nonprefetched messages that were rendered or had at least one link selected | +| `count_clicked` | Total number of times that links were selected across all messages | +| `count_unique_clicked` | Total number of messages which had at least one link selected one or more times | +| `count_bounce` | Total number of bounced messages, which includes both In-Band and Out-of-Band bounces | +| `count_hard_bounce` | Total number of Bounced messages due to hard bounce classification reasons | +| `count_soft_bounce` | Total number of Bounced messages due to soft bounce classification reasons | +| `count_block_bounce` | Total number of Bounced messages due to an IP block | +| `count_admin_bounce` | Total number of Bounced messages due to admin bounce classification reasons, also includes Rejected | +| `count_undetermined_bounce` | Total number of Bounced messages due to undetermined bounce reasons | +| `count_rejected` | Messages rejected due to policy or that failed to generate | +| `count_policy_rejection` | Messages rejected by SparkPost due to policy | +| `count_generation_failed` | Message generation failed for an intended recipient | +| `count_generation_rejection` | Messages rejected by SparkPost due to policy | +| `count_inband_bounce` | Messages that bounced on delivery attempt during the SMTP session | +| `count_outofband_bounce` | Messages that the ISP bounced subsequent to a successful delivery | +| `count_delayed` | Total number of delays due to any temporary failure | +| `count_delayed_first` | Messages delayed on the first delivery attempt | +| `total_msg_volume` | Total size of delivered messages, in bytes (including attachments) | +| `count_spam_complaint` | Number of spam complaints received from an ISP | +| `total_delivery_time_first` | Total time taken to deliver messages on first attempt (milliseconds) | +| `total_delivery_time_subsequent` | Total time taken to delivery messages on subsequent attempts (milliseconds) | +| `count_unsubscribe` | Total number of unsubscribes as a result of clicked links and the ISP list unsubscribe feature | | `count_inbox_panel` | Deliverability Add-On Panel messages delivered to the inbox. | | `count_spam_panel` | Deliverability Add-On Panel messages delivered to the spam folder. | | `count_inbox_seed` | Deliverability Add-On All Seed messages delivered to the inbox. | From 02b727816a649761a36a9c2a42ee689a9645f6b7 Mon Sep 17 00:00:00 2001 From: Gabriel Soga Date: Thu, 28 Apr 2022 19:07:27 -0300 Subject: [PATCH 3/3] SAA-527 adding hyphen to prefetched --- content/api/metrics.apib | 100 +++++++++++++++++++-------------------- 1 file changed, 50 insertions(+), 50 deletions(-) diff --git a/content/api/metrics.apib b/content/api/metrics.apib index af4e2592..e9b1d898 100644 --- a/content/api/metrics.apib +++ b/content/api/metrics.apib @@ -14,56 +14,56 @@ Metrics API data is retained for 6 months. Definitions for terms found in Metrics API -| Term | Definition | -|----------------------------------------------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `count_targeted` | Messages successfully injected into SparkPost as well as rejected by it | -| `count_injected` | Messages injected to or received by SparkPost | -| `count_sent` | Messages that SparkPost attempted to deliver, which includes both Deliveries and Bounces | -| `count_accepted` | Messages an ISP or other remote domain accepted (less Out-of-Band Bounces) | -| `count_delivered` | Messages delivered | -| `count_delivered_first` | Messages delivered on the first attempt | -| `count_delivered_subsequent` | Messages delivered that required more than one delivery attempt | -| `count_rendered` | Total renderings of a message | -| `count_nonprefetched_rendered` | Total nonprefetched renderings of a message | -| `count_initial_rendered` | Total initial renderings of a message | -| `count_nonprefetched_initial_rendered` | Total initial nonprefetched renderings of a message | -| `count_unique_rendered` | Total number of messages that were rendered at least once | -| `count_nonprefetched_unique_rendered` | Total number of nonprefetched messages that were rendered at least once | -| `count_unique_initial_rendered` | Total number of messages that were initally rendered at least once | -| `count_nonprefetched_unique_initial_rendered` | Total number of nonprefetched messages that were initally rendered at least once | -| `count_unique_confirmed_opened` | Total number of messages that were rendered or had at least one link selected | -| `count_nonprefetched_unique_confirmed_opened` | Total number of nonprefetched messages that were rendered or had at least one link selected | -| `count_clicked` | Total number of times that links were selected across all messages | -| `count_unique_clicked` | Total number of messages which had at least one link selected one or more times | -| `count_bounce` | Total number of bounced messages, which includes both In-Band and Out-of-Band bounces | -| `count_hard_bounce` | Total number of Bounced messages due to hard bounce classification reasons | -| `count_soft_bounce` | Total number of Bounced messages due to soft bounce classification reasons | -| `count_block_bounce` | Total number of Bounced messages due to an IP block | -| `count_admin_bounce` | Total number of Bounced messages due to admin bounce classification reasons, also includes Rejected | -| `count_undetermined_bounce` | Total number of Bounced messages due to undetermined bounce reasons | -| `count_rejected` | Messages rejected due to policy or that failed to generate | -| `count_policy_rejection` | Messages rejected by SparkPost due to policy | -| `count_generation_failed` | Message generation failed for an intended recipient | -| `count_generation_rejection` | Messages rejected by SparkPost due to policy | -| `count_inband_bounce` | Messages that bounced on delivery attempt during the SMTP session | -| `count_outofband_bounce` | Messages that the ISP bounced subsequent to a successful delivery | -| `count_delayed` | Total number of delays due to any temporary failure | -| `count_delayed_first` | Messages delayed on the first delivery attempt | -| `total_msg_volume` | Total size of delivered messages, in bytes (including attachments) | -| `count_spam_complaint` | Number of spam complaints received from an ISP | -| `total_delivery_time_first` | Total time taken to deliver messages on first attempt (milliseconds) | -| `total_delivery_time_subsequent` | Total time taken to delivery messages on subsequent attempts (milliseconds) | -| `count_unsubscribe` | Total number of unsubscribes as a result of clicked links and the ISP list unsubscribe feature | -| `count_inbox_panel` | Deliverability Add-On Panel messages delivered to the inbox. | -| `count_spam_panel` | Deliverability Add-On Panel messages delivered to the spam folder. | -| `count_inbox_seed` | Deliverability Add-On All Seed messages delivered to the inbox. | -| `count_spam_seed` | Deliverability Add-On All Seed messages delivered to the spam folder. -| `count_inbox_seed_private` | Deliverability Add-On Private Seed messages delivered to the inbox. | -| `count_spam_seed_private` | Deliverability Add-On Private Seed messages delivered to the spam folder. -| `count_inbox_seed_virtual` | Deliverability Add-On Virtual Seed messages delivered to the inbox. | -| `count_spam_seed_virtual` | Deliverability Add-On Virtual Seed messages delivered to the spam folder. -| `count_moved_to_inbox` | Deliverability Add-On Panel messages delivered to the spam folder then moved to the inbox. | -| `count_moved_to_spam` | Deliverability Add-On Panel messages delivered to the inbox then moved to the spam folder. | +| Term | Definition | +|----------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `count_targeted` | Messages successfully injected into SparkPost as well as rejected by it | +| `count_injected` | Messages injected to or received by SparkPost | +| `count_sent` | Messages that SparkPost attempted to deliver, which includes both Deliveries and Bounces | +| `count_accepted` | Messages an ISP or other remote domain accepted (less Out-of-Band Bounces) | +| `count_delivered` | Messages delivered | +| `count_delivered_first` | Messages delivered on the first attempt | +| `count_delivered_subsequent` | Messages delivered that required more than one delivery attempt | +| `count_rendered` | Total renderings of a message | +| `count_nonprefetched_rendered` | Total non-prefetched renderings of a message | +| `count_initial_rendered` | Total initial renderings of a message | +| `count_nonprefetched_initial_rendered` | Total initial non-prefetched renderings of a message | +| `count_unique_rendered` | Total number of messages that were rendered at least once | +| `count_nonprefetched_unique_rendered` | Total number of non-prefetched messages that were rendered at least once | +| `count_unique_initial_rendered` | Total number of messages that were initally rendered at least once | +| `count_nonprefetched_unique_initial_rendered` | Total number of non-prefetched messages that were initally rendered at least once | +| `count_unique_confirmed_opened` | Total number of messages that were rendered or had at least one link selected | +| `count_nonprefetched_unique_confirmed_opened` | Total number of non-prefetched messages that were rendered or had at least one link selected | +| `count_clicked` | Total number of times that links were selected across all messages | +| `count_unique_clicked` | Total number of messages which had at least one link selected one or more times | +| `count_bounce` | Total number of bounced messages, which includes both In-Band and Out-of-Band bounces | +| `count_hard_bounce` | Total number of Bounced messages due to hard bounce classification reasons | +| `count_soft_bounce` | Total number of Bounced messages due to soft bounce classification reasons | +| `count_block_bounce` | Total number of Bounced messages due to an IP block | +| `count_admin_bounce` | Total number of Bounced messages due to admin bounce classification reasons, also includes Rejected | +| `count_undetermined_bounce` | Total number of Bounced messages due to undetermined bounce reasons | +| `count_rejected` | Messages rejected due to policy or that failed to generate | +| `count_policy_rejection` | Messages rejected by SparkPost due to policy | +| `count_generation_failed` | Message generation failed for an intended recipient | +| `count_generation_rejection` | Messages rejected by SparkPost due to policy | +| `count_inband_bounce` | Messages that bounced on delivery attempt during the SMTP session | +| `count_outofband_bounce` | Messages that the ISP bounced subsequent to a successful delivery | +| `count_delayed` | Total number of delays due to any temporary failure | +| `count_delayed_first` | Messages delayed on the first delivery attempt | +| `total_msg_volume` | Total size of delivered messages, in bytes (including attachments) | +| `count_spam_complaint` | Number of spam complaints received from an ISP | +| `total_delivery_time_first` | Total time taken to deliver messages on first attempt (milliseconds) | +| `total_delivery_time_subsequent` | Total time taken to delivery messages on subsequent attempts (milliseconds) | +| `count_unsubscribe` | Total number of unsubscribes as a result of clicked links and the ISP list unsubscribe feature | +| `count_inbox_panel` | Deliverability Add-On Panel messages delivered to the inbox. | +| `count_spam_panel` | Deliverability Add-On Panel messages delivered to the spam folder. | +| `count_inbox_seed` | Deliverability Add-On All Seed messages delivered to the inbox. | +| `count_spam_seed` | Deliverability Add-On All Seed messages delivered to the spam folder. | +| `count_inbox_seed_private` | Deliverability Add-On Private Seed messages delivered to the inbox. | +| `count_spam_seed_private` | Deliverability Add-On Private Seed messages delivered to the spam folder. | +| `count_inbox_seed_virtual` | Deliverability Add-On Virtual Seed messages delivered to the inbox. | +| `count_spam_seed_virtual` | Deliverability Add-On Virtual Seed messages delivered to the spam folder. | +| `count_moved_to_inbox` | Deliverability Add-On Panel messages delivered to the spam folder then moved to the inbox. | +| `count_moved_to_spam` | Deliverability Add-On Panel messages delivered to the inbox then moved to the spam folder. | Note: The metrics `count_inbox_panel`,`count_spam_panel`, `count_inbox_seed`, `count_spam_seed`,`count_inbox_seed_private`,`count_spam_seed_private`,