@pushwoosh/rpc-gateway-statistics-api 1.3.841 → 1.3.842

package/data.js

@@ -1914,6 +1914,18 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v1.MessageHistoryChannel": {
+        "type": "E",
+        "values": [
+            "MESSAGE_HISTORY_CHANNEL_UNSPECIFIED",
+            "MESSAGE_HISTORY_CHANNEL_PUSH",
+            "MESSAGE_HISTORY_CHANNEL_INBOX",
+            "MESSAGE_HISTORY_CHANNEL_EMAIL",
+            "MESSAGE_HISTORY_CHANNEL_SMS",
+            "MESSAGE_HISTORY_CHANNEL_WHATSAPP",
+            "MESSAGE_HISTORY_CHANNEL_FB_MESSENGER"
+        ]
+    },
     "pushwoosh.statistics.statistics.v1.GetMessageHistoryFilters": {
         "type": "I",
         "fields": {
@@ -1950,6 +1962,9 @@ export const data = {
             "messageCodes": {
                 "type": "string",
                 "array": true
+            },
+            "channel": {
+                "type": "pushwoosh.statistics.statistics.v1.MessageHistoryChannel"
             }
         }
     },
@@ -2000,6 +2015,20 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v1.MessageHistoryInboxMetric": {
+        "type": "I",
+        "fields": {
+            "read": {
+                "type": "number"
+            },
+            "clicked": {
+                "type": "number"
+            },
+            "clickRate": {
+                "type": "number"
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v1.MessageHistoryItemMetric": {
         "type": "I",
         "fields": {
@@ -2014,6 +2043,9 @@ export const data = {
             },
             "errors": {
                 "type": "number"
+            },
+            "inbox": {
+                "type": "pushwoosh.statistics.statistics.v1.MessageHistoryInboxMetric"
             }
         }
     },
@@ -2080,6 +2112,12 @@ export const data = {
             },
             "smsPresetCode": {
                 "type": "string"
+            },
+            "inboxExpiresAt": {
+                "type": "string"
+            },
+            "channel": {
+                "type": "pushwoosh.statistics.statistics.v1.MessageHistoryChannel"
             }
         }
     },

package/package.json

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

package/pushwoosh_statistics_statistics_v1.d.ts

@@ -804,6 +804,11 @@ export type MessageHistoryOrderBy = {
     by: MessageHistoryOrderColumn;
     order: OrderType;
 };
+/**
+ * MessageHistoryChannel is one tab of the one-time messages listing: a message belongs to
+ * exactly one channel, told apart by its source and platforms
+ */
+export type MessageHistoryChannel = 'MESSAGE_HISTORY_CHANNEL_UNSPECIFIED' | 'MESSAGE_HISTORY_CHANNEL_PUSH' | 'MESSAGE_HISTORY_CHANNEL_INBOX' | 'MESSAGE_HISTORY_CHANNEL_EMAIL' | 'MESSAGE_HISTORY_CHANNEL_SMS' | 'MESSAGE_HISTORY_CHANNEL_WHATSAPP' | 'MESSAGE_HISTORY_CHANNEL_FB_MESSENGER';
 export type GetMessageHistoryFilters = {
     statuses: MessageStatus[];
     platforms: number[];
@@ -814,6 +819,7 @@ export type GetMessageHistoryFilters = {
     campaigns: string[];
     messageIds: number[];
     messageCodes: string[];
+    channel: MessageHistoryChannel;
 };
 export type GetMessageHistoryRequest_MessageType = 'UNKNOWN' | 'MARKETING' | 'TRANSACTIONAL';
 export type GetMessageHistoryRequest = {
@@ -829,11 +835,23 @@ export type GetMessageHistoryRequest = {
     messageType: GetMessageHistoryRequest_MessageType;
     checkForMessages: boolean;
 };
+/**
+ * MessageHistoryInboxMetric counts an App Inbox message's entries by what their users did
+ * with them; users, not devices, one per entry over its whole lifetime
+ */
+export type MessageHistoryInboxMetric = {
+    read: number;
+    clicked: number;
+    /** clicked / recipients, percent */
+    clickRate: number;
+};
 export type MessageHistoryItemMetric = {
     recipients: number;
     opened: number;
     ctr: number;
     errors: number;
+    /** App Inbox messages only */
+    inbox: MessageHistoryInboxMetric;
 };
 export type MessageHistoryItem = {
     messageId: number;
@@ -857,6 +875,9 @@ export type MessageHistoryItem = {
     viberTemplateId: string;
     whatsappContentId: string;
     smsPresetCode: string;
+    /** App Inbox messages only; when the entries leave the inboxes */
+    inboxExpiresAt: string;
+    channel: MessageHistoryChannel;
 };
 export type GetMessageHistoryResponse = {
     total: number;