@pushwoosh/rpc-v2-http-api-data 0.2.322 → 0.2.323

package/data.js

@@ -13292,6 +13292,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/events:getTotalStatistics"
             },
+            "GetRevenueStatistics": {
+                "request": "pushwoosh.rpc_v2.events.GetRevenueStatisticsRequest",
+                "response": "pushwoosh.rpc_v2.events.GetRevenueStatisticsResponse",
+                "method": "post",
+                "path": "/api/events:getRevenueStatistics"
+            },
             "GetConversionSettings": {
                 "request": "pushwoosh.rpc_v2.events.GetConversionSettingsRequest",
                 "response": "pushwoosh.rpc_v2.events.ConversionSettings",
@@ -13340,6 +13346,14 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.events.RevenueMappingSource": {
+        "type": "E",
+        "values": [
+            "REVENUE_MAPPING_SOURCE_UNSPECIFIED",
+            "REVENUE_MAPPING_SOURCE_MANUAL",
+            "REVENUE_MAPPING_SOURCE_AUTO"
+        ]
+    },
     "pushwoosh.rpc_v2.events.RevenueMapping": {
         "type": "I",
         "fields": {
@@ -13354,6 +13368,12 @@ export const data = {
             },
             "productIdAttr": {
                 "type": "string"
+            },
+            "source": {
+                "type": "pushwoosh.rpc_v2.events.RevenueMappingSource"
+            },
+            "disabled": {
+                "type": "boolean"
             }
         }
     },
@@ -13757,6 +13777,59 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.events.GetRevenueStatisticsRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "events": {
+                "type": "string",
+                "array": true
+            },
+            "dateFrom": {
+                "type": "Date"
+            },
+            "dateTo": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.events.GetRevenueStatisticsResponse.CurrencyAmount": {
+        "type": "I",
+        "fields": {
+            "currency": {
+                "type": "string"
+            },
+            "amount": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.events.GetRevenueStatisticsResponse.EventRevenue": {
+        "type": "I",
+        "fields": {
+            "event": {
+                "type": "string"
+            },
+            "triggeredCount": {
+                "type": "number"
+            },
+            "incomeByCurrency": {
+                "type": "pushwoosh.rpc_v2.events.GetRevenueStatisticsResponse.CurrencyAmount",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.events.GetRevenueStatisticsResponse": {
+        "type": "I",
+        "fields": {
+            "metrics": {
+                "type": "pushwoosh.rpc_v2.events.GetRevenueStatisticsResponse.EventRevenue",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.events.ContactType": {
         "type": "E",
         "values": [

package/events.d.ts

@@ -8,6 +8,7 @@ export type EventsService_GetAttributeValues = RpcMethod<GetAttributeValuesReque
 export type EventsService_GetTriggeredCount = RpcMethod<GetTriggeredCountRequest, GetTriggeredCountResponse>;
 export type EventsService_GetDetailedStatistics = RpcMethod<GetDetailedStatisticsRequest, GetDetailedStatisticsResponse>;
 export type EventsService_GetTotalStatistics = RpcMethod<GetTotalStatisticsRequest, GetTotalStatisticsResponse>;
+export type EventsService_GetRevenueStatistics = RpcMethod<GetRevenueStatisticsRequest, GetRevenueStatisticsResponse>;
 export type EventsService_GetConversionSettings = RpcMethod<GetConversionSettingsRequest, ConversionSettings>;
 export type EventsService_SaveConversionSettings = RpcMethod<SaveConversionSettingsRequest, ConversionSettings>;
 export interface EventsService {
@@ -29,6 +30,8 @@ export interface EventsService {
     GetDetailedStatistics: EventsService_GetDetailedStatistics;
     /** Returns total and unique triggered counts for custom events over a date range, optionally scoped to a message code or campaign. Use to attribute event volume to a specific send or campaign. */
     GetTotalStatistics: EventsService_GetTotalStatistics;
+    /** Returns per-currency revenue totals and triggered counts for the revenue-mapped events of an application over a date range. Use to show how much revenue an event brought, kept in the original currencies. */
+    GetRevenueStatistics: EventsService_GetRevenueStatistics;
     /** Returns which custom events of an application count as conversions for campaign attribution, each with its attribution window, plus the contact type (click or send) conversions are counted from. Empty events means attribution is not configured yet. */
     GetConversionSettings: EventsService_GetConversionSettings;
     /** Replaces the conversion settings of an application: up to 3 events with an attribution window each (24h, 72h, 7d or 30d) and one contact type for all of them. Events left out of the request stop counting as conversions. */
@@ -45,6 +48,11 @@ export type EventAttribute = {
     name: string;
     type: EventAttribute_Type;
 };
+/**
+ * RevenueMappingSource is who created a revenue mapping: a user, the platform
+ * (system __amount/__currency attributes), or unset for rows predating the field.
+ */
+export type RevenueMappingSource = 'REVENUE_MAPPING_SOURCE_UNSPECIFIED' | 'REVENUE_MAPPING_SOURCE_MANUAL' | 'REVENUE_MAPPING_SOURCE_AUTO';
 /**
  * RevenueMapping maps a source event's attributes onto the normalized
  * PW_Conversion revenue slots. Each field holds the name of the source
@@ -55,6 +63,8 @@ export type RevenueMapping = {
     currencyAttr: string;
     transactionIdAttr: string;
     productIdAttr: string;
+    source: RevenueMappingSource;
+    disabled: boolean;
 };
 export type Event = {
     name: string;
@@ -229,6 +239,28 @@ export type GetTotalStatisticsResponse = {
     /** Distinct users across all events at once; metrics are per event, so summing their uniq counts double-counts. */
     totalUniqTriggeredCount: number;
 };
+export type GetRevenueStatisticsRequest = {
+    /** Application code (format XXXXX-XXXXX) whose revenue to count. */
+    application?: string;
+    /** Names of the custom events to report; empty returns every revenue-carrying event. */
+    events?: string[];
+    dateFrom?: Date;
+    dateTo?: Date;
+};
+export type GetRevenueStatisticsResponse_CurrencyAmount = {
+    /** ISO currency code, upper case. */
+    currency: string;
+    amount: number;
+};
+export type GetRevenueStatisticsResponse_EventRevenue = {
+    event: string;
+    triggeredCount: number;
+    /** Totals per original currency, no conversion applied. */
+    incomeByCurrency: GetRevenueStatisticsResponse_CurrencyAmount[];
+};
+export type GetRevenueStatisticsResponse = {
+    metrics: GetRevenueStatisticsResponse_EventRevenue[];
+};
 /** ContactType is the touch a conversion is counted from: the click on the message (default) or the send itself. */
 export type ContactType = 'CONTACT_TYPE_UNSPECIFIED' | 'CONTACT_TYPE_CLICK' | 'CONTACT_TYPE_SENT';
 export type ConversionEvent = {

package/package.json

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