@pushwoosh/rpc-v2-http-api-data 0.2.306 → 0.2.308

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",
@@ -10420,6 +10493,12 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.data_erasure.ListDataErasureTaskRowsResponse",
                 "method": "get",
                 "path": "/api/data_erasure/tasks/{task_id}/rows"
+            },
+            "GetTaskReport": {
+                "request": "pushwoosh.rpc_v2.data_erasure.GetDataErasureTaskReportRequest",
+                "response": "pushwoosh.rpc_v2.data_erasure.GetDataErasureTaskReportResponse",
+                "method": "get",
+                "path": "/api/data_erasure/tasks/{task_id}/report"
             }
         }
     },
@@ -10591,6 +10670,28 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.data_erasure.GetDataErasureTaskReportRequest": {
+        "type": "I",
+        "fields": {
+            "taskId": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.data_erasure.GetDataErasureTaskReportResponse": {
+        "type": "I",
+        "fields": {
+            "filename": {
+                "type": "string"
+            },
+            "contentType": {
+                "type": "string"
+            },
+            "content": {
+                "type": "string"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.data_erasure.DataErasureTaskRow": {
         "type": "I",
         "fields": {

package/data_erasure.d.ts

@@ -3,6 +3,7 @@ export type DataErasureService_CreateTask = RpcMethod<CreateDataErasureTaskReque
 export type DataErasureService_GetTask = RpcMethod<GetDataErasureTaskRequest, GetDataErasureTaskResponse>;
 export type DataErasureService_ListTasks = RpcMethod<ListDataErasureTasksRequest, ListDataErasureTasksResponse>;
 export type DataErasureService_ListTaskRows = RpcMethod<ListDataErasureTaskRowsRequest, ListDataErasureTaskRowsResponse>;
+export type DataErasureService_GetTaskReport = RpcMethod<GetDataErasureTaskReportRequest, GetDataErasureTaskReportResponse>;
 /**
  * DataErasureService is the self-serve door to erasing the personal data of an end
  * user (GDPR). The erase itself runs as a background task; these methods start it,
@@ -17,6 +18,8 @@ export interface DataErasureService {
     ListTasks: DataErasureService_ListTasks;
     /** Returns the per-identifier outcome of one task: what was deleted, not found, skipped or failed. Identifiers are reported as hashes, the task never stores them in the clear. */
     ListTaskRows: DataErasureService_ListTaskRows;
+    /** Returns the whole report of one task as a CSV file: a row per identifier per application with its outcome. Use it to keep the evidence of an erasure outside Pushwoosh; list_data_erasure_task_rows shows the same rows page by page. */
+    GetTaskReport: DataErasureService_GetTaskReport;
 }
 /** How the subjects of an erasure request are addressed. */
 export type SubjectIdentifierType = 'SUBJECT_IDENTIFIER_UNKNOWN' | 'SUBJECT_IDENTIFIER_USER_ID' | 'SUBJECT_IDENTIFIER_HWID' | 'SUBJECT_IDENTIFIER_EMAIL';
@@ -78,6 +81,19 @@ export type DataErasureTask = {
     startedAt: Date;
     finishedAt: Date;
 };
+export type GetDataErasureTaskReportRequest = {
+    taskId?: number;
+};
+export type GetDataErasureTaskReportResponse = {
+    /** Suggested file name, e.g. data-erasure-task-42.csv. */
+    filename: string;
+    contentType: string;
+    /**
+     * The file itself, base64 over http; the render refuses a report whose encoded
+     * body would pass maxResponseBodyBytes.
+     */
+    content: string;
+};
 export type DataErasureTaskRow = {
     /** sha256 of the identifier: the journal of an erasure must not hold personal data. */
     identifierHash: string;

package/package.json

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