@pushwoosh/rpc-gateway-statistics-api 1.3.689
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/commonTypes.d.ts +18 -0
- package/commonTypes.js +3 -0
- package/data.d.ts +2 -0
- package/data.js +4192 -0
- package/index.d.ts +13 -0
- package/index.js +3 -0
- package/package.json +19 -0
- package/pushwoosh_statistics_statistics_v1.d.ts +796 -0
- package/pushwoosh_statistics_statistics_v1.js +3 -0
- package/pushwoosh_statistics_statistics_v2.d.ts +189 -0
- package/pushwoosh_statistics_statistics_v2.js +3 -0
- package/pushwoosh_statistics_statistics_v2_dashboards.d.ts +143 -0
- package/pushwoosh_statistics_statistics_v2_dashboards.js +3 -0
- package/pushwoosh_statistics_statistics_v2_overview.d.ts +59 -0
- package/pushwoosh_statistics_statistics_v2_overview.js +3 -0
- package/pushwoosh_statistics_statistics_v2_statistics.d.ts +706 -0
- package/pushwoosh_statistics_statistics_v2_statistics.js +3 -0
- package/pushwoosh_statistics_types.d.ts +23 -0
- package/pushwoosh_statistics_types.js +3 -0
- package/types.d.ts +59 -0
- package/types.js +3 -0
|
@@ -0,0 +1,706 @@
|
|
|
1
|
+
import { RpcMethod } from './commonTypes';
|
|
2
|
+
import { TimeInterval as pushwoosh_statistics_types_TimeInterval } from './pushwoosh_statistics_types';
|
|
3
|
+
export type StatisticsService_GetBouncedEmails = RpcMethod<GetBouncedEmailsRequest, GetBouncedEmailsResponse>;
|
|
4
|
+
export type StatisticsService_GetMessagesStatistics = RpcMethod<GetMessagesStatisticsRequest, GetMessagesStatisticsResponse>;
|
|
5
|
+
export type StatisticsService_GetCampaignStatistics = RpcMethod<GetCampaignStatisticsRequest, GetCampaignStatisticsResponse>;
|
|
6
|
+
export type StatisticsService_GetCampaignLinkClicks = RpcMethod<GetCampaignLinkClicksRequest, GetCampaignLinkClicksResponse>;
|
|
7
|
+
export type StatisticsService_GetDeliveryReport = RpcMethod<GetDeliveryReportRequest, GetDeliveryReportResponse>;
|
|
8
|
+
export type StatisticsService_GetErrorsStatistics = RpcMethod<GetErrorsStatisticsRequest, GetErrorsStatisticsResponse>;
|
|
9
|
+
export type StatisticsService_GetJourneyMetrics = RpcMethod<GetJourneyMetricsRequest, GetJourneyMetricsResponse>;
|
|
10
|
+
export type StatisticsService_GetUsersStatistics = RpcMethod<GetUsersStatisticsRequest, GetUsersStatisticsResponse>;
|
|
11
|
+
export type StatisticsService_GetMAUStatistics = RpcMethod<GetMAUStatisticsRequest, GetMAUStatisticsResponse>;
|
|
12
|
+
export type StatisticsService_GetDAUStatistics = RpcMethod<GetDAUStatisticsRequest, GetDAUStatisticsResponse>;
|
|
13
|
+
export type StatisticsService_GetPushApplicationStatistics = RpcMethod<GetPushApplicationStatisticsRequest, GetPushApplicationStatisticsResponse>;
|
|
14
|
+
export type StatisticsService_GetEmailApplicationStatistics = RpcMethod<GetEmailApplicationStatisticsRequest, GetEmailApplicationStatisticsResponse>;
|
|
15
|
+
export type StatisticsService_GetActiveAudience = RpcMethod<GetActiveAudienceRequest, GetActiveAudienceResponse>;
|
|
16
|
+
export type StatisticsService_GetUniqueEmailRecipients = RpcMethod<GetUniqueEmailRecipientsRequest, GetUniqueEmailRecipientsResponse>;
|
|
17
|
+
export type StatisticsService_GetSubscriptionFormStatistics = RpcMethod<GetSubscriptionFormStatisticsRequest, GetSubscriptionFormStatisticsResponse>;
|
|
18
|
+
export type StatisticsService_GetPopupFormsStatistics = RpcMethod<GetPopupFormsStatisticsRequest, GetPopupFormsStatisticsResponse>;
|
|
19
|
+
export type StatisticsService_GetInboundWebhookActivityLog = RpcMethod<GetInboundWebhookActivityLogRequest, GetInboundWebhookActivityLogResponse>;
|
|
20
|
+
export type StatisticsService_GetInboundWebhooksStatus = RpcMethod<GetInboundWebhooksStatusRequest, GetInboundWebhooksStatusResponse>;
|
|
21
|
+
export type StatisticsService_GetUserFCSuppressions = RpcMethod<GetUserFCSuppressionsRequest, GetUserFCSuppressionsResponse>;
|
|
22
|
+
/** StatisticsService provides various statistics operations */
|
|
23
|
+
export interface StatisticsService {
|
|
24
|
+
/** GetBouncedEmails returns list of bounced email addresses for messages or campaigns */
|
|
25
|
+
GetBouncedEmails: StatisticsService_GetBouncedEmails;
|
|
26
|
+
/** GetMessagesStatistics returns message statistics grouped by platform and time intervals */
|
|
27
|
+
GetMessagesStatistics: StatisticsService_GetMessagesStatistics;
|
|
28
|
+
/** GetCampaignStatistics returns detailed campaign statistics with time series data */
|
|
29
|
+
GetCampaignStatistics: StatisticsService_GetCampaignStatistics;
|
|
30
|
+
/** GetCampaignLinkClicks returns link click statistics for campaigns */
|
|
31
|
+
GetCampaignLinkClicks: StatisticsService_GetCampaignLinkClicks;
|
|
32
|
+
/** GetDeliveryReport returns delivery report with error details for campaigns */
|
|
33
|
+
GetDeliveryReport: StatisticsService_GetDeliveryReport;
|
|
34
|
+
/** GetErrorsStatistics returns error statistics over time for campaigns */
|
|
35
|
+
GetErrorsStatistics: StatisticsService_GetErrorsStatistics;
|
|
36
|
+
/** GetJourneyMetrics returns journey metrics with time series data and totals */
|
|
37
|
+
GetJourneyMetrics: StatisticsService_GetJourneyMetrics;
|
|
38
|
+
/** GetUsersStatistics returns application users counts statistics with time series data */
|
|
39
|
+
GetUsersStatistics: StatisticsService_GetUsersStatistics;
|
|
40
|
+
/** GetMAUStatistics returns mau statistics with time series data */
|
|
41
|
+
GetMAUStatistics: StatisticsService_GetMAUStatistics;
|
|
42
|
+
/** GetDAUStatistics returns dau statistics with time series data */
|
|
43
|
+
GetDAUStatistics: StatisticsService_GetDAUStatistics;
|
|
44
|
+
/** GetPushApplicationStatistics returns push statistics (total devices, sends, open rate) with time series data */
|
|
45
|
+
GetPushApplicationStatistics: StatisticsService_GetPushApplicationStatistics;
|
|
46
|
+
/** GetEmailApplicationStatistics returns email statistics (total devices, sends, open rate) with time series data */
|
|
47
|
+
GetEmailApplicationStatistics: StatisticsService_GetEmailApplicationStatistics;
|
|
48
|
+
/** GetActiveAudience returns active users and active devices groped by application and platform */
|
|
49
|
+
GetActiveAudience: StatisticsService_GetActiveAudience;
|
|
50
|
+
/** GetUniqueEmailRecipients returns count of unique email HWIDs that received at least one successful send in the given period */
|
|
51
|
+
GetUniqueEmailRecipients: StatisticsService_GetUniqueEmailRecipients;
|
|
52
|
+
/** GetSubscriptionFormStatistics returns subscription form statistics (views, submissions, conversions) */
|
|
53
|
+
GetSubscriptionFormStatistics: StatisticsService_GetSubscriptionFormStatistics;
|
|
54
|
+
/** GetPopupFormsStatistics returns popup forms statistics (visits, impressions) */
|
|
55
|
+
GetPopupFormsStatistics: StatisticsService_GetPopupFormsStatistics;
|
|
56
|
+
/** GetInboundWebhookActivityLog returns activity log for inbound webhooks */
|
|
57
|
+
GetInboundWebhookActivityLog: StatisticsService_GetInboundWebhookActivityLog;
|
|
58
|
+
/** GetInboundWebhooksStatus returns status of webhooks based on their last log entry */
|
|
59
|
+
GetInboundWebhooksStatus: StatisticsService_GetInboundWebhooksStatus;
|
|
60
|
+
/** GetUserFCSuppressions returns list of messages from which user was excluded by frequency capping */
|
|
61
|
+
GetUserFCSuppressions: StatisticsService_GetUserFCSuppressions;
|
|
62
|
+
}
|
|
63
|
+
/** EmailEventType represents different types of email delivery events */
|
|
64
|
+
export type EmailEventType =
|
|
65
|
+
/** Unknown or unspecified email event type */
|
|
66
|
+
'EmailEventTypeUnknown'
|
|
67
|
+
/** User marked email as spam */
|
|
68
|
+
| 'Complaint'
|
|
69
|
+
/** Temporary delivery failure (mailbox full, server down) */
|
|
70
|
+
| 'Softbounce'
|
|
71
|
+
/** Permanent delivery failure (invalid address) */
|
|
72
|
+
| 'Hardbounce';
|
|
73
|
+
/** GetBouncedEmailsRequest represents a request to retrieve bounced email addresses */
|
|
74
|
+
export type GetBouncedEmailsRequest = {
|
|
75
|
+
/** Application Code to filter by */
|
|
76
|
+
application: string;
|
|
77
|
+
/** Specific message code to filter by */
|
|
78
|
+
messageCode: string;
|
|
79
|
+
/** Campaign Code to filter by */
|
|
80
|
+
campaign: string;
|
|
81
|
+
/** Start date for the time range filter */
|
|
82
|
+
dateFrom: Date;
|
|
83
|
+
/** End date for the time range filter */
|
|
84
|
+
dateTo: Date;
|
|
85
|
+
/** Type of email event to filter by */
|
|
86
|
+
type: EmailEventType;
|
|
87
|
+
/** Number of results per page for pagination */
|
|
88
|
+
perPage: number;
|
|
89
|
+
/** Page number for pagination */
|
|
90
|
+
page: number;
|
|
91
|
+
};
|
|
92
|
+
/** BouncedEmail represents a single bounced email record */
|
|
93
|
+
export type BouncedEmail = {
|
|
94
|
+
/** Email address that bounced */
|
|
95
|
+
email: string;
|
|
96
|
+
/** Timestamp when the bounce occurred */
|
|
97
|
+
date: Date;
|
|
98
|
+
/** Detailed reason for the bounce */
|
|
99
|
+
reason: string;
|
|
100
|
+
/** Type of bounce event */
|
|
101
|
+
type: EmailEventType;
|
|
102
|
+
};
|
|
103
|
+
/** GetBouncedEmailsResponse contains the list of bounced emails and total count */
|
|
104
|
+
export type GetBouncedEmailsResponse = {
|
|
105
|
+
/** Total number of bounced emails matching the criteria */
|
|
106
|
+
total: number;
|
|
107
|
+
/** List of bounced email records */
|
|
108
|
+
bouncedEmails: BouncedEmail[];
|
|
109
|
+
};
|
|
110
|
+
/** GetMessagesStatisticsRequest represents a request for message statistics grouped by platform and time */
|
|
111
|
+
export type GetMessagesStatisticsRequest = {
|
|
112
|
+
/** List of platform IDs to filter by */
|
|
113
|
+
platforms: number[];
|
|
114
|
+
/** Time interval for grouping statistics */
|
|
115
|
+
interval: pushwoosh_statistics_types_TimeInterval;
|
|
116
|
+
/** Specific message code to get statistics for */
|
|
117
|
+
messageCode: string;
|
|
118
|
+
};
|
|
119
|
+
/** PushMetricWithTimestamp contains push notification metrics for a specific time and platform */
|
|
120
|
+
export type PushMetricWithTimestamp = {
|
|
121
|
+
/** Timestamp for these metrics */
|
|
122
|
+
timestamp: string;
|
|
123
|
+
/** Platform ID (iOS, Android, etc.) */
|
|
124
|
+
platform: number;
|
|
125
|
+
/** Number of messages sent */
|
|
126
|
+
sends: number;
|
|
127
|
+
/** Number of messages opened */
|
|
128
|
+
opens: number;
|
|
129
|
+
/** Number of messages delivered */
|
|
130
|
+
deliveries: number;
|
|
131
|
+
/** Number of inbox opens */
|
|
132
|
+
inboxOpens: number;
|
|
133
|
+
/** Number of messages that couldn't be shown */
|
|
134
|
+
unshowableSends: number;
|
|
135
|
+
/** Number of errors during sending */
|
|
136
|
+
errors: number;
|
|
137
|
+
};
|
|
138
|
+
/** EventStats contains statistics for a specific conversion event */
|
|
139
|
+
export type Conversion_EventStats = {
|
|
140
|
+
/** Event name */
|
|
141
|
+
name: string;
|
|
142
|
+
/** Number of times event occurred */
|
|
143
|
+
hits: number;
|
|
144
|
+
/** Conversion rate percentage */
|
|
145
|
+
conversion: number;
|
|
146
|
+
/** Revenue generated from this event */
|
|
147
|
+
revenue: number;
|
|
148
|
+
};
|
|
149
|
+
/** Conversion represents conversion metrics and associated events */
|
|
150
|
+
export type Conversion = {
|
|
151
|
+
/** Total number of messages sent */
|
|
152
|
+
sends: number;
|
|
153
|
+
/** Total number of messages opened */
|
|
154
|
+
opens: number;
|
|
155
|
+
/** List of conversion events and their statistics */
|
|
156
|
+
events: Conversion_EventStats[];
|
|
157
|
+
};
|
|
158
|
+
/** GetMessagesStatisticsResponse contains message statistics and conversion data */
|
|
159
|
+
export type GetMessagesStatisticsResponse = {
|
|
160
|
+
/** Time series metrics for messages */
|
|
161
|
+
metrics: PushMetricWithTimestamp[];
|
|
162
|
+
/** Conversion statistics */
|
|
163
|
+
conversion: Conversion;
|
|
164
|
+
};
|
|
165
|
+
/** GetCampaignStatisticsRequest represents a request for detailed campaign statistics */
|
|
166
|
+
export type GetCampaignStatisticsRequest = {
|
|
167
|
+
/** Application Code */
|
|
168
|
+
application: string;
|
|
169
|
+
/** Application group ID for multi-app campaigns */
|
|
170
|
+
applicationGroup: string;
|
|
171
|
+
/** Specific message code */
|
|
172
|
+
messageCode: string;
|
|
173
|
+
/** Campaign Code */
|
|
174
|
+
campaign: string;
|
|
175
|
+
/** Customer journey ID */
|
|
176
|
+
journey: string;
|
|
177
|
+
/** Start of time range */
|
|
178
|
+
timestampFrom: Date;
|
|
179
|
+
/** End of time range */
|
|
180
|
+
timestampTo: Date;
|
|
181
|
+
/** Time interval for grouping data */
|
|
182
|
+
interval: pushwoosh_statistics_types_TimeInterval;
|
|
183
|
+
/** Timezone for displaying timestamps */
|
|
184
|
+
timezone: string;
|
|
185
|
+
};
|
|
186
|
+
/** Breakdown contains platform-specific values over time */
|
|
187
|
+
export type GetCampaignStatisticsResponse_PlatformTimeSeries_Breakdown = {
|
|
188
|
+
/** Platform name (iOS, Android, etc.) */
|
|
189
|
+
platform: string;
|
|
190
|
+
/** Values for each timestamp */
|
|
191
|
+
values: number[];
|
|
192
|
+
};
|
|
193
|
+
/** PlatformTimeSeries represents time series data broken down by platform */
|
|
194
|
+
export type GetCampaignStatisticsResponse_PlatformTimeSeries = {
|
|
195
|
+
/** Time points for the series */
|
|
196
|
+
timestamps: Date[];
|
|
197
|
+
/** Platform-specific breakdowns */
|
|
198
|
+
breakdowns: GetCampaignStatisticsResponse_PlatformTimeSeries_Breakdown[];
|
|
199
|
+
/** Total across all platforms */
|
|
200
|
+
total: number;
|
|
201
|
+
};
|
|
202
|
+
/** Metrics contains all campaign metrics */
|
|
203
|
+
export type GetCampaignStatisticsResponse_Metrics = {
|
|
204
|
+
/** Send statistics over time */
|
|
205
|
+
sends: GetCampaignStatisticsResponse_PlatformTimeSeries;
|
|
206
|
+
/** Delivery statistics over time */
|
|
207
|
+
deliveries: GetCampaignStatisticsResponse_PlatformTimeSeries;
|
|
208
|
+
/** Open statistics over time (unique) */
|
|
209
|
+
opens: GetCampaignStatisticsResponse_PlatformTimeSeries;
|
|
210
|
+
/** Recipients count per platform */
|
|
211
|
+
recipientsByPlatform: Record<string, number>;
|
|
212
|
+
/** Total recipients count */
|
|
213
|
+
recipients: number;
|
|
214
|
+
/** Total open statistics over time (including duplicates) */
|
|
215
|
+
totalOpens: GetCampaignStatisticsResponse_PlatformTimeSeries;
|
|
216
|
+
/** Total open statistics (including duplicates) */
|
|
217
|
+
totalDeliveries: number;
|
|
218
|
+
/** Unique users skipped by frequency capping */
|
|
219
|
+
frequencyCappingUniqueUsers: number;
|
|
220
|
+
/** Total skipped count by frequency capping */
|
|
221
|
+
frequencyCappingSuppressions: number;
|
|
222
|
+
};
|
|
223
|
+
/** GetCampaignStatisticsResponse contains detailed campaign statistics with platform breakdowns */
|
|
224
|
+
export type GetCampaignStatisticsResponse = {
|
|
225
|
+
/** Campaign metrics data */
|
|
226
|
+
metrics: GetCampaignStatisticsResponse_Metrics;
|
|
227
|
+
};
|
|
228
|
+
/** GetCampaignLinkClicksRequest represents a request for campaign link click statistics */
|
|
229
|
+
export type GetCampaignLinkClicksRequest = {
|
|
230
|
+
/** Application Code */
|
|
231
|
+
application: string;
|
|
232
|
+
/** Application group ID for multi-app campaigns */
|
|
233
|
+
applicationGroup: string;
|
|
234
|
+
/** Specific message code */
|
|
235
|
+
messageCode: string;
|
|
236
|
+
/** Campaign Code */
|
|
237
|
+
campaign: string;
|
|
238
|
+
/** Start of time range */
|
|
239
|
+
timestampFrom: Date;
|
|
240
|
+
/** End of time range */
|
|
241
|
+
timestampTo: Date;
|
|
242
|
+
};
|
|
243
|
+
/** Attributes represents URL parameters and their click counts */
|
|
244
|
+
export type GetCampaignLinkClicksResponse_LinkClick_Attributes = {
|
|
245
|
+
/** URL parameters (e.g., 'name=sam', 'age=20') */
|
|
246
|
+
attributes: string[];
|
|
247
|
+
/** Number of clicks with these parameters */
|
|
248
|
+
clicks: number;
|
|
249
|
+
};
|
|
250
|
+
/**
|
|
251
|
+
* LinkClick represents click statistics for a specific link
|
|
252
|
+
* Example: 'https://google.com?name=sam&age=20'
|
|
253
|
+
* link: 'https://google.com'
|
|
254
|
+
* attributes: ['name=sam', 'age=20']
|
|
255
|
+
*/
|
|
256
|
+
export type GetCampaignLinkClicksResponse_LinkClick = {
|
|
257
|
+
/** Base URL without parameters */
|
|
258
|
+
link: string;
|
|
259
|
+
/** Total clicks for this link */
|
|
260
|
+
clicks: number;
|
|
261
|
+
/** Breakdown by URL parameters */
|
|
262
|
+
attributes: GetCampaignLinkClicksResponse_LinkClick_Attributes[];
|
|
263
|
+
};
|
|
264
|
+
/** GetCampaignLinkClicksResponse contains link click statistics for a campaign */
|
|
265
|
+
export type GetCampaignLinkClicksResponse = {
|
|
266
|
+
/** List of clicked links with statistics */
|
|
267
|
+
links: GetCampaignLinkClicksResponse_LinkClick[];
|
|
268
|
+
/** Total number of clicks across all links */
|
|
269
|
+
totalClicks: number;
|
|
270
|
+
/** Number of unique users who clicked */
|
|
271
|
+
uniqClick: number;
|
|
272
|
+
};
|
|
273
|
+
/** GetDeliveryReportRequest represents a request for delivery report with error details */
|
|
274
|
+
export type GetDeliveryReportRequest = {
|
|
275
|
+
/** Application Code */
|
|
276
|
+
application: string;
|
|
277
|
+
/** Application group ID for multi-app campaigns */
|
|
278
|
+
applicationGroup: string;
|
|
279
|
+
/** Specific message code */
|
|
280
|
+
messageCode: string;
|
|
281
|
+
/** Campaign Code */
|
|
282
|
+
campaign: string;
|
|
283
|
+
/** Customer journey ID */
|
|
284
|
+
journey: string;
|
|
285
|
+
/** Start of time range */
|
|
286
|
+
timestampFrom: Date;
|
|
287
|
+
/** End of time range */
|
|
288
|
+
timestampTo: Date;
|
|
289
|
+
};
|
|
290
|
+
/** ProcessingErrorsType categorizes sending errors */
|
|
291
|
+
export type GetDeliveryReportResponse_DeliveryReport_ProcessingErrorsType =
|
|
292
|
+
/** Any error types */
|
|
293
|
+
'processing_unknown'
|
|
294
|
+
/** Error during sending */
|
|
295
|
+
| 'send'
|
|
296
|
+
/** Error during publishing */
|
|
297
|
+
| 'publish';
|
|
298
|
+
/** MailboxErrorType categorizes email delivery errors */
|
|
299
|
+
export type GetDeliveryReportResponse_DeliveryReport_MailboxErrorType =
|
|
300
|
+
/** All error types (for compatibility with export service) */
|
|
301
|
+
'all'
|
|
302
|
+
/** Spam complaints from recipients */
|
|
303
|
+
| 'complaints'
|
|
304
|
+
/** Temporary delivery failures */
|
|
305
|
+
| 'soft_bounces'
|
|
306
|
+
/** Permanent delivery failures */
|
|
307
|
+
| 'hard_bounces';
|
|
308
|
+
/** ReportError represents a specific delivery error and its count */
|
|
309
|
+
export type GetDeliveryReportResponse_DeliveryReport_ReportError = {
|
|
310
|
+
/** Error message */
|
|
311
|
+
error: string;
|
|
312
|
+
/** Detailed error description for UI */
|
|
313
|
+
tooltip: string;
|
|
314
|
+
/** Number of occurrences */
|
|
315
|
+
count: number;
|
|
316
|
+
/** HTTP/SMTP status code */
|
|
317
|
+
statusCode: number;
|
|
318
|
+
/** Error category for email errors */
|
|
319
|
+
mailboxErrorType: GetDeliveryReportResponse_DeliveryReport_MailboxErrorType;
|
|
320
|
+
/** Error category for processing errors */
|
|
321
|
+
processingErrorType: GetDeliveryReportResponse_DeliveryReport_ProcessingErrorsType;
|
|
322
|
+
/** Error category for email errors */
|
|
323
|
+
mailboxErrorStatus: number;
|
|
324
|
+
};
|
|
325
|
+
/** DeliveryReport contains error statistics for message delivery */
|
|
326
|
+
export type GetDeliveryReportResponse_DeliveryReport = {
|
|
327
|
+
/** Platform ID where errors occurred */
|
|
328
|
+
platform: number;
|
|
329
|
+
/** Total number of errors */
|
|
330
|
+
total: number;
|
|
331
|
+
/** List of specific errors */
|
|
332
|
+
errors: GetDeliveryReportResponse_DeliveryReport_ReportError[];
|
|
333
|
+
};
|
|
334
|
+
/** GetDeliveryReportResponse contains delivery reports with error breakdowns */
|
|
335
|
+
export type GetDeliveryReportResponse = {
|
|
336
|
+
/** Push notification sending errors */
|
|
337
|
+
senderErrors: GetDeliveryReportResponse_DeliveryReport[];
|
|
338
|
+
/** Email delivery errors */
|
|
339
|
+
mailErrors: GetDeliveryReportResponse_DeliveryReport;
|
|
340
|
+
};
|
|
341
|
+
/** GetErrorsStatisticsRequest represents a request for error statistics over time */
|
|
342
|
+
export type GetErrorsStatisticsRequest = {
|
|
343
|
+
/** Application Code */
|
|
344
|
+
application: string;
|
|
345
|
+
/** Application group ID for multi-app campaigns */
|
|
346
|
+
applicationGroup: string;
|
|
347
|
+
/** Specific message code */
|
|
348
|
+
messageCode: string;
|
|
349
|
+
/** Campaign Code */
|
|
350
|
+
campaign: string;
|
|
351
|
+
/** Customer journey ID */
|
|
352
|
+
journey: string;
|
|
353
|
+
/** Start of time range */
|
|
354
|
+
timestampFrom: Date;
|
|
355
|
+
/** End of time range */
|
|
356
|
+
timestampTo: Date;
|
|
357
|
+
};
|
|
358
|
+
/** GetErrorsStatisticsResponse contains error counts over time */
|
|
359
|
+
export type GetErrorsStatisticsResponse = {
|
|
360
|
+
/** Time points for error measurements */
|
|
361
|
+
timestamps: Date[];
|
|
362
|
+
/** Error counts corresponding to each timestamp */
|
|
363
|
+
errors: number[];
|
|
364
|
+
};
|
|
365
|
+
/** GetJourneyMetricsRequest represents a request for journey metrics with time series data */
|
|
366
|
+
export type GetJourneyMetricsRequest = {
|
|
367
|
+
/** Application Code */
|
|
368
|
+
application: string;
|
|
369
|
+
/** Customer journey UUID */
|
|
370
|
+
journey: string;
|
|
371
|
+
/** Start of time range */
|
|
372
|
+
timestampFrom: Date;
|
|
373
|
+
/** End of time range */
|
|
374
|
+
timestampTo: Date;
|
|
375
|
+
/** Time interval for grouping data */
|
|
376
|
+
interval: pushwoosh_statistics_types_TimeInterval;
|
|
377
|
+
/** Timezone for displaying timestamps */
|
|
378
|
+
timezone: string;
|
|
379
|
+
/** List of platforms to filter */
|
|
380
|
+
platforms: number[];
|
|
381
|
+
};
|
|
382
|
+
/** ChannelMetrics contains metrics for a specific channel over time */
|
|
383
|
+
export type GetJourneyMetricsResponse_ChannelMetrics = {
|
|
384
|
+
/** Channel name (push, email, whatsapp, sms) */
|
|
385
|
+
channel: string;
|
|
386
|
+
/** Sends for each timestamp */
|
|
387
|
+
sends: number[];
|
|
388
|
+
/** Opens for each timestamp (unique) */
|
|
389
|
+
opens: number[];
|
|
390
|
+
/** Deliveries for each timestamp */
|
|
391
|
+
deliveries: number[];
|
|
392
|
+
/** Errors for each timestamp */
|
|
393
|
+
deliveryIssues: number[];
|
|
394
|
+
/** Hard bounces for each timestamp */
|
|
395
|
+
hardBounces: number[];
|
|
396
|
+
/** Soft bounces for each timestamp */
|
|
397
|
+
softBounces: number[];
|
|
398
|
+
/** Complaints for each timestamp */
|
|
399
|
+
complaints: number[];
|
|
400
|
+
/** Link clicks for each timestamp */
|
|
401
|
+
clicks: number[];
|
|
402
|
+
/** Unsubscribes for each timestamp */
|
|
403
|
+
unsubscribes: number[];
|
|
404
|
+
/** Total opens for each timestamp (including duplicates) */
|
|
405
|
+
totalOpens: number[];
|
|
406
|
+
/** Total deliveries for each timestamp (including duplicates) */
|
|
407
|
+
totalDeliveries: number[];
|
|
408
|
+
};
|
|
409
|
+
/** ChannelTotals contains totals for a specific channel */
|
|
410
|
+
export type GetJourneyMetricsResponse_ChannelTotals = {
|
|
411
|
+
/** Channel name (push, email, whatsapp, sms) */
|
|
412
|
+
channel: string;
|
|
413
|
+
/** Total messages sent for this channel */
|
|
414
|
+
sent: number;
|
|
415
|
+
/** Total unique recipients for this channel */
|
|
416
|
+
recipients: number;
|
|
417
|
+
/** Total messages opened for this channel (unique) */
|
|
418
|
+
opened: number;
|
|
419
|
+
/** Total delivery issues/errors for this channel */
|
|
420
|
+
deliveryIssues: number;
|
|
421
|
+
/** Total messages delivered for this channel */
|
|
422
|
+
delivered: number;
|
|
423
|
+
/** Total hard bounces for this channel */
|
|
424
|
+
hardBounces: number;
|
|
425
|
+
/** Total soft bounces for this channel */
|
|
426
|
+
softBounces: number;
|
|
427
|
+
/** Total complaints for this channel */
|
|
428
|
+
complaints: number;
|
|
429
|
+
/** Total link clicks for this channel */
|
|
430
|
+
clicks: number;
|
|
431
|
+
/** Total unsubscribes for this channel */
|
|
432
|
+
unsubscribes: number;
|
|
433
|
+
/** Total messages opened for this channel (including duplicates) */
|
|
434
|
+
totalOpened: number;
|
|
435
|
+
/** Total deliveries for this channel (including duplicates) */
|
|
436
|
+
totalDeliveries: number;
|
|
437
|
+
/** Unique users skipped by frequency capping */
|
|
438
|
+
frequencyCappingUniqueUsers: number;
|
|
439
|
+
/** Total skipped count by frequency capping */
|
|
440
|
+
frequencyCappingSuppressions: number;
|
|
441
|
+
};
|
|
442
|
+
/** GetJourneyMetricsResponse contains journey metrics with time series data and totals broken down by channels */
|
|
443
|
+
export type GetJourneyMetricsResponse = {
|
|
444
|
+
/** Time points for the series */
|
|
445
|
+
timestamps: Date[];
|
|
446
|
+
/** Metrics broken down by channel over time */
|
|
447
|
+
channelMetrics: GetJourneyMetricsResponse_ChannelMetrics[];
|
|
448
|
+
/** Aggregated totals */
|
|
449
|
+
channelTotals: GetJourneyMetricsResponse_ChannelTotals[];
|
|
450
|
+
};
|
|
451
|
+
export type GetUsersStatisticsRequest = {
|
|
452
|
+
/** Application Code */
|
|
453
|
+
application: string;
|
|
454
|
+
};
|
|
455
|
+
export type GetUsersStatisticsResponse = {
|
|
456
|
+
/** Time points for the series */
|
|
457
|
+
timestamps: Date[];
|
|
458
|
+
/** Total users for each timestamp */
|
|
459
|
+
usersCount: number[];
|
|
460
|
+
/** Time interval for grouping data */
|
|
461
|
+
interval: pushwoosh_statistics_types_TimeInterval;
|
|
462
|
+
};
|
|
463
|
+
export type GetMAUStatisticsRequest = {
|
|
464
|
+
/** Application Code */
|
|
465
|
+
application: string;
|
|
466
|
+
};
|
|
467
|
+
export type GetMAUStatisticsResponse = {
|
|
468
|
+
/** Time points for the series */
|
|
469
|
+
timestamps: Date[];
|
|
470
|
+
/** monthly active users for each timestamp */
|
|
471
|
+
usersCount: number[];
|
|
472
|
+
};
|
|
473
|
+
export type GetDAUStatisticsRequest = {
|
|
474
|
+
/** Application Code */
|
|
475
|
+
application: string;
|
|
476
|
+
};
|
|
477
|
+
export type GetDAUStatisticsResponse = {
|
|
478
|
+
/** Time points for the series */
|
|
479
|
+
timestamps: Date[];
|
|
480
|
+
/** daily active users for each timestamp */
|
|
481
|
+
usersCount: number[];
|
|
482
|
+
};
|
|
483
|
+
export type GetPushApplicationStatisticsRequest = {
|
|
484
|
+
/** Application Code */
|
|
485
|
+
application: string;
|
|
486
|
+
};
|
|
487
|
+
export type PlatformStatistics = {
|
|
488
|
+
platform: string;
|
|
489
|
+
values: number[];
|
|
490
|
+
};
|
|
491
|
+
export type GetPushApplicationStatisticsResponse = {
|
|
492
|
+
/** Time points for the series */
|
|
493
|
+
timestamps: Date[];
|
|
494
|
+
/** total devices for each timestamp */
|
|
495
|
+
totalDevices: PlatformStatistics[];
|
|
496
|
+
/** total sends for each timestamp */
|
|
497
|
+
sends: PlatformStatistics[];
|
|
498
|
+
/** open rate for each timestamp */
|
|
499
|
+
openRate: PlatformStatistics[];
|
|
500
|
+
/** Time interval for grouping data */
|
|
501
|
+
interval: pushwoosh_statistics_types_TimeInterval;
|
|
502
|
+
};
|
|
503
|
+
export type GetEmailApplicationStatisticsRequest = {
|
|
504
|
+
/** Application Code */
|
|
505
|
+
application: string;
|
|
506
|
+
};
|
|
507
|
+
export type GetEmailApplicationStatisticsResponse = {
|
|
508
|
+
/** Time points for the series */
|
|
509
|
+
timestamps: Date[];
|
|
510
|
+
/** total devices for each timestamp */
|
|
511
|
+
totalDevices: PlatformStatistics[];
|
|
512
|
+
/** total sends for each timestamp */
|
|
513
|
+
sends: PlatformStatistics[];
|
|
514
|
+
/** open rate for each timestamp */
|
|
515
|
+
openRate: PlatformStatistics[];
|
|
516
|
+
/** Time interval for grouping data */
|
|
517
|
+
interval: pushwoosh_statistics_types_TimeInterval;
|
|
518
|
+
};
|
|
519
|
+
/** ActiveAudienceType specifies the type of active users calculation */
|
|
520
|
+
export type ActiveAudienceType =
|
|
521
|
+
/** Unspecified type */
|
|
522
|
+
'ACTIVE_USERS_TYPE_UNSPECIFIED'
|
|
523
|
+
/** Daily Active Users (MAU) */
|
|
524
|
+
| 'ACTIVE_USERS_TYPE_DAY'
|
|
525
|
+
/** Monthly Active Users from month start */
|
|
526
|
+
| 'ACTIVE_USERS_TYPE_MONTH'
|
|
527
|
+
/** Monthly Active Users from specified date */
|
|
528
|
+
| 'ACTIVE_USERS_TYPE_CALENDAR_MONTH'
|
|
529
|
+
/** Monthly Active Users from specified date */
|
|
530
|
+
| 'ACTIVE_USERS_TYPE_CALENDAR_MONTH_WITH_TOKEN'
|
|
531
|
+
/** Monthly Active Users from specified date with device with token */
|
|
532
|
+
| 'ACTIVE_USERS_TYPE_MONTH_WITH_TOKEN'
|
|
533
|
+
/** Daily Active Devices (MAD) */
|
|
534
|
+
| 'ACTIVE_DEVICES_TYPE_DAY'
|
|
535
|
+
/** Monthly Active Devices from month start */
|
|
536
|
+
| 'ACTIVE_DEVICES_TYPE_MONTH'
|
|
537
|
+
/** Monthly Active Devices from specified date */
|
|
538
|
+
| 'ACTIVE_DEVICES_TYPE_CALENDAR_MONTH'
|
|
539
|
+
/** Monthly Active Devices with push token */
|
|
540
|
+
| 'ACTIVE_DEVICES_TYPE_MONTH_WITH_TOKEN';
|
|
541
|
+
export type ActiveAudienceCount = {
|
|
542
|
+
timestamp: Date;
|
|
543
|
+
applicationId: number;
|
|
544
|
+
platformId: number;
|
|
545
|
+
count: number;
|
|
546
|
+
};
|
|
547
|
+
export type GetActiveAudienceRequest = {
|
|
548
|
+
applicationIds: number[];
|
|
549
|
+
platformIds: number[];
|
|
550
|
+
dateFrom: Date;
|
|
551
|
+
dateTo: Date;
|
|
552
|
+
type: ActiveAudienceType;
|
|
553
|
+
};
|
|
554
|
+
export type GetActiveAudienceResponse = {
|
|
555
|
+
rows: ActiveAudienceCount[];
|
|
556
|
+
};
|
|
557
|
+
/** GetUniqueEmailRecipientsRequest represents a request to count unique email HWIDs with successful sends */
|
|
558
|
+
export type GetUniqueEmailRecipientsRequest = {
|
|
559
|
+
applicationIds: number[];
|
|
560
|
+
/** Start date for the time range filter */
|
|
561
|
+
dateFrom: Date;
|
|
562
|
+
/** End date for the time range filter */
|
|
563
|
+
dateTo: Date;
|
|
564
|
+
};
|
|
565
|
+
/** GetUniqueEmailRecipientsResponse contains the count of unique email HWIDs */
|
|
566
|
+
export type GetUniqueEmailRecipientsResponse = {
|
|
567
|
+
/** Count of unique email HWIDs with at least one successful send */
|
|
568
|
+
uniqueRecipients: number;
|
|
569
|
+
};
|
|
570
|
+
export type GetSubscriptionFormStatisticsRequest = {
|
|
571
|
+
/** Application Code */
|
|
572
|
+
application: string;
|
|
573
|
+
/** Form Code */
|
|
574
|
+
form: string;
|
|
575
|
+
/** Start date for the time range filter */
|
|
576
|
+
dateFrom: Date;
|
|
577
|
+
/** End date for the time range filter */
|
|
578
|
+
dateTo: Date;
|
|
579
|
+
};
|
|
580
|
+
export type GetSubscriptionFormStatisticsResponse = {
|
|
581
|
+
/** Total views */
|
|
582
|
+
views: number;
|
|
583
|
+
/** Total submissions */
|
|
584
|
+
submissions: number;
|
|
585
|
+
/** Total conversions */
|
|
586
|
+
conversions: number;
|
|
587
|
+
};
|
|
588
|
+
export type GetPopupFormsStatisticsRequest = {
|
|
589
|
+
/** Application Code */
|
|
590
|
+
application: string;
|
|
591
|
+
/** Form Codes */
|
|
592
|
+
forms: string[];
|
|
593
|
+
/** Start date for the time range filter */
|
|
594
|
+
dateFrom: Date;
|
|
595
|
+
/** End date for the time range filter */
|
|
596
|
+
dateTo: Date;
|
|
597
|
+
};
|
|
598
|
+
export type GetPopupFormsStatisticsResponse_FormStatistics = {
|
|
599
|
+
/** Total visits */
|
|
600
|
+
visits: number;
|
|
601
|
+
/** Total impressions */
|
|
602
|
+
impressions: number;
|
|
603
|
+
};
|
|
604
|
+
export type GetPopupFormsStatisticsResponse = {
|
|
605
|
+
forms: Record<string, GetPopupFormsStatisticsResponse_FormStatistics>;
|
|
606
|
+
};
|
|
607
|
+
/** WebhookLogStatus represents the status of inbound webhook processing */
|
|
608
|
+
export type WebhookLogStatus =
|
|
609
|
+
/** Unknown or unspecified status */
|
|
610
|
+
'WEBHOOK_LOG_STATUS_UNKNOWN'
|
|
611
|
+
/** Webhook processed successfully */
|
|
612
|
+
| 'WEBHOOK_LOG_STATUS_SUCCESS'
|
|
613
|
+
/** Internal server error during processing */
|
|
614
|
+
| 'WEBHOOK_LOG_STATUS_INTERNAL_ERROR'
|
|
615
|
+
/** Validation error in webhook data */
|
|
616
|
+
| 'WEBHOOK_LOG_STATUS_VALIDATE_ERROR'
|
|
617
|
+
/** Webhook is inactive or disabled */
|
|
618
|
+
| 'WEBHOOK_LOG_STATUS_WEBHOOK_INACTIVE'
|
|
619
|
+
/** Authorization error */
|
|
620
|
+
| 'WEBHOOK_LOG_STATUS_AUTHORIZATION_ERROR';
|
|
621
|
+
/** GetInboundWebhookActivityLogRequest represents a request to retrieve inbound webhook activity log */
|
|
622
|
+
export type GetInboundWebhookActivityLogRequest = {
|
|
623
|
+
/** Application ID to filter by */
|
|
624
|
+
applicationId: number;
|
|
625
|
+
/** Webhook UUID to filter by */
|
|
626
|
+
webhookUuid: string;
|
|
627
|
+
/** Start date for the time range filter */
|
|
628
|
+
timestampFrom: Date;
|
|
629
|
+
/** End date for the time range filter */
|
|
630
|
+
timestampTo: Date;
|
|
631
|
+
/** Maximum number of records to return */
|
|
632
|
+
limit: number;
|
|
633
|
+
/** Number of records to skip for pagination */
|
|
634
|
+
offset: number;
|
|
635
|
+
};
|
|
636
|
+
/** InboundWebhookLogItem represents a single log entry for inbound webhook processing */
|
|
637
|
+
export type InboundWebhookLogItem = {
|
|
638
|
+
/** Timestamp when the webhook was processed */
|
|
639
|
+
timestamp: Date;
|
|
640
|
+
/** Webhook UUID */
|
|
641
|
+
webhookUuid: string;
|
|
642
|
+
/** Request identifier */
|
|
643
|
+
identifier: string;
|
|
644
|
+
/** Processing status */
|
|
645
|
+
status: WebhookLogStatus;
|
|
646
|
+
/** Status message or error description */
|
|
647
|
+
message: string;
|
|
648
|
+
/** Raw request data */
|
|
649
|
+
rawRequest: string;
|
|
650
|
+
};
|
|
651
|
+
/** GetInboundWebhookActivityLogResponse contains the list of webhook log entries and totals */
|
|
652
|
+
export type GetInboundWebhookActivityLogResponse = {
|
|
653
|
+
/** List of webhook log entries */
|
|
654
|
+
logItems: InboundWebhookLogItem[];
|
|
655
|
+
/** Total number of log entries matching the filter */
|
|
656
|
+
total: number;
|
|
657
|
+
/** Total number of successful webhook calls */
|
|
658
|
+
totalSuccess: number;
|
|
659
|
+
/** Total number of failed webhook calls */
|
|
660
|
+
totalFailed: number;
|
|
661
|
+
};
|
|
662
|
+
/** GetInboundWebhooksStatusRequest represents a request to get status of webhooks by their UUIDs */
|
|
663
|
+
export type GetInboundWebhooksStatusRequest = {
|
|
664
|
+
/** Application ID to filter by */
|
|
665
|
+
applicationId: number;
|
|
666
|
+
/** List of webhook UUIDs to get status for */
|
|
667
|
+
webhookUuids: string[];
|
|
668
|
+
};
|
|
669
|
+
/** GetInboundWebhooksStatusResponse contains map of webhook UUID to status */
|
|
670
|
+
export type GetInboundWebhooksStatusResponse = {
|
|
671
|
+
/** Map of webhook UUID to its last log status */
|
|
672
|
+
statuses: Record<string, WebhookLogStatus>;
|
|
673
|
+
};
|
|
674
|
+
/** GetUserFCSuppressionsRequest represents a request to retrieve user's frequency capping suppressions */
|
|
675
|
+
export type GetUserFCSuppressionsRequest = {
|
|
676
|
+
/** Application Code to filter by */
|
|
677
|
+
application: string;
|
|
678
|
+
/** User ID to get suppressions for */
|
|
679
|
+
userId: string;
|
|
680
|
+
/** Page number for pagination */
|
|
681
|
+
page: number;
|
|
682
|
+
/** Number of results per page for pagination */
|
|
683
|
+
perPage: number;
|
|
684
|
+
};
|
|
685
|
+
/** FCSuppressionRecord represents a single frequency capping suppression record */
|
|
686
|
+
export type FCSuppressionRecord = {
|
|
687
|
+
/** Timestamp when suppression occurred */
|
|
688
|
+
timestamp: Date;
|
|
689
|
+
/** Message code (can be empty) */
|
|
690
|
+
messageCode: string;
|
|
691
|
+
/** Campaign code */
|
|
692
|
+
campaignCode: string;
|
|
693
|
+
/** Journey UUID (determined via point) */
|
|
694
|
+
journeyUuid: string;
|
|
695
|
+
};
|
|
696
|
+
/** GetUserFCSuppressionsResponse contains the list of FC suppressions and pagination info */
|
|
697
|
+
export type GetUserFCSuppressionsResponse = {
|
|
698
|
+
/** Total number of suppressions */
|
|
699
|
+
total: number;
|
|
700
|
+
/** Current page number */
|
|
701
|
+
page: number;
|
|
702
|
+
/** Number of results per page */
|
|
703
|
+
perPage: number;
|
|
704
|
+
/** List of suppression records */
|
|
705
|
+
suppressions: FCSuppressionRecord[];
|
|
706
|
+
};
|