@pushwoosh/rpc-v2-http-api-data 0.2.107 → 0.2.109

package/data.js

@@ -25374,7 +25374,8 @@ export const data = {
             "TAG_VALUES",
             "CAMPAIGNS",
             "MESSAGES",
-            "JOURNEYS"
+            "JOURNEYS",
+            "SEGMENTS"
         ]
     },
     "pushwoosh.rpc_v2.statistics_dashboards_widgets.MathOperator": {
@@ -25617,6 +25618,12 @@ export const data = {
             },
             "timezone": {
                 "type": "string"
+            },
+            "includeAllOneTime": {
+                "type": "boolean"
+            },
+            "includeAllJourneys": {
+                "type": "boolean"
             }
         }
     },
@@ -25665,6 +25672,10 @@ export const data = {
             "metrics": {
                 "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetLinearChartMetricsResponse.Metric",
                 "array": true
+            },
+            "notPreparedSegments": {
+                "type": "string",
+                "array": true
             }
         }
     },
@@ -25708,6 +25719,10 @@ export const data = {
             "metrics": {
                 "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetTotalsChartMetricsResponse.Metric",
                 "array": true
+            },
+            "notPreparedSegments": {
+                "type": "string",
+                "array": true
             }
         }
     },

package/package.json

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

package/statistics_dashboards_widgets.d.ts

@@ -191,7 +191,13 @@ export type Breakdown =
  * To split data by journeys.
  * Applicable to: Metrics that support journey filtering.
  */
- | 'JOURNEYS';
+ | 'JOURNEYS'
+/**
+ * To compare cohorts: every prepared segment from fltrs becomes its own series
+ * named after the segment, instead of the segments being merged into one.
+ * Applicable to: Metrics that support segment filtering (events, revenue, push/email).
+ */
+ | 'SEGMENTS';
 export type MathOperator = 'MATH_OPERATOR_UNSPECIFIED' | 'EQ' | 'NOT_EQ' | 'GTE' | 'LTE' | 'BETWEEN' | 'IN' | 'NOT_IN' | 'ANY' | 'NOT_SET';
 export type Value_kind_string = {
     type: 'string';
@@ -322,7 +328,7 @@ export type ChartParams_Filter = {
 };
 export type ChartParams_BreakdownParams = {
     /**
-     * Type of breakdown to apply (BREAKDOWN_UNKNOWN, PLATFORMS, EVENT_ATTRIBUTE, TAG_VALUES, CAMPAIGNS, MESSAGES, JOURNEYS).
+     * Type of breakdown to apply (BREAKDOWN_UNKNOWN, PLATFORMS, EVENT_ATTRIBUTE, TAG_VALUES, CAMPAIGNS, MESSAGES, JOURNEYS, SEGMENTS).
      * Determines how data is segmented in the response.
      * CRITICAL RULE: If a breakdown is applied to a chart, that chart MUST display ONLY ONE metric.
      * The breakdown.type chosen MUST correspond to the metric type being broken down.
@@ -376,6 +382,12 @@ export type ChartParams = {
      * Used to correctly bucket data into time intervals.
      */
     timezone: string;
+    /**
+     * Scope event metrics by message source: exactly one true narrows the chart to
+     * that source, both true or both false leave it unrestricted.
+     */
+    includeAllOneTime: boolean;
+    includeAllJourneys: boolean;
 };
 export type GetLinearChartMetricsRequest = {
     /**
@@ -404,6 +416,12 @@ export type GetLinearChartMetricsResponse = {
     timestamps: Date[];
     /** List of metrics with their breakdown data. Each metric can have multiple breakdowns. */
     metrics: GetLinearChartMetricsResponse_Metric[];
+    /**
+     * Codes of the requested segments whose snapshot is not prepared. Their filtering
+     * was NOT applied to the returned metrics, so the numbers must not be presented
+     * as filtered by those segments.
+     */
+    notPreparedSegments: string[];
 };
 export type GetTotalsChartMetricsRequest = {
     /**
@@ -430,6 +448,12 @@ export type GetTotalsChartMetricsResponse_Metric = {
 export type GetTotalsChartMetricsResponse = {
     /** List of metrics with their aggregated total values and breakdowns. */
     metrics: GetTotalsChartMetricsResponse_Metric[];
+    /**
+     * Codes of the requested segments whose snapshot is not prepared. Their filtering
+     * was NOT applied to the returned metrics, so the numbers must not be presented
+     * as filtered by those segments.
+     */
+    notPreparedSegments: string[];
 };
 export type GetFunnelRequest = {
     /**