@pushwoosh/rpc-gateway-statistics-api 1.3.858 → 1.3.860

package/data.js

@@ -3777,6 +3777,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/v2/statistics/overview/getReachByPlatform"
             },
+            "GetChannelReach": {
+                "request": "pushwoosh.statistics.statistics.v2.overviewkpi.GetChannelReachRequest",
+                "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetChannelReachResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/overview/getChannelReach"
+            },
             "GetActiveTrend": {
                 "request": "pushwoosh.statistics.statistics.v2.overviewkpi.GetActiveTrendRequest",
                 "response": "pushwoosh.statistics.statistics.v2.overviewkpi.GetActiveTrendResponse",
@@ -4007,6 +4013,79 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.ReachChannel": {
+        "type": "E",
+        "values": [
+            "REACH_CHANNEL_UNSPECIFIED",
+            "REACH_CHANNEL_PUSH",
+            "REACH_CHANNEL_EMAIL",
+            "REACH_CHANNEL_SMS",
+            "REACH_CHANNEL_WHATSAPP",
+            "REACH_CHANNEL_INBOX"
+        ]
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetChannelReachRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "day": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetChannelReachResponse.Combination": {
+        "type": "I",
+        "fields": {
+            "channels": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.ReachChannel",
+                "array": true
+            },
+            "users": {
+                "type": "number"
+            },
+            "percent": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetChannelReachResponse": {
+        "type": "I",
+        "fields": {
+            "day": {
+                "type": "Date"
+            },
+            "total": {
+                "type": "number"
+            },
+            "reachable": {
+                "type": "number"
+            },
+            "reachablePercent": {
+                "type": "number"
+            },
+            "multiChannel": {
+                "type": "number"
+            },
+            "multiChannelPercent": {
+                "type": "number"
+            },
+            "combinations": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.GetChannelReachResponse.Combination",
+                "array": true
+            },
+            "unreachable": {
+                "type": "number"
+            },
+            "unreachablePercent": {
+                "type": "number"
+            },
+            "inboxAvailable": {
+                "type": "boolean"
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v2.overviewkpi.GetActiveTrendRequest": {
         "type": "I",
         "fields": {

package/package.json

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

package/pushwoosh_statistics_statistics_v2_overviewkpi.d.ts

@@ -2,6 +2,7 @@ import { RpcMethod } from './commonTypes';
 export type OverviewKPIService_GetOverviewKPI = RpcMethod<GetOverviewKPIRequest, GetOverviewKPIResponse>;
 export type OverviewKPIService_GetAudienceFunnel = RpcMethod<GetAudienceFunnelRequest, GetAudienceFunnelResponse>;
 export type OverviewKPIService_GetReachByPlatform = RpcMethod<GetReachByPlatformRequest, GetReachByPlatformResponse>;
+export type OverviewKPIService_GetChannelReach = RpcMethod<GetChannelReachRequest, GetChannelReachResponse>;
 export type OverviewKPIService_GetActiveTrend = RpcMethod<GetActiveTrendRequest, GetActiveTrendResponse>;
 export type OverviewKPIService_GetChannelUsersTrend = RpcMethod<GetChannelUsersTrendRequest, GetChannelUsersTrendResponse>;
 export type OverviewKPIService_GetEmailRates = RpcMethod<GetEmailRatesRequest, GetEmailRatesResponse>;
@@ -25,6 +26,11 @@ export interface OverviewKPIService {
     GetAudienceFunnel: OverviewKPIService_GetAudienceFunnel;
     /** GetReachByPlatform returns reachable users split by platform. */
     GetReachByPlatform: OverviewKPIService_GetReachByPlatform;
+    /**
+     * GetChannelReach splits the users of a snapshot day by the exact set of channels
+     * they are reachable on, so every user lands in one combination.
+     */
+    GetChannelReach: OverviewKPIService_GetChannelReach;
     /** GetActiveTrend returns the daily DAU and rolling-30 MAU series. */
     GetActiveTrend: OverviewKPIService_GetActiveTrend;
     /** GetChannelUsersTrend returns the daily users-with-channel series of one platform. */
@@ -131,8 +137,8 @@ export type GetReachByPlatformResponse_Platform = {
     /** reachable users active within the window, same 30 days as the funnel */
     activeReachable: number;
     /**
-     * users reachable on this platform by any channel, push token or email
-     * address alike; the only non-zero field on an email, SMS or WhatsApp row
+     * users reachable on this platform: PAE on a push platform, an address on
+     * email, SMS or WhatsApp, where it is the only non-zero field
      */
     usersWithChannel: number;
 };
@@ -146,6 +152,40 @@ export type GetReachByPlatformResponse = {
      */
     platforms: GetReachByPlatformResponse_Platform[];
 };
+export type ReachChannel = 'REACH_CHANNEL_UNSPECIFIED'
+/** a device with a token and push permission */
+ | 'REACH_CHANNEL_PUSH'
+/** an address with no unsubscribe and no hard bounce */
+ | 'REACH_CHANNEL_EMAIL' | 'REACH_CHANNEL_SMS' | 'REACH_CHANNEL_WHATSAPP'
+/** any app or browser device, token or not; only for an application that shows an inbox */
+ | 'REACH_CHANNEL_INBOX';
+export type GetChannelReachRequest = {
+    applicationCode: string;
+    day: Date;
+};
+export type GetChannelReachResponse_Combination = {
+    /** the exact set: a user in this row is reachable on these channels and no other */
+    channels: ReachChannel[];
+    users: number;
+    /** of total, in percent */
+    percent: number;
+};
+export type GetChannelReachResponse = {
+    day: Date;
+    /** every user of the application; combinations plus unreachable add up to it */
+    total: number;
+    reachable: number;
+    reachablePercent: number;
+    /** users reachable on two channels or more */
+    multiChannel: number;
+    multiChannelPercent: number;
+    /** largest first; empty combinations and the unreachable users are left out */
+    combinations: GetChannelReachResponse_Combination[];
+    unreachable: number;
+    unreachablePercent: number;
+    /** false when the application shows no inbox: its inbox users are folded into the rest */
+    inboxAvailable: boolean;
+};
 export type GetActiveTrendRequest = {
     applicationCode: string;
     dayFrom: Date;