@pushwoosh/rpc-gateway-statistics-api 1.3.741 → 1.3.743

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
@@ -3274,16 +3274,28 @@ export const data = {
3274
3274
  },
3275
3275
  "GetMessageDeliveryFunnel": {
3276
3276
  "request": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelRequest",
3277
- "response": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse",
3277
+ "response": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse",
3278
3278
  "method": "post",
3279
3279
  "path": "/api/v2/statistics/messages/getDeliveryFunnel"
3280
3280
  },
3281
+ "GetCampaignDeliveryFunnel": {
3282
+ "request": "pushwoosh.statistics.statistics.v2.statistics.GetCampaignDeliveryFunnelRequest",
3283
+ "response": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse",
3284
+ "method": "post",
3285
+ "path": "/api/v2/statistics/messages/getCampaignDeliveryFunnel"
3286
+ },
3281
3287
  "GetMessageDeliveryTimeline": {
3282
3288
  "request": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineRequest",
3283
- "response": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse",
3289
+ "response": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse",
3284
3290
  "method": "post",
3285
3291
  "path": "/api/v2/statistics/messages/getDeliveryTimeline"
3286
3292
  },
3293
+ "GetCampaignDeliveryTimeline": {
3294
+ "request": "pushwoosh.statistics.statistics.v2.statistics.GetCampaignDeliveryTimelineRequest",
3295
+ "response": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse",
3296
+ "method": "post",
3297
+ "path": "/api/v2/statistics/messages/getCampaignDeliveryTimeline"
3298
+ },
3287
3299
  "GetActiveAudience": {
3288
3300
  "request": "pushwoosh.statistics.statistics.v2.statistics.GetActiveAudienceRequest",
3289
3301
  "response": "pushwoosh.statistics.statistics.v2.statistics.GetActiveAudienceResponse",
@@ -4120,7 +4132,7 @@ export const data = {
4120
4132
  }
4121
4133
  }
4122
4134
  },
4123
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.Stage": {
4135
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.Stage": {
4124
4136
  "type": "E",
4125
4137
  "values": [
4126
4138
  "STAGE_UNSPECIFIED",
@@ -4132,7 +4144,7 @@ export const data = {
4132
4144
  "STAGE_INTERACTIONS"
4133
4145
  ]
4134
4146
  },
4135
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.Kind": {
4147
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.Kind": {
4136
4148
  "type": "E",
4137
4149
  "values": [
4138
4150
  "KIND_UNSPECIFIED",
@@ -4140,7 +4152,7 @@ export const data = {
4140
4152
  "KIND_REASON"
4141
4153
  ]
4142
4154
  },
4143
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.FunnelState": {
4155
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.FunnelState": {
4144
4156
  "type": "E",
4145
4157
  "values": [
4146
4158
  "FUNNEL_STATE_UNSPECIFIED",
@@ -4149,7 +4161,7 @@ export const data = {
4149
4161
  "FUNNEL_STATE_EXPIRED"
4150
4162
  ]
4151
4163
  },
4152
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.DeliveriesForm": {
4164
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.DeliveriesForm": {
4153
4165
  "type": "E",
4154
4166
  "values": [
4155
4167
  "DELIVERIES_FORM_UNSPECIFIED",
@@ -4157,7 +4169,7 @@ export const data = {
4157
4169
  "DELIVERIES_FORM_BASIC"
4158
4170
  ]
4159
4171
  },
4160
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.BasicFormReason": {
4172
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.BasicFormReason": {
4161
4173
  "type": "E",
4162
4174
  "values": [
4163
4175
  "BASIC_FORM_REASON_UNSPECIFIED",
@@ -4167,7 +4179,7 @@ export const data = {
4167
4179
  "BASIC_FORM_REASON_NOT_APPLICABLE"
4168
4180
  ]
4169
4181
  },
4170
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.Channel": {
4182
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.Channel": {
4171
4183
  "type": "E",
4172
4184
  "values": [
4173
4185
  "CHANNEL_UNSPECIFIED",
@@ -4177,31 +4189,31 @@ export const data = {
4177
4189
  "CHANNEL_OTHER"
4178
4190
  ]
4179
4191
  },
