@pushwoosh/rpc-gateway-statistics-api 1.3.904 → 1.3.906
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 +51 -0
- package/package.json +1 -1
- package/pushwoosh_statistics_statistics_v1.d.ts +6 -0
- package/pushwoosh_statistics_statistics_v2_conversions.d.ts +4 -0
- package/pushwoosh_statistics_statistics_v2_dashboards.d.ts +4 -0
- package/pushwoosh_statistics_statistics_v2_overviewkpi.d.ts +6 -0
- package/pushwoosh_statistics_statistics_v2_statistics.d.ts +14 -0
package/data.js
CHANGED
|
@@ -897,6 +897,9 @@ export const data = {
|
|
|
897
897
|
"platformIds": {
|
|
898
898
|
"type": "number",
|
|
899
899
|
"array": true
|
|
900
|
+
},
|
|
901
|
+
"includeBots": {
|
|
902
|
+
"type": "boolean"
|
|
900
903
|
}
|
|
901
904
|
}
|
|
902
905
|
},
|
|
@@ -2346,6 +2349,9 @@ export const data = {
|
|
|
2346
2349
|
},
|
|
2347
2350
|
"dateRange": {
|
|
2348
2351
|
"type": "pushwoosh.statistics.types.DateRange"
|
|
2352
|
+
},
|
|
2353
|
+
"includeBots": {
|
|
2354
|
+
"type": "boolean"
|
|
2349
2355
|
}
|
|
2350
2356
|
}
|
|
2351
2357
|
},
|
|
@@ -2398,6 +2404,9 @@ export const data = {
|
|
|
2398
2404
|
},
|
|
2399
2405
|
"params": {
|
|
2400
2406
|
"type": "pushwoosh.statistics.statistics.v1.EmailLinkParams"
|
|
2407
|
+
},
|
|
2408
|
+
"includeBots": {
|
|
2409
|
+
"type": "boolean"
|
|
2401
2410
|
}
|
|
2402
2411
|
}
|
|
2403
2412
|
},
|
|
@@ -2557,6 +2566,9 @@ export const data = {
|
|
|
2557
2566
|
},
|
|
2558
2567
|
"perPage": {
|
|
2559
2568
|
"type": "number"
|
|
2569
|
+
},
|
|
2570
|
+
"includeBots": {
|
|
2571
|
+
"type": "boolean"
|
|
2560
2572
|
}
|
|
2561
2573
|
}
|
|
2562
2574
|
},
|
|
@@ -2710,6 +2722,9 @@ export const data = {
|
|
|
2710
2722
|
},
|
|
2711
2723
|
"currency": {
|
|
2712
2724
|
"type": "string"
|
|
2725
|
+
},
|
|
2726
|
+
"includeBots": {
|
|
2727
|
+
"type": "boolean"
|
|
2713
2728
|
}
|
|
2714
2729
|
}
|
|
2715
2730
|
},
|
|
@@ -3018,6 +3033,9 @@ export const data = {
|
|
|
3018
3033
|
"fields": {
|
|
3019
3034
|
"params": {
|
|
3020
3035
|
"type": "pushwoosh.statistics.statistics.v2.dashboards.ChartParams"
|
|
3036
|
+
},
|
|
3037
|
+
"includeBots": {
|
|
3038
|
+
"type": "boolean"
|
|
3021
3039
|
}
|
|
3022
3040
|
}
|
|
3023
3041
|
},
|
|
@@ -3070,6 +3088,9 @@ export const data = {
|
|
|
3070
3088
|
"fields": {
|
|
3071
3089
|
"params": {
|
|
3072
3090
|
"type": "pushwoosh.statistics.statistics.v2.dashboards.ChartParams"
|
|
3091
|
+
},
|
|
3092
|
+
"includeBots": {
|
|
3093
|
+
"type": "boolean"
|
|
3073
3094
|
}
|
|
3074
3095
|
}
|
|
3075
3096
|
},
|
|
@@ -4534,6 +4555,9 @@ export const data = {
|
|
|
4534
4555
|
},
|
|
4535
4556
|
"dayTo": {
|
|
4536
4557
|
"type": "Date"
|
|
4558
|
+
},
|
|
4559
|
+
"includeBots": {
|
|
4560
|
+
"type": "boolean"
|
|
4537
4561
|
}
|
|
4538
4562
|
}
|
|
4539
4563
|
},
|
|
@@ -4626,6 +4650,9 @@ export const data = {
|
|
|
4626
4650
|
},
|
|
4627
4651
|
"dayTo": {
|
|
4628
4652
|
"type": "Date"
|
|
4653
|
+
},
|
|
4654
|
+
"includeBots": {
|
|
4655
|
+
"type": "boolean"
|
|
4629
4656
|
}
|
|
4630
4657
|
}
|
|
4631
4658
|
},
|
|
@@ -4668,6 +4695,9 @@ export const data = {
|
|
|
4668
4695
|
},
|
|
4669
4696
|
"dayTo": {
|
|
4670
4697
|
"type": "Date"
|
|
4698
|
+
},
|
|
4699
|
+
"includeBots": {
|
|
4700
|
+
"type": "boolean"
|
|
4671
4701
|
}
|
|
4672
4702
|
}
|
|
4673
4703
|
},
|
|
@@ -5430,6 +5460,9 @@ export const data = {
|
|
|
5430
5460
|
},
|
|
5431
5461
|
"timezone": {
|
|
5432
5462
|
"type": "string"
|
|
5463
|
+
},
|
|
5464
|
+
"includeBots": {
|
|
5465
|
+
"type": "boolean"
|
|
5433
5466
|
}
|
|
5434
5467
|
}
|
|
5435
5468
|
},
|
|
@@ -5528,6 +5561,9 @@ export const data = {
|
|
|
5528
5561
|
},
|
|
5529
5562
|
"timestampTo": {
|
|
5530
5563
|
"type": "Date"
|
|
5564
|
+
},
|
|
5565
|
+
"includeBots": {
|
|
5566
|
+
"type": "boolean"
|
|
5531
5567
|
}
|
|
5532
5568
|
}
|
|
5533
5569
|
},
|
|
@@ -5587,6 +5623,9 @@ export const data = {
|
|
|
5587
5623
|
},
|
|
5588
5624
|
"timestampTo": {
|
|
5589
5625
|
"type": "Date"
|
|
5626
|
+
},
|
|
5627
|
+
"includeBots": {
|
|
5628
|
+
"type": "boolean"
|
|
5590
5629
|
}
|
|
5591
5630
|
}
|
|
5592
5631
|
},
|
|
@@ -6095,6 +6134,9 @@ export const data = {
|
|
|
6095
6134
|
"platforms": {
|
|
6096
6135
|
"type": "number",
|
|
6097
6136
|
"array": true
|
|
6137
|
+
},
|
|
6138
|
+
"includeBots": {
|
|
6139
|
+
"type": "boolean"
|
|
6098
6140
|
}
|
|
6099
6141
|
}
|
|
6100
6142
|
},
|
|
@@ -6359,6 +6401,9 @@ export const data = {
|
|
|
6359
6401
|
"platforms": {
|
|
6360
6402
|
"type": "number",
|
|
6361
6403
|
"array": true
|
|
6404
|
+
},
|
|
6405
|
+
"includeBots": {
|
|
6406
|
+
"type": "boolean"
|
|
6362
6407
|
}
|
|
6363
6408
|
}
|
|
6364
6409
|
},
|
|
@@ -6380,6 +6425,9 @@ export const data = {
|
|
|
6380
6425
|
},
|
|
6381
6426
|
"to": {
|
|
6382
6427
|
"type": "Date"
|
|
6428
|
+
},
|
|
6429
|
+
"includeBots": {
|
|
6430
|
+
"type": "boolean"
|
|
6383
6431
|
}
|
|
6384
6432
|
}
|
|
6385
6433
|
},
|
|
@@ -6401,6 +6449,9 @@ export const data = {
|
|
|
6401
6449
|
},
|
|
6402
6450
|
"to": {
|
|
6403
6451
|
"type": "Date"
|
|
6452
|
+
},
|
|
6453
|
+
"includeBots": {
|
|
6454
|
+
"type": "boolean"
|
|
6404
6455
|
}
|
|
6405
6456
|
}
|
|
6406
6457
|
},
|
package/package.json
CHANGED
|
@@ -356,6 +356,8 @@ export type GetMessagesTotalStatisticsCPRequest = {
|
|
|
356
356
|
interval: pushwoosh_statistics_types_TimeInterval;
|
|
357
357
|
/** platforms to count; empty keeps every platform of the application */
|
|
358
358
|
platformIds: number[];
|
|
359
|
+
/** Counts email clicks and opens labelled as bots; by default they are left out. */
|
|
360
|
+
includeBots: boolean;
|
|
359
361
|
};
|
|
360
362
|
export type ShortMessageMetric = {
|
|
361
363
|
sent: number;
|
|
@@ -993,6 +995,8 @@ export type EmailLinkParams = {
|
|
|
993
995
|
export type GetAdCampaignStatisticsRequest = {
|
|
994
996
|
campaignId: number;
|
|
995
997
|
dateRange: pushwoosh_statistics_types_DateRange;
|
|
998
|
+
/** Counts email clicks and opens labelled as bots; by default they are left out. */
|
|
999
|
+
includeBots: boolean;
|
|
996
1000
|
};
|
|
997
1001
|
/**
|
|
998
1002
|
* One row per creative of the campaign. Opens are opens of the letters that
|
|
@@ -1028,6 +1032,8 @@ export type GetAdCampaignStatisticsResponse = {
|
|
|
1028
1032
|
export type GetEmailLinkStatisticsRequest = {
|
|
1029
1033
|
filters: EmailLinkFilter;
|
|
1030
1034
|
params: EmailLinkParams;
|
|
1035
|
+
/** Counts email clicks and opens labelled as bots; by default they are left out. */
|
|
1036
|
+
includeBots: boolean;
|
|
1031
1037
|
};
|
|
1032
1038
|
export type FullLinkStatistics = {
|
|
1033
1039
|
fullLink: string;
|
|
@@ -42,6 +42,8 @@ export type GetBoardRequest = {
|
|
|
42
42
|
page: number;
|
|
43
43
|
/** Rows per page; 0 reads as 20, 200 at most */
|
|
44
44
|
perPage: number;
|
|
45
|
+
/** Count email clicks and opens labelled as bots; false leaves them out */
|
|
46
|
+
includeBots: boolean;
|
|
45
47
|
};
|
|
46
48
|
/** Row is one message, in-app, journey or journey point on the board */
|
|
47
49
|
export type Row = {
|
|
@@ -135,6 +137,8 @@ export type GetJourneyRequest = {
|
|
|
135
137
|
contactType: ContactType;
|
|
136
138
|
/** Keep revenue of one currency; empty keeps all */
|
|
137
139
|
currency: string;
|
|
140
|
+
/** Count email clicks and opens labelled as bots; false leaves them out */
|
|
141
|
+
includeBots: boolean;
|
|
138
142
|
};
|
|
139
143
|
export type GetJourneyResponse_Version = {
|
|
140
144
|
number: number;
|
|
@@ -101,6 +101,8 @@ export type ChartParams = {
|
|
|
101
101
|
};
|
|
102
102
|
export type GetLinearChartMetricsRequest = {
|
|
103
103
|
params: ChartParams;
|
|
104
|
+
/** Counts email clicks and opens labelled as bots; by default they are left out. */
|
|
105
|
+
includeBots: boolean;
|
|
104
106
|
};
|
|
105
107
|
export type GetLinearChartMetricsResponse_Breakdown = {
|
|
106
108
|
breakdown: string;
|
|
@@ -122,6 +124,8 @@ export type GetLinearChartMetricsResponse = {
|
|
|
122
124
|
};
|
|
123
125
|
export type GetTotalsChartMetricsRequest = {
|
|
124
126
|
params: ChartParams;
|
|
127
|
+
/** Counts email clicks and opens labelled as bots; by default they are left out. */
|
|
128
|
+
includeBots: boolean;
|
|
125
129
|
};
|
|
126
130
|
export type GetTotalsChartMetricsResponse_Breakdown = {
|
|
127
131
|
breakdown: string;
|
|
@@ -286,6 +286,8 @@ export type GetEmailActivityDistributionRequest = {
|
|
|
286
286
|
applicationCode: string;
|
|
287
287
|
dayFrom: Date;
|
|
288
288
|
dayTo: Date;
|
|
289
|
+
/** Counts email clicks and opens labelled as bots; by default they are left out. */
|
|
290
|
+
includeBots: boolean;
|
|
289
291
|
};
|
|
290
292
|
export type GetEmailActivityDistributionResponse = {
|
|
291
293
|
/** users of the base, taken from the last snapshot day the writer has filled */
|
|
@@ -342,6 +344,8 @@ export type GetEmailPerformanceRequest = {
|
|
|
342
344
|
applicationCode: string;
|
|
343
345
|
dayFrom: Date;
|
|
344
346
|
dayTo: Date;
|
|
347
|
+
/** Counts email clicks and opens labelled as bots; by default they are left out. */
|
|
348
|
+
includeBots: boolean;
|
|
345
349
|
};
|
|
346
350
|
/** EmailPerformanceCounts is one counting unit of the four numbers the tiles divide. */
|
|
347
351
|
export type EmailPerformanceCounts = {
|
|
@@ -361,6 +365,8 @@ export type GetEmailCategoryStatsRequest = {
|
|
|
361
365
|
applicationCode: string;
|
|
362
366
|
dayFrom: Date;
|
|
363
367
|
dayTo: Date;
|
|
368
|
+
/** Counts email clicks and opens labelled as bots; by default they are left out. */
|
|
369
|
+
includeBots: boolean;
|
|
364
370
|
};
|
|
365
371
|
/**
|
|
366
372
|
* EmailCategoryStats is one row of the table. An empty code is the letters that
|
|
@@ -194,6 +194,8 @@ export type GetCampaignStatisticsRequest = {
|
|
|
194
194
|
interval: pushwoosh_statistics_types_TimeInterval;
|
|
195
195
|
/** Timezone for displaying timestamps */
|
|
196
196
|
timezone: string;
|
|
197
|
+
/** Counts email clicks and opens labelled as bots; by default they are left out. */
|
|
198
|
+
includeBots: boolean;
|
|
197
199
|
};
|
|
198
200
|
/** Breakdown contains platform-specific values over time */
|
|
199
201
|
export type GetCampaignStatisticsResponse_PlatformTimeSeries_Breakdown = {
|
|
@@ -255,6 +257,8 @@ export type GetCampaignLinkClicksRequest = {
|
|
|
255
257
|
timestampFrom: Date;
|
|
256
258
|
/** End of time range */
|
|
257
259
|
timestampTo: Date;
|
|
260
|
+
/** Counts email clicks and opens labelled as bots; by default they are left out. */
|
|
261
|
+
includeBots: boolean;
|
|
258
262
|
};
|
|
259
263
|
/** Attributes represents URL parameters and their click counts */
|
|
260
264
|
export type GetCampaignLinkClicksResponse_LinkClick_Attributes = {
|
|
@@ -296,6 +300,8 @@ export type GetBlockRevenueRequest = {
|
|
|
296
300
|
timestampFrom: Date;
|
|
297
301
|
/** End of time range */
|
|
298
302
|
timestampTo: Date;
|
|
303
|
+
/** Counts email clicks and opens labelled as bots; by default they are left out. */
|
|
304
|
+
includeBots: boolean;
|
|
299
305
|
};
|
|
300
306
|
/** BlockRevenue is one block's clicks and the revenue of the buyers who clicked it */
|
|
301
307
|
export type GetBlockRevenueResponse_BlockRevenue = {
|
|
@@ -601,6 +607,8 @@ export type GetMessageDeliveryFunnelRequest = {
|
|
|
601
607
|
messageCode: string;
|
|
602
608
|
/** Optional platform ID filter */
|
|
603
609
|
platforms: number[];
|
|
610
|
+
/** Counts email clicks and opens labelled as bots; by default they are left out */
|
|
611
|
+
includeBots: boolean;
|
|
604
612
|
};
|
|
605
613
|
/**
|
|
606
614
|
* Stage is a funnel level. Stages always come in the order they appear in the
|
|
@@ -838,6 +846,8 @@ export type GetCampaignDeliveryFunnelRequest = {
|
|
|
838
846
|
campaignCode: string;
|
|
839
847
|
/** Optional platform ID filter */
|
|
840
848
|
platforms: number[];
|
|
849
|
+
/** Counts email clicks and opens labelled as bots; by default they are left out. */
|
|
850
|
+
includeBots: boolean;
|
|
841
851
|
};
|
|
842
852
|
/**
|
|
843
853
|
* GetMessageDeliveryTimelineRequest asks for one message's metrics over time. Unlike
|
|
@@ -859,6 +869,8 @@ export type GetMessageDeliveryTimelineRequest = {
|
|
|
859
869
|
*/
|
|
860
870
|
from: Date;
|
|
861
871
|
to: Date;
|
|
872
|
+
/** Counts email clicks and opens labelled as bots; by default they are left out. */
|
|
873
|
+
includeBots: boolean;
|
|
862
874
|
};
|
|
863
875
|
/**
|
|
864
876
|
* GetCampaignDeliveryTimelineRequest asks for one campaign's metrics over time. Same
|
|
@@ -880,6 +892,8 @@ export type GetCampaignDeliveryTimelineRequest = {
|
|
|
880
892
|
*/
|
|
881
893
|
from: Date;
|
|
882
894
|
to: Date;
|
|
895
|
+
/** Counts email clicks and opens labelled as bots; by default they are left out. */
|
|
896
|
+
includeBots: boolean;
|
|
883
897
|
};
|
|
884
898
|
/**
|
|
885
899
|
* Metric is one line of the chart. Metrics, not funnel stages: STAGE_DELIVERIES
|