@pushwoosh/rpc-v2-http-api-data 0.2.43 → 0.2.45

package/applications.d.ts

@@ -16,6 +16,7 @@ export type ApplicationsService_UpdateControlGroupPercentage = RpcMethod<UpdateC
 export type ApplicationsService_DisableControlGroup = RpcMethod<DisableControlGroupRequest, DisableControlGroupResponse>;
 export type ApplicationsService_ForceUpdateControlGroupCalculation = RpcMethod<ForceUpdateControlGroupCalculationRequest, ForceUpdateControlGroupCalculationResponse>;
 export type ApplicationsService_GetControlGroupCalculationStatus = RpcMethod<GetControlGroupCalculationStatusRequest, GetControlGroupCalculationStatusResponse>;
+export type ApplicationsService_GetControlGroupAnalytics = RpcMethod<GetControlGroupAnalyticsRequest, GetControlGroupAnalyticsResponse>;
 export type ApplicationsService_GetDOIConfig = RpcMethod<GetDOIConfigRequest, GetDOIConfigResponse>;
 export type ApplicationsService_SetDOIConfig = RpcMethod<SetDOIConfigRequest, SetDOIConfigResponse>;
 export interface ApplicationsService {
@@ -35,6 +36,7 @@ export interface ApplicationsService {
     DisableControlGroup: ApplicationsService_DisableControlGroup;
     ForceUpdateControlGroupCalculation: ApplicationsService_ForceUpdateControlGroupCalculation;
     GetControlGroupCalculationStatus: ApplicationsService_GetControlGroupCalculationStatus;
+    GetControlGroupAnalytics: ApplicationsService_GetControlGroupAnalytics;
     GetDOIConfig: ApplicationsService_GetDOIConfig;
     SetDOIConfig: ApplicationsService_SetDOIConfig;
 }
@@ -215,6 +217,37 @@ export type ShuffleControlGroupRequest = {
     code: string;
 };
 export type ShuffleControlGroupResponse = {};
+export type GetControlGroupAnalyticsRequest_WindowDays = 'WINDOW_DAYS_UNSPECIFIED' | 'WINDOW_DAYS_3' | 'WINDOW_DAYS_7' | 'WINDOW_DAYS_30';
+/**
+ * GetControlGroupAnalyticsRequest asks for the precomputed Control-vs-Treatment
+ * analytics for a window preset (3/7/30 days).
+ */
+export type GetControlGroupAnalyticsRequest = {
+    code?: string;
+    windowDays?: GetControlGroupAnalyticsRequest_WindowDays;
+};
+export type ControlGroupAnalyticsGroup = {
+    users: number;
+    conversions: number;
+    conversionRate: number;
+    eventsPerUser: number;
+};
+export type ControlGroupAnalyticsEvent_Significance = 'SIGNIFICANCE_UNSPECIFIED' | 'SIGNIFICANCE_NOT_ENOUGH_DATA' | 'SIGNIFICANCE_NOT_SIGNIFICANT' | 'SIGNIFICANCE_SIGNIFICANT';
+export type ControlGroupAnalyticsEvent = {
+    event: string;
+    treatment: ControlGroupAnalyticsGroup;
+    control: ControlGroupAnalyticsGroup;
+    upliftPct: number;
+    incrementalEvents: number;
+    percentOfTreatment: number;
+    zScore: number;
+    pValue: number;
+    confidencePct: number;
+    significance: ControlGroupAnalyticsEvent_Significance;
+};
+export type GetControlGroupAnalyticsResponse = {
+    events: ControlGroupAnalyticsEvent[];
+};
 export type DoubleOptInConfig = {
     enabled: boolean;
     emailPreset: string;

package/data.js

@@ -2651,6 +2651,12 @@ export const data = {
                 "method": "get",
                 "path": "/api/applications/{code}/control_group/calculation_status"
             },
+            "GetControlGroupAnalytics": {
+                "request": "pushwoosh.rpc_v2.applications.GetControlGroupAnalyticsRequest",
+                "response": "pushwoosh.rpc_v2.applications.GetControlGroupAnalyticsResponse",
+                "method": "get",
+                "path": "/api/applications/{code}/control_group/analytics"
+            },
             "GetDOIConfig": {
                 "request": "pushwoosh.rpc_v2.applications.GetDOIConfigRequest",
                 "response": "pushwoosh.rpc_v2.applications.GetDOIConfigResponse",
@@ -3147,6 +3153,96 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.applications.GetControlGroupAnalyticsRequest.WindowDays": {
+        "type": "E",
+        "values": [
+            "WINDOW_DAYS_UNSPECIFIED",
+            "WINDOW_DAYS_3",
+            "WINDOW_DAYS_7",
+            "WINDOW_DAYS_30"
+        ]
+    },
+    "pushwoosh.rpc_v2.applications.GetControlGroupAnalyticsRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "windowDays": {
+                "type": "pushwoosh.rpc_v2.applications.GetControlGroupAnalyticsRequest.WindowDays"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications.ControlGroupAnalyticsGroup": {
+        "type": "I",
+        "fields": {
+            "users": {
+                "type": "number"
+            },
+            "conversions": {
+                "type": "number"
+            },
+            "conversionRate": {
+                "type": "number"
+            },
+            "eventsPerUser": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications.ControlGroupAnalyticsEvent.Significance": {
+        "type": "E",
+        "values": [
+            "SIGNIFICANCE_UNSPECIFIED",
+            "SIGNIFICANCE_NOT_ENOUGH_DATA",
+            "SIGNIFICANCE_NOT_SIGNIFICANT",
+            "SIGNIFICANCE_SIGNIFICANT"
+        ]
+    },
+    "pushwoosh.rpc_v2.applications.ControlGroupAnalyticsEvent": {
+        "type": "I",
+        "fields": {
+            "event": {
+                "type": "string"
+            },
+            "treatment": {
+                "type": "pushwoosh.rpc_v2.applications.ControlGroupAnalyticsGroup"
+            },
+            "control": {
+                "type": "pushwoosh.rpc_v2.applications.ControlGroupAnalyticsGroup"
+            },
+            "upliftPct": {
+                "type": "number"
+            },
+            "incrementalEvents": {
+                "type": "number"
+            },
+            "percentOfTreatment": {
+                "type": "number"
+            },
+            "zScore": {
+                "type": "number"
+            },
+            "pValue": {
+                "type": "number"
+            },
+            "confidencePct": {
+                "type": "number"
+            },
+            "significance": {
+                "type": "pushwoosh.rpc_v2.applications.ControlGroupAnalyticsEvent.Significance"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications.GetControlGroupAnalyticsResponse": {
+        "type": "I",
+        "fields": {
+            "events": {
+                "type": "pushwoosh.rpc_v2.applications.ControlGroupAnalyticsEvent",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.applications.DoubleOptInConfig": {
         "type": "I",
         "fields": {

package/package.json

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

package/rich_medias.d.ts

@@ -252,7 +252,7 @@ export type CreateResponse = {
 export type CreateNativeRequest = {
     /** Name of Rich Media. */
     name?: string;
-    /** Content of native-config.json: json object with displayName and the matching display block. */
+    /** Content of native-config.json: json object with displayType and the matching display block. */
     content?: string;
     /** Json object of localizations keyed by language code, e.g. {"en": {...}}. */
     localization?: string;
@@ -268,7 +268,7 @@ export type UpdateNativeRequest = {
     code?: string;
     /** Name of Rich Media. */
     name?: string;
-    /** Content of native-config.json: json object with displayName and the matching display block. */
+    /** Content of native-config.json: json object with displayType and the matching display block. */
     content?: string;
     /** Json object of localizations keyed by language code, e.g. {"en": {...}}. */
     localization?: string;