@pushwoosh/rpc-gateway-statistics-api 1.3.756 → 1.3.758

package/data.js

@@ -213,6 +213,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/v2/statistics/audience/getEmailEventTriggeredPerformance"
             },
+            "GetEmailCategoryPerformanceCP": {
+                "request": "pushwoosh.statistics.statistics.v1.GetEmailCategoryPerformanceCPRequest",
+                "response": "pushwoosh.statistics.statistics.v1.GetEmailCategoryPerformanceCPResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/audience/getEmailCategoryPerformance"
+            },
             "GetRetentionTotalStatisticsCP": {
                 "request": "pushwoosh.statistics.statistics.v1.GetRetentionTotalStatisticsCPRequest",
                 "response": "pushwoosh.statistics.statistics.v1.GetRetentionTotalStatisticsCPResponse",
@@ -1264,6 +1270,58 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v1.GetEmailCategoryPerformanceCPRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "timestampFrom": {
+                "type": "string"
+            },
+            "timestampTo": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.EmailCategoryPerformance": {
+        "type": "I",
+        "fields": {
+            "categoryCode": {
+                "type": "string"
+            },
+            "categoryName": {
+                "type": "string"
+            },
+            "sends": {
+                "type": "number"
+            },
+            "opens": {
+                "type": "number"
+            },
+            "clicks": {
+                "type": "number"
+            },
+            "unsubscribes": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.GetEmailCategoryPerformanceCPResponse": {
+        "type": "I",
+        "fields": {
+            "rows": {
+                "type": "pushwoosh.statistics.statistics.v1.EmailCategoryPerformance",
+                "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.756",
+    "version": "1.3.758",
     "description": "Statistics API gateway HTTP API Types and Data",
     "main": "index.js",
     "module": "index.js",

package/pushwoosh_statistics_statistics_v1.d.ts

@@ -23,6 +23,7 @@ export type StatisticsService_GetSubscribersTotalStatisticsCP = RpcMethod<GetSub
 export type StatisticsService_GetSubscribersDailyStatisticsCP = RpcMethod<GetSubscribersDailyStatisticsCPRequest, GetSubscribersDailyStatisticsCPResponse>;
 export type StatisticsService_GetEmailActivityDistributionCP = RpcMethod<GetEmailActivityDistributionCPRequest, GetEmailActivityDistributionCPResponse>;
 export type StatisticsService_GetEmailEventTriggeredPerformanceCP = RpcMethod<GetEmailEventTriggeredPerformanceCPRequest, GetEmailEventTriggeredPerformanceCPResponse>;
+export type StatisticsService_GetEmailCategoryPerformanceCP = RpcMethod<GetEmailCategoryPerformanceCPRequest, GetEmailCategoryPerformanceCPResponse>;
 export type StatisticsService_GetRetentionTotalStatisticsCP = RpcMethod<GetRetentionTotalStatisticsCPRequest, GetRetentionTotalStatisticsCPResponse>;
 export type StatisticsService_GetEngagementTotalStatisticsCP = RpcMethod<GetEngagementTotalStatisticsCPRequest, GetEngagementTotalStatisticsCPResponse>;
 export type StatisticsService_GetActiveUsersTotalStatisticsCP = RpcMethod<GetActiveUsersTotalStatisticsCPRequest, GetActiveUsersTotalStatisticsCPResponse>;
@@ -73,6 +74,8 @@ export interface StatisticsService {
     GetEmailActivityDistributionCP: StatisticsService_GetEmailActivityDistributionCP;
     /** GetEmailEventTriggeredPerformanceCP returns performance of event-triggered emails for control panel */
     GetEmailEventTriggeredPerformanceCP: StatisticsService_GetEmailEventTriggeredPerformanceCP;
+    /** GetEmailCategoryPerformanceCP returns per-email-category performance for control panel */
+    GetEmailCategoryPerformanceCP: StatisticsService_GetEmailCategoryPerformanceCP;
     /** GetRetentionTotalStatisticsCP returns user retention statistics */
     GetRetentionTotalStatisticsCP: StatisticsService_GetRetentionTotalStatisticsCP;
     /** GetEngagementTotalStatisticsCP returns user engagement metrics */
@@ -497,6 +500,27 @@ export type GetEmailEventTriggeredPerformanceCPResponse = {
     windowFrom: string;
     windowTo: string;
 };
+export type GetEmailCategoryPerformanceCPRequest = {
+    applicationCode: string;
+    timestampFrom: string;
+    timestampTo: string;
+};
+export type EmailCategoryPerformance = {
+    categoryCode: string;
+    categoryName: string;
+    sends: number;
+    opens: number;
+    clicks: number;
+    /** Unsubscribes from this very category, not from the whole mailing. */
+    unsubscribes: number;
+};
+/** One row per email category of the application, including categories nothing was sent to. */
+export type GetEmailCategoryPerformanceCPResponse = {
+    rows: EmailCategoryPerformance[];
+    /** The window actually read, clamped to the event log retention. */
+    windowFrom: string;
+    windowTo: string;
+};
 export type GetRetentionTotalStatisticsCPRequest = {
     applicationCode: string;
     timestampFrom: string;