@pushwoosh/rpc-gateway-statistics-api 1.3.811 → 1.3.813

package/data.js

@@ -3601,6 +3601,12 @@ export const data = {
                 "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetBaseChangeResponse",
                 "method": "post",
                 "path": "/api/v2/statistics/overview/getBaseChange"
+            },
+            "GetUserMessageMetrics": {
+                "request": "pushwoosh.statistics.statistics.v2.overviewkpi.GetUserMessageMetricsRequest",
+                "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetUserMessageMetricsResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/overview/getUserMessageMetrics"
             }
         }
     },
@@ -3897,6 +3903,67 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetUserMessageMetricsRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "dayFrom": {
+                "type": "Date"
+            },
+            "dayTo": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetUserMessageMetricsResponse.Platform": {
+        "type": "I",
+        "fields": {
+            "platformId": {
+                "type": "number"
+            },
+            "sends": {
+                "type": "number"
+            },
+            "deliveries": {
+                "type": "number"
+            },
+            "errors": {
+                "type": "number"
+            },
+            "deliveryRatePercent": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetUserMessageMetricsResponse": {
+        "type": "I",
+        "fields": {
+            "sends": {
+                "type": "number"
+            },
+            "deliveries": {
+                "type": "number"
+            },
+            "errors": {
+                "type": "number"
+            },
+            "deliveryRatePercent": {
+                "type": "number"
+            },
+            "platforms": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.GetUserMessageMetricsResponse.Platform",
+                "array": true
+            },
+            "firstWrittenDay": {
+                "type": "Date"
+            },
+            "dataAvailable": {
+                "type": "boolean"
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v2.statistics.StatisticsService": {
         "type": "S",
         "key": "statisticsV2",

package/package.json

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

package/pushwoosh_statistics_statistics_v2_overviewkpi.d.ts

@@ -5,6 +5,7 @@ export type OverviewKPIService_GetReachByPlatform = RpcMethod<GetReachByPlatform
 export type OverviewKPIService_GetActiveTrend = RpcMethod<GetActiveTrendRequest, GetActiveTrendResponse>;
 export type OverviewKPIService_GetRetentionCurve = RpcMethod<GetRetentionCurveRequest, GetRetentionCurveResponse>;
 export type OverviewKPIService_GetBaseChange = RpcMethod<GetBaseChangeRequest, GetBaseChangeResponse>;
+export type OverviewKPIService_GetUserMessageMetrics = RpcMethod<GetUserMessageMetricsRequest, GetUserMessageMetricsResponse>;
 /**
  * OverviewKPIService serves the user-level Overview tab. Every method reads the
  * pre-aggregated daily tables only, never the raw actions log.
@@ -22,6 +23,8 @@ export interface OverviewKPIService {
     GetRetentionCurve: OverviewKPIService_GetRetentionCurve;
     /** GetBaseChange returns how the push device base moved over a period. */
     GetBaseChange: OverviewKPIService_GetBaseChange;
+    /** GetUserMessageMetrics returns the Performance numbers counted in users. */
+    GetUserMessageMetrics: OverviewKPIService_GetUserMessageMetrics;
 }
 export type GetOverviewKPIRequest = {
     applicationCode: string;
@@ -177,3 +180,37 @@ export type GetMAUOverviewResponse = {
     /** same sum restricted to users holding a valid push token */
     activeWithToken30: number;
 };
+export type GetUserMessageMetricsRequest = {
+    applicationCode: string;
+    dayFrom: Date;
+    dayTo: Date;
+};
+export type GetUserMessageMetricsResponse_Platform = {
+    platformId: number;
+    sends: number;
+    deliveries: number;
+    errors: number;
+    deliveryRatePercent: number;
+};
+export type GetUserMessageMetricsResponse = {
+    /** users the gateway was asked for: the ones it took plus the ones it refused */
+    sends: number;
+    /** users the gateway took, confirmed by the device or not */
+    deliveries: number;
+    /** users whose send the gateway refused */
+    errors: number;
+    /** deliveries over sends, in percent, rounded to two decimals */
+    deliveryRatePercent: number;
+    /**
+     * a user reached on two platforms is counted in each, so the rows do not sum
+     * to the totals above
+     */
+    platforms: GetUserMessageMetricsResponse_Platform[];
+    /**
+     * first day the mart holds for this application; an earlier day_from asks for
+     * numbers that were never written and can no longer be rebuilt
+     */
+    firstWrittenDay: Date;
+    /** false when the mart has nothing for this application at all */
+    dataAvailable: boolean;
+};