@pushwoosh/rpc-gateway-statistics-api 1.3.844 → 1.3.846

package/data.js

@@ -3795,6 +3795,18 @@ export const data = {
                 "method": "post",
                 "path": "/api/v2/statistics/overview/getEmailActivityDistribution"
             },
+            "GetEmailBaseChange": {
+                "request": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailBaseChangeRequest",
+                "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailBaseChangeResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/overview/getEmailBaseChange"
+            },
+            "GetEmailPerformance": {
+                "request": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailPerformanceRequest",
+                "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailPerformanceResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/overview/getEmailPerformance"
+            },
             "GetRetentionCurve": {
                 "request": "pushwoosh.statistics.statistics.v2.overviewkpi.GetRetentionCurveRequest",
                 "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetRetentionCurveResponse",
@@ -4183,6 +4195,94 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailBaseChangeRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "dayFrom": {
+                "type": "Date"
+            },
+            "dayTo": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailBaseChangeResponse": {
+        "type": "I",
+        "fields": {
+            "baseStartDay": {
+                "type": "Date"
+            },
+            "baseStart": {
+                "type": "number"
+            },
+            "baseEndDay": {
+                "type": "Date"
+            },
+            "baseEnd": {
+                "type": "number"
+            },
+            "unsubscribed": {
+                "type": "number"
+            },
+            "complainedOrBounced": {
+                "type": "number"
+            },
+            "newSubscribers": {
+                "type": "number"
+            },
+            "otherChanges": {
+                "type": "number"
+            },
+            "baseAvailable": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailPerformanceRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "dayFrom": {
+                "type": "Date"
+            },
+            "dayTo": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.EmailPerformanceCounts": {
+        "type": "I",
+        "fields": {
+            "sends": {
+                "type": "number"
+            },
+            "deliveries": {
+                "type": "number"
+            },
+            "opens": {
+                "type": "number"
+            },
+            "clicks": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailPerformanceResponse": {
+        "type": "I",
+        "fields": {
+            "bySends": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailPerformanceCounts"
+            },
+            "byUsers": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailPerformanceCounts"
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v2.overviewkpi.GetRetentionCurveRequest": {
         "type": "I",
         "fields": {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pushwoosh/rpc-gateway-statistics-api",
-    "version": "1.3.844",
+    "version": "1.3.846",
     "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,8 @@ export type OverviewKPIService_GetActiveTrend = RpcMethod<GetActiveTrendRequest,
 export type OverviewKPIService_GetChannelUsersTrend = RpcMethod<GetChannelUsersTrendRequest, GetChannelUsersTrendResponse>;
 export type OverviewKPIService_GetEmailRates = RpcMethod<GetEmailRatesRequest, GetEmailRatesResponse>;
 export type OverviewKPIService_GetEmailActivityDistribution = RpcMethod<GetEmailActivityDistributionRequest, GetEmailActivityDistributionResponse>;
+export type OverviewKPIService_GetEmailBaseChange = RpcMethod<GetEmailBaseChangeRequest, GetEmailBaseChangeResponse>;
+export type OverviewKPIService_GetEmailPerformance = RpcMethod<GetEmailPerformanceRequest, GetEmailPerformanceResponse>;
 export type OverviewKPIService_GetRetentionCurve = RpcMethod<GetRetentionCurveRequest, GetRetentionCurveResponse>;
 export type OverviewKPIService_GetBaseChange = RpcMethod<GetBaseChangeRequest, GetBaseChangeResponse>;
 export type OverviewKPIService_GetUserMessageMetrics = RpcMethod<GetUserMessageMetricsRequest, GetUserMessageMetricsResponse>;
@@ -31,6 +33,10 @@ export interface OverviewKPIService {
     GetEmailRates: OverviewKPIService_GetEmailRates;
     /** 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. */
+    GetEmailBaseChange: OverviewKPIService_GetEmailBaseChange;
+    /** GetEmailPerformance returns the sends, deliveries, opens and clicks of the period. */
+    GetEmailPerformance: OverviewKPIService_GetEmailPerformance;
     /** GetRetentionCurve returns the D1/D7/D30 curve of one cohort. */
     GetRetentionCurve: OverviewKPIService_GetRetentionCurve;
     /** GetBaseChange returns how the push device base moved over a period. */
@@ -242,6 +248,55 @@ export type GetEmailActivityDistributionResponse = {
     openedNotClickedPercent: number;
     dormantPercent: number;
 };
+export type GetEmailBaseChangeRequest = {
+    applicationCode: string;
+    dayFrom: Date;
+    dayTo: Date;
+};
+export type GetEmailBaseChangeResponse = {
+    /**
+     * both ends are measured snapshots of the days named beside them, and the
+     * days are the first and the last the writer filled inside the period
+     */
+    baseStartDay: Date;
+    baseStart: number;
+    baseEndDay: Date;
+    baseEnd: number;
+    /**
+     * The flows below cover the days between the two ends, not the whole request.
+     * Unsubscribing leaves the address in place, so this one is never subtracted.
+     */
+    unsubscribed: number;
+    /** one count over both event types, not two counts added up */
+    complainedOrBounced: number;
+    newSubscribers: number;
+    /**
+     * what the two ends moved by beyond the flows above; negative as often as
+     * positive, so it is signed
+     */
+    otherChanges: number;
+    /** false when the period holds no snapshot day at all */
+    baseAvailable: boolean;
+};
+export type GetEmailPerformanceRequest = {
+    applicationCode: string;
+    dayFrom: Date;
+    dayTo: Date;
+};
+/** EmailPerformanceCounts is one counting unit of the four numbers the tiles divide. */
+export type EmailPerformanceCounts = {
+    sends: number;
+    deliveries: number;
+    /** Apple MPP prefetches are left out where the log marks them */
+    opens: number;
+    /** clicks on our own unsubscribe link belong to the unsubscribe event, not here */
+    clicks: number;
+};
+export type GetEmailPerformanceResponse = {
+    /** every email of the application, whatever composed it */
+    bySends: EmailPerformanceCounts;
+    byUsers: EmailPerformanceCounts;
+};
 export type GetRetentionCurveRequest = {
     applicationCode: string;
     /** day the cohort registered on */