@pushwoosh/rpc-gateway-statistics-api 1.3.848 → 1.3.850

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/data.js CHANGED
@@ -6302,6 +6302,94 @@ export const data = {
6302
6302
  }
6303
6303
  }
6304
6304
  },
6305
+ "pushwoosh.statistics.statistics.v2.statistics.GetHoldoutUpliftRequest": {
6306
+ "type": "I",
6307
+ "fields": {
6308
+ "application": {
6309
+ "type": "string"
6310
+ },
6311
+ "journeyUuid": {
6312
+ "type": "string"
6313
+ }
6314
+ }
6315
+ },
6316
+ "pushwoosh.statistics.statistics.v2.statistics.HoldoutUpliftEvent": {
6317
+ "type": "I",
6318
+ "fields": {
6319
+ "event": {
6320
+ "type": "string"
6321
+ },
6322
+ "treatment": {
6323
+ "type": "pushwoosh.statistics.statistics.v2.statistics.ControlGroupAnalyticsGroup"
6324
+ },
6325
+ "control": {
6326
+ "type": "pushwoosh.statistics.statistics.v2.statistics.ControlGroupAnalyticsGroup"
6327
+ },
6328
+ "upliftPct": {
6329
+ "type": "number"
6330
+ },
6331
+ "incrementalEvents": {
6332
+ "type": "number"
6333
+ },
6334
+ "percentOfTreatment": {
6335
+ "type": "number"
6336
+ },
6337
+ "zScore": {
6338
+ "type": "number"
6339
+ },
6340
+ "pValue": {
6341
+ "type": "number"
6342
+ },
6343
+ "confidencePct": {
6344
+ "type": "number"
6345
+ },
6346
+ "significance": {
6347
+ "type": "pushwoosh.statistics.statistics.v2.statistics.ControlGroupAnalyticsEvent.Significance"
6348
+ },
6349
+ "revenueTracked": {
6350
+ "type": "boolean"
6351
+ },
6352
+ "treatmentRevenue": {
6353
+ "type": "number",
6354
+ "mapKeyType": "string"
6355
+ },
6356
+ "controlRevenue": {
6357
+ "type": "number",
6358
+ "mapKeyType": "string"
6359
+ },
6360
+ "incrementalRevenue": {
6361
+ "type": "number",
6362
+ "mapKeyType": "string"
6363
+ }
6364
+ }
6365
+ },
6366
+ "pushwoosh.statistics.statistics.v2.statistics.HoldoutUpliftPoint": {
6367
+ "type": "I",
6368
+ "fields": {
6369
+ "pointUuid": {
6370
+ "type": "string"
6371
+ },
6372
+ "computedAt": {
6373
+ "type": "Date"
6374
+ },
6375
+ "attributionWindowSeconds": {
6376
+ "type": "number"
6377
+ },
6378
+ "events": {
6379
+ "type": "pushwoosh.statistics.statistics.v2.statistics.HoldoutUpliftEvent",
6380
+ "array": true
6381
+ }
6382
+ }
6383
+ },
6384
+ "pushwoosh.statistics.statistics.v2.statistics.GetHoldoutUpliftResponse": {
6385
+ "type": "I",
6386
+ "fields": {
6387
+ "points": {
6388
+ "type": "pushwoosh.statistics.statistics.v2.statistics.HoldoutUpliftPoint",
6389
+ "array": true
6390
+ }
6391
+ }
6392
+ },
6305
6393
  "pushwoosh.statistics.statistics.v2.statistics.GetEmailCategoryPerformanceRequest": {
6306
6394
  "type": "I",
6307
6395
  "fields": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-gateway-statistics-api",
3
- "version": "1.3.848",
3
+ "version": "1.3.850",
4
4
  "description": "Statistics API gateway HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",
@@ -293,7 +293,7 @@ export type GetEmailPerformanceRequest = {
293
293
  export type EmailPerformanceCounts = {
294
294
  sends: number;
295
295
  deliveries: number;
296
- /** Apple MPP prefetches are left out where the log marks them */
296
+ /** Apple MPP prefetches are counted in, as the daily chart under the tiles counts them */
297
297
  opens: number;
298
298
  /** clicks on our own unsubscribe link belong to the unsubscribe event, not here */
299
299
  clicks: number;
@@ -1151,6 +1151,60 @@ export type GetControlGroupAnalyticsResponse = {
1151
1151
  /** Per-event analytics rows */
1152
1152
  events: ControlGroupAnalyticsEvent[];
1153
1153
  };
1154
+ /** GetHoldoutUpliftRequest asks for the uplift of one journey against its holdouts */
1155
+ export type GetHoldoutUpliftRequest = {
1156
+ /** Application Code */
1157
+ application: string;
1158
+ /** Journey UUID */
1159
+ journeyUuid: string;
1160
+ };
1161
+ /** HoldoutUpliftEvent contains In-journey-vs-Holdout metrics for a single goal event */
1162
+ export type HoldoutUpliftEvent = {
1163
+ /** Goal event name */
1164
+ event: string;
1165
+ /** Travellers that went on into the journey */
1166
+ treatment: ControlGroupAnalyticsGroup;
1167
+ /** Travellers held out */
1168
+ control: ControlGroupAnalyticsGroup;
1169
+ /** Relative uplift of treatment over control, percent */
1170
+ upliftPct: number;
1171
+ /** Estimated events attributable to the journey */
1172
+ incrementalEvents: number;
1173
+ /** Incremental events as percent of treatment events */
1174
+ percentOfTreatment: number;
1175
+ /** Z-score of the uplift */
1176
+ zScore: number;
1177
+ /** P-value of the uplift */
1178
+ pValue: number;
1179
+ /** Confidence level, percent */
1180
+ confidencePct: number;
1181
+ /** Statistical significance verdict */
1182
+ significance: ControlGroupAnalyticsEvent_Significance;
1183
+ /** Revenue source is configured for the event; false means it was read from legacy attributes */
1184
+ revenueTracked: boolean;
1185
+ /** Treatment revenue per currency, not converted */
1186
+ treatmentRevenue: Record<string, number>;
1187
+ /** Holdout revenue per currency, not converted */
1188
+ controlRevenue: Record<string, number>;
1189
+ /** Revenue attributable to the journey per currency */
1190
+ incrementalRevenue: Record<string, number>;
1191
+ };
1192
+ /** HoldoutUpliftPoint is the latest report of one Holdout Split point */
1193
+ export type HoldoutUpliftPoint = {
1194
+ /** Holdout Split point UUID */
1195
+ pointUuid: string;
1196
+ /** When the report was computed */
1197
+ computedAt: Date;
1198
+ /** Conversion window counted from passing the point */
1199
+ attributionWindowSeconds: number;
1200
+ /** Per-goal rows */
1201
+ events: HoldoutUpliftEvent[];
1202
+ };
1203
+ /** GetHoldoutUpliftResponse contains the latest report per Holdout Split point */
1204
+ export type GetHoldoutUpliftResponse = {
1205
+ /** One entry per point that has a report */
1206
+ points: HoldoutUpliftPoint[];
1207
+ };
1154
1208
  /** GetEmailCategoryPerformanceRequest asks for per-category counters over the period */
1155
1209
  export type GetEmailCategoryPerformanceRequest = {
1156
1210
  /** Application Code */