@pushwoosh/rpc-gateway-statistics-api 1.3.900 → 1.3.901

package/data.js

@@ -897,6 +897,9 @@ export const data = {
             "platformIds": {
                 "type": "number",
                 "array": true
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -2346,6 +2349,9 @@ export const data = {
             },
             "dateRange": {
                 "type": "pushwoosh.statistics.types.DateRange"
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -2398,6 +2404,9 @@ export const data = {
             },
             "params": {
                 "type": "pushwoosh.statistics.statistics.v1.EmailLinkParams"
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -2557,6 +2566,9 @@ export const data = {
             },
             "perPage": {
                 "type": "number"
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -2710,6 +2722,9 @@ export const data = {
             },
             "currency": {
                 "type": "string"
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -3018,6 +3033,9 @@ export const data = {
         "fields": {
             "params": {
                 "type": "pushwoosh.statistics.statistics.v2.dashboards.ChartParams"
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -3070,6 +3088,9 @@ export const data = {
         "fields": {
             "params": {
                 "type": "pushwoosh.statistics.statistics.v2.dashboards.ChartParams"
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -4534,6 +4555,9 @@ export const data = {
             },
             "dayTo": {
                 "type": "Date"
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -4626,6 +4650,9 @@ export const data = {
             },
             "dayTo": {
                 "type": "Date"
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -4668,6 +4695,9 @@ export const data = {
             },
             "dayTo": {
                 "type": "Date"
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -5430,6 +5460,9 @@ export const data = {
             },
             "timezone": {
                 "type": "string"
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -5528,6 +5561,9 @@ export const data = {
             },
             "timestampTo": {
                 "type": "Date"
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -5587,6 +5623,9 @@ export const data = {
             },
             "timestampTo": {
                 "type": "Date"
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -6092,6 +6131,9 @@ export const data = {
             "platforms": {
                 "type": "number",
                 "array": true
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -6353,6 +6395,9 @@ export const data = {
             "platforms": {
                 "type": "number",
                 "array": true
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -6374,6 +6419,9 @@ export const data = {
             },
             "to": {
                 "type": "Date"
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },
@@ -6395,6 +6443,9 @@ export const data = {
             },
             "to": {
                 "type": "Date"
+            },
+            "includeBots": {
+                "type": "boolean"
             }
         }
     },

package/package.json

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

package/pushwoosh_statistics_statistics_v1.d.ts

@@ -356,6 +356,8 @@ export type GetMessagesTotalStatisticsCPRequest = {
     interval: pushwoosh_statistics_types_TimeInterval;
     /** platforms to count; empty keeps every platform of the application */
     platformIds: number[];
+    /** Counts email clicks and opens labelled as bots; by default they are left out. */
+    includeBots: boolean;
 };
 export type ShortMessageMetric = {
     sent: number;
@@ -993,6 +995,8 @@ export type EmailLinkParams = {
 export type GetAdCampaignStatisticsRequest = {
     campaignId: number;
     dateRange: pushwoosh_statistics_types_DateRange;
+    /** Counts email clicks and opens labelled as bots; by default they are left out. */
+    includeBots: boolean;
 };
 /**
  * One row per creative of the campaign. Opens are opens of the letters that
@@ -1028,6 +1032,8 @@ export type GetAdCampaignStatisticsResponse = {
 export type GetEmailLinkStatisticsRequest = {
     filters: EmailLinkFilter;
     params: EmailLinkParams;
+    /** Counts email clicks and opens labelled as bots; by default they are left out. */
+    includeBots: boolean;
 };
 export type FullLinkStatistics = {
     fullLink: string;

package/pushwoosh_statistics_statistics_v2_conversions.d.ts

@@ -42,6 +42,8 @@ export type GetBoardRequest = {
     page: number;
     /** Rows per page; 0 reads as 20, 200 at most */
     perPage: number;
+    /** Count email clicks and opens labelled as bots; false leaves them out */
+    includeBots: boolean;
 };
 /** Row is one message, in-app, journey or journey point on the board */
 export type Row = {
@@ -135,6 +137,8 @@ export type GetJourneyRequest = {
     contactType: ContactType;
     /** Keep revenue of one currency; empty keeps all */
     currency: string;
+    /** Count email clicks and opens labelled as bots; false leaves them out */
+    includeBots: boolean;
 };
 export type GetJourneyResponse_Version = {
     number: number;

package/pushwoosh_statistics_statistics_v2_dashboards.d.ts

@@ -101,6 +101,8 @@ export type ChartParams = {
 };
 export type GetLinearChartMetricsRequest = {
     params: ChartParams;
+    /** Counts email clicks and opens labelled as bots; by default they are left out. */
+    includeBots: boolean;
 };
 export type GetLinearChartMetricsResponse_Breakdown = {
     breakdown: string;
@@ -122,6 +124,8 @@ export type GetLinearChartMetricsResponse = {
 };
 export type GetTotalsChartMetricsRequest = {
     params: ChartParams;
+    /** Counts email clicks and opens labelled as bots; by default they are left out. */
+    includeBots: boolean;
 };
 export type GetTotalsChartMetricsResponse_Breakdown = {
     breakdown: string;

package/pushwoosh_statistics_statistics_v2_overviewkpi.d.ts

@@ -286,6 +286,8 @@ export type GetEmailActivityDistributionRequest = {
     applicationCode: string;
     dayFrom: Date;
     dayTo: Date;
+    /** Counts email clicks and opens labelled as bots; by default they are left out. */
+    includeBots: boolean;
 };
 export type GetEmailActivityDistributionResponse = {
     /** users of the base, taken from the last snapshot day the writer has filled */
@@ -342,6 +344,8 @@ export type GetEmailPerformanceRequest = {
     applicationCode: string;
     dayFrom: Date;
     dayTo: Date;
+    /** Counts email clicks and opens labelled as bots; by default they are left out. */
+    includeBots: boolean;
 };
 /** EmailPerformanceCounts is one counting unit of the four numbers the tiles divide. */
 export type EmailPerformanceCounts = {
@@ -361,6 +365,8 @@ export type GetEmailCategoryStatsRequest = {
     applicationCode: string;
     dayFrom: Date;
     dayTo: Date;
+    /** Counts email clicks and opens labelled as bots; by default they are left out. */
+    includeBots: boolean;
 };
 /**
  * EmailCategoryStats is one row of the table. An empty code is the letters that

package/pushwoosh_statistics_statistics_v2_statistics.d.ts

@@ -194,6 +194,8 @@ export type GetCampaignStatisticsRequest = {
     interval: pushwoosh_statistics_types_TimeInterval;
     /** Timezone for displaying timestamps */
     timezone: string;
+    /** Counts email clicks and opens labelled as bots; by default they are left out. */
+    includeBots: boolean;
 };
 /** Breakdown contains platform-specific values over time */
 export type GetCampaignStatisticsResponse_PlatformTimeSeries_Breakdown = {
@@ -255,6 +257,8 @@ export type GetCampaignLinkClicksRequest = {
     timestampFrom: Date;
     /** End of time range */
     timestampTo: Date;
+    /** Counts email clicks and opens labelled as bots; by default they are left out. */
+    includeBots: boolean;
 };
 /** Attributes represents URL parameters and their click counts */
 export type GetCampaignLinkClicksResponse_LinkClick_Attributes = {
@@ -296,6 +300,8 @@ export type GetBlockRevenueRequest = {
     timestampFrom: Date;
     /** End of time range */
     timestampTo: Date;
+    /** Counts email clicks and opens labelled as bots; by default they are left out. */
+    includeBots: boolean;
 };
 /** BlockRevenue is one block's clicks and the revenue of the buyers who clicked it */
 export type GetBlockRevenueResponse_BlockRevenue = {
@@ -599,6 +605,12 @@ export type GetMessageDeliveryFunnelRequest = {
     messageCode: string;
     /** Optional platform ID filter */
     platforms: number[];
+    /**
+     * No interval: the funnel has no time axis, see GetMessageDeliveryTimeline. The
+     * platform split is always returned, so there is no flag to ask for it.
+     * Counts email clicks and opens labelled as bots; by default they are left out.
+     */
+    includeBots: boolean;
 };
 /**
  * Stage is a funnel level. Stages always come in the order they appear in the
@@ -831,6 +843,8 @@ export type GetCampaignDeliveryFunnelRequest = {
     campaignCode: string;
     /** Optional platform ID filter */
     platforms: number[];
+    /** Counts email clicks and opens labelled as bots; by default they are left out. */
+    includeBots: boolean;
 };
 /**
  * GetMessageDeliveryTimelineRequest asks for one message's metrics over time. Unlike
@@ -852,6 +866,8 @@ export type GetMessageDeliveryTimelineRequest = {
      */
     from: Date;
     to: Date;
+    /** Counts email clicks and opens labelled as bots; by default they are left out. */
+    includeBots: boolean;
 };
 /**
  * GetCampaignDeliveryTimelineRequest asks for one campaign's metrics over time. Same
@@ -873,6 +889,8 @@ export type GetCampaignDeliveryTimelineRequest = {
      */
     from: Date;
     to: Date;
+    /** Counts email clicks and opens labelled as bots; by default they are left out. */
+    includeBots: boolean;
 };
 /**
  * Metric is one line of the chart. Metrics, not funnel stages: STAGE_DELIVERIES