@pushwoosh/rpc-v2-http-api-data 0.2.327 → 0.2.329

package/customer_journey.d.ts

@@ -1,11 +1,14 @@
 import { RpcMethod } from './commonTypes';
 export type CustomerJourneyService_GetDeviceEntries = RpcMethod<GetDeviceEntriesRequest, GetDeviceEntriesResponse>;
 export type CustomerJourneyService_GetCampaignPreset = RpcMethod<GetCampaignPresetRequest, GetCampaignPresetResponse>;
+export type CustomerJourneyService_GetHoldoutUplift = RpcMethod<GetHoldoutUpliftRequest, GetHoldoutUpliftResponse>;
 export interface CustomerJourneyService {
     /** Lists the customer journeys a single device (by HWID) has entered in an application, with each entry's status, enter/leave times and campaign type, paged. Use to reconstruct one device's journey participation history. */
     GetDeviceEntries: CustomerJourneyService_GetDeviceEntries;
     /** Returns the message preset code and point type of the first send point of a journey campaign, looked up by campaign code. Use to find which push/email/SMS/WhatsApp preset a single-message journey campaign delivers. */
     GetCampaignPreset: CustomerJourneyService_GetCampaignPreset;
+    /** Returns the latest nightly uplift report of a journey against each of its Holdout Split points: per goal event, travellers that went on into the journey versus those held out, with conversion rates, relative uplift, significance and revenue per currency. Use to judge whether a journey moves its goals. */
+    GetHoldoutUplift: CustomerJourneyService_GetHoldoutUplift;
 }
 export type GetDeviceEntriesRequest = {
     /** Device hardware id (HWID) whose journey entries to list. */
@@ -44,3 +47,60 @@ export type GetCampaignPresetResponse = {
     preset: string;
     type: PointType;
 };
+export type GetHoldoutUpliftRequest = {
+    /** Application code (format XXXXX-XXXXX) the journey belongs to. */
+    application?: string;
+    /** UUID of the journey whose Holdout Split report to return. */
+    journeyUuid?: string;
+};
+export type HoldoutUpliftGroup = {
+    /** Travellers in this arm. */
+    users: number;
+    /** Travellers of this arm who performed the goal event within the window. */
+    conversions: number;
+    /** conversions / users * 100. */
+    conversionRate: number;
+    /** Goal events per traveller of this arm. */
+    eventsPerUser: number;
+};
+export type HoldoutUpliftEvent_Significance = 'SIGNIFICANCE_UNSPECIFIED' | 'SIGNIFICANCE_NOT_ENOUGH_DATA' | 'SIGNIFICANCE_NOT_SIGNIFICANT' | 'SIGNIFICANCE_SIGNIFICANT';
+export type HoldoutUpliftEvent = {
+    /** Goal event name. */
+    event: string;
+    /** Travellers that went on into the journey. */
+    treatment: HoldoutUpliftGroup;
+    /** Travellers held out at the point. */
+    control: HoldoutUpliftGroup;
+    /** Relative uplift of treatment over control, percent. */
+    upliftPct: number;
+    /** Estimated goal events attributable to the journey. */
+    incrementalEvents: number;
+    /** Incremental events as percent of treatment events. */
+    percentOfTreatment: number;
+    zScore: number;
+    pValue: number;
+    /** Confidence level, percent. */
+    confidencePct: number;
+    significance: HoldoutUpliftEvent_Significance;
+    /** Revenue source is configured for the event; false means the amounts come from legacy attributes. */
+    revenueTracked: boolean;
+    /** Treatment revenue per currency code, not converted. */
+    treatmentRevenue: Record<string, number>;
+    /** Holdout revenue per currency code, not converted. */
+    controlRevenue: Record<string, number>;
+    /** Revenue attributable to the journey per currency code. */
+    incrementalRevenue: Record<string, number>;
+};
+export type HoldoutUpliftPoint = {
+    /** UUID of the Holdout Split point. */
+    pointUuid: string;
+    /** When the report was computed; it is refreshed once a day. */
+    computedAt: Date;
+    /** Conversion window counted from the moment a traveller passed the point. */
+    attributionWindowSeconds: number;
+    events: HoldoutUpliftEvent[];
+};
+export type GetHoldoutUpliftResponse = {
+    /** One entry per Holdout Split point that already has a report. */
+    points: HoldoutUpliftPoint[];
+};

package/data.js

@@ -10336,6 +10336,12 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.customer_journey.GetCampaignPresetResponse",
                 "method": "get",
                 "path": "/api/journeys:get-campaign-preset"
+            },
+            "GetHoldoutUplift": {
+                "request": "pushwoosh.rpc_v2.customer_journey.GetHoldoutUpliftRequest",
+                "response": "pushwoosh.rpc_v2.customer_journey.GetHoldoutUpliftResponse",
+                "method": "post",
+                "path": "/api/journeys:get-holdout-uplift"
             }
         }
     },
