@pushwoosh/rpc-gateway-statistics-api 1.3.845 → 1.3.847

package/data.js

@@ -3801,6 +3801,18 @@ export const data = {
                 "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"
+            },
+            "GetEmailCategoryStats": {
+                "request": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailCategoryStatsRequest",
+                "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailCategoryStatsResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/overview/getEmailCategoryStats"
+            },
             "GetRetentionCurve": {
                 "request": "pushwoosh.statistics.statistics.v2.overviewkpi.GetRetentionCurveRequest",
                 "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetRetentionCurveResponse",
@@ -4235,6 +4247,100 @@ export const data = {
             }
         }
     },
+    "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.GetEmailCategoryStatsRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "dayFrom": {
+                "type": "Date"
+            },
+            "dayTo": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.EmailCategoryStats": {
+        "type": "I",
+        "fields": {
+            "categoryCode": {
+                "type": "string"
+            },
+            "categoryName": {
+                "type": "string"
+            },
+            "sends": {
+                "type": "number"
+            },
+            "recipients": {
+                "type": "number"
+            },
+            "opens": {
+                "type": "number"
+            },
+            "clicks": {
+                "type": "number"
+            },
+            "unsubscribers": {
+                "type": "number"
+            },
+            "cohortUnsubscribers": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailCategoryStatsResponse": {
+        "type": "I",
+        "fields": {
+            "rows": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailCategoryStats",
+                "array": true
+            }
+        }
+    },
     "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.845",
+    "version": "1.3.847",
     "description": "Statistics API gateway HTTP API Types and Data",
     "main": "index.js",
     "module": "index.js",

package/pushwoosh_statistics_statistics_v2_overviewkpi.d.ts

@@ -7,6 +7,8 @@ export type OverviewKPIService_GetChannelUsersTrend = RpcMethod<GetChannelUsersT
 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_GetEmailCategoryStats = RpcMethod<GetEmailCategoryStatsRequest, GetEmailCategoryStatsResponse>;
 export type OverviewKPIService_GetRetentionCurve = RpcMethod<GetRetentionCurveRequest, GetRetentionCurveResponse>;
 export type OverviewKPIService_GetBaseChange = RpcMethod<GetBaseChangeRequest, GetBaseChangeResponse>;
 export type OverviewKPIService_GetUserMessageMetrics = RpcMethod<GetUserMessageMetricsRequest, GetUserMessageMetricsResponse>;
@@ -34,6 +36,10 @@ export interface OverviewKPIService {
     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;
+    /** GetEmailCategoryStats returns the per-category email numbers of the period. */
+    GetEmailCategoryStats: OverviewKPIService_GetEmailCategoryStats;
     /** GetRetentionCurve returns the D1/D7/D30 curve of one cohort. */
     GetRetentionCurve: OverviewKPIService_GetRetentionCurve;
     /** GetBaseChange returns how the push device base moved over a period. */
@@ -275,6 +281,56 @@ export type GetEmailBaseChangeResponse = {
     /** 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 GetEmailCategoryStatsRequest = {
+    applicationCode: string;
+    dayFrom: Date;
+    dayTo: Date;
+};
+/**
+ * EmailCategoryStats is one row of the table. An empty code is the letters that
+ * neither their message nor their journey point names.
+ */
+export type EmailCategoryStats = {
+    categoryCode: string;
+    categoryName: string;
+    /** letters, not recipients */
+    sends: number;
+    recipients: number;
+    /** users who opened; Apple MPP prefetches are left out where the log marks them */
+    opens: number;
+    /** users who clicked; our own unsubscribe link belongs to the unsubscribe event */
+    clicks: number;
+    /** everyone who unsubscribed inside the period, whatever letter caused it */
+    unsubscribers: number;
+    /**
+     * of them, those whose letter was sent inside the period too: the only
+     * numerator that cannot exceed the sends it is divided by
+     */
+    cohortUnsubscribers: number;
+};
+export type GetEmailCategoryStatsResponse = {
+    /** one row per category of the application, zero rows and the unnamed row included */
+    rows: EmailCategoryStats[];
+};
 export type GetRetentionCurveRequest = {
     applicationCode: string;
     /** day the cohort registered on */