@pushwoosh/rpc-v2-http-api-data 0.2.305 → 0.2.307

package/applications_statistics.d.ts

@@ -2,6 +2,7 @@ import { RpcMethod } from './commonTypes';
 export type ApplicationsStatisticsService_GetUsersStatistics = RpcMethod<GetUsersStatisticsRequest, GetUsersStatisticsResponse>;
 export type ApplicationsStatisticsService_GetMAUStatistics = RpcMethod<GetMAUStatisticsRequest, GetMAUStatisticsResponse>;
 export type ApplicationsStatisticsService_GetDAUStatistics = RpcMethod<GetDAUStatisticsRequest, GetDAUStatisticsResponse>;
+export type ApplicationsStatisticsService_GetProjectsBreakdown = RpcMethod<GetProjectsBreakdownRequest, GetProjectsBreakdownResponse>;
 export type ApplicationsStatisticsService_GetPushApplicationStatistics = RpcMethod<GetPushApplicationStatisticsRequest, GetPushApplicationStatisticsResponse>;
 export type ApplicationsStatisticsService_GetEmailApplicationStatistics = RpcMethod<GetEmailApplicationStatisticsRequest, GetEmailApplicationStatisticsResponse>;
 export type ApplicationsStatisticsService_GetEmailCategoryPerformance = RpcMethod<GetEmailCategoryPerformanceRequest, GetEmailCategoryPerformanceResponse>;
@@ -12,6 +13,8 @@ export interface ApplicationsStatisticsService {
     GetMAUStatistics: ApplicationsStatisticsService_GetMAUStatistics;
     /** Returns the daily active users (DAU) time series for an application (application code XXXXX-XXXXX). Use for daily engagement; use get_application_mau_statistics for monthly active users. */
     GetDAUStatistics: ApplicationsStatisticsService_GetDAUStatistics;
+    /** Returns one row per project (sends, opens, installs, subscriptions) over a period, for every project the caller may see or for the listed ones. Use for the cross-project report; use the per-application methods for one project's charts. */
+    GetProjectsBreakdown: ApplicationsStatisticsService_GetProjectsBreakdown;
     /** Returns per-platform push time series (total devices, sends, open rate) for an application (application code XXXXX-XXXXX). Use for the push channel dashboard; use get_application_email_statistics for the email channel. */
     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. */
@@ -120,3 +123,41 @@ export type GetEmailCategoryPerformanceResponse = {
     /** Window actually read */
     windowTo: Date;
 };
+export type GetProjectsBreakdownRequest = {
+    /** First day of the period (inclusive). */
+    dateFrom?: Date;
+    /** Last day of the period (inclusive). */
+    dateTo?: Date;
+    /** Application codes (format XXXXX-XXXXX); empty means every project the caller may see. */
+    applications?: string[];
+};
+export type ProjectBreakdownRow = {
+    /** Application code */
+    application: string;
+    /** Application title */
+    title: string;
+    /** Messages sent in the period */
+    sends: number;
+    /** Message opens in the period */
+    opens: number;
+    /** Installs in the period */
+    installs: number;
+    /** Subscriptions in the period */
+    subscriptions: number;
+};
+/**
+ * Column sums over the rows. installs_sum and subscriptions_sum are NOT unique people:
+ * a user active in two projects is counted by each of them.
+ */
+export type ProjectBreakdownTotals = {
+    sends: number;
+    opens: number;
+    installsSum: number;
+    subscriptionsSum: number;
+};
+export type GetProjectsBreakdownResponse = {
+    /** One row per project, sorted by title */
+    projects: ProjectBreakdownRow[];
+    /** Column sums; audience columns overlap between projects */
+    totals: ProjectBreakdownTotals;
+};

package/data.js

@@ -7600,6 +7600,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/v2/statistics/messages/getDAUStatistics"
             },
+            "GetProjectsBreakdown": {
+                "request": "pushwoosh.rpc_v2.applications_statistics.GetProjectsBreakdownRequest",
+                "response": "pushwoosh.rpc_v2.applications_statistics.GetProjectsBreakdownResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/projects/breakdown"
+            },
             "GetPushApplicationStatistics": {
                 "request": "pushwoosh.rpc_v2.applications_statistics.GetPushApplicationStatisticsRequest",
                 "response": "pushwoosh.rpc_v2.applications_statistics.GetPushApplicationStatisticsResponse",
@@ -7824,6 +7830,73 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.applications_statistics.GetProjectsBreakdownRequest": {
+        "type": "I",
+        "fields": {
+            "dateFrom": {
+                "type": "Date"
+            },
+            "dateTo": {
+                "type": "Date"
+            },
+            "applications": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications_statistics.ProjectBreakdownRow": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "title": {
+                "type": "string"
+            },
+            "sends": {
+                "type": "number"
+            },
+            "opens": {
+                "type": "number"
+            },
+            "installs": {
+                "type": "number"
+            },
+            "subscriptions": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications_statistics.ProjectBreakdownTotals": {
+        "type": "I",
+        "fields": {
+            "sends": {
+                "type": "number"
+            },
+            "opens": {
+                "type": "number"
+            },
+            "installsSum": {
+                "type": "number"
+            },
+            "subscriptionsSum": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications_statistics.GetProjectsBreakdownResponse": {
+        "type": "I",
+        "fields": {
+            "projects": {
+                "type": "pushwoosh.rpc_v2.applications_statistics.ProjectBreakdownRow",
+                "array": true
+            },
+            "totals": {
+                "type": "pushwoosh.rpc_v2.applications_statistics.ProjectBreakdownTotals"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.approvals.ApprovalsService": {
         "type": "S",
         "key": "approvals",

package/package.json

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