@pushwoosh/rpc-gateway-statistics-api 1.3.759 → 1.3.761

package/data.js

@@ -219,6 +219,18 @@ export const data = {
                 "method": "post",
                 "path": "/api/v2/statistics/audience/getEmailCategoryPerformance"
             },
+            "GetEmailFrequencyCappingCP": {
+                "request": "pushwoosh.statistics.statistics.v1.GetEmailFrequencyCappingCPRequest",
+                "response": "pushwoosh.statistics.statistics.v1.GetEmailFrequencyCappingCPResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/audience/getEmailFrequencyCapping"
+            },
+            "GetEmailUnsubscribeByFrequencyCP": {
+                "request": "pushwoosh.statistics.statistics.v1.GetEmailUnsubscribeByFrequencyCPRequest",
+                "response": "pushwoosh.statistics.statistics.v1.GetEmailUnsubscribeByFrequencyCPResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/audience/getEmailUnsubscribeByFrequency"
+            },
             "GetRetentionTotalStatisticsCP": {
                 "request": "pushwoosh.statistics.statistics.v1.GetRetentionTotalStatisticsCPRequest",
                 "response": "pushwoosh.statistics.statistics.v1.GetRetentionTotalStatisticsCPResponse",
@@ -1322,6 +1334,101 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v1.GetEmailFrequencyCappingCPRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "timestampFrom": {
+                "type": "string"
+            },
+            "timestampTo": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.EmailFrequencyCappingMetricWithTimestamp": {
+        "type": "I",
+        "fields": {
+            "timestamp": {
+                "type": "string"
+            },
+            "suppressions": {
+                "type": "number"
+            },
+            "uniqueUsers": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.GetEmailFrequencyCappingCPResponse": {
+        "type": "I",
+        "fields": {
+            "suppressions": {
+                "type": "number"
+            },
+            "uniqueUsers": {
+                "type": "number"
+            },
+            "rows": {
+                "type": "pushwoosh.statistics.statistics.v1.EmailFrequencyCappingMetricWithTimestamp",
+                "array": true
+            },
+            "windowFrom": {
+                "type": "string"
+            },
+            "windowTo": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.GetEmailUnsubscribeByFrequencyCPRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "timestampFrom": {
+                "type": "string"
+            },
+            "timestampTo": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.EmailUnsubscribeFrequencyBucket": {
+        "type": "I",
+        "fields": {
+            "from": {
+                "type": "number"
+            },
+            "to": {
+                "type": "number"
+            },
+            "recipients": {
+                "type": "number"
+            },
+            "unsubscribed": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.GetEmailUnsubscribeByFrequencyCPResponse": {
+        "type": "I",
+        "fields": {
+            "buckets": {
+                "type": "pushwoosh.statistics.statistics.v1.EmailUnsubscribeFrequencyBucket",
+                "array": true
+            },
+            "windowFrom": {
+                "type": "string"
+            },
+            "windowTo": {
+                "type": "string"
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v1.GetRetentionTotalStatisticsCPRequest": {
         "type": "I",
         "fields": {
@@ -3415,6 +3522,200 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetOverviewKPIRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "day": {
+                "type": "Date"
+            },
+            "growthPeriodDays": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetOverviewKPIResponse": {
+        "type": "I",
+        "fields": {
+            "day": {
+                "type": "Date"
+            },
+            "reachable": {
+                "type": "number"
+            },
+            "netReachableGrowthPercent": {
+                "type": "number"
+            },
+            "dau": {
+                "type": "number"
+            },
+            "mau30": {
+                "type": "number"
+            },
+            "stickinessPercent": {
+                "type": "number"
+            },
+            "unifiedMau30": {
+                "type": "number"
+            },
+            "windowMetricsAvailable": {
+                "type": "boolean"
+            },
+            "netReachableGrowthAvailable": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetAudienceFunnelRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "day": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetAudienceFunnelResponse": {
+        "type": "I",
+        "fields": {
+            "day": {
+                "type": "Date"
+            },
+            "totalUsers": {
+                "type": "number"
+            },
+            "subscribers": {
+                "type": "number"
+            },
+            "reachable": {
+                "type": "number"
+            },
+            "activeReachable": {
+                "type": "number"
+            },
+            "activeReachableWindowDays": {
+                "type": "number"
+            },
+            "activeReachableIsApproximate": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetReachByPlatformRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "day": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetReachByPlatformResponse.Platform": {
+        "type": "I",
+        "fields": {
+            "platformId": {
+                "type": "number"
+            },
+            "reachable": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetReachByPlatformResponse": {
+        "type": "I",
+        "fields": {
+            "day": {
+                "type": "Date"
+            },
+            "platforms": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.GetReachByPlatformResponse.Platform",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetActiveTrendRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "dayFrom": {
+                "type": "Date"
+            },
+            "dayTo": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetActiveTrendResponse.Point": {
+        "type": "I",
+        "fields": {
+            "day": {
+                "type": "Date"
+            },
+            "dau": {
+                "type": "number"
+            },
+            "mau30": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetActiveTrendResponse": {
+        "type": "I",
+        "fields": {
+            "points": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.GetActiveTrendResponse.Point",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetRetentionCurveRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "cohortDate": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetRetentionCurveResponse.Point": {
+        "type": "I",
+        "fields": {
+            "dayN": {
+                "type": "number"
+            },
+            "cohortSize": {
+                "type": "number"
+            },
+            "retained": {
+                "type": "number"
+            },
+            "retentionPercent": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.overviewkpi.GetRetentionCurveResponse": {
+        "type": "I",
+        "fields": {
+            "cohortDate": {
+                "type": "Date"
+            },
+            "points": {
+                "type": "pushwoosh.statistics.statistics.v2.overviewkpi.GetRetentionCurveResponse.Point",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v2.statistics.StatisticsService": {
         "type": "S",
         "key": "statisticsV2",

package/package.json

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

package/pushwoosh_statistics_statistics_v1.d.ts

@@ -24,6 +24,8 @@ export type StatisticsService_GetSubscribersDailyStatisticsCP = RpcMethod<GetSub
 export type StatisticsService_GetEmailActivityDistributionCP = RpcMethod<GetEmailActivityDistributionCPRequest, GetEmailActivityDistributionCPResponse>;
 export type StatisticsService_GetEmailEventTriggeredPerformanceCP = RpcMethod<GetEmailEventTriggeredPerformanceCPRequest, GetEmailEventTriggeredPerformanceCPResponse>;
 export type StatisticsService_GetEmailCategoryPerformanceCP = RpcMethod<GetEmailCategoryPerformanceCPRequest, GetEmailCategoryPerformanceCPResponse>;
+export type StatisticsService_GetEmailFrequencyCappingCP = RpcMethod<GetEmailFrequencyCappingCPRequest, GetEmailFrequencyCappingCPResponse>;
+export type StatisticsService_GetEmailUnsubscribeByFrequencyCP = RpcMethod<GetEmailUnsubscribeByFrequencyCPRequest, GetEmailUnsubscribeByFrequencyCPResponse>;
 export type StatisticsService_GetRetentionTotalStatisticsCP = RpcMethod<GetRetentionTotalStatisticsCPRequest, GetRetentionTotalStatisticsCPResponse>;
 export type StatisticsService_GetEngagementTotalStatisticsCP = RpcMethod<GetEngagementTotalStatisticsCPRequest, GetEngagementTotalStatisticsCPResponse>;
 export type StatisticsService_GetActiveUsersTotalStatisticsCP = RpcMethod<GetActiveUsersTotalStatisticsCPRequest, GetActiveUsersTotalStatisticsCPResponse>;
@@ -76,6 +78,10 @@ export interface StatisticsService {
     GetEmailEventTriggeredPerformanceCP: StatisticsService_GetEmailEventTriggeredPerformanceCP;
     /** GetEmailCategoryPerformanceCP returns per-email-category performance for control panel */
     GetEmailCategoryPerformanceCP: StatisticsService_GetEmailCategoryPerformanceCP;
+    /** GetEmailFrequencyCappingCP returns email sends suppressed by frequency capping for control panel */
+    GetEmailFrequencyCappingCP: StatisticsService_GetEmailFrequencyCappingCP;
+    /** GetEmailUnsubscribeByFrequencyCP returns the unsubscribe rate by how many letters an address got */
+    GetEmailUnsubscribeByFrequencyCP: StatisticsService_GetEmailUnsubscribeByFrequencyCP;
     /** GetRetentionTotalStatisticsCP returns user retention statistics */
     GetRetentionTotalStatisticsCP: StatisticsService_GetRetentionTotalStatisticsCP;
     /** GetEngagementTotalStatisticsCP returns user engagement metrics */
@@ -521,6 +527,49 @@ export type GetEmailCategoryPerformanceCPResponse = {
     windowFrom: string;
     windowTo: string;
 };
+export type GetEmailFrequencyCappingCPRequest = {
+    applicationCode: string;
+    timestampFrom: string;
+    timestampTo: string;
+};
+export type EmailFrequencyCappingMetricWithTimestamp = {
+    timestamp: string;
+    suppressions: number;
+    uniqueUsers: number;
+};
+/**
+ * rows are daily buckets, zero-filled over the window; the totals stand apart because a
+ * unique-users total is not the sum of its daily ones.
+ */
+export type GetEmailFrequencyCappingCPResponse = {
+    suppressions: number;
+    uniqueUsers: number;
+    rows: EmailFrequencyCappingMetricWithTimestamp[];
+    /** The window actually read, clamped to the action log retention. */
+    windowFrom: string;
+    windowTo: string;
+};
+export type GetEmailUnsubscribeByFrequencyCPRequest = {
+    applicationCode: string;
+    timestampFrom: string;
+    timestampTo: string;
+};
+/**
+ * One bucket of addresses by how many letters they got in the period; to = 0 is the open
+ * ended last bucket.
+ */
+export type EmailUnsubscribeFrequencyBucket = {
+    from: number;
+    to: number;
+    recipients: number;
+    unsubscribed: number;
+};
+export type GetEmailUnsubscribeByFrequencyCPResponse = {
+    buckets: EmailUnsubscribeFrequencyBucket[];
+    /** The window actually read, clamped to the action log retention. */
+    windowFrom: string;
+    windowTo: string;
+};
 export type GetRetentionTotalStatisticsCPRequest = {
     applicationCode: string;
     timestampFrom: string;

package/pushwoosh_statistics_statistics_v2_overviewkpi.d.ts

@@ -0,0 +1,97 @@
+export type GetOverviewKPIRequest = {
+    applicationCode: string;
+    /** snapshot day, only year-month-day are used */
+    day: Date;
+    /** period of the reachable growth, in days */
+    growthPeriodDays: number;
+};
+export type GetOverviewKPIResponse = {
+    /** day the numbers belong to */
+    day: Date;
+    /** users with at least one device that has push permission and a valid token */
+    reachable: number;
+    /** reachable change over growth_period_days, in percent */
+    netReachableGrowthPercent: number;
+    /** unique users who opened the application that day */
+    dau: number;
+    /** unique users who opened it within the rolling 30 days ending that day */
+    mau30: number;
+    /** dau / mau_30, in percent */
+    stickinessPercent: number;
+    /** users reached by push, email, SMS or WhatsApp in the rolling 30 days */
+    unifiedMau30: number;
+    /** rolling-30 numbers are absent until the raw log covers the whole window */
+    windowMetricsAvailable: boolean;
+    /** growth needs a second snapshot, so it is absent on the first days */
+    netReachableGrowthAvailable: boolean;
+};
+export type GetAudienceFunnelRequest = {
+    applicationCode: string;
+    day: Date;
+};
+export type GetAudienceFunnelResponse = {
+    day: Date;
+    /** all users of the application */
+    totalUsers: number;
+    /** users with at least one push device holding a valid token */
+    subscribers: number;
+    /** users with push permission and a valid token */
+    reachable: number;
+    /** reachable users active within the window */
+    activeReachable: number;
+    /** window of the active_reachable step, in days */
+    activeReachableWindowDays: number;
+    /**
+     * true while active_reachable falls back to "active with a token": that step
+     * is an event window, not a snapshot, so it may exceed the reachable step
+     */
+    activeReachableIsApproximate: boolean;
+};
+export type GetReachByPlatformRequest = {
+    applicationCode: string;
+    day: Date;
+};
+export type GetReachByPlatformResponse_Platform = {
+    platformId: number;
+    reachable: number;
+};
+export type GetReachByPlatformResponse = {
+    day: Date;
+    /**
+     * a user counts in every platform where they have a reachable device, so the
+     * sum over platforms may exceed the total
+     */
+    platforms: GetReachByPlatformResponse_Platform[];
+};
+export type GetActiveTrendRequest = {
+    applicationCode: string;
+    dayFrom: Date;
+    dayTo: Date;
+};
+export type GetActiveTrendResponse_Point = {
+    day: Date;
+    dau: number;
+    mau30: number;
+};
+export type GetActiveTrendResponse = {
+    /**
+     * one point per day; the values are approximate distinct counts and must not
+     * be summed or merged across points
+     */
+    points: GetActiveTrendResponse_Point[];
+};
+export type GetRetentionCurveRequest = {
+    applicationCode: string;
+    /** day the cohort registered on */
+    cohortDate: Date;
+};
+export type GetRetentionCurveResponse_Point = {
+    dayN: number;
+    cohortSize: number;
+    retained: number;
+    retentionPercent: number;
+};
+export type GetRetentionCurveResponse = {
+    cohortDate: Date;
+    points: GetRetentionCurveResponse_Point[];
+};

package/pushwoosh_statistics_statistics_v2_overviewkpi.js

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