4180
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.ChannelFunnel": {
4192
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.ChannelFunnel": {
4181
4193
  "type": "I",
4182
4194
  "fields": {
4183
4195
  "channel": {
4184
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.Channel"
4196
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.Channel"
4185
4197
  },
4186
4198
  "funnel": {
4187
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.StageItem",
4199
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.StageItem",
4188
4200
  "array": true
4189
4201
  },
4190
4202
  "deliveriesForm": {
4191
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.DeliveriesForm"
4203
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.DeliveriesForm"
4192
4204
  },
4193
4205
  "basicFormReason": {
4194
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.BasicFormReason"
4206
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.BasicFormReason"
4195
4207
  },
4196
4208
  "confirmedDeliveries": {
4197
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.ConfirmedDeliveries"
4209
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.ConfirmedDeliveries"
4198
4210
  },
4199
4211
  "emailBounces": {
4200
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.EmailBounces"
4212
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.EmailBounces"
4201
4213
  }
4202
4214
  }
4203
4215
  },
4204
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.PlatformCount": {
4216
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.PlatformCount": {
4205
4217
  "type": "I",
4206
4218
  "fields": {
4207
4219
  "platform": {
@@ -4212,11 +4224,11 @@ export const data = {
4212
4224
  }
4213
4225
  }
4214
4226
  },
4215
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.Piece": {
4227
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.Piece": {
4216
4228
  "type": "I",
4217
4229
  "fields": {
4218
4230
  "kind": {
4219
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.Kind"
4231
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.Kind"
4220
4232
  },
4221
4233
  "category": {
4222
4234
  "type": "string"
@@ -4225,12 +4237,12 @@ export const data = {
4225
4237
  "type": "number"
4226
4238
  },
4227
4239
  "platforms": {
4228
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.PlatformCount",
4240
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.PlatformCount",
4229
4241
  "array": true
4230
4242
  }
4231
4243
  }
4232
4244
  },
4233
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.ErrorRow": {
4245
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.ErrorRow": {
4234
4246
  "type": "I",
4235
4247
  "fields": {
4236
4248
  "category": {
@@ -4240,47 +4252,47 @@ export const data = {
4240
4252
  "type": "number"
4241
4253
  },
4242
4254
  "platforms": {
4243
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.PlatformCount",
4255
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.PlatformCount",
4244
4256
  "array": true
4245
4257
  }
4246
4258
  }
4247
4259
  },
4248
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.StageItem": {
4260
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.StageItem": {
4249
4261
  "type": "I",
4250
4262
  "fields": {
4251
4263
  "stage": {
4252
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.Stage"
4264
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.Stage"
4253
4265
  },
4254
4266
  "count": {
4255
4267
  "type": "number"
4256
4268
  },
4257
4269
  "pieces": {
4258
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.Piece",
4270
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.Piece",
4259
4271
  "array": true
4260
4272
  },
4261
4273
  "errors": {
4262
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.ErrorRow",
4274
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.ErrorRow",
4263
4275
  "array": true
4264
4276
  },
4265
4277
  "platforms": {
4266
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.PlatformCount",
4278
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.PlatformCount",
4267
4279
  "array": true
4268
4280
  }
4269
4281
  }
4270
4282
  },
4271
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.ConfirmedDeliveries": {
4283
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.ConfirmedDeliveries": {
4272
4284
  "type": "I",
4273
4285
  "fields": {
4274
4286
  "count": {
4275
4287
  "type": "number"
4276
4288
  },
4277
4289
  "platforms": {
4278
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.PlatformCount",
4290
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.PlatformCount",
4279
4291
  "array": true
4280
4292
  }
4281
4293
  }
4282
4294
  },
4283
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.EmailBounces": {
4295
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.EmailBounces": {
4284
4296
  "type": "I",
4285
4297
  "fields": {
4286
4298
  "hard": {
@@ -4294,11 +4306,11 @@ export const data = {
4294
4306
  }
4295
4307
  }
4296
4308
  },
