@pushwoosh/rpc-gateway-statistics-api 1.3.810 → 1.3.812

package/data.js

@@ -3897,6 +3897,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.810",
+    "version": "1.3.812",
     "description": "Statistics API gateway HTTP API Types and Data",
     "main": "index.js",
     "module": "index.js",

package/pushwoosh_statistics_statistics_v2_overviewkpi.d.ts

@@ -177,3 +177,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;
+};