@pushwoosh/rpc-v2-http-api-data 0.2.126 → 0.2.128

package/data.js

@@ -17525,6 +17525,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/messages/statistics"
             },
+            "GetBlockRevenue": {
+                "request": "pushwoosh.rpc_v2.messages.GetBlockRevenueRequest",
+                "response": "pushwoosh.rpc_v2.messages.GetBlockRevenueResponse",
+                "method": "post",
+                "path": "/api/messages/blockRevenue"
+            },
             "GetLinkClicksStatistics": {
                 "request": "pushwoosh.rpc_v2.messages.GetLinkClicksStatisticsRequest",
                 "response": "pushwoosh.rpc_v2.messages.GetLinkClicksStatisticsResponse",
@@ -17883,6 +17889,58 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.messages.GetBlockRevenueRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "messageCode": {
+                "type": "string"
+            },
+            "timestampFrom": {
+                "type": "Date"
+            },
+            "timestampTo": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.messages.GetBlockRevenueResponse.BlockRevenue": {
+        "type": "I",
+        "fields": {
+            "block": {
+                "type": "string"
+            },
+            "strategy": {
+                "type": "string"
+            },
+            "clicks": {
+                "type": "number"
+            },
+            "uniqClicks": {
+                "type": "number"
+            },
+            "revenue": {
+                "type": "number"
+            },
+            "currency": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.messages.GetBlockRevenueResponse": {
+        "type": "I",
+        "fields": {
+            "blocks": {
+                "type": "pushwoosh.rpc_v2.messages.GetBlockRevenueResponse.BlockRevenue",
+                "array": true
+            },
+            "revenueTrackingConfigured": {
+                "type": "boolean"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.messages.GetLinkClicksStatisticsRequest": {
         "type": "I",
         "fields": {

package/messages.d.ts

@@ -4,6 +4,7 @@ export type MessagesService_Get = RpcMethod<GetMessageRequest, GetMessageRespons
 export type MessagesService_Cancel = RpcMethod<CancelMessageRequest, CancelMessageResponse>;
 export type MessagesService_Delete = RpcMethod<DeleteMessageRequest, DeleteMessageResponse>;
 export type MessagesService_GetStatistics = RpcMethod<GetStatisticsRequest, GetStatisticsResponse>;
+export type MessagesService_GetBlockRevenue = RpcMethod<GetBlockRevenueRequest, GetBlockRevenueResponse>;
 export type MessagesService_GetLinkClicksStatistics = RpcMethod<GetLinkClicksStatisticsRequest, GetLinkClicksStatisticsResponse>;
 export type MessagesService_GetDeliveryReport = RpcMethod<GetDeliveryReportRequest, GetDeliveryReportResponse>;
 export type MessagesService_FindRecipients = RpcMethod<FindRecipientsRequest, FindRecipientsResponse>;
@@ -21,6 +22,8 @@ export interface MessagesService {
     Delete: MessagesService_Delete;
     /** Returns aggregate delivery and open time-series plus recipient counts for a single message (by message_code) or a whole campaign, over an optional time range. For one send's delivered/opened numbers pass message_code. */
     GetStatistics: MessagesService_GetStatistics;
+    /** Returns per-block clicks and the revenue of the recipients who clicked them, for one message's products blocks. Revenues are multi-touch and do not add up to the message total. */
+    GetBlockRevenue: MessagesService_GetBlockRevenue;
     /** Returns per-link click counts (total and unique) for a message or campaign. Use to see which links in the content were clicked and how often. */
     GetLinkClicksStatistics: MessagesService_GetLinkClicksStatistics;
     /** Returns per-platform delivery error breakdowns (sender and mailbox errors) for a message or campaign over a time range. Use to diagnose why a send under-delivered. */
@@ -146,6 +149,41 @@ export type GetStatisticsResponse_Metrics = {
 export type GetStatisticsResponse = {
     metrics: GetStatisticsResponse_Metrics;
 };
+export type GetBlockRevenueRequest = {
+    /** Application code (format XXXXX-XXXXX). */
+    application?: string;
+    /** Message code to scope the report to a single send. */
+    messageCode?: string;
+    timestampFrom?: Date;
+    timestampTo?: Date;
+};
+/**
+ * One products block of the message and the revenue of the recipients 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 products. */
+    strategy: string;
+    clicks: number;
+    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;
+};
+export type GetBlockRevenueResponse = {
+    blocks: GetBlockRevenueResponse_BlockRevenue[];
+    /**
+     * False when the account tracks no revenue: the UI says so instead of showing
+     * a zero, which would read as "the block earned nothing".
+     */
+    revenueTrackingConfigured: boolean;
+};
 export type GetLinkClicksStatisticsRequest = {
     /** Application code (format XXXXX-XXXXX). Optional if application_group is set. */
     application?: string;

package/package.json

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