4297
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse": {
4309
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse": {
4298
4310
  "type": "I",
4299
4311
  "fields": {
4300
4312
  "channels": {
4301
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.ChannelFunnel",
4313
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.ChannelFunnel",
4302
4314
  "array": true
4303
4315
  },
4304
4316
  "windowFrom": {
@@ -4308,7 +4320,7 @@ export const data = {
4308
4320
  "type": "Date"
4309
4321
  },
4310
4322
  "funnelState": {
4311
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.FunnelState"
4323
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.FunnelState"
4312
4324
  }
4313
4325
  }
4314
4326
  },
@@ -4345,7 +4357,28 @@ export const data = {
4345
4357
  }
4346
4358
  }
4347
4359
  },
4348
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.Metric": {
4360
+ "pushwoosh.statistics.statistics.v2.statistics.GetCampaignDeliveryTimelineRequest": {
4361
+ "type": "I",
4362
+ "fields": {
4363
+ "campaignCode": {
4364
+ "type": "string"
4365
+ },
4366
+ "platforms": {
4367
+ "type": "number",
4368
+ "array": true
4369
+ },
4370
+ "interval": {
4371
+ "type": "pushwoosh.statistics.types.TimeInterval"
4372
+ },
4373
+ "from": {
4374
+ "type": "Date"
4375
+ },
4376
+ "to": {
4377
+ "type": "Date"
4378
+ }
4379
+ }
4380
+ },
4381
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.Metric": {
4349
4382
  "type": "E",
4350
4383
  "values": [
4351
4384
  "METRIC_UNSPECIFIED",
@@ -4356,7 +4389,7 @@ export const data = {
4356
4389
  "METRIC_OPENED"
4357
4390
  ]
4358
4391
  },
4359
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.Point": {
4392
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.Point": {
4360
4393
  "type": "I",
4361
4394
  "fields": {
4362
4395
  "bucket": {
@@ -4367,7 +4400,7 @@ export const data = {
4367
4400
  }
4368
4401
  }
4369
4402
  },
4370
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.PlatformSeries": {
4403
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.PlatformSeries": {
4371
4404
  "type": "I",
4372
4405
  "fields": {
4373
4406
  "platform": {
@@ -4377,31 +4410,31 @@ export const data = {
4377
4410
  "type": "number"
4378
4411
  },
4379
4412
  "points": {
4380
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.Point",
4413
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.Point",
4381
4414
  "array": true
4382
4415
  }
4383
4416
  }
4384
4417
  },
4385
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.MetricSeries": {
4418
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.MetricSeries": {
4386
4419
  "type": "I",
4387
4420
  "fields": {
4388
4421
  "metric": {
4389
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.Metric"
4422
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.Metric"
4390
4423
  },
4391
4424
  "count": {
4392
4425
  "type": "number"
4393
4426
  },
4394
4427
  "platforms": {
4395
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.PlatformSeries",
4428
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.PlatformSeries",
4396
4429
  "array": true
4397
4430
  }
4398
4431
  }
4399
4432
  },
