@pushwoosh/rpc-gateway-statistics-api 1.3.790 → 1.3.792

package/data.js

@@ -3504,6 +3504,12 @@ export const data = {
                 "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetRetentionCurveResponse",
                 "method": "post",
                 "path": "/api/v2/statistics/overview/getRetentionCurve"
+            },
+            "GetBaseChange": {
+                "request": "pushwoosh.statistics.statistics.v2.overviewkpi.GetBaseChangeRequest",
+                "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetBaseChangeResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/overview/getBaseChange"
             }
         }
     },
@@ -3573,6 +3579,9 @@ export const data = {
             "totalUsers": {
                 "type": "number"
             },
+            "usersWithPushDevice": {
+                "type": "number"
+            },
             "subscribers": {
                 "type": "number"
             },
@@ -3722,6 +3731,46 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetBaseChangeRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "dayFrom": {
+                "type": "Date"
+            },
+            "dayTo": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetBaseChangeResponse": {
+        "type": "I",
+        "fields": {
+            "baseStartDay": {
+                "type": "Date"
+            },
+            "baseStart": {
+                "type": "number"
+            },
+            "baseEndDay": {
+                "type": "Date"
+            },
+            "baseEnd": {
+                "type": "number"
+            },
+            "newRegistrations": {
+                "type": "number"
+            },
+            "expiredTokens": {
+                "type": "number"
+            },
+            "baseAvailable": {
+                "type": "boolean"
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v2.overviewkpi.GetMAUOverviewRequest": {
         "type": "I",
         "fields": {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pushwoosh/rpc-gateway-statistics-api",
-    "version": "1.3.790",
+    "version": "1.3.792",
     "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_GetRetentionCurve = RpcMethod<GetRetentionCurveRequest, GetRetentionCurveResponse>;
+export type OverviewKPIService_GetBaseChange = RpcMethod<GetBaseChangeRequest, GetBaseChangeResponse>;
 /**
  * OverviewKPIService serves the user-level Overview tab. Every method reads the
  * pre-aggregated daily tables only, never the raw actions log.
@@ -19,6 +20,8 @@ export interface OverviewKPIService {
     GetActiveTrend: OverviewKPIService_GetActiveTrend;
     /** GetRetentionCurve returns the D1/D7/D30 curve of one cohort. */
     GetRetentionCurve: OverviewKPIService_GetRetentionCurve;
+    /** GetBaseChange returns how the push device base moved over a period. */
+    GetBaseChange: OverviewKPIService_GetBaseChange;
 }
 export type GetOverviewKPIRequest = {
     applicationCode: string;
@@ -55,6 +58,8 @@ export type GetAudienceFunnelResponse = {
     day: Date;
     /** all users of the application */
     totalUsers: number;
+    /** users with at least one push device, with or without a token */
+    usersWithPushDevice: number;
     /** users with at least one push device holding a valid token */
     subscribers: number;
     /** users with push permission and a valid token */
@@ -70,7 +75,7 @@ export type GetAudienceFunnelResponse = {
     /** token present, system permission revoked */
     permissionOff: number;
     permissionOffPercent: number;
-    /** no push token at all, including the email and sms only audience */
+    /** has a push device but no token at all */
     neverOptedIn: number;
     neverOptedInPercent: number;
 };
@@ -126,6 +131,27 @@ export type GetRetentionCurveResponse = {
     cohortDate: Date;
     points: GetRetentionCurveResponse_Point[];
 };
+export type GetBaseChangeRequest = {
+    applicationCode: string;
+    dayFrom: Date;
+    dayTo: Date;
+};
+export type GetBaseChangeResponse = {
+    /**
+     * Both bases are measured snapshots of the day named beside them, never the
+     * sum of the flows: the flows do not add up to the difference by themselves.
+     */
+    baseStartDay: Date;
+    baseStart: number;
+    baseEndDay: Date;
+    baseEnd: number;
+    /** devices registered over the period, push platforms only */
+    newRegistrations: number;
+    /** devices whose token a provider reported invalid, gateway responses only */
+    expiredTokens: number;
+    /** false when no snapshot exists for either end of the period */
+    baseAvailable: boolean;
+};
 export type GetMAUOverviewRequest = {
     /** applications to sum over; ids of other accounts are ignored */
     applicationIds: number[];