@pushwoosh/rpc-gateway-statistics-api 1.3.815 → 1.3.817

package/data.js

@@ -3924,6 +3924,26 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetUserMessageMetricsResponse.Unique": {
+        "type": "I",
+        "fields": {
+            "sends": {
+                "type": "number"
+            },
+            "deliveries": {
+                "type": "number"
+            },
+            "errors": {
+                "type": "number"
+            },
+            "opens": {
+                "type": "number"
+            },
+            "deliveryRatePercent": {
+                "type": "number"
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v2.overviewkpi.GetUserMessageMetricsResponse.Platform": {
         "type": "I",
         "fields": {
@@ -3941,6 +3961,12 @@ export const data = {
             },
             "deliveryRatePercent": {
                 "type": "number"
+            },
+            "opens": {
+                "type": "number"
+            },
+            "unique": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.GetUserMessageMetricsResponse.Unique"
             }
         }
     },
@@ -3968,6 +3994,12 @@ export const data = {
             },
             "dataAvailable": {
                 "type": "boolean"
+            },
+            "opens": {
+                "type": "number"
+            },
+            "unique": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.GetUserMessageMetricsResponse.Unique"
             }
         }
     },
@@ -4082,6 +4114,12 @@ 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"
             }
         }
     },
@@ -5719,5 +5757,122 @@ 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/package.json

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

package/pushwoosh_statistics_statistics_v2_overviewkpi.d.ts

@@ -185,12 +185,25 @@ export type GetUserMessageMetricsRequest = {
     dayFrom: Date;
     dayTo: Date;
 };
+/**
+ * the same tiles with every user counted once over the whole period instead
+ * of once a day; a sum of daily counts is not a headcount
+ */
+export type GetUserMessageMetricsResponse_Unique = {
+    sends: number;
+    deliveries: number;
+    errors: number;
+    opens: number;
+    deliveryRatePercent: number;
+};
 export type GetUserMessageMetricsResponse_Platform = {
     platformId: number;
     sends: number;
     deliveries: number;
     errors: number;
     deliveryRatePercent: number;
+    opens: number;
+    unique: GetUserMessageMetricsResponse_Unique;
 };
 export type GetUserMessageMetricsResponse = {
     /** users the gateway was asked for: the ones it took plus the ones it refused */
@@ -213,4 +226,10 @@ export type GetUserMessageMetricsResponse = {
     firstWrittenDay: Date;
     /** false when the mart has nothing for this application at all */
     dataAvailable: boolean;
+    /**
+     * opens of the period, counted on the day of the open rather than of the
+     * send, so opens and sends of one period do not reconcile
+     */
+    opens: number;
+    unique: GetUserMessageMetricsResponse_Unique;
 };

package/pushwoosh_statistics_statistics_v2_statistics.d.ts

@@ -18,6 +18,7 @@ export type StatisticsService_GetMessageDeliveryTimeline = RpcMethod<GetMessageD
 export type StatisticsService_GetCampaignDeliveryTimeline = RpcMethod<GetCampaignDeliveryTimelineRequest, GetDeliveryTimelineResponse>;
 export type StatisticsService_GetActiveAudience = RpcMethod<GetActiveAudienceRequest, GetActiveAudienceResponse>;
 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 */
@@ -71,6 +72,11 @@ 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 = 
@@ -1177,3 +1183,53 @@ 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;
+};