4400
- "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse": {
4433
+ "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse": {
4401
4434
  "type": "I",
4402
4435
  "fields": {
4403
4436
  "series": {
4404
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.MetricSeries",
4437
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.MetricSeries",
4405
4438
  "array": true
4406
4439
  },
4407
4440
  "windowFrom": {
@@ -4411,13 +4444,13 @@ export const data = {
4411
4444
  "type": "Date"
4412
4445
  },
4413
4446
  "funnelState": {
4414
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryFunnelResponse.FunnelState"
4447
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryFunnelResponse.FunnelState"
4415
4448
  },
4416
4449
  "interval": {
4417
4450
  "type": "pushwoosh.statistics.types.TimeInterval"
4418
4451
  },
4419
4452
  "eventAxisMetrics": {
4420
- "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.Metric",
4453
+ "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.Metric",
4421
4454
  "array": true
4422
4455
  }
4423
4456
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-gateway-statistics-api",
3
- "version": "1.3.741",
3
+ "version": "1.3.743",
4
4
  "description": "Statistics API gateway HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",
@@ -12,8 +12,10 @@ export type StatisticsService_GetMAUStatistics = RpcMethod<GetMAUStatisticsReque
12
12
  export type StatisticsService_GetDAUStatistics = RpcMethod<GetDAUStatisticsRequest, GetDAUStatisticsResponse>;
13
13
  export type StatisticsService_GetPushApplicationStatistics = RpcMethod<GetPushApplicationStatisticsRequest, GetPushApplicationStatisticsResponse>;
14
14
  export type StatisticsService_GetEmailApplicationStatistics = RpcMethod<GetEmailApplicationStatisticsRequest, GetEmailApplicationStatisticsResponse>;
15
- export type StatisticsService_GetMessageDeliveryFunnel = RpcMethod<GetMessageDeliveryFunnelRequest, GetMessageDeliveryFunnelResponse>;
16
- export type StatisticsService_GetMessageDeliveryTimeline = RpcMethod<GetMessageDeliveryTimelineRequest, GetMessageDeliveryTimelineResponse>;
15
+ export type StatisticsService_GetMessageDeliveryFunnel = RpcMethod<GetMessageDeliveryFunnelRequest, GetDeliveryFunnelResponse>;
16
+ export type StatisticsService_GetCampaignDeliveryFunnel = RpcMethod<GetCampaignDeliveryFunnelRequest, GetDeliveryFunnelResponse>;
17
+ export type StatisticsService_GetMessageDeliveryTimeline = RpcMethod<GetMessageDeliveryTimelineRequest, GetDeliveryTimelineResponse>;
18
+ export type StatisticsService_GetCampaignDeliveryTimeline = RpcMethod<GetCampaignDeliveryTimelineRequest, GetDeliveryTimelineResponse>;
17
19
  export type StatisticsService_GetActiveAudience = RpcMethod<GetActiveAudienceRequest, GetActiveAudienceResponse>;
18
20
  /** StatisticsService provides various statistics operations */
19
21
  export interface StatisticsService {
@@ -46,11 +48,21 @@ export interface StatisticsService {
46
48
  * -> opened -> interactions. A stage equals the sum of its pieces, all of them.
47
49
  */
48
50
  GetMessageDeliveryFunnel: StatisticsService_GetMessageDeliveryFunnel;
51
+ /**
52
+ * GetCampaignDeliveryFunnel sums GetMessageDeliveryFunnel over a campaign's messages.
53
+ * Uniques stay unique within a message, so one subscriber can count more than once.
54
+ */
55
+ GetCampaignDeliveryFunnel: StatisticsService_GetCampaignDeliveryFunnel;
49
56
  /**
50
57
  * GetMessageDeliveryTimeline returns the same message's numbers over time: the funnel
51
58
  * answers "how many", this answers "when".
52
59
  */
53
60
  GetMessageDeliveryTimeline: StatisticsService_GetMessageDeliveryTimeline;
61
+ /**
62
+ * GetCampaignDeliveryTimeline is GetMessageDeliveryTimeline over a campaign's messages.
63
+ * Uniques stay unique within a message, so one subscriber can count more than once.
64
+ */
65
+ GetCampaignDeliveryTimeline: StatisticsService_GetCampaignDeliveryTimeline;
54
66
  /** GetActiveAudience returns active users and active devices groped by application and platform */
55
67
  GetActiveAudience: StatisticsService_GetActiveAudience;
56
68
  }
@@ -574,7 +586,7 @@ export type GetMessageDeliveryFunnelRequest = {
574
586
  * Stage is a funnel level. Stages always come in the order they appear in the
575
587
  * funnel array; the numbers here do not define that order.
576
588
  */
577
- export type GetMessageDeliveryFunnelResponse_Stage = 'STAGE_UNSPECIFIED'
589
+ export type GetDeliveryFunnelResponse_Stage = 'STAGE_UNSPECIFIED'
578
590
  /** taken into processing */
579
591
  | 'STAGE_AUDIENCE'
580
592
  /** accepted by the gateway */
@@ -594,7 +606,7 @@ export type GetMessageDeliveryFunnelResponse_Stage = 'STAGE_UNSPECIFIED'
594
606
  * Kind tells how a piece relates to its stage total. Every piece is a summand: the
595
607
  * pieces of a stage are disjoint and add up to its count.
596
608
  */
597
- export type GetMessageDeliveryFunnelResponse_Kind = 'KIND_UNSPECIFIED'
609
+ export type GetDeliveryFunnelResponse_Kind = 'KIND_UNSPECIFIED'
598
610
  /** moved on to the next stage */
599
611
  | 'KIND_PASSED'
600
612
  /** did not move on, for this reason */
@@ -603,7 +615,7 @@ export type GetMessageDeliveryFunnelResponse_Kind = 'KIND_UNSPECIFIED'
603
615
  * FunnelState describes the response before any stage is read: an empty funnel has two
604
616
  * very different meanings and one shape.
605
617
  */
606
- export type GetMessageDeliveryFunnelResponse_FunnelState = 'FUNNEL_STATE_UNSPECIFIED'
618
+ export type GetDeliveryFunnelResponse_FunnelState = 'FUNNEL_STATE_UNSPECIFIED'
607
619
  /** the funnel is populated */
608
620
  | 'FUNNEL_STATE_READY'
609
621
  /** nothing happened for this message yet */
@@ -614,7 +626,7 @@ export type GetMessageDeliveryFunnelResponse_FunnelState = 'FUNNEL_STATE_UNSPECI
614
626
  * DeliveriesForm tells which breakdown STAGE_DELIVERIES carries. The forms count
615
627
  * different sets, so their rows are not continuous. There is no withheld form.
616
628
  */
617
- export type GetMessageDeliveryFunnelResponse_DeliveriesForm = 'DELIVERIES_FORM_UNSPECIFIED'
629
+ export type GetDeliveryFunnelResponse_DeliveriesForm = 'DELIVERIES_FORM_UNSPECIFIED'
618
630
  /** three disjoint rows, alert state known */
619
631
  | 'DELIVERIES_FORM_PER_DEVICE'
620
632
  /** two rows, alert state unknown */
@@ -623,7 +635,7 @@ export type GetMessageDeliveryFunnelResponse_DeliveriesForm = 'DELIVERIES_FORM_U
623
635
  * BasicFormReason explains why the per-device breakdown is missing; set only in the
624
636
  * basic form. NO_DELIVERIES is not NO_EVENTS — sends did happen.
625
637
  */
626
- export type GetMessageDeliveryFunnelResponse_BasicFormReason = 'BASIC_FORM_REASON_UNSPECIFIED'
638
+ export type GetDeliveryFunnelResponse_BasicFormReason = 'BASIC_FORM_REASON_UNSPECIFIED'
627
639
  /** older than the row-level log keeps */
628
640
  | 'BASIC_FORM_REASON_RETENTION'
629
641
  /** system message, account not covered */
@@ -639,7 +651,7 @@ export type GetMessageDeliveryFunnelResponse_BasicFormReason = 'BASIC_FORM_REASO
639
651
  * Channel groups platforms by how their funnel reads. Web push is apart from mobile
640
652
  * push because its alert state is always on: an ALERTS_DISABLED row could not fill.
641
653
  */
642
- export type GetMessageDeliveryFunnelResponse_Channel = 'CHANNEL_UNSPECIFIED'
654
+ export type GetDeliveryFunnelResponse_Channel = 'CHANNEL_UNSPECIFIED'
643
655
  /** iOS, OSX, Android, Amazon, Huawei */
644
656
  | 'CHANNEL_MOBILE_PUSH'
645
657
  /** Safari, Chrome, Firefox */
@@ -650,67 +662,67 @@ export type GetMessageDeliveryFunnelResponse_Channel = 'CHANNEL_UNSPECIFIED'
650
662
  * ChannelFunnel is one channel's whole funnel. The form belongs here rather than to
651
663
  * the response: a message on iOS and Email carries two different ones at once.
652
664
  */
653
- export type GetMessageDeliveryFunnelResponse_ChannelFunnel = {
654
- channel: GetMessageDeliveryFunnelResponse_Channel;
655
- funnel: GetMessageDeliveryFunnelResponse_StageItem[];
656
- deliveriesForm: GetMessageDeliveryFunnelResponse_DeliveriesForm;
657
- basicFormReason: GetMessageDeliveryFunnelResponse_BasicFormReason;
658
- confirmedDeliveries: GetMessageDeliveryFunnelResponse_ConfirmedDeliveries;
665
+ export type GetDeliveryFunnelResponse_ChannelFunnel = {
666
+ channel: GetDeliveryFunnelResponse_Channel;
667
+ funnel: GetDeliveryFunnelResponse_StageItem[];
668
+ deliveriesForm: GetDeliveryFunnelResponse_DeliveriesForm;
669
+ basicFormReason: GetDeliveryFunnelResponse_BasicFormReason;
670
+ confirmedDeliveries: GetDeliveryFunnelResponse_ConfirmedDeliveries;
659
671
  /** Email only, absent when not measured. Never a stage row — see EmailBounces. */
660
- emailBounces: GetMessageDeliveryFunnelResponse_EmailBounces;
672
+ emailBounces: GetDeliveryFunnelResponse_EmailBounces;
661
673
  };
662
674
  /**
663
675
  * PlatformCount is one platform's share of the number above it; the parent is always
664
676
  * their sum. A platform with nothing to report is absent, which is not a zero.
665
677
  */
666
- export type GetMessageDeliveryFunnelResponse_PlatformCount = {
678
+ export type GetDeliveryFunnelResponse_PlatformCount = {
667
679
  platform: number;
668
680
  count: number;
669
681
  };
670
682
  /** Piece is one row of the funnel table. */
671
- export type GetMessageDeliveryFunnelResponse_Piece = {
672
- kind: GetMessageDeliveryFunnelResponse_Kind;
683
+ export type GetDeliveryFunnelResponse_Piece = {
684
+ kind: GetDeliveryFunnelResponse_Kind;
673
685
  /** FREQUENCY_CAPPING, ACCEPTED_BY_GATEWAY, ... */
674
686
  category: string;
675
687
  count: number;
676
- platforms: GetMessageDeliveryFunnelResponse_PlatformCount[];
688
+ platforms: GetDeliveryFunnelResponse_PlatformCount[];
677
689
  };
678
690
  /**
679
691
  * ErrorRow is what STAGE_ERRORS carries instead of pieces: a Piece in all but name,
680
692
  * since every row of that stage is a drop-out.
681
693
  */
682
- export type GetMessageDeliveryFunnelResponse_ErrorRow = {
694
+ export type GetDeliveryFunnelResponse_ErrorRow = {
683
695
  /** INVALID_TOKEN, QUOTA_EXCEEDED, INTERNAL_ERROR, ... */
684
696
  category: string;
685
697
  count: number;
686
- platforms: GetMessageDeliveryFunnelResponse_PlatformCount[];
698
+ platforms: GetDeliveryFunnelResponse_PlatformCount[];
687
699
  };
688
700
  /**
689
701
  * StageItem is one funnel level with its breakdown. STAGE_DELIVERIES counts accepted
690
702
  * sends — how many there were to confirm, not how many confirmed.
691
703
  */
692
- export type GetMessageDeliveryFunnelResponse_StageItem = {
693
- stage: GetMessageDeliveryFunnelResponse_Stage;
704
+ export type GetDeliveryFunnelResponse_StageItem = {
705
+ stage: GetDeliveryFunnelResponse_Stage;
694
706
  count: number;
695
707
  /** empty on STAGE_ERRORS */
696
- pieces: GetMessageDeliveryFunnelResponse_Piece[];
708
+ pieces: GetDeliveryFunnelResponse_Piece[];
697
709
  /** STAGE_ERRORS only */
698
- errors: GetMessageDeliveryFunnelResponse_ErrorRow[];
699
- platforms: GetMessageDeliveryFunnelResponse_PlatformCount[];
710
+ errors: GetDeliveryFunnelResponse_ErrorRow[];
711
+ platforms: GetDeliveryFunnelResponse_PlatformCount[];
700
712
  };
701
713
  /**
702
714
  * ConfirmedDeliveries equals the tracking log CSV export: past the accepted set, never
703
715
  * clamped (derive no stage row), email-only without allow_show_delivery_statistics.
704
716
  */
705
- export type GetMessageDeliveryFunnelResponse_ConfirmedDeliveries = {
717
+ export type GetDeliveryFunnelResponse_ConfirmedDeliveries = {
706
718
  count: number;
707
- platforms: GetMessageDeliveryFunnelResponse_PlatformCount[];
719
+ platforms: GetDeliveryFunnelResponse_PlatformCount[];
708
720
  };
709
721
  /**
710
722
  * EmailBounces is what the mail provider refused, in recipient addresses. It sits beside
711
723
  * the stages and belongs to none of them, on purpose and never clamped.
712
724
  */
713
- export type GetMessageDeliveryFunnelResponse_EmailBounces = {
725
+ export type GetDeliveryFunnelResponse_EmailBounces = {
714
726
  /** at least one permanent refusal */
715
727
  hard: number;
716
728
  /** refused, never permanently */
@@ -721,19 +733,23 @@ export type GetMessageDeliveryFunnelResponse_EmailBounces = {
721
733
  */
722
734
  alsoConfirmed: number;
723
735
  };
724
- export type GetMessageDeliveryFunnelResponse = {
736
+ /**
737
+ * GetDeliveryFunnelResponse is the shared answer of both funnel methods: a campaign's
738
+ * funnel is the sum of its messages' funnels, so the shape has to be the same one.
739
+ */
740
+ export type GetDeliveryFunnelResponse = {
725
741
  /**
726
742
  * Channels are not ordered; a client looks one up by its channel field, not by
727
743
  * position.
728
744
  */
729
- channels: GetMessageDeliveryFunnelResponse_ChannelFunnel[];
745
+ channels: GetDeliveryFunnelResponse_ChannelFunnel[];
730
746
  /**
731
747
  * The window the funnel was computed over, derived from the data: the numbers are
732
748
  * meaningless without it, and the pre-aggregate TTL can cut it short.
733
749
  */
734
750
  windowFrom: Date;
735
751
  windowTo: Date;
736
- funnelState: GetMessageDeliveryFunnelResponse_FunnelState;
752
+ funnelState: GetDeliveryFunnelResponse_FunnelState;
737
753
  };
738
754
  /**
739
755
  * GetCampaignDeliveryFunnelRequest asks for one campaign's funnel. No time range, for the
@@ -766,11 +782,32 @@ export type GetMessageDeliveryTimelineRequest = {
766
782
  from: Date;
767
783
  to: Date;
768
784
  };
785
+ /**
786
+ * GetCampaignDeliveryTimelineRequest asks for one campaign's metrics over time. Same
787
+ * window rules as the message timeline; the window is the campaign's, not one message's.
788
+ */
789
+ export type GetCampaignDeliveryTimelineRequest = {
790
+ /** Campaign code, required */
791
+ campaignCode: string;
792
+ /** Optional platform ID filter */
793
+ platforms: number[];
794
+ /**
795
+ * Bucket width. Unset lets the server pick from the window as every other series here
796
+ * does: a year -> month, over a month -> day, over a day -> hour, else minute.
797
+ */
798
+ interval: pushwoosh_statistics_types_TimeInterval;
799
+ /**
800
+ * The window to read; an unset end is the campaign's own, and narrowing it narrows the
801
+ * counts. A stated `from` rounds down to the minute, `to` clips exactly, derived — a day wide.
802
+ */
803
+ from: Date;
804
+ to: Date;
805
+ };
769
806
  /**
770
807
  * Metric is one line of the chart. Metrics, not funnel stages: STAGE_DELIVERIES
771
808
  * counts accepted sends, and the number a reader wants there is not a stage at all.
772
809
  */
773
- export type GetMessageDeliveryTimelineResponse_Metric = 'METRIC_UNSPECIFIED'
810
+ export type GetDeliveryTimelineResponse_Metric = 'METRIC_UNSPECIFIED'
774
811
  /** taken into processing */
775
812
  | 'METRIC_AUDIENCE'
776
813
  /** accepted by the gateway */
@@ -785,7 +822,7 @@ export type GetMessageDeliveryTimelineResponse_Metric = 'METRIC_UNSPECIFIED'
785
822
  * Point is one bucket of a series, always UTC. Empty buckets are not emitted: the
786
823
  * client draws the axis from the window and the interval.
787
824
  */
788
- export type GetMessageDeliveryTimelineResponse_Point = {
825
+ export type GetDeliveryTimelineResponse_Point = {
789
826
  /** start of the interval */
790
827
  bucket: Date;
791
828
  count: number;
@@ -794,21 +831,25 @@ export type GetMessageDeliveryTimelineResponse_Point = {
794
831
  * PlatformSeries is one platform's line: a metric's count is the sum of its platforms,
795
832
  * and a platform's points sum to its own count.
796
833
  */
797
- export type GetMessageDeliveryTimelineResponse_PlatformSeries = {
834
+ export type GetDeliveryTimelineResponse_PlatformSeries = {
798
835
  platform: number;
799
836
  count: number;
800
- points: GetMessageDeliveryTimelineResponse_Point[];
837
+ points: GetDeliveryTimelineResponse_Point[];
801
838
  };
802
- export type GetMessageDeliveryTimelineResponse_MetricSeries = {
803
- metric: GetMessageDeliveryTimelineResponse_Metric;
839
+ export type GetDeliveryTimelineResponse_MetricSeries = {
840
+ metric: GetDeliveryTimelineResponse_Metric;
804
841
  count: number;
805
- platforms: GetMessageDeliveryTimelineResponse_PlatformSeries[];
842
+ platforms: GetDeliveryTimelineResponse_PlatformSeries[];
806
843
  };
807
- export type GetMessageDeliveryTimelineResponse = {
808
- series: GetMessageDeliveryTimelineResponse_MetricSeries[];
844
+ /**
845
+ * GetDeliveryTimelineResponse is the shared answer of both timeline methods: a campaign's
846
+ * series is the same shape as a message's, summed over the campaign's messages.
847
+ */
848
+ export type GetDeliveryTimelineResponse = {
849
+ series: GetDeliveryTimelineResponse_MetricSeries[];
809
850
  /**
810
- * The window actually read: what the request asked for, clamped to the data,
811
- * or the message's own window when the request asked for neither end.
851
+ * The window actually read: what the request asked for, clamped to the data, or the
852
+ * subject's own window when the request asked for neither end.
812
853
  */
813
854
  windowFrom: Date;
814
855
  windowTo: Date;
@@ -816,7 +857,7 @@ export type GetMessageDeliveryTimelineResponse = {
816
857
  * Same three states as the funnel, and for the same reasons: an empty answer
817
858
  * has to say which kind of empty it is.
818
859
  */
819
- funnelState: GetMessageDeliveryFunnelResponse_FunnelState;
860
+ funnelState: GetDeliveryFunnelResponse_FunnelState;
820
861
  /**
821
862
  * The bucket width actually used, whether it came from the request or from the
822
863
  * automatic pick.
@@ -826,7 +867,7 @@ export type GetMessageDeliveryTimelineResponse = {
826
867
  * These metrics are counted when the device answered, the others when we sent. The
827
868
  * metrics of one bucket are therefore not a funnel: they reconcile over the window.
828
869
  */
829
- eventAxisMetrics: GetMessageDeliveryTimelineResponse_Metric[];
870
+ eventAxisMetrics: GetDeliveryTimelineResponse_Metric[];
830
871
  };
831
872
  /** ActiveAudienceType specifies the type of active users calculation */
832
873
  export type ActiveAudienceType =