@pushwoosh/rpc-gateway-statistics-api 1.3.806 → 1.3.808

package/data.js

@@ -225,6 +225,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/v2/statistics/audience/getEmailUnsubscribeByFrequency"
             },
+            "GetEmailProviderStatisticsCP": {
+                "request": "pushwoosh.statistics.statistics.v1.GetEmailProviderStatisticsCPRequest",
+                "response": "pushwoosh.statistics.statistics.v1.GetEmailProviderStatisticsCPResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/audience/getEmailProviderStatistics"
+            },
             "GetRetentionTotalStatisticsCP": {
                 "request": "pushwoosh.statistics.statistics.v1.GetRetentionTotalStatisticsCPRequest",
                 "response": "pushwoosh.statistics.statistics.v1.GetRetentionTotalStatisticsCPResponse",
@@ -1397,6 +1403,64 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v1.GetEmailProviderStatisticsCPRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "timestampFrom": {
+                "type": "string"
+            },
+            "timestampTo": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.EmailProviderStatistics": {
+        "type": "I",
+        "fields": {
+            "provider": {
+                "type": "string"
+            },
+            "sends": {
+                "type": "number"
+            },
+            "deliveries": {
+                "type": "number"
+            },
+            "opens": {
+                "type": "number"
+            },
+            "hardBounces": {
+                "type": "number"
+            },
+            "softBounces": {
+                "type": "number"
+            },
+            "complaints": {
+                "type": "number"
+            },
+            "unsubscribes": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.GetEmailProviderStatisticsCPResponse": {
+        "type": "I",
+        "fields": {
+            "rows": {
+                "type": "pushwoosh.statistics.statistics.v1.EmailProviderStatistics",
+                "array": true
+            },
+            "windowFrom": {
+                "type": "string"
+            },
+            "windowTo": {
+                "type": "string"
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v1.GetRetentionTotalStatisticsCPRequest": {
         "type": "I",
         "fields": {

package/package.json

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

package/pushwoosh_statistics_statistics_v1.d.ts

@@ -25,6 +25,7 @@ export type StatisticsService_GetEmailActivityDistributionCP = RpcMethod<GetEmai
 export type StatisticsService_GetEmailEventTriggeredPerformanceCP = RpcMethod<GetEmailEventTriggeredPerformanceCPRequest, GetEmailEventTriggeredPerformanceCPResponse>;
 export type StatisticsService_GetEmailFrequencyCappingCP = RpcMethod<GetEmailFrequencyCappingCPRequest, GetEmailFrequencyCappingCPResponse>;
 export type StatisticsService_GetEmailUnsubscribeByFrequencyCP = RpcMethod<GetEmailUnsubscribeByFrequencyCPRequest, GetEmailUnsubscribeByFrequencyCPResponse>;
+export type StatisticsService_GetEmailProviderStatisticsCP = RpcMethod<GetEmailProviderStatisticsCPRequest, GetEmailProviderStatisticsCPResponse>;
 export type StatisticsService_GetRetentionTotalStatisticsCP = RpcMethod<GetRetentionTotalStatisticsCPRequest, GetRetentionTotalStatisticsCPResponse>;
 export type StatisticsService_GetEngagementTotalStatisticsCP = RpcMethod<GetEngagementTotalStatisticsCPRequest, GetEngagementTotalStatisticsCPResponse>;
 export type StatisticsService_GetActiveUsersTotalStatisticsCP = RpcMethod<GetActiveUsersTotalStatisticsCPRequest, GetActiveUsersTotalStatisticsCPResponse>;
@@ -80,6 +81,8 @@ export interface StatisticsService {
     GetEmailFrequencyCappingCP: StatisticsService_GetEmailFrequencyCappingCP;
     /** GetEmailUnsubscribeByFrequencyCP returns the unsubscribe rate by how many letters an address got */
     GetEmailUnsubscribeByFrequencyCP: StatisticsService_GetEmailUnsubscribeByFrequencyCP;
+    /** GetEmailProviderStatisticsCP breaks email delivery of the period down by the recipients' mailbox provider */
+    GetEmailProviderStatisticsCP: StatisticsService_GetEmailProviderStatisticsCP;
     /** GetRetentionTotalStatisticsCP returns user retention statistics */
     GetRetentionTotalStatisticsCP: StatisticsService_GetRetentionTotalStatisticsCP;
     /** GetEngagementTotalStatisticsCP returns user engagement metrics */
@@ -561,6 +564,33 @@ export type GetEmailUnsubscribeByFrequencyCPResponse = {
     windowFrom: string;
     windowTo: string;
 };
+export type GetEmailProviderStatisticsCPRequest = {
+    applicationCode: string;
+    timestampFrom: string;
+    timestampTo: string;
+};
+/**
+ * One mailbox provider of the recipients: gmail, outlook, yahoo, apple, yandex, mailru, or
+ * other for every domain the taxonomy does not name. Counts are events, except opens, which
+ * count each (recipient, message) once so a re-read letter cannot push opens past deliveries.
+ */
+export type EmailProviderStatistics = {
+    provider: string;
+    sends: number;
+    deliveries: number;
+    opens: number;
+    hardBounces: number;
+    softBounces: number;
+    complaints: number;
+    unsubscribes: number;
+};
+export type GetEmailProviderStatisticsCPResponse = {
+    /** Providers with at least one event in the window, most sends first. */
+    rows: EmailProviderStatistics[];
+    /** The window actually read, clamped to the email event log retention. */
+    windowFrom: string;
+    windowTo: string;
+};
 export type GetRetentionTotalStatisticsCPRequest = {
     applicationCode: string;
     timestampFrom: string;