@pushwoosh/rpc-gateway-statistics-api 1.3.850 → 1.3.852

package/data.js

@@ -3819,6 +3819,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/v2/statistics/overview/getEmailSendFrequency"
             },
+            "GetEmailFrequencyCapping": {
+                "request": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailFrequencyCappingRequest",
+                "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailFrequencyCappingResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/overview/getEmailFrequencyCapping"
+            },
             "GetRetentionCurve": {
                 "request": "pushwoosh.statistics.statistics.v2.overviewkpi.GetRetentionCurveRequest",
                 "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetRetentionCurveResponse",
@@ -4390,6 +4396,58 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailFrequencyCappingRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "dayFrom": {
+                "type": "Date"
+            },
+            "dayTo": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.EmailFrequencyCappingDay": {
+        "type": "I",
+        "fields": {
+            "day": {
+                "type": "Date"
+            },
+            "suppressions": {
+                "type": "number"
+            },
+            "uniqueUsers": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailFrequencyCappingResponse": {
+        "type": "I",
+        "fields": {
+            "suppressions": {
+                "type": "number"
+            },
+            "uniqueUsers": {
+                "type": "number"
+            },
+            "rows": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailFrequencyCappingDay",
+                "array": true
+            },
+            "unresolvedSuppressions": {
+                "type": "number"
+            },
+            "windowFrom": {
+                "type": "Date"
+            },
+            "windowTo": {
+                "type": "Date"
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v2.overviewkpi.GetRetentionCurveRequest": {
         "type": "I",
         "fields": {
@@ -5316,6 +5374,18 @@ export const data = {
             "totalOpensAmpp": {
                 "type": "number",
                 "array": true
+            },
+            "reached": {
+                "type": "number",
+                "array": true
+            },
+            "read": {
+                "type": "number",
+                "array": true
+            },
+            "dismissed": {
+                "type": "number",
+                "array": true
             }
         }
     },
@@ -5372,6 +5442,15 @@ export const data = {
             },
             "totalOpenedAmpp": {
                 "type": "number"
+            },
+            "reached": {
+                "type": "number"
+            },
+            "read": {
+                "type": "number"
+            },
+            "dismissed": {
+                "type": "number"
             }
         }
     },

package/package.json

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

package/pushwoosh_statistics_statistics_v2_overviewkpi.d.ts

@@ -10,6 +10,7 @@ export type OverviewKPIService_GetEmailBaseChange = RpcMethod<GetEmailBaseChange
 export type OverviewKPIService_GetEmailPerformance = RpcMethod<GetEmailPerformanceRequest, GetEmailPerformanceResponse>;
 export type OverviewKPIService_GetEmailCategoryStats = RpcMethod<GetEmailCategoryStatsRequest, GetEmailCategoryStatsResponse>;
 export type OverviewKPIService_GetEmailSendFrequency = RpcMethod<GetEmailSendFrequencyRequest, GetEmailSendFrequencyResponse>;
+export type OverviewKPIService_GetEmailFrequencyCapping = RpcMethod<GetEmailFrequencyCappingRequest, GetEmailFrequencyCappingResponse>;
 export type OverviewKPIService_GetRetentionCurve = RpcMethod<GetRetentionCurveRequest, GetRetentionCurveResponse>;
 export type OverviewKPIService_GetBaseChange = RpcMethod<GetBaseChangeRequest, GetBaseChangeResponse>;
 export type OverviewKPIService_GetUserMessageMetrics = RpcMethod<GetUserMessageMetricsRequest, GetUserMessageMetricsResponse>;
@@ -43,6 +44,8 @@ export interface OverviewKPIService {
     GetEmailCategoryStats: OverviewKPIService_GetEmailCategoryStats;
     /** GetEmailSendFrequency splits the users of the period by how many letters they got. */
     GetEmailSendFrequency: OverviewKPIService_GetEmailSendFrequency;
+    /** GetEmailFrequencyCapping returns the email sends frequency capping suppressed. */
+    GetEmailFrequencyCapping: OverviewKPIService_GetEmailFrequencyCapping;
     /** GetRetentionCurve returns the D1/D7/D30 curve of one cohort. */
     GetRetentionCurve: OverviewKPIService_GetRetentionCurve;
     /** GetBaseChange returns how the push device base moved over a period. */
@@ -359,6 +362,32 @@ export type GetEmailSendFrequencyResponse = {
      */
     unsubscribedWithoutSends: number;
 };
+export type GetEmailFrequencyCappingRequest = {
+    applicationCode: string;
+    dayFrom: Date;
+    dayTo: Date;
+};
+/** EmailFrequencyCappingDay is one bar of the chart under the totals. */
+export type EmailFrequencyCappingDay = {
+    day: Date;
+    suppressions: number;
+    uniqueUsers: number;
+};
+export type GetEmailFrequencyCappingResponse = {
+    suppressions: number;
+    /** not the sum of the daily ones: a user suppressed on two days counts once */
+    uniqueUsers: number;
+    /** zero-filled over the window, so a quiet day is a bar of zero and not a gap */
+    rows: EmailFrequencyCappingDay[];
+    /**
+     * suppressions whose message row has already expired, so no channel could be
+     * read off them; they are in none of the numbers above
+     */
+    unresolvedSuppressions: number;
+    /** the window actually read, clamped to the suppression mart retention */
+    windowFrom: Date;
+    windowTo: Date;
+};
 export type GetRetentionCurveRequest = {
     applicationCode: string;
     /** day the cohort registered on */

package/pushwoosh_statistics_statistics_v2_statistics.d.ts

@@ -441,7 +441,7 @@ export type GetJourneyMetricsRequest = {
 };
 /** ChannelMetrics contains metrics for a specific channel over time */
 export type GetJourneyMetricsResponse_ChannelMetrics = {
-    /** Channel name (push, email, whatsapp, sms) */
+    /** Channel name (push, email, whatsapp, sms, line, inbox) */
     channel: string;
     /** Sends for each timestamp */
     sends: number[];
@@ -457,7 +457,7 @@ export type GetJourneyMetricsResponse_ChannelMetrics = {
     softBounces: number[];
     /** Complaints for each timestamp */
     complaints: number[];
-    /** Link clicks for each timestamp */
+    /** Link clicks for each timestamp; for inbox: entries opened (tapped) */
     clicks: number[];
     /** Unsubscribes for each timestamp */
     unsubscribes: number[];
@@ -469,10 +469,16 @@ export type GetJourneyMetricsResponse_ChannelMetrics = {
     opensAmpp: number[];
     /** Total ampp (Apple MPP / machine) opens for each timestamp, subset of total_opens */
     totalOpensAmpp: number[];
+    /** App Inbox only: entries that first reached the state inside the interval. Zero for other channels. */
+    reached: number[];
+    /** Read */
+    read: number[];
+    /** Dismissed, read or not */
+    dismissed: number[];
 };
 /** ChannelTotals contains totals for a specific channel */
 export type GetJourneyMetricsResponse_ChannelTotals = {
-    /** Channel name (push, email, whatsapp, sms) */
+    /** Channel name (push, email, whatsapp, sms, line, inbox) */
     channel: string;
     /** Total messages sent for this channel */
     sent: number;
@@ -490,7 +496,7 @@ export type GetJourneyMetricsResponse_ChannelTotals = {
     softBounces: number;
     /** Total complaints for this channel */
     complaints: number;
-    /** Total link clicks for this channel */
+    /** Total link clicks for this channel; for inbox: entries opened (tapped) */
     clicks: number;
     /** Total unsubscribes for this channel */
     unsubscribes: number;
@@ -506,6 +512,12 @@ export type GetJourneyMetricsResponse_ChannelTotals = {
     openedAmpp: number;
     /** Total ampp (Apple MPP / machine) opens for this channel, subset of total_opened */
     totalOpenedAmpp: number;
+    /** App Inbox only, zero for other channels. */
+    reached: number;
+    /** Entries read */
+    read: number;
+    /** Entries dismissed, read or not */
+    dismissed: number;
 };
 /** GetJourneyMetricsResponse contains journey metrics with time series data and totals broken down by channels */
 export type GetJourneyMetricsResponse = {