@pushwoosh/rpc-gateway-statistics-api 1.3.849 → 1.3.851

package/data.js

@@ -5316,6 +5316,18 @@ export const data = {
             "totalOpensAmpp": {
                 "type": "number",
                 "array": true
+            },
+            "reached": {
+                "type": "number",
+                "array": true
+            },
+            "read": {
+                "type": "number",
+                "array": true
+            },
+            "dismissed": {
+                "type": "number",
+                "array": true
             }
         }
     },
@@ -5372,6 +5384,15 @@ export const data = {
             },
             "totalOpenedAmpp": {
                 "type": "number"
+            },
+            "reached": {
+                "type": "number"
+            },
+            "read": {
+                "type": "number"
+            },
+            "dismissed": {
+                "type": "number"
             }
         }
     },
@@ -6302,6 +6323,94 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v2.statistics.GetHoldoutUpliftRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "journeyUuid": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.HoldoutUpliftEvent": {
+        "type": "I",
+        "fields": {
+            "event": {
+                "type": "string"
+            },
+            "treatment": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.ControlGroupAnalyticsGroup"
+            },
+            "control": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.ControlGroupAnalyticsGroup"
+            },
+            "upliftPct": {
+                "type": "number"
+            },
+            "incrementalEvents": {
+                "type": "number"
+            },
+            "percentOfTreatment": {
+                "type": "number"
+            },
+            "zScore": {
+                "type": "number"
+            },
+            "pValue": {
+                "type": "number"
+            },
+            "confidencePct": {
+                "type": "number"
+            },
+            "significance": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.ControlGroupAnalyticsEvent.Significance"
+            },
+            "revenueTracked": {
+                "type": "boolean"
+            },
+            "treatmentRevenue": {
+                "type": "number",
+                "mapKeyType": "string"
+            },
+            "controlRevenue": {
+                "type": "number",
+                "mapKeyType": "string"
+            },
+            "incrementalRevenue": {
+                "type": "number",
+                "mapKeyType": "string"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.HoldoutUpliftPoint": {
+        "type": "I",
+        "fields": {
+            "pointUuid": {
+                "type": "string"
+            },
+            "computedAt": {
+                "type": "Date"
+            },
+            "attributionWindowSeconds": {
+                "type": "number"
+            },
+            "events": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.HoldoutUpliftEvent",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.GetHoldoutUpliftResponse": {
+        "type": "I",
+        "fields": {
+            "points": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.HoldoutUpliftPoint",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v2.statistics.GetEmailCategoryPerformanceRequest": {
         "type": "I",
         "fields": {

package/package.json

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

package/pushwoosh_statistics_statistics_v2_statistics.d.ts

@@ -441,7 +441,7 @@ export type GetJourneyMetricsRequest = {
 };
 /** ChannelMetrics contains metrics for a specific channel over time */
 export type GetJourneyMetricsResponse_ChannelMetrics = {
-    /** Channel name (push, email, whatsapp, sms) */
+    /** Channel name (push, email, whatsapp, sms, line, inbox) */
     channel: string;
     /** Sends for each timestamp */
     sends: number[];
@@ -457,7 +457,7 @@ export type GetJourneyMetricsResponse_ChannelMetrics = {
     softBounces: number[];
     /** Complaints for each timestamp */
     complaints: number[];
-    /** Link clicks for each timestamp */
+    /** Link clicks for each timestamp; for inbox: entries opened (tapped) */
     clicks: number[];
     /** Unsubscribes for each timestamp */
     unsubscribes: number[];
@@ -469,10 +469,16 @@ export type GetJourneyMetricsResponse_ChannelMetrics = {
     opensAmpp: number[];
     /** Total ampp (Apple MPP / machine) opens for each timestamp, subset of total_opens */
     totalOpensAmpp: number[];
+    /** App Inbox only: entries that first reached the state inside the interval. Zero for other channels. */
+    reached: number[];
+    /** Read */
+    read: number[];
+    /** Dismissed, read or not */
+    dismissed: number[];
 };
 /** ChannelTotals contains totals for a specific channel */
 export type GetJourneyMetricsResponse_ChannelTotals = {
-    /** Channel name (push, email, whatsapp, sms) */
+    /** Channel name (push, email, whatsapp, sms, line, inbox) */
     channel: string;
     /** Total messages sent for this channel */
     sent: number;
@@ -490,7 +496,7 @@ export type GetJourneyMetricsResponse_ChannelTotals = {
     softBounces: number;
     /** Total complaints for this channel */
     complaints: number;
-    /** Total link clicks for this channel */
+    /** Total link clicks for this channel; for inbox: entries opened (tapped) */
     clicks: number;
     /** Total unsubscribes for this channel */
     unsubscribes: number;
@@ -506,6 +512,12 @@ export type GetJourneyMetricsResponse_ChannelTotals = {
     openedAmpp: number;
     /** Total ampp (Apple MPP / machine) opens for this channel, subset of total_opened */
     totalOpenedAmpp: number;
+    /** App Inbox only, zero for other channels. */
+    reached: number;
+    /** Entries read */
+    read: number;
+    /** Entries dismissed, read or not */
+    dismissed: number;
 };
 /** GetJourneyMetricsResponse contains journey metrics with time series data and totals broken down by channels */
 export type GetJourneyMetricsResponse = {
@@ -1151,6 +1163,60 @@ export type GetControlGroupAnalyticsResponse = {
     /** Per-event analytics rows */
     events: ControlGroupAnalyticsEvent[];
 };
+/** GetHoldoutUpliftRequest asks for the uplift of one journey against its holdouts */
+export type GetHoldoutUpliftRequest = {
+    /** Application Code */
+    application: string;
+    /** Journey UUID */
+    journeyUuid: string;
+};
+/** HoldoutUpliftEvent contains In-journey-vs-Holdout metrics for a single goal event */
+export type HoldoutUpliftEvent = {
+    /** Goal event name */
+    event: string;
+    /** Travellers that went on into the journey */
+    treatment: ControlGroupAnalyticsGroup;
+    /** Travellers held out */
+    control: ControlGroupAnalyticsGroup;
+    /** Relative uplift of treatment over control, percent */
+    upliftPct: number;
+    /** Estimated events attributable to the journey */
+    incrementalEvents: number;
+    /** Incremental events as percent of treatment events */
+    percentOfTreatment: number;
+    /** Z-score of the uplift */
+    zScore: number;
+    /** P-value of the uplift */
+    pValue: number;
+    /** Confidence level, percent */
+    confidencePct: number;
+    /** Statistical significance verdict */
+    significance: ControlGroupAnalyticsEvent_Significance;
+    /** Revenue source is configured for the event; false means it was read from legacy attributes */
+    revenueTracked: boolean;
+    /** Treatment revenue per currency, not converted */
+    treatmentRevenue: Record<string, number>;
+    /** Holdout revenue per currency, not converted */
+    controlRevenue: Record<string, number>;
+    /** Revenue attributable to the journey per currency */
+    incrementalRevenue: Record<string, number>;
+};
+/** HoldoutUpliftPoint is the latest report of one Holdout Split point */
+export type HoldoutUpliftPoint = {
+    /** Holdout Split point UUID */
+    pointUuid: string;
+    /** When the report was computed */
+    computedAt: Date;
+    /** Conversion window counted from passing the point */
+    attributionWindowSeconds: number;
+    /** Per-goal rows */
+    events: HoldoutUpliftEvent[];
+};
+/** GetHoldoutUpliftResponse contains the latest report per Holdout Split point */
+export type GetHoldoutUpliftResponse = {
+    /** One entry per point that has a report */
+    points: HoldoutUpliftPoint[];
+};
 /** GetEmailCategoryPerformanceRequest asks for per-category counters over the period */
 export type GetEmailCategoryPerformanceRequest = {
     /** Application Code */