@pushwoosh/rpc-v2-http-api-data 0.2.152 → 0.2.153

package/applications_statistics.d.ts

@@ -4,6 +4,7 @@ export type ApplicationsStatisticsService_GetMAUStatistics = RpcMethod<GetMAUSta
 export type ApplicationsStatisticsService_GetDAUStatistics = RpcMethod<GetDAUStatisticsRequest, GetDAUStatisticsResponse>;
 export type ApplicationsStatisticsService_GetPushApplicationStatistics = RpcMethod<GetPushApplicationStatisticsRequest, GetPushApplicationStatisticsResponse>;
 export type ApplicationsStatisticsService_GetEmailApplicationStatistics = RpcMethod<GetEmailApplicationStatisticsRequest, GetEmailApplicationStatisticsResponse>;
+export type ApplicationsStatisticsService_GetEmailCategoryPerformance = RpcMethod<GetEmailCategoryPerformanceRequest, GetEmailCategoryPerformanceResponse>;
 export interface ApplicationsStatisticsService {
     /** Returns the total registered-users time series for an application (application code XXXXX-XXXXX). Use for the overall audience-size trend; use get_application_mau_statistics or get_application_dau_statistics for active-user counts. */
     GetUsersStatistics: ApplicationsStatisticsService_GetUsersStatistics;
@@ -15,6 +16,8 @@ export interface ApplicationsStatisticsService {
     GetPushApplicationStatistics: ApplicationsStatisticsService_GetPushApplicationStatistics;
     /** Returns per-platform email time series (total devices, sends, open rate) for an application (application code XXXXX-XXXXX). Use for the email channel dashboard; use get_application_push_statistics for the push channel. */
     GetEmailApplicationStatistics: ApplicationsStatisticsService_GetEmailApplicationStatistics;
+    /** Returns one row per email category of an application (application code XXXXX-XXXXX): sends, openers, clickers and unsubscribes over the period. Use for the email category table of project statistics. */
+    GetEmailCategoryPerformance: ApplicationsStatisticsService_GetEmailCategoryPerformance;
 }
 export type TimeInterval = 'TIME_INTERVAL_UNSPECIFIED' | 'TIME_INTERVAL_HOUR' | 'TIME_INTERVAL_DAY' | 'TIME_INTERVAL_WEEK' | 'TIME_INTERVAL_MONTH';
 export type GetUsersStatisticsRequest = {
@@ -87,3 +90,33 @@ export type GetEmailApplicationStatisticsResponse = {
     /** Time interval for grouping data */
     interval: TimeInterval;
 };
+export type GetEmailCategoryPerformanceRequest = {
+    /** Application code (format XXXXX-XXXXX) to fetch statistics for. */
+    application?: string;
+    /** Period start */
+    dateFrom?: Date;
+    /** Period end */
+    dateTo?: Date;
+};
+export type EmailCategoryPerformance = {
+    /** Category code */
+    categoryCode: string;
+    /** Category name as the account named it */
+    categoryName: string;
+    /** Letters sent */
+    sends: number;
+    /** Recipients who opened at least one of them */
+    opens: number;
+    /** Recipients who clicked a link other than unsubscribe */
+    clicks: number;
+    /** Recipients who unsubscribed from this very category */
+    unsubscribes: number;
+};
+export type GetEmailCategoryPerformanceResponse = {
+    /** One row per category of the application, zero rows included */
+    rows: EmailCategoryPerformance[];
+    /** Window actually read, clamped to the log retention */
+    windowFrom: Date;
+    /** Window actually read */
+    windowTo: Date;
+};

package/data.js

@@ -6801,6 +6801,12 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.applications_statistics.GetEmailApplicationStatisticsResponse",
                 "method": "post",
                 "path": "/api/v2/statistics/messages/getEmailApplicationStatistics"
+            },
+            "GetEmailCategoryPerformance": {
+                "request": "pushwoosh.rpc_v2.applications_statistics.GetEmailCategoryPerformanceRequest",
+                "response": "pushwoosh.rpc_v2.applications_statistics.GetEmailCategoryPerformanceResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/messages/getEmailCategoryPerformance"
             }
         }
     },
@@ -6956,6 +6962,58 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.applications_statistics.GetEmailCategoryPerformanceRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "dateFrom": {
+                "type": "Date"
+            },
+            "dateTo": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications_statistics.EmailCategoryPerformance": {
+        "type": "I",
+        "fields": {
+            "categoryCode": {
+                "type": "string"
+            },
+            "categoryName": {
+                "type": "string"
+            },
+            "sends": {
+                "type": "number"
+            },
+            "opens": {
+                "type": "number"
+            },
+            "clicks": {
+                "type": "number"
+            },
+            "unsubscribes": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications_statistics.GetEmailCategoryPerformanceResponse": {
+        "type": "I",
+        "fields": {
+            "rows": {
+                "type": "pushwoosh.rpc_v2.applications_statistics.EmailCategoryPerformance",
+                "array": true
+            },
+            "windowFrom": {
+                "type": "Date"
+            },
+            "windowTo": {
+                "type": "Date"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.campaigns.CampaignsService": {
         "type": "S",
         "key": "campaigns",

package/package.json

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