@pushwoosh/rpc-gateway-statistics-api 1.3.705 → 1.3.707

package/data.js

@@ -1241,6 +1241,23 @@ export const data = {
             },
             "timestampTo": {
                 "type": "string"
+            },
+            "interval": {
+                "type": "pushwoosh.statistics.types.TimeInterval"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.FrequencyCappingMetricWithTimestamp": {
+        "type": "I",
+        "fields": {
+            "timestamp": {
+                "type": "string"
+            },
+            "frequencyCappingSuppressions": {
+                "type": "number"
+            },
+            "frequencyCappingUniqueUsers": {
+                "type": "number"
             }
         }
     },
@@ -1252,6 +1269,10 @@ export const data = {
             },
             "frequencyCappingUniqueUsers": {
                 "type": "number"
+            },
+            "rows": {
+                "type": "pushwoosh.statistics.statistics.v1.FrequencyCappingMetricWithTimestamp",
+                "array": true
             }
         }
     },
@@ -4091,5 +4112,95 @@ export const data = {
                 "array": true
             }
         }
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.GetControlGroupAnalyticsRequest.WindowDays": {
+        "type": "E",
+        "values": [
+            "WINDOW_DAYS_UNSPECIFIED",
+            "WINDOW_DAYS_3",
+            "WINDOW_DAYS_7",
+            "WINDOW_DAYS_30"
+        ]
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.GetControlGroupAnalyticsRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "windowDays": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.GetControlGroupAnalyticsRequest.WindowDays"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.ControlGroupAnalyticsGroup": {
+        "type": "I",
+        "fields": {
+            "users": {
+                "type": "number"
+            },
+            "conversions": {
+                "type": "number"
+            },
+            "conversionRate": {
+                "type": "number"
+            },
+            "eventsPerUser": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.ControlGroupAnalyticsEvent.Significance": {
+        "type": "E",
+        "values": [
+            "SIGNIFICANCE_UNSPECIFIED",
+            "SIGNIFICANCE_NOT_ENOUGH_DATA",
+            "SIGNIFICANCE_NOT_SIGNIFICANT",
+            "SIGNIFICANCE_SIGNIFICANT"
+        ]
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.ControlGroupAnalyticsEvent": {
+        "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"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.GetControlGroupAnalyticsResponse": {
+        "type": "I",
+        "fields": {
+            "events": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.ControlGroupAnalyticsEvent",
+                "array": true
+            }
+        }
     }
 };

package/package.json

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

package/pushwoosh_statistics_statistics_v2_statistics.d.ts

@@ -695,3 +695,53 @@ export type GetUserFCSuppressionsResponse = {
     /** List of suppression records */
     suppressions: FCSuppressionRecord[];
 };
+/** WindowDays is the analytics window preset */
+export type GetControlGroupAnalyticsRequest_WindowDays = 'WINDOW_DAYS_UNSPECIFIED' | 'WINDOW_DAYS_3' | 'WINDOW_DAYS_7' | 'WINDOW_DAYS_30';
+/** GetControlGroupAnalyticsRequest represents a request for Global Control Group analytics */
+export type GetControlGroupAnalyticsRequest = {
+    /** Application Code */
+    application: string;
+    /** Analytics window preset */
+    windowDays: GetControlGroupAnalyticsRequest_WindowDays;
+};
+/** ControlGroupAnalyticsGroup contains metrics for one side of the experiment (treatment or control) */
+export type ControlGroupAnalyticsGroup = {
+    /** Number of users in the group */
+    users: number;
+    /** Number of users who performed the event */
+    conversions: number;
+    /** conversions / users */
+    conversionRate: number;
+    /** Total events / users */
+    eventsPerUser: number;
+};
+/** Significance is the statistical significance verdict for the uplift */
+export type ControlGroupAnalyticsEvent_Significance = 'SIGNIFICANCE_UNSPECIFIED' | 'SIGNIFICANCE_NOT_ENOUGH_DATA' | 'SIGNIFICANCE_NOT_SIGNIFICANT' | 'SIGNIFICANCE_SIGNIFICANT';
+/** ControlGroupAnalyticsEvent contains Control-vs-Treatment metrics for a single event */
+export type ControlGroupAnalyticsEvent = {
+    /** Event name */
+    event: string;
+    /** Treatment group metrics */
+    treatment: ControlGroupAnalyticsGroup;
+    /** Control group metrics */
+    control: ControlGroupAnalyticsGroup;
+    /** Relative uplift of treatment over control, percent */
+    upliftPct: number;
+    /** Estimated events attributable to messaging */
+    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;
+};
+/** GetControlGroupAnalyticsResponse contains per-event Control-vs-Treatment analytics */
+export type GetControlGroupAnalyticsResponse = {
+    /** Per-event analytics rows */
+    events: ControlGroupAnalyticsEvent[];
+};