@pushwoosh/rpc-gateway-statistics-api 1.3.885 → 1.3.887

package/data.js

@@ -4100,6 +4100,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/v2/statistics/overview/getEmailRates"
             },
+            "GetEmailPostmasterOverview": {
+                "request": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailPostmasterOverviewRequest",
+                "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailPostmasterOverviewResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/overview/getEmailPostmasterOverview"
+            },
             "GetEmailActivityDistribution": {
                 "request": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailActivityDistributionRequest",
                 "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailActivityDistributionResponse",
@@ -5063,6 +5069,106 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailPostmasterOverviewRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "dayFrom": {
+                "type": "Date"
+            },
+            "dayTo": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.EmailPostmasterErrorCode": {
+        "type": "E",
+        "values": [
+            "EMAIL_POSTMASTER_ERROR_CODE_UNKNOWN",
+            "EMAIL_POSTMASTER_ERROR_CODE_BAD_ATTACHMENT",
+            "EMAIL_POSTMASTER_ERROR_CODE_BAD_OR_MISSING_PTR_RECORD",
+            "EMAIL_POSTMASTER_ERROR_CODE_IP_IN_RBLS",
+            "EMAIL_POSTMASTER_ERROR_CODE_LOW_DOMAIN_REPUTATION",
+            "EMAIL_POSTMASTER_ERROR_CODE_LOW_IP_REPUTATION",
+            "EMAIL_POSTMASTER_ERROR_CODE_SPAMMY_CONTENT",
+            "EMAIL_POSTMASTER_ERROR_CODE_STAMP_POLICY_ERROR",
+            "EMAIL_POSTMASTER_ERROR_CODE_ANOMALOUS_TRAFFIC_PATTERN",
+            "EMAIL_POSTMASTER_ERROR_CODE_OTHER"
+        ]
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.EmailPostmasterErrorReason": {
+        "type": "I",
+        "fields": {
+            "errorType": {
+                "type": "string"
+            },
+            "errorReason": {
+                "type": "string"
+            },
+            "rate": {
+                "type": "number"
+            },
+            "code": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailPostmasterErrorCode"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.EmailPostmasterDomain.Day": {
+        "type": "I",
+        "fields": {
+            "day": {
+                "type": "Date"
+            },
+            "spamRate": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.EmailPostmasterDomain": {
+        "type": "I",
+        "fields": {
+            "domain": {
+                "type": "string"
+            },
+            "hasData": {
+                "type": "boolean"
+            },
+            "spamRate": {
+                "type": "number"
+            },
+            "hasPrevious": {
+                "type": "boolean"
+            },
+            "previousSpamRate": {
+                "type": "number"
+            },
+            "days": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailPostmasterDomain.Day",
+                "array": true
+            },
+            "deliveryErrorRate": {
+                "type": "number"
+            },
+            "errorReasons": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailPostmasterErrorReason",
+                "array": true
+            },
+            "lastDay": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailPostmasterOverviewResponse": {
+        "type": "I",
+        "fields": {
+            "domains": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailPostmasterDomain",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v2.statistics.StatisticsService": {
         "type": "S",
         "key": "statisticsV2",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pushwoosh/rpc-gateway-statistics-api",
-    "version": "1.3.885",
+    "version": "1.3.887",
     "description": "Statistics API gateway HTTP API Types and Data",
     "main": "index.js",
     "module": "index.js",

package/pushwoosh_statistics_statistics_v2_overviewkpi.d.ts

@@ -6,6 +6,7 @@ export type OverviewKPIService_GetChannelReach = RpcMethod<GetChannelReachReques
 export type OverviewKPIService_GetActiveTrend = RpcMethod<GetActiveTrendRequest, GetActiveTrendResponse>;
 export type OverviewKPIService_GetChannelUsersTrend = RpcMethod<GetChannelUsersTrendRequest, GetChannelUsersTrendResponse>;
 export type OverviewKPIService_GetEmailRates = RpcMethod<GetEmailRatesRequest, GetEmailRatesResponse>;
+export type OverviewKPIService_GetEmailPostmasterOverview = RpcMethod<GetEmailPostmasterOverviewRequest, GetEmailPostmasterOverviewResponse>;
 export type OverviewKPIService_GetEmailActivityDistribution = RpcMethod<GetEmailActivityDistributionRequest, GetEmailActivityDistributionResponse>;
 export type OverviewKPIService_GetEmailBaseChange = RpcMethod<GetEmailBaseChangeRequest, GetEmailBaseChangeResponse>;
 export type OverviewKPIService_GetEmailPerformance = RpcMethod<GetEmailPerformanceRequest, GetEmailPerformanceResponse>;
@@ -40,6 +41,11 @@ export interface OverviewKPIService {
      * sending pause counts them, plus the account-wide check that pause runs on.
      */
     GetEmailRates: OverviewKPIService_GetEmailRates;
+    /**
+     * GetEmailPostmasterOverview returns Gmail Postmaster stats of the account's sender domains
+     * connected and verified in Settings → Email Configuration: the whole domain's mail, not only Pushwoosh's.
+     */
+    GetEmailPostmasterOverview: OverviewKPIService_GetEmailPostmasterOverview;
     /** GetEmailActivityDistribution splits the email base into clicked, opened and dormant users. */
     GetEmailActivityDistribution: OverviewKPIService_GetEmailActivityDistribution;
     /** GetEmailBaseChange returns how the email user base moved over a period. */
@@ -563,3 +569,47 @@ export type GetUserMessageMetricsResponse = {
      */
     days: GetUserMessageMetricsResponse_Day[];
 };
+export type GetEmailPostmasterOverviewRequest = {
+    applicationCode: string;
+    dayFrom: Date;
+    dayTo: Date;
+};
+/** Gmail Postmaster delivery error reasons known to this API; anything Gmail adds later is UNKNOWN. */
+export type EmailPostmasterErrorCode = 'EMAIL_POSTMASTER_ERROR_CODE_UNKNOWN' | 'EMAIL_POSTMASTER_ERROR_CODE_BAD_ATTACHMENT' | 'EMAIL_POSTMASTER_ERROR_CODE_BAD_OR_MISSING_PTR_RECORD' | 'EMAIL_POSTMASTER_ERROR_CODE_IP_IN_RBLS' | 'EMAIL_POSTMASTER_ERROR_CODE_LOW_DOMAIN_REPUTATION' | 'EMAIL_POSTMASTER_ERROR_CODE_LOW_IP_REPUTATION' | 'EMAIL_POSTMASTER_ERROR_CODE_SPAMMY_CONTENT' | 'EMAIL_POSTMASTER_ERROR_CODE_STAMP_POLICY_ERROR' | 'EMAIL_POSTMASTER_ERROR_CODE_ANOMALOUS_TRAFFIC_PATTERN' | 'EMAIL_POSTMASTER_ERROR_CODE_OTHER';
+/** EmailPostmasterErrorReason is the average daily share of mail Gmail refused for one reason. */
+export type EmailPostmasterErrorReason = {
+    /** reject or temp_fail, as Gmail reports it. */
+    errorType: string;
+    /** Raw Gmail reason, for display of a reason the code does not know yet; branch on code. */
+    errorReason: string;
+    rate: number;
+    /** Stable code of error_reason. */
+    code: EmailPostmasterErrorCode;
+};
+export type EmailPostmasterDomain_Day = {
+    day: Date;
+    spamRate: number;
+};
+/**
+ * EmailPostmasterDomain is one verified sender domain. Rates are fractions averaged over the days
+ * Gmail reported, since Postmaster gives no volumes to weight them by; a day without data is absent.
+ */
+export type EmailPostmasterDomain = {
+    domain: string;
+    /** False when Gmail reported nothing in the period, e.g. too little mail to Gmail. */
+    hasData: boolean;
+    spamRate: number;
+    /** The same average over the period of equal length right before; has_previous is false without data. */
+    hasPrevious: boolean;
+    previousSpamRate: number;
+    days: EmailPostmasterDomain_Day[];
+    deliveryErrorRate: number;
+    /** Largest first; reasons Gmail reported as zero are left out. */
+    errorReasons: EmailPostmasterErrorReason[];
+    /** Last day Gmail has published; Gmail publishes a day about three days late. */
+    lastDay: Date;
+};
+export type GetEmailPostmasterOverviewResponse = {
+    /** Sorted by name; empty when no domain of the account is verified in Gmail Postmaster. */
+    domains: EmailPostmasterDomain[];
+};