@pushwoosh/rpc-v2-http-api-data 0.2.303 → 0.2.305
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/applications_controlgroup.d.ts +16 -0
- package/data.js +90 -5
- package/package.json +1 -1
- package/pushwoosh_export_messages_v2.d.ts +46 -6
|
@@ -4,6 +4,7 @@ export type ApplicationsControlGroupService_CreateControlGroup = RpcMethod<Creat
|
|
|
4
4
|
export type ApplicationsControlGroupService_GetControlGroup = RpcMethod<GetControlGroupRequest, GetControlGroupResponse>;
|
|
5
5
|
export type ApplicationsControlGroupService_DeleteControlGroup = RpcMethod<DeleteControlGroupRequest, DeleteControlGroupResponse>;
|
|
6
6
|
export type ApplicationsControlGroupService_UpdateControlGroupPercentage = RpcMethod<UpdateControlGroupPercentageRequest, UpdateControlGroupPercentageResponse>;
|
|
7
|
+
export type ApplicationsControlGroupService_UpdateControlGroupCountries = RpcMethod<UpdateControlGroupCountriesRequest, UpdateControlGroupCountriesResponse>;
|
|
7
8
|
export type ApplicationsControlGroupService_DisableControlGroup = RpcMethod<DisableControlGroupRequest, DisableControlGroupResponse>;
|
|
8
9
|
export type ApplicationsControlGroupService_ReshuffleControlGroup = RpcMethod<ReshuffleControlGroupRequest, ReshuffleControlGroupResponse>;
|
|
9
10
|
export type ApplicationsControlGroupService_ForceUpdateControlGroupCalculation = RpcMethod<ForceUpdateControlGroupCalculationRequest, ForceUpdateControlGroupCalculationResponse>;
|
|
@@ -29,6 +30,8 @@ export interface ApplicationsControlGroupService {
|
|
|
29
30
|
DeleteControlGroup: ApplicationsControlGroupService_DeleteControlGroup;
|
|
30
31
|
/** Sets the hold-out percentage (1-20) of one control group. Resizing keeps every existing member: the hold-out grows or shrinks around them rather than being redrawn. */
|
|
31
32
|
UpdateControlGroupPercentage: ApplicationsControlGroupService_UpdateControlGroupPercentage;
|
|
33
|
+
/** Sets the countries one control group is scoped to (lowercase ISO-3166-1 alpha-2, empty list means the whole base). Changing the scope restarts the uplift measurement, because the population being compared changes; the hold-out itself is not redrawn. */
|
|
34
|
+
UpdateControlGroupCountries: ApplicationsControlGroupService_UpdateControlGroupCountries;
|
|
32
35
|
/** Switches one control group off, keeping it and its generation so that switching it back on restores the same hold-out rather than drawing a new one. */
|
|
33
36
|
DisableControlGroup: ApplicationsControlGroupService_DisableControlGroup;
|
|
34
37
|
/** Redraws one control group's hold-out by incrementing its generation. This is the only way to get a different sample: membership is deterministic, so disabling and re-enabling reproduces exactly the same one. */
|
|
@@ -86,6 +89,8 @@ export type ControlGroup = {
|
|
|
86
89
|
* <application_id>:<generation>:<name>:<user_id> the hash is taken over.
|
|
87
90
|
*/
|
|
88
91
|
applicationId: number;
|
|
92
|
+
/** Countries the hold-out is scoped to, lowercase ISO-3166-1 alpha-2; empty is every country. */
|
|
93
|
+
countries: string[];
|
|
89
94
|
};
|
|
90
95
|
export type ListControlGroupsRequest = {
|
|
91
96
|
/** Application code (format XXXXX-XXXXX) whose control groups to list. */
|
|
@@ -103,6 +108,8 @@ export type CreateControlGroupRequest = {
|
|
|
103
108
|
percentage?: number;
|
|
104
109
|
/** Seglang expression to measure the group over; empty means the whole base. */
|
|
105
110
|
segment?: string;
|
|
111
|
+
/** Countries to scope the hold-out to, lowercase ISO-3166-1 alpha-2; empty means every country. */
|
|
112
|
+
countries?: string[];
|
|
106
113
|
};
|
|
107
114
|
export type CreateControlGroupResponse = {
|
|
108
115
|
group: ControlGroup;
|
|
@@ -139,6 +146,15 @@ export type UpdateControlGroupPercentageRequest = {
|
|
|
139
146
|
percentage?: number;
|
|
140
147
|
};
|
|
141
148
|
export type UpdateControlGroupPercentageResponse = {};
|
|
149
|
+
export type UpdateControlGroupCountriesRequest = {
|
|
150
|
+
/** Application code (format XXXXX-XXXXX) the group belongs to. */
|
|
151
|
+
code?: string;
|
|
152
|
+
/** Control group code (format XXXXX-XXXXX) to scope. */
|
|
153
|
+
controlGroupCode?: string;
|
|
154
|
+
/** Lowercase ISO-3166-1 alpha-2 codes; an empty list widens the group back to the whole base. */
|
|
155
|
+
countries?: string[];
|
|
156
|
+
};
|
|
157
|
+
export type UpdateControlGroupCountriesResponse = {};
|
|
142
158
|
export type DisableControlGroupRequest = {
|
|
143
159
|
/** Application code (format XXXXX-XXXXX) the group belongs to. */
|
|
144
160
|
code?: string;
|
package/data.js
CHANGED
|
@@ -6887,6 +6887,12 @@ export const data = {
|
|
|
6887
6887
|
"method": "post",
|
|
6888
6888
|
"path": "/api/applications/{code}/control_groups/{control_group_code}"
|
|
6889
6889
|
},
|
|
6890
|
+
"UpdateControlGroupCountries": {
|
|
6891
|
+
"request": "pushwoosh.rpc_v2.applications_controlgroup.UpdateControlGroupCountriesRequest",
|
|
6892
|
+
"response": "pushwoosh.rpc_v2.applications_controlgroup.UpdateControlGroupCountriesResponse",
|
|
6893
|
+
"method": "post",
|
|
6894
|
+
"path": "/api/applications/{code}/control_groups/{control_group_code}/countries"
|
|
6895
|
+
},
|
|
6890
6896
|
"DisableControlGroup": {
|
|
6891
6897
|
"request": "pushwoosh.rpc_v2.applications_controlgroup.DisableControlGroupRequest",
|
|
6892
6898
|
"response": "pushwoosh.rpc_v2.applications_controlgroup.DisableControlGroupResponse",
|
|
@@ -6989,6 +6995,10 @@ export const data = {
|
|
|
6989
6995
|
},
|
|
6990
6996
|
"applicationId": {
|
|
6991
6997
|
"type": "number"
|
|
6998
|
+
},
|
|
6999
|
+
"countries": {
|
|
7000
|
+
"type": "string",
|
|
7001
|
+
"array": true
|
|
6992
7002
|
}
|
|
6993
7003
|
}
|
|
6994
7004
|
},
|
|
@@ -7023,6 +7033,10 @@ export const data = {
|
|
|
7023
7033
|
},
|
|
7024
7034
|
"segment": {
|
|
7025
7035
|
"type": "string"
|
|
7036
|
+
},
|
|
7037
|
+
"countries": {
|
|
7038
|
+
"type": "string",
|
|
7039
|
+
"array": true
|
|
7026
7040
|
}
|
|
7027
7041
|
}
|
|
7028
7042
|
},
|
|
@@ -7098,6 +7112,25 @@ export const data = {
|
|
|
7098
7112
|
"type": "I",
|
|
7099
7113
|
"fields": {}
|
|
7100
7114
|
},
|
|
7115
|
+
"pushwoosh.rpc_v2.applications_controlgroup.UpdateControlGroupCountriesRequest": {
|
|
7116
|
+
"type": "I",
|
|
7117
|
+
"fields": {
|
|
7118
|
+
"code": {
|
|
7119
|
+
"type": "string"
|
|
7120
|
+
},
|
|
7121
|
+
"controlGroupCode": {
|
|
7122
|
+
"type": "string"
|
|
7123
|
+
},
|
|
7124
|
+
"countries": {
|
|
7125
|
+
"type": "string",
|
|
7126
|
+
"array": true
|
|
7127
|
+
}
|
|
7128
|
+
}
|
|
7129
|
+
},
|
|
7130
|
+
"pushwoosh.rpc_v2.applications_controlgroup.UpdateControlGroupCountriesResponse": {
|
|
7131
|
+
"type": "I",
|
|
7132
|
+
"fields": {}
|
|
7133
|
+
},
|
|
7101
7134
|
"pushwoosh.rpc_v2.applications_controlgroup.DisableControlGroupRequest": {
|
|
7102
7135
|
"type": "I",
|
|
7103
7136
|
"fields": {
|
|
@@ -13699,7 +13732,8 @@ export const data = {
|
|
|
13699
13732
|
"TASK_TYPE_EXPORT_MESSAGE_UNSUBSCRIBED",
|
|
13700
13733
|
"TASK_TYPE_EXPORT_MESSAGE_ERROR_RECIPIENTS",
|
|
13701
13734
|
"TASK_TYPE_EXPORT_EMAIL_SUPPRESSIONS",
|
|
13702
|
-
"TASK_TYPE_EXPORT_API_TOKEN_USAGE"
|
|
13735
|
+
"TASK_TYPE_EXPORT_API_TOKEN_USAGE",
|
|
13736
|
+
"TASK_TYPE_EXPORT_CONTROL_GROUP_ANALYTICS"
|
|
13703
13737
|
]
|
|
13704
13738
|
},
|
|
13705
13739
|
"pushwoosh.export_messages.v2.ExportRequest": {
|
|
@@ -13800,6 +13834,9 @@ export const data = {
|
|
|
13800
13834
|
},
|
|
13801
13835
|
"exportApiTokenUsage": {
|
|
13802
13836
|
"type": "pushwoosh.export_messages.v2.ExportApiTokenUsageArgs"
|
|
13837
|
+
},
|
|
13838
|
+
"exportControlGroupAnalytics": {
|
|
13839
|
+
"type": "pushwoosh.export_messages.v2.ExportControlGroupAnalyticsArgs"
|
|
13803
13840
|
}
|
|
13804
13841
|
},
|
|
13805
13842
|
"oneofs": {
|
|
@@ -13835,7 +13872,8 @@ export const data = {
|
|
|
13835
13872
|
"exportMessageUnsubscribed",
|
|
13836
13873
|
"exportMessageErrorRecipients",
|
|
13837
13874
|
"exportEmailSuppressions",
|
|
13838
|
-
"exportApiTokenUsage"
|
|
13875
|
+
"exportApiTokenUsage",
|
|
13876
|
+
"exportControlGroupAnalytics"
|
|
13839
13877
|
]
|
|
13840
13878
|
}
|
|
13841
13879
|
}
|
|
@@ -13997,6 +14035,9 @@ export const data = {
|
|
|
13997
14035
|
},
|
|
13998
14036
|
"exportApiTokenUsageResult": {
|
|
13999
14037
|
"type": "pushwoosh.export_messages.v2.ExportApiTokenUsageResult"
|
|
14038
|
+
},
|
|
14039
|
+
"exportControlGroupAnalyticsResult": {
|
|
14040
|
+
"type": "pushwoosh.export_messages.v2.ExportControlGroupAnalyticsResult"
|
|
14000
14041
|
}
|
|
14001
14042
|
},
|
|
14002
14043
|
"oneofs": {
|
|
@@ -14033,7 +14074,8 @@ export const data = {
|
|
|
14033
14074
|
"exportMessageUnsubscribedResult",
|
|
14034
14075
|
"exportMessageErrorRecipientsResult",
|
|
14035
14076
|
"exportEmailSuppressionsResult",
|
|
14036
|
-
"exportApiTokenUsageResult"
|
|
14077
|
+
"exportApiTokenUsageResult",
|
|
14078
|
+
"exportControlGroupAnalyticsResult"
|
|
14037
14079
|
]
|
|
14038
14080
|
}
|
|
14039
14081
|
}
|
|
@@ -14179,6 +14221,9 @@ export const data = {
|
|
|
14179
14221
|
"exportApiTokenUsage": {
|
|
14180
14222
|
"type": "pushwoosh.export_messages.v2.ExportApiTokenUsageArgs"
|
|
14181
14223
|
},
|
|
14224
|
+
"exportControlGroupAnalytics": {
|
|
14225
|
+
"type": "pushwoosh.export_messages.v2.ExportControlGroupAnalyticsArgs"
|
|
14226
|
+
},
|
|
14182
14227
|
"failedTask": {
|
|
14183
14228
|
"type": "pushwoosh.export_messages.v2.TaskFailed"
|
|
14184
14229
|
},
|
|
@@ -14265,6 +14310,9 @@ export const data = {
|
|
|
14265
14310
|
},
|
|
14266
14311
|
"exportApiTokenUsageResult": {
|
|
14267
14312
|
"type": "pushwoosh.export_messages.v2.ExportApiTokenUsageResult"
|
|
14313
|
+
},
|
|
14314
|
+
"exportControlGroupAnalyticsResult": {
|
|
14315
|
+
"type": "pushwoosh.export_messages.v2.ExportControlGroupAnalyticsResult"
|
|
14268
14316
|
}
|
|
14269
14317
|
},
|
|
14270
14318
|
"oneofs": {
|
|
@@ -14297,7 +14345,8 @@ export const data = {
|
|
|
14297
14345
|
"exportMessageUnsubscribed",
|
|
14298
14346
|
"exportMessageErrorRecipients",
|
|
14299
14347
|
"exportEmailSuppressions",
|
|
14300
|
-
"exportApiTokenUsage"
|
|
14348
|
+
"exportApiTokenUsage",
|
|
14349
|
+
"exportControlGroupAnalytics"
|
|
14301
14350
|
]
|
|
14302
14351
|
},
|
|
14303
14352
|
"result": {
|
|
@@ -14330,7 +14379,8 @@ export const data = {
|
|
|
14330
14379
|
"exportMessageUnsubscribedResult",
|
|
14331
14380
|
"exportMessageErrorRecipientsResult",
|
|
14332
14381
|
"exportEmailSuppressionsResult",
|
|
14333
|
-
"exportApiTokenUsageResult"
|
|
14382
|
+
"exportApiTokenUsageResult",
|
|
14383
|
+
"exportControlGroupAnalyticsResult"
|
|
14334
14384
|
]
|
|
14335
14385
|
}
|
|
14336
14386
|
}
|
|
@@ -15372,6 +15422,37 @@ export const data = {
|
|
|
15372
15422
|
}
|
|
15373
15423
|
}
|
|
15374
15424
|
},
|
|
15425
|
+
"pushwoosh.export_messages.v2.ExportControlGroupAnalyticsArgs": {
|
|
15426
|
+
"type": "I",
|
|
15427
|
+
"fields": {
|
|
15428
|
+
"applicationCode": {
|
|
15429
|
+
"type": "string"
|
|
15430
|
+
},
|
|
15431
|
+
"dateFrom": {
|
|
15432
|
+
"type": "string"
|
|
15433
|
+
},
|
|
15434
|
+
"dateTo": {
|
|
15435
|
+
"type": "string"
|
|
15436
|
+
},
|
|
15437
|
+
"campaign": {
|
|
15438
|
+
"type": "string"
|
|
15439
|
+
},
|
|
15440
|
+
"journey": {
|
|
15441
|
+
"type": "string"
|
|
15442
|
+
}
|
|
15443
|
+
}
|
|
15444
|
+
},
|
|
15445
|
+
"pushwoosh.export_messages.v2.ExportControlGroupAnalyticsResult": {
|
|
15446
|
+
"type": "I",
|
|
15447
|
+
"fields": {
|
|
15448
|
+
"file": {
|
|
15449
|
+
"type": "string"
|
|
15450
|
+
},
|
|
15451
|
+
"fileUrl": {
|
|
15452
|
+
"type": "string"
|
|
15453
|
+
}
|
|
15454
|
+
}
|
|
15455
|
+
},
|
|
15375
15456
|
"pushwoosh.export_messages.v2.ExportMessageErrorRecipientsArgs": {
|
|
15376
15457
|
"type": "I",
|
|
15377
15458
|
"fields": {
|
|
@@ -15702,6 +15783,10 @@ export const data = {
|
|
|
15702
15783
|
},
|
|
15703
15784
|
"messageType": {
|
|
15704
15785
|
"type": "string"
|
|
15786
|
+
},
|
|
15787
|
+
"applications": {
|
|
15788
|
+
"type": "string",
|
|
15789
|
+
"array": true
|
|
15705
15790
|
}
|
|
15706
15791
|
}
|
|
15707
15792
|
},
|
package/package.json
CHANGED
|
@@ -6,7 +6,7 @@ export type TaskType = 'TASK_TYPE_UNSPECIFIED' | 'TASK_TYPE_FAILED' | 'TASK_TYPE
|
|
|
6
6
|
/** deprecated */
|
|
7
7
|
| 'TASK_TYPE_EXPORT_APPLY_SEGMENT_TO_MESSAGE' | 'TASK_TYPE_CALCULATE_RETENTION'
|
|
8
8
|
/** deprecated */
|
|
9
|
-
| 'TASK_TYPE_APPLY_SEGMENT_TO_METRIC' | 'TASK_TYPE_EXPORT_RICH_MEDIA_RECIPIENTS' | 'TASK_TYPE_EXPORT_BOUNCED_EMAILS' | 'TASK_TYPE_EXPORT_JOURNEYS_HISTORY' | 'TASK_TYPE_EXPORT_JOURNEY_POINT_USERS' | 'TASK_TYPE_EXPORT_MESSAGE_RECIPIENTS' | 'TASK_TYPE_EXPORT_MESSAGE_CLICKS_DEVICES' | 'TASK_TYPE_EXPORT_MESSAGE_EVENT_TRIGGERED_DEVICES' | 'TASK_TYPE_EXPORT_MESSAGE_ERROR_DEVICES' | 'TASK_TYPE_CREATE_SEGMENT_FROM_MESSAGE' | 'TASK_TYPE_UPDATE_SEGMENT_INSIGHTS_LIST' | 'TASK_TYPE_EXPORT_JOURNEY_USERS_LIST' | 'TASK_TYPE_EXPORT_JOURNEY_POINTS_STATISTICS' | 'TASK_TYPE_EXPORT_JOURNEY_GOAL_USERS' | 'TASK_TYPE_EXPORT_CONTROL_GROUP' | 'TASK_TYPE_EXPORT_SUBSCRIPTION_FORM_SUBSCRIBED_USERS' | 'TASK_TYPE_EXPORT_UNIFIED_MESSAGES' | 'TASK_TYPE_EXPORT_MESSAGE_AUDIENCE' | 'TASK_TYPE_EXPORT_MESSAGE_STAGE_RECIPIENTS' | 'TASK_TYPE_EXPORT_MESSAGE_CLICKED_RECIPIENTS' | 'TASK_TYPE_EXPORT_MESSAGE_UNSUBSCRIBED' | 'TASK_TYPE_EXPORT_MESSAGE_ERROR_RECIPIENTS' | 'TASK_TYPE_EXPORT_EMAIL_SUPPRESSIONS' | 'TASK_TYPE_EXPORT_API_TOKEN_USAGE';
|
|
9
|
+
| 'TASK_TYPE_APPLY_SEGMENT_TO_METRIC' | 'TASK_TYPE_EXPORT_RICH_MEDIA_RECIPIENTS' | 'TASK_TYPE_EXPORT_BOUNCED_EMAILS' | 'TASK_TYPE_EXPORT_JOURNEYS_HISTORY' | 'TASK_TYPE_EXPORT_JOURNEY_POINT_USERS' | 'TASK_TYPE_EXPORT_MESSAGE_RECIPIENTS' | 'TASK_TYPE_EXPORT_MESSAGE_CLICKS_DEVICES' | 'TASK_TYPE_EXPORT_MESSAGE_EVENT_TRIGGERED_DEVICES' | 'TASK_TYPE_EXPORT_MESSAGE_ERROR_DEVICES' | 'TASK_TYPE_CREATE_SEGMENT_FROM_MESSAGE' | 'TASK_TYPE_UPDATE_SEGMENT_INSIGHTS_LIST' | 'TASK_TYPE_EXPORT_JOURNEY_USERS_LIST' | 'TASK_TYPE_EXPORT_JOURNEY_POINTS_STATISTICS' | 'TASK_TYPE_EXPORT_JOURNEY_GOAL_USERS' | 'TASK_TYPE_EXPORT_CONTROL_GROUP' | 'TASK_TYPE_EXPORT_SUBSCRIPTION_FORM_SUBSCRIBED_USERS' | 'TASK_TYPE_EXPORT_UNIFIED_MESSAGES' | 'TASK_TYPE_EXPORT_MESSAGE_AUDIENCE' | 'TASK_TYPE_EXPORT_MESSAGE_STAGE_RECIPIENTS' | 'TASK_TYPE_EXPORT_MESSAGE_CLICKED_RECIPIENTS' | 'TASK_TYPE_EXPORT_MESSAGE_UNSUBSCRIBED' | 'TASK_TYPE_EXPORT_MESSAGE_ERROR_RECIPIENTS' | 'TASK_TYPE_EXPORT_EMAIL_SUPPRESSIONS' | 'TASK_TYPE_EXPORT_API_TOKEN_USAGE' | 'TASK_TYPE_EXPORT_CONTROL_GROUP_ANALYTICS';
|
|
10
10
|
export type ExportRequest_args_trackingLogCsv = {
|
|
11
11
|
type: 'trackingLogCsv';
|
|
12
12
|
data: TrackingLogCSVArgs;
|
|
@@ -131,7 +131,11 @@ export type ExportRequest_args_exportApiTokenUsage = {
|
|
|
131
131
|
type: 'exportApiTokenUsage';
|
|
132
132
|
data: ExportApiTokenUsageArgs;
|
|
133
133
|
};
|
|
134
|
-
export type
|
|
134
|
+
export type ExportRequest_args_exportControlGroupAnalytics = {
|
|
135
|
+
type: 'exportControlGroupAnalytics';
|
|
136
|
+
data: ExportControlGroupAnalyticsArgs;
|
|
137
|
+
};
|
|
138
|
+
export type ExportRequest_args = ExportRequest_args_trackingLogCsv | ExportRequest_args_exportMessagesV2 | ExportRequest_args_exportUnregisteredDevices | ExportRequest_args_exportRichMediaFormValues | ExportRequest_args_applySegmentToMessage | ExportRequest_args_exportApplySegmentToMessage | ExportRequest_args_calculateRetention | ExportRequest_args_applySegmentToMetric | ExportRequest_args_exportRichMediaRecipients | ExportRequest_args_exportBouncedEmails | ExportRequest_args_exportJourneysHistory | ExportRequest_args_exportJourneyPointUsers | ExportRequest_args_exportMessageRecipients | ExportRequest_args_exportMessageClicksDevices | ExportRequest_args_exportMessageEventTriggeredDevices | ExportRequest_args_exportMessageErrorDevices | ExportRequest_args_createSegmentFromMessage | ExportRequest_args_updateSegmentInsightsList | ExportRequest_args_exportJourneyUsersList | ExportRequest_args_exportJourneyPointsStatistics | ExportRequest_args_exportJourneyGoalUsers | ExportRequest_args_exportControlGroup | ExportRequest_args_exportSubscriptionFormSubscribedUsers | ExportRequest_args_exportUnifiedMessages | ExportRequest_args_exportMessageAudience | ExportRequest_args_exportMessageStageRecipients | ExportRequest_args_exportMessageClickedRecipients | ExportRequest_args_exportMessageUnsubscribed | ExportRequest_args_exportMessageErrorRecipients | ExportRequest_args_exportEmailSuppressions | ExportRequest_args_exportApiTokenUsage | ExportRequest_args_exportControlGroupAnalytics;
|
|
135
139
|
export type ExportRequest = {
|
|
136
140
|
type?: TaskType;
|
|
137
141
|
args: ExportRequest_args;
|
|
@@ -282,7 +286,11 @@ export type ResultResponse_result_exportApiTokenUsageResult = {
|
|
|
282
286
|
type: 'exportApiTokenUsageResult';
|
|
283
287
|
data: ExportApiTokenUsageResult;
|
|
284
288
|
};
|
|
285
|
-
export type
|
|
289
|
+
export type ResultResponse_result_exportControlGroupAnalyticsResult = {
|
|
290
|
+
type: 'exportControlGroupAnalyticsResult';
|
|
291
|
+
data: ExportControlGroupAnalyticsResult;
|
|
292
|
+
};
|
|
293
|
+
export type ResultResponse_result = ResultResponse_result_failedTask | ResultResponse_result_trackingLogResult | ResultResponse_result_exportMessagesV2Result | ResultResponse_result_exportUnregisteredDevicesResult | ResultResponse_result_exportRichMediaFormValuesResult | ResultResponse_result_applySegmentToMessageResult | ResultResponse_result_exportApplySegmentToMessageResult | ResultResponse_result_calculateRetentionResult | ResultResponse_result_applySegmentToMetricResult | ResultResponse_result_exportRichMediaRecipientsResult | ResultResponse_result_exportBouncedEmailsResult | ResultResponse_result_exportJourneysHistoryResult | ResultResponse_result_exportJourneyPointUsersResult | ResultResponse_result_exportMessageRecipientsResult | ResultResponse_result_exportMessageClicksDevicesResult | ResultResponse_result_exportMessageEventTriggeredDevicesResult | ResultResponse_result_exportMessageErrorDevicesResult | ResultResponse_result_createSegmentFromMessageResult | ResultResponse_result_updateSegmentInsightsListResult | ResultResponse_result_exportJourneyUsersListResult | ResultResponse_result_exportJourneyPointsStatisticsResult | ResultResponse_result_exportJourneyGoalUsersResult | ResultResponse_result_exportControlGroupResult | ResultResponse_result_exportSubscriptionFormSubscribedUsersResult | ResultResponse_result_exportUnifiedMessagesResult | ResultResponse_result_exportMessageAudienceResult | ResultResponse_result_exportMessageStageRecipientsResult | ResultResponse_result_exportMessageClickedRecipientsResult | ResultResponse_result_exportMessageUnsubscribedResult | ResultResponse_result_exportMessageErrorRecipientsResult | ResultResponse_result_exportEmailSuppressionsResult | ResultResponse_result_exportApiTokenUsageResult | ResultResponse_result_exportControlGroupAnalyticsResult;
|
|
286
294
|
export type ResultResponse = {
|
|
287
295
|
type: TaskType;
|
|
288
296
|
result: ResultResponse_result;
|
|
@@ -417,7 +425,11 @@ export type TaskInfo_args_exportApiTokenUsage = {
|
|
|
417
425
|
type: 'exportApiTokenUsage';
|
|
418
426
|
data: ExportApiTokenUsageArgs;
|
|
419
427
|
};
|
|
420
|
-
export type
|
|
428
|
+
export type TaskInfo_args_exportControlGroupAnalytics = {
|
|
429
|
+
type: 'exportControlGroupAnalytics';
|
|
430
|
+
data: ExportControlGroupAnalyticsArgs;
|
|
431
|
+
};
|
|
432
|
+
export type TaskInfo_args = TaskInfo_args_trackingLogCsv | TaskInfo_args_exportMessagesV2 | TaskInfo_args_exportUnregisteredDevices | TaskInfo_args_exportRichMediaFormValues | TaskInfo_args_applySegmentToMessage | TaskInfo_args_exportRichMediaRecipients | TaskInfo_args_exportJourneysHistory | TaskInfo_args_exportMessageRecipients | TaskInfo_args_exportMessageClicksDevices | TaskInfo_args_exportMessageEventTriggeredDevices | TaskInfo_args_exportMessageErrorsDevices | TaskInfo_args_createSegmentFromMessage | TaskInfo_args_updateSegmentInsightsList | TaskInfo_args_exportBouncedEmails | TaskInfo_args_exportJourneyUsersList | TaskInfo_args_exportJourneyPointsStatistics | TaskInfo_args_exportJourneyGoalUsers | TaskInfo_args_exportJourneyPointUsers | TaskInfo_args_exportControlGroup | TaskInfo_args_exportSubscriptionFormSubscribedUsers | TaskInfo_args_exportUnifiedMessages | TaskInfo_args_exportMessageAudience | TaskInfo_args_exportMessageStageRecipients | TaskInfo_args_exportMessageClickedRecipients | TaskInfo_args_exportMessageUnsubscribed | TaskInfo_args_exportMessageErrorRecipients | TaskInfo_args_exportEmailSuppressions | TaskInfo_args_exportApiTokenUsage | TaskInfo_args_exportControlGroupAnalytics;
|
|
421
433
|
export type TaskInfo_result_failedTask = {
|
|
422
434
|
type: 'failedTask';
|
|
423
435
|
data: TaskFailed;
|
|
@@ -534,7 +546,11 @@ export type TaskInfo_result_exportApiTokenUsageResult = {
|
|
|
534
546
|
type: 'exportApiTokenUsageResult';
|
|
535
547
|
data: ExportApiTokenUsageResult;
|
|
536
548
|
};
|
|
537
|
-
export type
|
|
549
|
+
export type TaskInfo_result_exportControlGroupAnalyticsResult = {
|
|
550
|
+
type: 'exportControlGroupAnalyticsResult';
|
|
551
|
+
data: ExportControlGroupAnalyticsResult;
|
|
552
|
+
};
|
|
553
|
+
export type TaskInfo_result = TaskInfo_result_failedTask | TaskInfo_result_trackingLogResult | TaskInfo_result_exportMessagesV2Result | TaskInfo_result_exportUnregisteredDevicesResult | TaskInfo_result_exportRichMediaFormValuesResult | TaskInfo_result_applySegmentToMessageResult | TaskInfo_result_exportRichMediaRecipientsResult | TaskInfo_result_exportJourneysHistoryResult | TaskInfo_result_exportMessageRecipientsResult | TaskInfo_result_exportMessageClicksDevicesResult | TaskInfo_result_exportMessageEventTriggeredDevicesResult | TaskInfo_result_exportMessageErrorsDevicesResult | TaskInfo_result_createSegmentFromMessageResult | TaskInfo_result_updateSegmentInsightsListResult | TaskInfo_result_exportBouncedEmailsResult | TaskInfo_result_exportJourneyUsersListResult | TaskInfo_result_exportJourneyPointsStatisticsResult | TaskInfo_result_exportJourneyGoalUsersResult | TaskInfo_result_exportJourneyPointUsersResult | TaskInfo_result_exportControlGroupResult | TaskInfo_result_exportSubscriptionFormSubscribedUsersResult | TaskInfo_result_exportUnifiedMessagesResult | TaskInfo_result_exportMessageAudienceResult | TaskInfo_result_exportMessageStageRecipientsResult | TaskInfo_result_exportMessageClickedRecipientsResult | TaskInfo_result_exportMessageUnsubscribedResult | TaskInfo_result_exportMessageErrorRecipientsResult | TaskInfo_result_exportEmailSuppressionsResult | TaskInfo_result_exportApiTokenUsageResult | TaskInfo_result_exportControlGroupAnalyticsResult;
|
|
538
554
|
export type TaskInfo = {
|
|
539
555
|
id: number;
|
|
540
556
|
timestamp: string;
|
|
@@ -960,6 +976,27 @@ export type ExportApiTokenUsageArgs = {
|
|
|
960
976
|
export type ExportApiTokenUsageResult = {
|
|
961
977
|
file: string;
|
|
962
978
|
};
|
|
979
|
+
/**
|
|
980
|
+
* ExportControlGroupAnalyticsArgs exports the per-send uplift report: every campaign
|
|
981
|
+
* and journey hold-out of one application measured against its own treatment arm.
|
|
982
|
+
*/
|
|
983
|
+
export type ExportControlGroupAnalyticsArgs = {
|
|
984
|
+
/** Application whose report is exported; required. */
|
|
985
|
+
applicationCode: string;
|
|
986
|
+
/** Window start over the report timestamp, "2006-01-02" or "2006-01-02 15:04:05". */
|
|
987
|
+
dateFrom: string;
|
|
988
|
+
/** Window end, same format. */
|
|
989
|
+
dateTo: string;
|
|
990
|
+
/** Campaign code to export a single send; empty exports every campaign. */
|
|
991
|
+
campaign: string;
|
|
992
|
+
/** Journey uuid to export a single journey; empty exports every journey. */
|
|
993
|
+
journey: string;
|
|
994
|
+
};
|
|
995
|
+
export type ExportControlGroupAnalyticsResult = {
|
|
996
|
+
file: string;
|
|
997
|
+
/** Ready-to-use download URL for `file`; empty when the service has no base URL configured. */
|
|
998
|
+
fileUrl: string;
|
|
999
|
+
};
|
|
963
1000
|
/**
|
|
964
1001
|
* Recipients behind one error row of the statistics screen — same subject as the older
|
|
965
1002
|
* error export, plus the platform and transactional message_code filtering it lacks.
|
|
@@ -1080,9 +1117,10 @@ export type ExportSubscriptionFormSubscribedUsersResult = {
|
|
|
1080
1117
|
};
|
|
1081
1118
|
/**
|
|
1082
1119
|
* ExportUnifiedMessagesArgs asks for one CSV holding both one-time messages and
|
|
1083
|
-
* journey send points of
|
|
1120
|
+
* journey send points of one or more applications over [date_from, date_to].
|
|
1084
1121
|
*/
|
|
1085
1122
|
export type ExportUnifiedMessagesArgs = {
|
|
1123
|
+
/** Kept for the callers that export a single application; `applications` wins when both are set. */
|
|
1086
1124
|
application: string;
|
|
1087
1125
|
dateFrom: Date;
|
|
1088
1126
|
dateTo: Date;
|
|
@@ -1095,6 +1133,8 @@ export type ExportUnifiedMessagesArgs = {
|
|
|
1095
1133
|
* empty keeps both
|
|
1096
1134
|
*/
|
|
1097
1135
|
messageType: string;
|
|
1136
|
+
/** Application codes to export together; every row names its own project. */
|
|
1137
|
+
applications: string[];
|
|
1098
1138
|
};
|
|
1099
1139
|
export type ExportUnifiedMessagesResult = {
|
|
1100
1140
|
file: string;
|