@pushwoosh/rpc-gateway-statistics-api 1.3.831 → 1.3.833

package/data.js

@@ -35,7 +35,8 @@ export const data = {
             "WHATSAPP_API",
             "SMS_API",
             "INBOX_CP",
-            "INBOX_API"
+            "INBOX_API",
+            "TEST_EMAIL"
         ]
     },
     "pushwoosh.statistics.types.MessageType": {
@@ -3809,6 +3810,9 @@ export const data = {
             },
             "day": {
                 "type": "Date"
+            },
+            "platformId": {
+                "type": "number"
             }
         }
     },
@@ -3856,6 +3860,9 @@ export const data = {
             },
             "neverOptedInPercent": {
                 "type": "number"
+            },
+            "totalUsersAvailable": {
+                "type": "boolean"
             }
         }
     },
@@ -3878,6 +3885,15 @@ export const data = {
             },
             "reachable": {
                 "type": "number"
+            },
+            "usersWithPushDevice": {
+                "type": "number"
+            },
+            "subscribers": {
+                "type": "number"
+            },
+            "activeReachable": {
+                "type": "number"
             }
         }
     },
@@ -3904,6 +3920,9 @@ export const data = {
             },
             "dayTo": {
                 "type": "Date"
+            },
+            "platformId": {
+                "type": "number"
             }
         }
     },
@@ -3930,6 +3949,9 @@ export const data = {
             "points": {
                 "type": "pushwoosh.statistics.statistics.v2.overviewkpi.GetActiveTrendResponse.Point",
                 "array": true
+            },
+            "activeMetricsAvailable": {
+                "type": "boolean"
             }
         }
     },

package/package.json

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

package/pushwoosh_statistics_statistics_v2_overviewkpi.d.ts

@@ -56,6 +56,8 @@ export type GetOverviewKPIResponse = {
 export type GetAudienceFunnelRequest = {
     applicationCode: string;
     day: Date;
+    /** count only users reachable on this platform; 0 is the application total */
+    platformId: number;
 };
 export type GetAudienceFunnelResponse = {
     day: Date;
@@ -81,6 +83,11 @@ export type GetAudienceFunnelResponse = {
     /** has a push device but no token at all */
     neverOptedIn: number;
     neverOptedInPercent: number;
+    /**
+     * total_users is counted by another job that knows no platforms, so under a
+     * platform_id it comes back zero and this flag is false.
+     */
+    totalUsersAvailable: boolean;
 };
 export type GetReachByPlatformRequest = {
     applicationCode: string;
@@ -88,13 +95,20 @@ export type GetReachByPlatformRequest = {
 };
 export type GetReachByPlatformResponse_Platform = {
     platformId: number;
+    /** users with push permission and a valid token on this platform */
     reachable: number;
+    /** users with at least one push device on this platform, token or not */
+    usersWithPushDevice: number;
+    /** users whose device on this platform holds a valid token */
+    subscribers: number;
+    /** reachable users active within the window, same 30 days as the funnel */
+    activeReachable: number;
 };
 export type GetReachByPlatformResponse = {
     day: Date;
     /**
-     * a user counts in every platform where they have a reachable device, so the
-     * sum over platforms may exceed the total
+     * a user counts in every platform they carry the flag on, so the sum over
+     * platforms exceeds the application total; ordered by users_with_push_device
      */
     platforms: GetReachByPlatformResponse_Platform[];
 };
@@ -102,6 +116,8 @@ export type GetActiveTrendRequest = {
     applicationCode: string;
     dayFrom: Date;
     dayTo: Date;
+    /** take reachable of this platform only; 0 is the application total */
+    platformId: number;
 };
 export type GetActiveTrendResponse_Point = {
     day: Date;
@@ -117,6 +133,11 @@ export type GetActiveTrendResponse = {
      * be summed or merged across points
      */
     points: GetActiveTrendResponse_Point[];
+    /**
+     * dau and mau_30 are not counted per platform: under a platform_id they come
+     * back zero and this flag is false, while reachable stays filled.
+     */
+    activeMetricsAvailable: boolean;
 };
 export type GetRetentionCurveRequest = {
     applicationCode: string;

package/pushwoosh_statistics_types.d.ts

@@ -3,7 +3,7 @@ export type Source = 'SOURCE_UNSPECIFIED'
 /** deprecated */
  | 'AB_EXPERIMENT' | 'AB_TEST' | 'API' | 'AUTO_PUSH' | 'CP' | 'CSV' | 'CUSTOMER_JOURNEY' | 'EMAIL_API' | 'EMAIL_CP' | 'GEO_ZONE' | 'PUSH_ON_EVENT' | 'RSS' | 'SYSTEM'
 /** deprecated */
- | 'TWITTER' | 'TARGETED' | 'LIVE_ACTIVITY_API' | 'WHATSAPP_API' | 'SMS_API' | 'INBOX_CP' | 'INBOX_API';
+ | 'TWITTER' | 'TARGETED' | 'LIVE_ACTIVITY_API' | 'WHATSAPP_API' | 'SMS_API' | 'INBOX_CP' | 'INBOX_API' | 'TEST_EMAIL';
 export type MessageType = 'MESSAGE_TYPE_UNSPECIFIED' | 'TRANSACTIONAL' | 'BROADCAST' | 'ALL';
 export type Platform = 'PLATFORM_UNSPECIFIED' | 'IOS'
 /** deprecated */