@pushwoosh/rpc-gateway-statistics-api 1.3.840 → 1.3.841

package/data.js

@@ -3745,6 +3745,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/v2/statistics/overview/getChannelUsersTrend"
             },
+            "GetEmailRates": {
+                "request": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailRatesRequest",
+                "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailRatesResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/overview/getEmailRates"
+            },
             "GetRetentionCurve": {
                 "request": "pushwoosh.statistics.statistics.v2.overviewkpi.GetRetentionCurveRequest",
                 "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetRetentionCurveResponse",
@@ -4004,6 +4010,92 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailRatesRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "dayFrom": {
+                "type": "Date"
+            },
+            "dayTo": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.EmailRates": {
+        "type": "I",
+        "fields": {
+            "sends": {
+                "type": "number"
+            },
+            "complaints": {
+                "type": "number"
+            },
+            "hardbounces": {
+                "type": "number"
+            },
+            "complaintRatePercent": {
+                "type": "number"
+            },
+            "hardBounceRatePercent": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.EmailPauseCheck": {
+        "type": "I",
+        "fields": {
+            "windowDays": {
+                "type": "number"
+            },
+            "windowFrom": {
+                "type": "Date"
+            },
+            "rates": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailRates"
+            },
+            "complaintRateLimitPercent": {
+                "type": "number"
+            },
+            "hardBounceRateLimitPercent": {
+                "type": "number"
+            },
+            "minSends": {
+                "type": "number"
+            },
+            "evaluated": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailRatesResponse.Point": {
+        "type": "I",
+        "fields": {
+            "day": {
+                "type": "Date"
+            },
+            "rates": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailRates"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailRatesResponse": {
+        "type": "I",
+        "fields": {
+            "points": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailRatesResponse.Point",
+                "array": true
+            },
+            "totals": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailRates"
+            },
+            "pauseCheck": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailPauseCheck"
+            }
+        }
+    },
     "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.840",
+    "version": "1.3.841",
     "description": "Statistics API gateway HTTP API Types and Data",
     "main": "index.js",
     "module": "index.js",

package/pushwoosh_statistics_statistics_v2_overviewkpi.d.ts

@@ -4,6 +4,7 @@ export type OverviewKPIService_GetAudienceFunnel = RpcMethod<GetAudienceFunnelRe
 export type OverviewKPIService_GetReachByPlatform = RpcMethod<GetReachByPlatformRequest, GetReachByPlatformResponse>;
 export type OverviewKPIService_GetActiveTrend = RpcMethod<GetActiveTrendRequest, GetActiveTrendResponse>;
 export type OverviewKPIService_GetChannelUsersTrend = RpcMethod<GetChannelUsersTrendRequest, GetChannelUsersTrendResponse>;
+export type OverviewKPIService_GetEmailRates = RpcMethod<GetEmailRatesRequest, GetEmailRatesResponse>;
 export type OverviewKPIService_GetRetentionCurve = RpcMethod<GetRetentionCurveRequest, GetRetentionCurveResponse>;
 export type OverviewKPIService_GetBaseChange = RpcMethod<GetBaseChangeRequest, GetBaseChangeResponse>;
 export type OverviewKPIService_GetUserMessageMetrics = RpcMethod<GetUserMessageMetricsRequest, GetUserMessageMetricsResponse>;
@@ -22,6 +23,11 @@ export interface OverviewKPIService {
     GetActiveTrend: OverviewKPIService_GetActiveTrend;
     /** GetChannelUsersTrend returns the daily users-with-channel series of one platform. */
     GetChannelUsersTrend: OverviewKPIService_GetChannelUsersTrend;
+    /**
+     * GetEmailRates returns the complaint and hard bounce rates, counted the way the
+     * sending pause counts them, plus the account-wide check that pause runs on.
+     */
+    GetEmailRates: OverviewKPIService_GetEmailRates;
     /** GetRetentionCurve returns the D1/D7/D30 curve of one cohort. */
     GetRetentionCurve: OverviewKPIService_GetRetentionCurve;
     /** GetBaseChange returns how the push device base moved over a period. */
@@ -165,6 +171,53 @@ export type GetChannelUsersTrendResponse = {
     /** one point per day the writer has a row for; days it never ran are absent */
     points: GetChannelUsersTrendResponse_Point[];
 };
+export type GetEmailRatesRequest = {
+    applicationCode: string;
+    dayFrom: Date;
+    dayTo: Date;
+};
+/**
+ * EmailRates is one tally in events, the unit channels/email-feedback-api pauses by:
+ * both rates divide by sends, deliveries take no part.
+ */
+export type EmailRates = {
+    sends: number;
+    complaints: number;
+    hardbounces: number;
+    complaintRatePercent: number;
+    hardBounceRatePercent: number;
+};
+/**
+ * EmailPauseCheck is the very number the pause is decided on: the whole account over
+ * the restriction window, next to the limits it is compared against.
+ */
+export type EmailPauseCheck = {
+    /** emailratecounteraggregateperiod of the account, in days */
+    windowDays: number;
+    windowFrom: Date;
+    rates: EmailRates;
+    complaintRateLimitPercent: number;
+    hardBounceRateLimitPercent: number;
+    /** sends the window needs before the limits are looked at */
+    minSends: number;
+    /** false while the window holds fewer sends than min_sends: no pause can follow */
+    evaluated: boolean;
+};
+export type GetEmailRatesResponse_Point = {
+    day: Date;
+    rates: EmailRates;
+};
+export type GetEmailRatesResponse = {
+    /** the requested application and period, one point per day */
+    points: GetEmailRatesResponse_Point[];
+    /** the same application over the whole requested period */
+    totals: EmailRates;
+    /**
+     * the account-wide window the pause reads; absent scope and window on purpose
+     * differ from the two above, and that difference is the point of this field
+     */
+    pauseCheck: EmailPauseCheck;
+};
 export type GetRetentionCurveRequest = {
     applicationCode: string;
     /** day the cohort registered on */