@pushwoosh/rpc-gateway-statistics-api 1.3.876 → 1.3.877

package/data.js

@@ -2487,6 +2487,264 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v2.conversions.ConversionsService": {
+        "type": "S",
+        "key": "conversions",
+        "methods": {
+            "GetBoard": {
+                "request": "pushwoosh.statistics.statistics.v2.conversions.GetBoardRequest",
+                "response": "pushwoosh.statistics.statistics.v2.conversions.GetBoardResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/conversions/getBoard"
+            },
+            "GetJourney": {
+                "request": "pushwoosh.statistics.statistics.v2.conversions.GetJourneyRequest",
+                "response": "pushwoosh.statistics.statistics.v2.conversions.GetJourneyResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/conversions/getJourney"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.conversions.ContactType": {
+        "type": "E",
+        "values": [
+            "CONTACT_TYPE_UNSPECIFIED",
+            "CONTACT_TYPE_CLICK",
+            "CONTACT_TYPE_SENT"
+        ]
+    },
+    "pushwoosh.statistics.statistics.v2.conversions.CampaignType": {
+        "type": "E",
+        "values": [
+            "CAMPAIGN_TYPE_UNSPECIFIED",
+            "CAMPAIGN_TYPE_ONE_TIME",
+            "CAMPAIGN_TYPE_JOURNEY"
+        ]
+    },
+    "pushwoosh.statistics.statistics.v2.conversions.GetBoardRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "event": {
+                "type": "string"
+            },
+            "timestampFrom": {
+                "type": "Date"
+            },
+            "timestampTo": {
+                "type": "Date"
+            },
+            "attributionWindowSeconds": {
+                "type": "number"
+            },
+            "contactType": {
+                "type": "pushwoosh.statistics.statistics.v2.conversions.ContactType"
+            },
+            "campaignType": {
+                "type": "pushwoosh.statistics.statistics.v2.conversions.CampaignType"
+            },
+            "channel": {
+                "type": "string"
+            },
+            "currency": {
+                "type": "string"
+            },
+            "page": {
+                "type": "number"
+            },
+            "perPage": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.conversions.Row": {
+        "type": "I",
+        "fields": {
+            "messageId": {
+                "type": "number"
+            },
+            "campaignId": {
+                "type": "number"
+            },
+            "messageCode": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "sent": {
+                "type": "number"
+            },
+            "opened": {
+                "type": "number"
+            },
+            "clicked": {
+                "type": "number"
+            },
+            "conversions": {
+                "type": "number"
+            },
+            "uniqueUsers": {
+                "type": "number"
+            },
+            "revenue": {
+                "type": "pushwoosh.statistics.statistics.v2.conversions.Revenue",
+                "array": true
+            },
+            "campaignType": {
+                "type": "pushwoosh.statistics.statistics.v2.conversions.CampaignType"
+            },
+            "status": {
+                "type": "string"
+            },
+            "channels": {
+                "type": "string",
+                "array": true
+            },
+            "journeyUuid": {
+                "type": "string"
+            },
+            "conversionsWithoutCurrency": {
+                "type": "number"
+            },
+            "filtered": {
+                "type": "boolean"
+            },
+            "deleted": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.conversions.Revenue": {
+        "type": "I",
+        "fields": {
+            "currency": {
+                "type": "string"
+            },
+            "amount": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.conversions.GetBoardResponse.Totals": {
+        "type": "I",
+        "fields": {
+            "conversions": {
+                "type": "number"
+            },
+            "attributedConversions": {
+                "type": "number"
+            },
+            "uniqueUsers": {
+                "type": "number"
+            },
+            "revenue": {
+                "type": "pushwoosh.statistics.statistics.v2.conversions.Revenue",
+                "array": true
+            },
+            "conversionsWithoutCurrency": {
+                "type": "number"
+            },
+            "totalRevenue": {
+                "type": "pushwoosh.statistics.statistics.v2.conversions.Revenue",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.conversions.GetBoardResponse": {
+        "type": "I",
+        "fields": {
+            "totals": {
+                "type": "pushwoosh.statistics.statistics.v2.conversions.GetBoardResponse.Totals"
+            },
+            "rows": {
+                "type": "pushwoosh.statistics.statistics.v2.conversions.Row",
+                "array": true
+            },
+            "attributionWindowSeconds": {
+                "type": "number"
+            },
+            "contactType": {
+                "type": "pushwoosh.statistics.statistics.v2.conversions.ContactType"
+            },
+            "touchesFrom": {
+                "type": "Date"
+            },
+            "total": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.conversions.GetJourneyRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "event": {
+                "type": "string"
+            },
+            "journeyUuid": {
+                "type": "string"
+            },
+            "version": {
+                "type": "number"
+            },
+            "timestampFrom": {
+                "type": "Date"
+            },
+            "timestampTo": {
+                "type": "Date"
+            },
+            "attributionWindowSeconds": {
+                "type": "number"
+            },
+            "contactType": {
+                "type": "pushwoosh.statistics.statistics.v2.conversions.ContactType"
+            },
+            "currency": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.conversions.GetJourneyResponse.Version": {
+        "type": "I",
+        "fields": {
+            "number": {
+                "type": "number"
+            },
+            "uuid": {
+                "type": "string"
+            },
+            "activeFrom": {
+                "type": "Date"
+            },
+            "activeTo": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.conversions.GetJourneyResponse": {
+        "type": "I",
+        "fields": {
+            "title": {
+                "type": "string"
+            },
+            "versions": {
+                "type": "pushwoosh.statistics.statistics.v2.conversions.GetJourneyResponse.Version",
+                "array": true
+            },
+            "version": {
+                "type": "number"
+            },
+            "points": {
+                "type": "pushwoosh.statistics.statistics.v2.conversions.Row",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v2.dashboards.DashboardsService": {
         "type": "S",
         "key": "dashboards",
@@ -4887,12 +5145,6 @@ export const data = {
                 "response": "pushwoosh.statistics.statistics.v2.statistics.GetEmailCategoryPerformanceResponse",
                 "method": "post",
                 "path": "/api/v2/statistics/messages/getEmailCategoryPerformance"
-            },
-            "GetConversionsBoard": {
-                "request": "pushwoosh.statistics.statistics.v2.statistics.GetConversionsBoardRequest",
-                "response": "pushwoosh.statistics.statistics.v2.statistics.GetConversionsBoardResponse",
-                "method": "post",
-                "path": "/api/v2/statistics/messages/getConversionsBoard"
             }
         }
     },
@@ -6612,122 +6864,5 @@ export const data = {
                 "type": "Date"
             }
         }
-    },
-    "pushwoosh.statistics.statistics.v2.statistics.ContactType": {
-        "type": "E",
-        "values": [
-            "CONTACT_TYPE_UNSPECIFIED",
-            "CONTACT_TYPE_CLICK",
-            "CONTACT_TYPE_SENT"
-        ]
-    },
-    "pushwoosh.statistics.statistics.v2.statistics.GetConversionsBoardRequest": {
-        "type": "I",
-        "fields": {
-            "application": {
-                "type": "string"
-            },
-            "event": {
-                "type": "string"
-            },
-            "timestampFrom": {
-                "type": "Date"
-            },
-            "timestampTo": {
-                "type": "Date"
-            },
-            "attributionWindowSeconds": {
-                "type": "number"
-            },
-            "contactType": {
-                "type": "pushwoosh.statistics.statistics.v2.statistics.ContactType"
-            }
-        }
-    },
-    "pushwoosh.statistics.statistics.v2.statistics.GetConversionsBoardResponse.Revenue": {
-        "type": "I",
-        "fields": {
-            "currency": {
-                "type": "string"
-            },
-            "amount": {
-                "type": "number"
-            }
-        }
-    },
-    "pushwoosh.statistics.statistics.v2.statistics.GetConversionsBoardResponse.Row": {
-        "type": "I",
-        "fields": {
-            "messageId": {
-                "type": "number"
-            },
-            "campaignId": {
-                "type": "number"
-            },
-            "messageCode": {
-                "type": "string"
-            },
-            "name": {
-                "type": "string"
-            },
-            "sent": {
-                "type": "number"
-            },
-            "opened": {
-                "type": "number"
-            },
-            "clicked": {
-                "type": "number"
-            },
-            "conversions": {
-                "type": "number"
-            },
-            "uniqueUsers": {
-                "type": "number"
-            },
-            "revenue": {
-                "type": "pushwoosh.statistics.statistics.v2.statistics.GetConversionsBoardResponse.Revenue",
-                "array": true
-            }
-        }
-    },
-    "pushwoosh.statistics.statistics.v2.statistics.GetConversionsBoardResponse.Totals": {
-        "type": "I",
-        "fields": {
-            "conversions": {
-                "type": "number"
-            },
-            "attributedConversions": {
-                "type": "number"
-            },
-            "uniqueUsers": {
-                "type": "number"
-            },
-            "revenue": {
-                "type": "pushwoosh.statistics.statistics.v2.statistics.GetConversionsBoardResponse.Revenue",
-                "array": true
-            }
-        }
-    },
-    "pushwoosh.statistics.statistics.v2.statistics.GetConversionsBoardResponse": {
-        "type": "I",
-        "fields": {
-            "totals": {
-                "type": "pushwoosh.statistics.statistics.v2.statistics.GetConversionsBoardResponse.Totals"
-            },
-            "rows": {
-                "type": "pushwoosh.statistics.statistics.v2.statistics.GetConversionsBoardResponse.Row",
-                "array": true
-            },
-            "attributionWindowSeconds": {
-                "type": "number"
-            },
-            "contactType": {
-                "type": "pushwoosh.statistics.statistics.v2.statistics.ContactType"
-            },
-            "touchesFrom": {
-                "type": "Date"
-            }
-        }
     }
 };

package/index.d.ts

@@ -1,9 +1,11 @@
 import { StatisticsService as pushwoosh_statistics_statistics_v1_StatisticsService } from './pushwoosh_statistics_statistics_v1';
+import { ConversionsService as pushwoosh_statistics_statistics_v2_conversions_ConversionsService } from './pushwoosh_statistics_statistics_v2_conversions';
 import { DashboardsService as pushwoosh_statistics_statistics_v2_dashboards_DashboardsService } from './pushwoosh_statistics_statistics_v2_dashboards';
 import { OverviewKPIService as pushwoosh_statistics_statistics_v2_overviewkpi_OverviewKPIService } from './pushwoosh_statistics_statistics_v2_overviewkpi';
 import { StatisticsService as pushwoosh_statistics_statistics_v2_statistics_StatisticsService } from './pushwoosh_statistics_statistics_v2_statistics';
 export type API = {
     statisticsV1: pushwoosh_statistics_statistics_v1_StatisticsService;
+    conversions: pushwoosh_statistics_statistics_v2_conversions_ConversionsService;
     dashboards: pushwoosh_statistics_statistics_v2_dashboards_DashboardsService;
     overviewKPI: pushwoosh_statistics_statistics_v2_overviewkpi_OverviewKPIService;
     statisticsV2: pushwoosh_statistics_statistics_v2_statistics_StatisticsService;

package/package.json

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

package/pushwoosh_statistics_statistics_v2_conversions.d.ts

@@ -0,0 +1,149 @@
+import { RpcMethod } from './commonTypes';
+export type ConversionsService_GetBoard = RpcMethod<GetBoardRequest, GetBoardResponse>;
+export type ConversionsService_GetJourney = RpcMethod<GetJourneyRequest, GetJourneyResponse>;
+/**
+ * ConversionsService serves the Conversions board: conversions and revenue of an application's
+ * messages and journeys, each conversion credited to the user's last touch inside the attribution window
+ */
+export interface ConversionsService {
+    /** GetBoard returns the period totals and one page of rows, a row per message or journey. */
+    GetBoard: ConversionsService_GetBoard;
+    /** GetJourney returns one journey of the board broken down by the points of a chosen version. */
+    GetJourney: ConversionsService_GetJourney;
+}
+/** ContactType is the touch a conversion is credited to: the last send or the last click */
+export type ContactType = 'CONTACT_TYPE_UNSPECIFIED' | 'CONTACT_TYPE_CLICK' | 'CONTACT_TYPE_SENT';
+/** CampaignType tells what a board row is: a one-time message or a journey. */
+export type CampaignType = 'CAMPAIGN_TYPE_UNSPECIFIED' | 'CAMPAIGN_TYPE_ONE_TIME' | 'CAMPAIGN_TYPE_JOURNEY';
+/** GetBoardRequest asks for one page of the board of one conversion event */
+export type GetBoardRequest = {
+    /** Application Code */
+    application: string;
+    /** Name of one of the application's conversion events */
+    event: string;
+    /** Conversion time range start */
+    timestampFrom: Date;
+    /** Conversion time range end */
+    timestampTo: Date;
+    /** 86400, 259200, 604800 or 2592000; 0 reads as 259200 */
+    attributionWindowSeconds: number;
+    /** UNSPECIFIED reads as CLICK */
+    contactType: ContactType;
+    /** Keep only one-time messages or only journeys; UNSPECIFIED keeps both */
+    campaignType: CampaignType;
+    /** Keep messages of the channel and journeys' points of it, named as in Row.channels; empty keeps all */
+    channel: string;
+    /** Count only conversions carrying this currency (upper-case ISO code); empty keeps all */
+    currency: string;
+    /** 1-based page of rows; 0 reads as 1 */
+    page: number;
+    /** Rows per page; 0 reads as 20, 200 at most */
+    perPage: number;
+};
+/** Row is one message, journey or journey point on the board */
+export type Row = {
+    /** One-time message; 0 for a journey or a point */
+    messageId: number;
+    /** Journey point campaign; 0 for a one-time message or a whole journey */
+    campaignId: number;
+    messageCode: string;
+    /** Message title, journey title or point title */
+    name: string;
+    sent: number;
+    opened: number;
+    /** Email link clicks; 0 for channels without clicks */
+    clicked: number;
+    conversions: number;
+    uniqueUsers: number;
+    revenue: Revenue[];
+    campaignType: CampaignType;
+    /** active, paused or inactive; empty for a journey point */
+    status: string;
+    /** push, inbox, email, sms, whatsapp, fb_messenger, inapp, line, kakao, telegram, viber */
+    channels: string[];
+    /** Root version uuid of the journey; the key for GetJourney */
+    journeyUuid: string;
+    /** Conversions counted without revenue because the event carried no usable currency */
+    conversionsWithoutCurrency: number;
+    /** Journey row under a channel filter: only its points of that channel are counted */
+    filtered: boolean;
+    /** Journey point deleted from its version; what it earned still counts */
+    deleted: boolean;
+};
+/** Revenue is revenue in one currency, not converted */
+export type Revenue = {
+    /** Upper-case currency code as the events carried it */
+    currency: string;
+    /** Sum of the attributed conversions' amounts */
+    amount: number;
+};
+/**
+ * Totals of the period: conversions and total_revenue count every conversion of the event,
+ * attributed or not, whatever the filters; the rest sums the rows that passed campaign_type and channel
+ */
+export type GetBoardResponse_Totals = {
+    /** All conversions of the event in the period */
+    conversions: number;
+    /** Conversions credited to the rows that passed the filters */
+    attributedConversions: number;
+    /** Distinct users behind attributed_conversions */
+    uniqueUsers: number;
+    /** Revenue of attributed_conversions, per currency */
+    revenue: Revenue[];
+    /** Attributed conversions whose amount could not be counted */
+    conversionsWithoutCurrency: number;
+    /** Revenue of every conversion of the period, per currency */
+    totalRevenue: Revenue[];
+};
+/** GetBoardResponse contains the board totals and one page of rows */
+export type GetBoardResponse = {
+    totals: GetBoardResponse_Totals;
+    rows: Row[];
+    /** Effective window */
+    attributionWindowSeconds: number;
+    /** Effective contact type */
+    contactType: ContactType;
+    /** Touches are looked up from this moment: period start minus the window */
+    touchesFrom: Date;
+    /** Rows matching the filters, before paging */
+    total: number;
+};
+/** GetJourneyRequest asks for one journey of the board */
+export type GetJourneyRequest = {
+    /** Application Code */
+    application: string;
+    /** Conversion event name, as on the board */
+    event: string;
+    /** Root version uuid from a board row */
+    journeyUuid: string;
+    /** Journey version number; 0 reads as the latest */
+    version: number;
+    /** Conversion time range start */
+    timestampFrom: Date;
+    /** Conversion time range end */
+    timestampTo: Date;
+    /** Same values as on the board */
+    attributionWindowSeconds: number;
+    /** UNSPECIFIED reads as CLICK */
+    contactType: ContactType;
+    /** Keep revenue of one currency; empty keeps all */
+    currency: string;
+};
+export type GetJourneyResponse_Version = {
+    number: number;
+    uuid: string;
+    /** When the version was activated */
+    activeFrom: Date;
+    /** When the next version took over; unset for the current one */
+    activeTo: Date;
+};
+/** GetJourneyResponse contains the versions of the journey and the points of the chosen one */
+export type GetJourneyResponse = {
+    title: string;
+    /** Newest first */
+    versions: GetJourneyResponse_Version[];
+    /** Effective version */
+    version: number;
+    /** Points of the version, in journey order */
+    points: Row[];
+};

package/pushwoosh_statistics_statistics_v2_conversions.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export {};

package/pushwoosh_statistics_statistics_v2_statistics.d.ts

@@ -17,7 +17,6 @@ export type StatisticsService_GetCampaignDeliveryFunnel = RpcMethod<GetCampaignD
 export type StatisticsService_GetMessageDeliveryTimeline = RpcMethod<GetMessageDeliveryTimelineRequest, GetDeliveryTimelineResponse>;
 export type StatisticsService_GetCampaignDeliveryTimeline = RpcMethod<GetCampaignDeliveryTimelineRequest, GetDeliveryTimelineResponse>;
 export type StatisticsService_GetEmailCategoryPerformance = RpcMethod<GetEmailCategoryPerformanceRequest, GetEmailCategoryPerformanceResponse>;
-export type StatisticsService_GetConversionsBoard = RpcMethod<GetConversionsBoardRequest, GetConversionsBoardResponse>;
 /** StatisticsService provides various statistics operations */
 export interface StatisticsService {
     /** GetMessagesStatistics returns message statistics grouped by platform and time intervals */
@@ -69,11 +68,6 @@ export interface StatisticsService {
      * The caller names the categories; statistics only groups by the names it is given.
      */
     GetEmailCategoryPerformance: StatisticsService_GetEmailCategoryPerformance;
-    /**
-     * Campaign attribution board: conversions and revenue of an application's messages, each
-     * conversion credited to the last touch inside the attribution window (last touch).
-     */
-    GetConversionsBoard: StatisticsService_GetConversionsBoard;
 }
 /** EmailEventType represents different types of email delivery events */
 export type EmailEventType = 
@@ -1240,53 +1234,3 @@ export type GetEmailCategoryPerformanceResponse = {
     /** Window actually read */
     windowTo: Date;
 };
-export type ContactType = 'CONTACT_TYPE_UNSPECIFIED' | 'CONTACT_TYPE_CLICK' | 'CONTACT_TYPE_SENT';
-export type GetConversionsBoardRequest = {
-    /** Application Code */
-    application: string;
-    /** Conversion event name from the application's conversion settings */
-    event: string;
-    /** Conversion time range start */
-    timestampFrom: Date;
-    /** Conversion time range end */
-    timestampTo: Date;
-    /** Overrides the configured window; 0 keeps the setting */
-    attributionWindowSeconds: number;
-    /** Overrides the configured contact type; UNSPECIFIED keeps the setting */
-    contactType: ContactType;
-};
-export type GetConversionsBoardResponse_Revenue = {
-    currency: string;
-    amount: number;
-};
-export type GetConversionsBoardResponse_Row = {
-    messageId: number;
-    campaignId: number;
-    messageCode: string;
-    name: string;
-    sent: number;
-    opened: number;
-    clicked: number;
-    conversions: number;
-    uniqueUsers: number;
-    revenue: GetConversionsBoardResponse_Revenue[];
-};
-export type GetConversionsBoardResponse_Totals = {
-    /** All conversions of the event in the period */
-    conversions: number;
-    /** Conversions credited to a message */
-    attributedConversions: number;
-    uniqueUsers: number;
-    /** Revenue of attributed conversions */
-    revenue: GetConversionsBoardResponse_Revenue[];
-};
-export type GetConversionsBoardResponse = {
-    totals: GetConversionsBoardResponse_Totals;
-    rows: GetConversionsBoardResponse_Row[];
-    /** Effective window */
-    attributionWindowSeconds: number;
-    /** Effective contact type */
-    contactType: ContactType;
-    /** Touches are counted from this moment: period start minus the window */
-    touchesFrom: Date;
-};