@pushwoosh/rpc-gateway-statistics-api 1.3.738 → 1.3.740

package/data.js

@@ -3218,6 +3218,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/v2/statistics/messages/getCampaignLinkClicks"
             },
+            "GetBlockRevenue": {
+                "request": "pushwoosh.statistics.statistics.v2.statistics.GetBlockRevenueRequest",
+                "response": "pushwoosh.statistics.statistics.v2.statistics.GetBlockRevenueResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/messages/getBlockRevenue"
+            },
             "GetDeliveryReport": {
                 "request": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryReportRequest",
                 "response": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryReportResponse",
@@ -3613,6 +3619,58 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v2.statistics.GetBlockRevenueRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "messageCode": {
+                "type": "string"
+            },
+            "timestampFrom": {
+                "type": "Date"
+            },
+            "timestampTo": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.GetBlockRevenueResponse.BlockRevenue": {
+        "type": "I",
+        "fields": {
+            "block": {
+                "type": "string"
+            },
+            "strategy": {
+                "type": "string"
+            },
+            "clicks": {
+                "type": "number"
+            },
+            "uniqClicks": {
+                "type": "number"
+            },
+            "revenue": {
+                "type": "number"
+            },
+            "currency": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.GetBlockRevenueResponse": {
+        "type": "I",
+        "fields": {
+            "blocks": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.GetBlockRevenueResponse.BlockRevenue",
+                "array": true
+            },
+            "revenueTrackingConfigured": {
+                "type": "boolean"
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryReportRequest": {
         "type": "I",
         "fields": {
@@ -4137,6 +4195,9 @@ export const data = {
             },
             "confirmedDeliveries": {
                 "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.ConfirmedDeliveries"
+            },
+            "emailBounces": {
+                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.EmailBounces"
             }
         }
     },
@@ -4219,6 +4280,20 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.EmailBounces": {
+        "type": "I",
+        "fields": {
+            "hard": {
+                "type": "number"
+            },
+            "soft": {
+                "type": "number"
+            },
+            "alsoConfirmed": {
+                "type": "number"
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse": {
         "type": "I",
         "fields": {

package/package.json

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

package/pushwoosh_statistics_statistics_v2_statistics.d.ts

@@ -3,6 +3,7 @@ import { TimeInterval as pushwoosh_statistics_types_TimeInterval } from './pushw
 export type StatisticsService_GetMessagesStatistics = RpcMethod<GetMessagesStatisticsRequest, GetMessagesStatisticsResponse>;
 export type StatisticsService_GetCampaignStatistics = RpcMethod<GetCampaignStatisticsRequest, GetCampaignStatisticsResponse>;
 export type StatisticsService_GetCampaignLinkClicks = RpcMethod<GetCampaignLinkClicksRequest, GetCampaignLinkClicksResponse>;
+export type StatisticsService_GetBlockRevenue = RpcMethod<GetBlockRevenueRequest, GetBlockRevenueResponse>;
 export type StatisticsService_GetDeliveryReport = RpcMethod<GetDeliveryReportRequest, GetDeliveryReportResponse>;
 export type StatisticsService_GetErrorsStatistics = RpcMethod<GetErrorsStatisticsRequest, GetErrorsStatisticsResponse>;
 export type StatisticsService_GetJourneyMetrics = RpcMethod<GetJourneyMetricsRequest, GetJourneyMetricsResponse>;
@@ -22,6 +23,8 @@ export interface StatisticsService {
     GetCampaignStatistics: StatisticsService_GetCampaignStatistics;
     /** GetCampaignLinkClicks returns link click statistics for campaigns */
     GetCampaignLinkClicks: StatisticsService_GetCampaignLinkClicks;
+    /** GetBlockRevenue returns revenue attributed to the products blocks of a message */
+    GetBlockRevenue: StatisticsService_GetBlockRevenue;
     /** GetDeliveryReport returns delivery report with error details for campaigns */
     GetDeliveryReport: StatisticsService_GetDeliveryReport;
     /** GetErrorsStatistics returns error statistics over time for campaigns */
@@ -265,6 +268,44 @@ export type GetCampaignLinkClicksResponse = {
     /** Number of unique users who clicked */
     uniqClick: number;
 };
+/** GetBlockRevenueRequest represents a request for per-block revenue of a message */
+export type GetBlockRevenueRequest = {
+    /** Application Code */
+    application: string;
+    /** Specific message code */
+    messageCode: string;
+    /** Start of time range */
+    timestampFrom: Date;
+    /** End of time range */
+    timestampTo: Date;
+};
+/** BlockRevenue is one block's clicks and the revenue of the buyers who clicked it */
+export type GetBlockRevenueResponse_BlockRevenue = {
+    /** Block id carried by the product links (pw_block) */
+    block: string;
+    /** Ranking that produced the items (pw_strategy), empty for manual */
+    strategy: string;
+    /** Clicks on the block's product links */
+    clicks: number;
+    /** Recipients who clicked them */
+    uniqClicks: number;
+    /**
+     * Multi-touch: a buyer who clicked several blocks credits each of them in
+     * full, so block revenues do NOT add up to the message's total revenue.
+     */
+    revenue: number;
+    /** ISO 4217 code the revenue events carried */
+    currency: string;
+};
+/** GetBlockRevenueResponse contains revenue attributed to each products block */
+export type GetBlockRevenueResponse = {
+    blocks: GetBlockRevenueResponse_BlockRevenue[];
+    /**
+     * False when the account tracks no revenue at all: the UI shows a "revenue
+     * tracking is not set up" hint instead of a zero, which would read as "earned nothing".
+     */
+    revenueTrackingConfigured: boolean;
+};
 /** GetDeliveryReportRequest represents a request for delivery report with error details */
 export type GetDeliveryReportRequest = {
     /** Application Code */
@@ -615,6 +656,8 @@ export type GetMessageDeliveryFunnelResponse_ChannelFunnel = {
     deliveriesForm: GetMessageDeliveryFunnelResponse_DeliveriesForm;
     basicFormReason: GetMessageDeliveryFunnelResponse_BasicFormReason;
     confirmedDeliveries: GetMessageDeliveryFunnelResponse_ConfirmedDeliveries;
+    /** Email only, absent when not measured. Never a stage row — see EmailBounces. */
+    emailBounces: GetMessageDeliveryFunnelResponse_EmailBounces;
 };
 /**
  * PlatformCount is one platform's share of the number above it; the parent is always
@@ -663,6 +706,21 @@ export type GetMessageDeliveryFunnelResponse_ConfirmedDeliveries = {
     count: number;
     platforms: GetMessageDeliveryFunnelResponse_PlatformCount[];
 };
+/**
+ * EmailBounces is what the mail provider refused, in recipient addresses. It sits beside
+ * the stages and belongs to none of them, on purpose and never clamped.
+ */
+export type GetMessageDeliveryFunnelResponse_EmailBounces = {
+    /** at least one permanent refusal */
+    hard: number;
+    /** refused, never permanently */
+    soft: number;
+    /**
+     * Of hard+soft, how many also confirmed delivery, in any order, and so are counted
+     * inside CONFIRMED_BY_DEVICE too: the rest, hard + soft - also_confirmed, is not.
+     */
+    alsoConfirmed: number;
+};
 export type GetMessageDeliveryFunnelResponse = {
     /**
      * Channels are not ordered; a client looks one up by its channel field, not by