@pushwoosh/rpc-gateway-statistics-api 1.3.765 → 1.3.766

package/data.js

@@ -3821,6 +3821,12 @@ export const data = {
                 "response": "pushwoosh.statistics.statistics.v2.statistics.GetActiveAudienceResponse",
                 "method": "post",
                 "path": "/api/v2/statistics/audience/getActiveAudience"
+            },
+            "GetEmailCategoryPerformance": {
+                "request": "pushwoosh.statistics.statistics.v2.statistics.GetEmailCategoryPerformanceRequest",
+                "response": "pushwoosh.statistics.statistics.v2.statistics.GetEmailCategoryPerformanceResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/messages/getEmailCategoryPerformance"
             }
         }
     },
@@ -5370,5 +5376,59 @@ export const data = {
                 "array": true
             }
         }
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.GetEmailCategoryPerformanceRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "dateFrom": {
+                "type": "Date"
+            },
+            "dateTo": {
+                "type": "Date"
+            },
+            "campaignCategories": {
+                "type": "string",
+                "mapKeyType": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.EmailCategoryCounters": {
+        "type": "I",
+        "fields": {
+            "categoryCode": {
+                "type": "string"
+            },
+            "sends": {
+                "type": "number"
+            },
+            "opens": {
+                "type": "number"
+            },
+            "clicks": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.GetEmailCategoryPerformanceResponse": {
+        "type": "I",
+        "fields": {
+            "categories": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.EmailCategoryCounters",
+                "array": true
+            },
+            "unsubscribes": {
+                "type": "number",
+                "mapKeyType": "string"
+            },
+            "windowFrom": {
+                "type": "Date"
+            },
+            "windowTo": {
+                "type": "Date"
+            }
+        }
     }
 };

package/package.json

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

package/pushwoosh_statistics_statistics_v2_statistics.d.ts

@@ -17,6 +17,7 @@ export type StatisticsService_GetCampaignDeliveryFunnel = RpcMethod<GetCampaignD
 export type StatisticsService_GetMessageDeliveryTimeline = RpcMethod<GetMessageDeliveryTimelineRequest, GetDeliveryTimelineResponse>;
 export type StatisticsService_GetCampaignDeliveryTimeline = RpcMethod<GetCampaignDeliveryTimelineRequest, GetDeliveryTimelineResponse>;
 export type StatisticsService_GetActiveAudience = RpcMethod<GetActiveAudienceRequest, GetActiveAudienceResponse>;
+export type StatisticsService_GetEmailCategoryPerformance = RpcMethod<GetEmailCategoryPerformanceRequest, GetEmailCategoryPerformanceResponse>;
 /** StatisticsService provides various statistics operations */
 export interface StatisticsService {
     /** GetMessagesStatistics returns message statistics grouped by platform and time intervals */
@@ -65,6 +66,11 @@ export interface StatisticsService {
     GetCampaignDeliveryTimeline: StatisticsService_GetCampaignDeliveryTimeline;
     /** GetActiveAudience returns active users and active devices groped by application and platform */
     GetActiveAudience: StatisticsService_GetActiveAudience;
+    /**
+     * GetEmailCategoryPerformance counts email sends, openers and clickers per category code.
+     * The caller names the categories; statistics only groups by the names it is given.
+     */
+    GetEmailCategoryPerformance: StatisticsService_GetEmailCategoryPerformance;
 }
 /** EmailEventType represents different types of email delivery events */
 export type EmailEventType = 
@@ -1106,3 +1112,42 @@ export type GetControlGroupAnalyticsResponse = {
     /** Per-event analytics rows */
     events: ControlGroupAnalyticsEvent[];
 };
+/** GetEmailCategoryPerformanceRequest asks for per-category counters over the period */
+export type GetEmailCategoryPerformanceRequest = {
+    /** Application Code */
+    application: string;
+    /** Period start */
+    dateFrom: Date;
+    /** Period end */
+    dateTo: Date;
+    /**
+     * Category code per campaign, for the email sends that have no message row of their own;
+     * a send with a message row is named by the message and ignores this map.
+     */
+    campaignCategories: Record<number, string>;
+};
+/** EmailCategoryCounters holds the counters of one category code */
+export type EmailCategoryCounters = {
+    /** Category code the sends were grouped by */
+    categoryCode: string;
+    /** Letters sent */
+    sends: number;
+    /** Recipients who opened at least one of them */
+    opens: number;
+    /** Recipients who clicked a link other than unsubscribe */
+    clicks: number;
+};
+/**
+ * GetEmailCategoryPerformanceResponse contains per-category counters and the unsubscribes
+ * the unsubscribe event reports, keyed by the category name it carries
+ */
+export type GetEmailCategoryPerformanceResponse = {
+    /** Categories something was sent to */
+    categories: EmailCategoryCounters[];
+    /** Unsubscribed recipients per category name */
+    unsubscribes: Record<string, number>;
+    /** Window actually read, clamped to retention */
+    windowFrom: Date;
+    /** Window actually read */
+    windowTo: Date;
+};