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

package/data.js

@@ -207,6 +207,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/v2/statistics/audience/getEmailActivityDistribution"
             },
+            "GetEmailEventTriggeredPerformanceCP": {
+                "request": "pushwoosh.statistics.statistics.v1.GetEmailEventTriggeredPerformanceCPRequest",
+                "response": "pushwoosh.statistics.statistics.v1.GetEmailEventTriggeredPerformanceCPResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/audience/getEmailEventTriggeredPerformance"
+            },
             "GetRetentionTotalStatisticsCP": {
                 "request": "pushwoosh.statistics.statistics.v1.GetRetentionTotalStatisticsCPRequest",
                 "response": "pushwoosh.statistics.statistics.v1.GetRetentionTotalStatisticsCPResponse",
@@ -1210,6 +1216,54 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v1.GetEmailEventTriggeredPerformanceCPRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "timestampFrom": {
+                "type": "string"
+            },
+            "timestampTo": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.EmailPerformanceCounts": {
+        "type": "I",
+        "fields": {
+            "sends": {
+                "type": "number"
+            },
+            "deliveries": {
+                "type": "number"
+            },
+            "opens": {
+                "type": "number"
+            },
+            "clicks": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.GetEmailEventTriggeredPerformanceCPResponse": {
+        "type": "I",
+        "fields": {
+            "bySends": {
+                "type": "pushwoosh.statistics.statistics.v1.EmailPerformanceCounts"
+            },
+            "byUniques": {
+                "type": "pushwoosh.statistics.statistics.v1.EmailPerformanceCounts"
+            },
+            "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.755",
+    "version": "1.3.756",
     "description": "Statistics API gateway HTTP API Types and Data",
     "main": "index.js",
     "module": "index.js",

package/pushwoosh_statistics_statistics_v1.d.ts

@@ -22,6 +22,7 @@ export type StatisticsService_GetAverageCTRTotalStatisticsCP = RpcMethod<GetAver
 export type StatisticsService_GetSubscribersTotalStatisticsCP = RpcMethod<GetSubscribersTotalStatisticsCPRequest, GetSubscribersTotalStatisticsCPResponse>;
 export type StatisticsService_GetSubscribersDailyStatisticsCP = RpcMethod<GetSubscribersDailyStatisticsCPRequest, GetSubscribersDailyStatisticsCPResponse>;
 export type StatisticsService_GetEmailActivityDistributionCP = RpcMethod<GetEmailActivityDistributionCPRequest, GetEmailActivityDistributionCPResponse>;
+export type StatisticsService_GetEmailEventTriggeredPerformanceCP = RpcMethod<GetEmailEventTriggeredPerformanceCPRequest, GetEmailEventTriggeredPerformanceCPResponse>;
 export type StatisticsService_GetRetentionTotalStatisticsCP = RpcMethod<GetRetentionTotalStatisticsCPRequest, GetRetentionTotalStatisticsCPResponse>;
 export type StatisticsService_GetEngagementTotalStatisticsCP = RpcMethod<GetEngagementTotalStatisticsCPRequest, GetEngagementTotalStatisticsCPResponse>;
 export type StatisticsService_GetActiveUsersTotalStatisticsCP = RpcMethod<GetActiveUsersTotalStatisticsCPRequest, GetActiveUsersTotalStatisticsCPResponse>;
@@ -70,6 +71,8 @@ export interface StatisticsService {
     GetSubscribersDailyStatisticsCP: StatisticsService_GetSubscribersDailyStatisticsCP;
     /** GetEmailActivityDistributionCP splits the email subscribers base by what they did in the period */
     GetEmailActivityDistributionCP: StatisticsService_GetEmailActivityDistributionCP;
+    /** GetEmailEventTriggeredPerformanceCP returns performance of event-triggered emails for control panel */
+    GetEmailEventTriggeredPerformanceCP: StatisticsService_GetEmailEventTriggeredPerformanceCP;
     /** GetRetentionTotalStatisticsCP returns user retention statistics */
     GetRetentionTotalStatisticsCP: StatisticsService_GetRetentionTotalStatisticsCP;
     /** GetEngagementTotalStatisticsCP returns user engagement metrics */
@@ -468,6 +471,32 @@ export type GetEmailActivityDistributionCPResponse = {
     windowFrom: string;
     windowTo: string;
 };
+export type GetEmailEventTriggeredPerformanceCPRequest = {
+    applicationCode: string;
+    timestampFrom: string;
+    timestampTo: string;
+};
+export type EmailPerformanceCounts = {
+    sends: number;
+    deliveries: number;
+    opens: number;
+    clicks: number;
+};
+/**
+ * Event-triggered here means everything sent by automation — Customer Journey and the
+ * triggered API — as opposed to one-time campaigns composed in the control panel.
+ */
+export type GetEmailEventTriggeredPerformanceCPResponse = {
+    /**
+     * by_sends counts every send, by_uniques counts each recipient once; both come from one
+     * read so the control panel switches between them without a refetch.
+     */
+    bySends: EmailPerformanceCounts;
+    byUniques: EmailPerformanceCounts;
+    /** The window actually read, clamped to the event log retention. */
+    windowFrom: string;
+    windowTo: string;
+};
 export type GetRetentionTotalStatisticsCPRequest = {
     applicationCode: string;
     timestampFrom: string;