@pushwoosh/rpc-gateway-statistics-api 1.3.753 → 1.3.755

package/data.js

@@ -201,6 +201,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/v2/statistics/audience/getSubscribersDailyStatistics"
             },
+            "GetEmailActivityDistributionCP": {
+                "request": "pushwoosh.statistics.statistics.v1.GetEmailActivityDistributionCPRequest",
+                "response": "pushwoosh.statistics.statistics.v1.GetEmailActivityDistributionCPResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/audience/getEmailActivityDistribution"
+            },
             "GetRetentionTotalStatisticsCP": {
                 "request": "pushwoosh.statistics.statistics.v1.GetRetentionTotalStatisticsCPRequest",
                 "response": "pushwoosh.statistics.statistics.v1.GetRetentionTotalStatisticsCPResponse",
@@ -886,6 +892,9 @@ export const data = {
             },
             "complaints": {
                 "type": "number"
+            },
+            "unsubs": {
+                "type": "number"
             }
         }
     },
@@ -1161,6 +1170,46 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v1.GetEmailActivityDistributionCPRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "timestampFrom": {
+                "type": "string"
+            },
+            "timestampTo": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.GetEmailActivityDistributionCPResponse": {
+        "type": "I",
+        "fields": {
+            "base": {
+                "type": "number"
+            },
+            "clicked": {
+                "type": "number"
+            },
+            "openedNotClicked": {
+                "type": "number"
+            },
+            "dormant": {
+                "type": "number"
+            },
+            "machineOnlyOpeners": {
+                "type": "number"
+            },
+            "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.753",
+    "version": "1.3.755",
     "description": "Statistics API gateway HTTP API Types and Data",
     "main": "index.js",
     "module": "index.js",

package/pushwoosh_statistics_statistics_v1.d.ts

@@ -21,6 +21,7 @@ export type StatisticsService_GetEmailClicksTotalStatisticsCP = RpcMethod<GetEma
 export type StatisticsService_GetAverageCTRTotalStatisticsCP = RpcMethod<GetAverageCTRTotalStatisticsCPRequest, GetAverageCTRTotalStatisticsCPResponse>;
 export type StatisticsService_GetSubscribersTotalStatisticsCP = RpcMethod<GetSubscribersTotalStatisticsCPRequest, GetSubscribersTotalStatisticsCPResponse>;
 export type StatisticsService_GetSubscribersDailyStatisticsCP = RpcMethod<GetSubscribersDailyStatisticsCPRequest, GetSubscribersDailyStatisticsCPResponse>;
+export type StatisticsService_GetEmailActivityDistributionCP = RpcMethod<GetEmailActivityDistributionCPRequest, GetEmailActivityDistributionCPResponse>;
 export type StatisticsService_GetRetentionTotalStatisticsCP = RpcMethod<GetRetentionTotalStatisticsCPRequest, GetRetentionTotalStatisticsCPResponse>;
 export type StatisticsService_GetEngagementTotalStatisticsCP = RpcMethod<GetEngagementTotalStatisticsCPRequest, GetEngagementTotalStatisticsCPResponse>;
 export type StatisticsService_GetActiveUsersTotalStatisticsCP = RpcMethod<GetActiveUsersTotalStatisticsCPRequest, GetActiveUsersTotalStatisticsCPResponse>;
@@ -67,6 +68,8 @@ export interface StatisticsService {
     GetSubscribersTotalStatisticsCP: StatisticsService_GetSubscribersTotalStatisticsCP;
     /** GetSubscribersDailyStatisticsCP returns daily subscribers by platform over the requested period for control panel */
     GetSubscribersDailyStatisticsCP: StatisticsService_GetSubscribersDailyStatisticsCP;
+    /** GetEmailActivityDistributionCP splits the email subscribers base by what they did in the period */
+    GetEmailActivityDistributionCP: StatisticsService_GetEmailActivityDistributionCP;
     /** GetRetentionTotalStatisticsCP returns user retention statistics */
     GetRetentionTotalStatisticsCP: StatisticsService_GetRetentionTotalStatisticsCP;
     /** GetEngagementTotalStatisticsCP returns user engagement metrics */
@@ -346,6 +349,7 @@ export type ShortMessageMetric = {
     hardBounces: number;
     softBounces: number;
     complaints: number;
+    unsubs: number;
 };
 export type ShortMessageMetricWithTimestampPlatformID = {
     timestamp: string;
@@ -444,6 +448,26 @@ export type SubscribersDailyCountWithTimestampPlatformID = {
 export type GetSubscribersDailyStatisticsCPResponse = {
     rows: SubscribersDailyCountWithTimestampPlatformID[];
 };
+export type GetEmailActivityDistributionCPRequest = {
+    applicationCode: string;
+    timestampFrom: string;
+    timestampTo: string;
+};
+/**
+ * The three buckets partition the base: dormant is what is left of it, so the shares
+ * always add up to 100%.
+ */
+export type GetEmailActivityDistributionCPResponse = {
+    base: number;
+    clicked: number;
+    openedNotClicked: number;
+    dormant: number;
+    /** Addresses whose only opens were machine ones (Apple MPP), counted as dormant. */
+    machineOnlyOpeners: number;
+    /** The window actually read, clamped to the event log retention. */
+    windowFrom: string;
+    windowTo: string;
+};
 export type GetRetentionTotalStatisticsCPRequest = {
     applicationCode: string;
     timestampFrom: string;