@@ -10475,6 +10481,120 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.customer_journey.GetHoldoutUpliftRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "journeyUuid": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.customer_journey.HoldoutUpliftGroup": {
+        "type": "I",
+        "fields": {
+            "users": {
+                "type": "number"
+            },
+            "conversions": {
+                "type": "number"
+            },
+            "conversionRate": {
+                "type": "number"
+            },
+            "eventsPerUser": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.customer_journey.HoldoutUpliftEvent.Significance": {
+        "type": "E",
+        "values": [
+            "SIGNIFICANCE_UNSPECIFIED",
+            "SIGNIFICANCE_NOT_ENOUGH_DATA",
+            "SIGNIFICANCE_NOT_SIGNIFICANT",
+            "SIGNIFICANCE_SIGNIFICANT"
+        ]
+    },
+    "pushwoosh.rpc_v2.customer_journey.HoldoutUpliftEvent": {
+        "type": "I",
+        "fields": {
+            "event": {
+                "type": "string"
+            },
+            "treatment": {
+                "type": "pushwoosh.rpc_v2.customer_journey.HoldoutUpliftGroup"
+            },
+            "control": {
+                "type": "pushwoosh.rpc_v2.customer_journey.HoldoutUpliftGroup"
+            },
+            "upliftPct": {
+                "type": "number"
+            },
+            "incrementalEvents": {
+                "type": "number"
+            },
+            "percentOfTreatment": {
+                "type": "number"
+            },
+            "zScore": {
+                "type": "number"
+            },
+            "pValue": {
+                "type": "number"
+            },
+            "confidencePct": {
+                "type": "number"
+            },
+            "significance": {
+                "type": "pushwoosh.rpc_v2.customer_journey.HoldoutUpliftEvent.Significance"
+            },
+            "revenueTracked": {
+                "type": "boolean"
+            },
+            "treatmentRevenue": {
+                "type": "number",
+                "mapKeyType": "string"
+            },
+            "controlRevenue": {
+                "type": "number",
+                "mapKeyType": "string"
+            },
+            "incrementalRevenue": {
+                "type": "number",
+                "mapKeyType": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.customer_journey.HoldoutUpliftPoint": {
+        "type": "I",
+        "fields": {
+            "pointUuid": {
+                "type": "string"
+            },
+            "computedAt": {
+                "type": "Date"
+            },
+            "attributionWindowSeconds": {
+                "type": "number"
+            },
+            "events": {
+                "type": "pushwoosh.rpc_v2.customer_journey.HoldoutUpliftEvent",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.customer_journey.GetHoldoutUpliftResponse": {
+        "type": "I",
+        "fields": {
+            "points": {
+                "type": "pushwoosh.rpc_v2.customer_journey.HoldoutUpliftPoint",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.data_erasure.DataErasureService": {
         "type": "S",
         "key": "dataErasure",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/rpc-v2-http-api-data",
-  "version": "0.2.327",
+  "version": "0.2.329",
   "description": "RPC V2 HTTP API Types and Data",
   "main": "index.js",
   "module": "index.js",