@pushwoosh/rpc-gateway-statistics-api 1.3.879 → 1.3.881
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/data.js
CHANGED
|
@@ -1481,6 +1481,47 @@ export const data = {
|
|
|
1481
1481
|
},
|
|
1482
1482
|
"unsubscribes": {
|
|
1483
1483
|
"type": "number"
|
|
1484
|
+
},
|
|
1485
|
+
"bounceReasons": {
|
|
1486
|
+
"type": "pushwoosh.statistics.statistics.v1.EmailProviderBounceReason",
|
|
1487
|
+
"array": true
|
|
1488
|
+
}
|
|
1489
|
+
}
|
|
1490
|
+
},
|
|
1491
|
+
"pushwoosh.statistics.statistics.v1.EmailProviderBounceReason": {
|
|
1492
|
+
"type": "I",
|
|
1493
|
+
"fields": {
|
|
1494
|
+
"reason": {
|
|
1495
|
+
"type": "string"
|
|
1496
|
+
},
|
|
1497
|
+
"type": {
|
|
1498
|
+
"type": "pushwoosh.statistics.statistics.v1.EmailBounceType"
|
|
1499
|
+
},
|
|
1500
|
+
"count": {
|
|
1501
|
+
"type": "number"
|
|
1502
|
+
},
|
|
1503
|
+
"topCodes": {
|
|
1504
|
+
"type": "pushwoosh.statistics.statistics.v1.EmailProviderBounceCode",
|
|
1505
|
+
"array": true
|
|
1506
|
+
}
|
|
1507
|
+
}
|
|
1508
|
+
},
|
|
1509
|
+
"pushwoosh.statistics.statistics.v1.EmailBounceType": {
|
|
1510
|
+
"type": "E",
|
|
1511
|
+
"values": [
|
|
1512
|
+
"EMAIL_BOUNCE_TYPE_UNSPECIFIED",
|
|
1513
|
+
"EMAIL_BOUNCE_TYPE_HARD",
|
|
1514
|
+
"EMAIL_BOUNCE_TYPE_SOFT"
|
|
1515
|
+
]
|
|
1516
|
+
},
|
|
1517
|
+
"pushwoosh.statistics.statistics.v1.EmailProviderBounceCode": {
|
|
1518
|
+
"type": "I",
|
|
1519
|
+
"fields": {
|
|
1520
|
+
"code": {
|
|
1521
|
+
"type": "string"
|
|
1522
|
+
},
|
|
1523
|
+
"count": {
|
|
1524
|
+
"type": "number"
|
|
1484
1525
|
}
|
|
1485
1526
|
}
|
|
1486
1527
|
},
|
|
@@ -4458,12 +4499,6 @@ export const data = {
|
|
|
4458
4499
|
},
|
|
4459
4500
|
"hardBounceRatePercent": {
|
|
4460
4501
|
"type": "number"
|
|
4461
|
-
},
|
|
4462
|
-
"softbounces": {
|
|
4463
|
-
"type": "number"
|
|
4464
|
-
},
|
|
4465
|
-
"softBounceRatePercent": {
|
|
4466
|
-
"type": "number"
|
|
4467
4502
|
}
|
|
4468
4503
|
}
|
|
4469
4504
|
},
|
|
@@ -4501,24 +4536,6 @@ export const data = {
|
|
|
4501
4536
|
},
|
|
4502
4537
|
"rates": {
|
|
4503
4538
|
"type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailRates"
|
|
4504
|
-
},
|
|
4505
|
-
"bounceReasons": {
|
|
4506
|
-
"type": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailRatesResponse.BounceReason",
|
|
4507
|
-
"array": true
|
|
4508
|
-
}
|
|
4509
|
-
}
|
|
4510
|
-
},
|
|
4511
|
-
"pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailRatesResponse.BounceReason": {
|
|
4512
|
-
"type": "I",
|
|
4513
|
-
"fields": {
|
|
4514
|
-
"reason": {
|
|
4515
|
-
"type": "string"
|
|
4516
|
-
},
|
|
4517
|
-
"hard": {
|
|
4518
|
-
"type": "number"
|
|
4519
|
-
},
|
|
4520
|
-
"soft": {
|
|
4521
|
-
"type": "number"
|
|
4522
4539
|
}
|
|
4523
4540
|
}
|
|
4524
4541
|
},
|
|
@@ -4534,10 +4551,6 @@ export const data = {
|
|
|
4534
4551
|
},
|
|
4535
4552
|
"pauseCheck": {
|
|
4536
4553
|
"type": "pushwoosh.statistics.statistics.v2.overviewkpi.EmailPauseCheck"
|
|
4537
|
-
},
|
|
4538
|
-
"bounceReasons": {
|
|
4539
|
-
"type": "pushwoosh.statistics.statistics.v2.overviewkpi.GetEmailRatesResponse.BounceReason",
|
|
4540
|
-
"array": true
|
|
4541
4554
|
}
|
|
4542
4555
|
}
|
|
4543
4556
|
},
|
package/package.json
CHANGED
|
@@ -602,6 +602,25 @@ export type EmailProviderStatistics = {
|
|
|
602
602
|
softBounces: number;
|
|
603
603
|
complaints: number;
|
|
604
604
|
unsubscribes: number;
|
|
605
|
+
/** Bounce events of this provider by reason, most first; rates divide by sends above. */
|
|
606
|
+
bounceReasons: EmailProviderBounceReason[];
|
|
607
|
+
};
|
|
608
|
+
/**
|
|
609
|
+
* The bounce events of one provider that email-feedback-api classified into one reason,
|
|
610
|
+
* hard or soft; events logged before it wrote bounceReason are left out.
|
|
611
|
+
*/
|
|
612
|
+
export type EmailProviderBounceReason = {
|
|
613
|
+
/** The bounceReason value, e.g. mailbox_full. */
|
|
614
|
+
reason: string;
|
|
615
|
+
type: EmailBounceType;
|
|
616
|
+
count: number;
|
|
617
|
+
/** Up to three SMTP codes of these events, most first: the enhanced status, else the basic one. */
|
|
618
|
+
topCodes: EmailProviderBounceCode[];
|
|
619
|
+
};
|
|
620
|
+
export type EmailBounceType = 'EMAIL_BOUNCE_TYPE_UNSPECIFIED' | 'EMAIL_BOUNCE_TYPE_HARD' | 'EMAIL_BOUNCE_TYPE_SOFT';
|
|
621
|
+
export type EmailProviderBounceCode = {
|
|
622
|
+
code: string;
|
|
623
|
+
count: number;
|
|
605
624
|
};
|
|
606
625
|
export type GetEmailProviderStatisticsCPResponse = {
|
|
607
626
|
/** Providers with at least one event in the window, most sends first. */
|
|
@@ -36,7 +36,7 @@ export interface OverviewKPIService {
|
|
|
36
36
|
/** GetChannelUsersTrend returns the daily users-with-channel series of one platform. */
|
|
37
37
|
GetChannelUsersTrend: OverviewKPIService_GetChannelUsersTrend;
|
|
38
38
|
/**
|
|
39
|
-
* GetEmailRates returns the complaint and bounce rates, counted the way the
|
|
39
|
+
* GetEmailRates returns the complaint and hard bounce rates, counted the way the
|
|
40
40
|
* sending pause counts them, plus the account-wide check that pause runs on.
|
|
41
41
|
*/
|
|
42
42
|
GetEmailRates: OverviewKPIService_GetEmailRates;
|
|
@@ -236,7 +236,7 @@ export type GetEmailRatesRequest = {
|
|
|
236
236
|
};
|
|
237
237
|
/**
|
|
238
238
|
* EmailRates is one tally in events, the unit channels/email-feedback-api pauses by:
|
|
239
|
-
*
|
|
239
|
+
* both rates divide by sends, deliveries take no part.
|
|
240
240
|
*/
|
|
241
241
|
export type EmailRates = {
|
|
242
242
|
sends: number;
|
|
@@ -244,9 +244,6 @@ export type EmailRates = {
|
|
|
244
244
|
hardbounces: number;
|
|
245
245
|
complaintRatePercent: number;
|
|
246
246
|
hardBounceRatePercent: number;
|
|
247
|
-
/** the pause never reads soft bounces; they are here to be seen next to hard ones */
|
|
248
|
-
softbounces: number;
|
|
249
|
-
softBounceRatePercent: number;
|
|
250
247
|
};
|
|
251
248
|
/**
|
|
252
249
|
* EmailPauseCheck is the very number the pause is decided on: the whole account over
|
|
@@ -267,14 +264,6 @@ export type EmailPauseCheck = {
|
|
|
267
264
|
export type GetEmailRatesResponse_Point = {
|
|
268
265
|
day: Date;
|
|
269
266
|
rates: EmailRates;
|
|
270
|
-
/** this day's slice of the response bounce_reasons, in the same order and unit */
|
|
271
|
-
bounceReasons: GetEmailRatesResponse_BounceReason[];
|
|
272
|
-
};
|
|
273
|
-
export type GetEmailRatesResponse_BounceReason = {
|
|
274
|
-
/** the bounceReason value email-feedback-api wrote, e.g. mailbox_full */
|
|
275
|
-
reason: string;
|
|
276
|
-
hard: number;
|
|
277
|
-
soft: number;
|
|
278
267
|
};
|
|
279
268
|
export type GetEmailRatesResponse = {
|
|
280
269
|
/** the requested application and period, one point per day */
|
|
@@ -286,11 +275,6 @@ export type GetEmailRatesResponse = {
|
|
|
286
275
|
* differ from the two above, and that difference is the point of this field
|
|
287
276
|
*/
|
|
288
277
|
pauseCheck: EmailPauseCheck;
|
|
289
|
-
/**
|
|
290
|
-
* bounce events of the same application and period as totals, by hard+soft desc;
|
|
291
|
-
* only bounces logged since email-feedback-api started writing bounceReason
|
|
292
|
-
*/
|
|
293
|
-
bounceReasons: GetEmailRatesResponse_BounceReason[];
|
|
294
278
|
};
|
|
295
279
|
export type GetEmailActivityDistributionRequest = {
|
|
296
280
|
applicationCode: string;
|