@pushwoosh/rpc-v2-http-api-data 0.2.302 → 0.2.304
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 +31 -0
- package/data.js +101 -5
- package/package.json +1 -1
- package/pushwoosh_export_messages_v2.d.ts +46 -6
|
@@ -9,6 +9,7 @@ export type ApplicationsControlGroupService_ReshuffleControlGroup = RpcMethod<Re
|
|
|
9
9
|
export type ApplicationsControlGroupService_ForceUpdateControlGroupCalculation = RpcMethod<ForceUpdateControlGroupCalculationRequest, ForceUpdateControlGroupCalculationResponse>;
|
|
10
10
|
export type ApplicationsControlGroupService_GetControlGroupCalculationStatus = RpcMethod<GetControlGroupCalculationStatusRequest, GetCalculationStatusResponse>;
|
|
11
11
|
export type ApplicationsControlGroupService_GetControlGroupAnalytics = RpcMethod<GetControlGroupAnalyticsRequest, GetAnalyticsResponse>;
|
|
12
|
+
export type ApplicationsControlGroupService_CheckControlGroupMembership = RpcMethod<CheckControlGroupMembershipRequest, CheckControlGroupMembershipResponse>;
|
|
12
13
|
/**
|
|
13
14
|
* Global Control Group: a hold-out of an application's users that receives no
|
|
14
15
|
* marketing messages, so the effect of messaging can be measured against it.
|
|
@@ -38,6 +39,8 @@ export interface ApplicationsControlGroupService {
|
|
|
38
39
|
GetControlGroupCalculationStatus: ApplicationsControlGroupService_GetControlGroupCalculationStatus;
|
|
39
40
|
/** Returns the precomputed Control-vs-Treatment analytics for one control group. Only the default group has analytics: the nightly job still measures one hold-out per application, so any other group comes back empty until it learns about groups. */
|
|
40
41
|
GetControlGroupAnalytics: ApplicationsControlGroupService_GetControlGroupAnalytics;
|
|
42
|
+
/** Reports for each user id whether it is held out by one control group right now. Membership is computed from the id, so this answers without reading the base: use it to check the users of a send or an import instead of exporting the whole group. */
|
|
43
|
+
CheckControlGroupMembership: ApplicationsControlGroupService_CheckControlGroupMembership;
|
|
41
44
|
}
|
|
42
45
|
export type TaskStatus = 'TASK_STATUS_UNSPECIFIED' | 'TASK_STATUS_NOT_STARTED' | 'TASK_STATUS_IN_PROGRESS' | 'TASK_STATUS_COMPLETED';
|
|
43
46
|
/**
|
|
@@ -78,6 +81,11 @@ export type ControlGroup = {
|
|
|
78
81
|
lastModifiedAt: Date;
|
|
79
82
|
/** Email of the user who last changed the group. */
|
|
80
83
|
lastModifiedBy: string;
|
|
84
|
+
/**
|
|
85
|
+
* Numeric id of the application, the first part of the membership key
|
|
86
|
+
* <application_id>:<generation>:<name>:<user_id> the hash is taken over.
|
|
87
|
+
*/
|
|
88
|
+
applicationId: number;
|
|
81
89
|
};
|
|
82
90
|
export type ListControlGroupsRequest = {
|
|
83
91
|
/** Application code (format XXXXX-XXXXX) whose control groups to list. */
|
|
@@ -191,3 +199,26 @@ export type AnalyticsEvent = {
|
|
|
191
199
|
export type GetAnalyticsResponse = {
|
|
192
200
|
events: AnalyticsEvent[];
|
|
193
201
|
};
|
|
202
|
+
export type CheckControlGroupMembershipRequest = {
|
|
203
|
+
/** Application code (format XXXXX-XXXXX) the group belongs to. */
|
|
204
|
+
code?: string;
|
|
205
|
+
/** Control group code (format XXXXX-XXXXX) to check against. */
|
|
206
|
+
controlGroupCode?: string;
|
|
207
|
+
/**
|
|
208
|
+
* User ids to check, at most 1000 per call. An id the application has never
|
|
209
|
+
* seen is answered all the same: the verdict is a function of the id alone.
|
|
210
|
+
*/
|
|
211
|
+
userIds?: string[];
|
|
212
|
+
};
|
|
213
|
+
/**
|
|
214
|
+
* UserMembership is one user's verdict. A group that is off holds nobody, so
|
|
215
|
+
* every id comes back false rather than as an error.
|
|
216
|
+
*/
|
|
217
|
+
export type UserMembership = {
|
|
218
|
+
userId: string;
|
|
219
|
+
inControlGroup: boolean;
|
|
220
|
+
};
|
|
221
|
+
export type CheckControlGroupMembershipResponse = {
|
|
222
|
+
/** One entry per requested id, in the order they were given. */
|
|
223
|
+
users: UserMembership[];
|
|
224
|
+
};
|
package/data.js
CHANGED
|
@@ -6916,6 +6916,12 @@ export const data = {
|
|
|
6916
6916
|
"response": "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsResponse",
|
|
6917
6917
|
"method": "get",
|
|
6918
6918
|
"path": "/api/applications/{code}/control_groups/{control_group_code}/analytics"
|
|
6919
|
+
},
|
|
6920
|
+
"CheckControlGroupMembership": {
|
|
6921
|
+
"request": "pushwoosh.rpc_v2.applications_controlgroup.CheckControlGroupMembershipRequest",
|
|
6922
|
+
"response": "pushwoosh.rpc_v2.applications_controlgroup.CheckControlGroupMembershipResponse",
|
|
6923
|
+
"method": "post",
|
|
6924
|
+
"path": "/api/applications/{code}/control_groups/{control_group_code}/membership"
|
|
6919
6925
|
}
|
|
6920
6926
|
}
|
|
6921
6927
|
},
|
|
@@ -6980,6 +6986,9 @@ export const data = {
|
|
|
6980
6986
|
},
|
|
6981
6987
|
"lastModifiedBy": {
|
|
6982
6988
|
"type": "string"
|
|
6989
|
+
},
|
|
6990
|
+
"applicationId": {
|
|
6991
|
+
"type": "number"
|
|
6983
6992
|
}
|
|
6984
6993
|
}
|
|
6985
6994
|
},
|
|
@@ -7233,6 +7242,41 @@ export const data = {
|
|
|
7233
7242
|
}
|
|
7234
7243
|
}
|
|
7235
7244
|
},
|
|
7245
|
+
"pushwoosh.rpc_v2.applications_controlgroup.CheckControlGroupMembershipRequest": {
|
|
7246
|
+
"type": "I",
|
|
7247
|
+
"fields": {
|
|
7248
|
+
"code": {
|
|
7249
|
+
"type": "string"
|
|
7250
|
+
},
|
|
7251
|
+
"controlGroupCode": {
|
|
7252
|
+
"type": "string"
|
|
7253
|
+
},
|
|
7254
|
+
"userIds": {
|
|
7255
|
+
"type": "string",
|
|
7256
|
+
"array": true
|
|
7257
|
+
}
|
|
7258
|
+
}
|
|
7259
|
+
},
|
|
7260
|
+
"pushwoosh.rpc_v2.applications_controlgroup.UserMembership": {
|
|
7261
|
+
"type": "I",
|
|
7262
|
+
"fields": {
|
|
7263
|
+
"userId": {
|
|
7264
|
+
"type": "string"
|
|
7265
|
+
},
|
|
7266
|
+
"inControlGroup": {
|
|
7267
|
+
"type": "boolean"
|
|
7268
|
+
}
|
|
7269
|
+
}
|
|
7270
|
+
},
|
|
7271
|
+
"pushwoosh.rpc_v2.applications_controlgroup.CheckControlGroupMembershipResponse": {
|
|
7272
|
+
"type": "I",
|
|
7273
|
+
"fields": {
|
|
7274
|
+
"users": {
|
|
7275
|
+
"type": "pushwoosh.rpc_v2.applications_controlgroup.UserMembership",
|
|
7276
|
+
"array": true
|
|
7277
|
+
}
|
|
7278
|
+
}
|
|
7279
|
+
},
|
|
7236
7280
|
"pushwoosh.rpc_v2.applications_groups.ApplicationsGroupsService": {
|
|
7237
7281
|
"type": "S",
|
|
7238
7282
|
"key": "applicationsGroups",
|
|
@@ -13655,7 +13699,8 @@ export const data = {
|
|
|
13655
13699
|
"TASK_TYPE_EXPORT_MESSAGE_UNSUBSCRIBED",
|
|
13656
13700
|
"TASK_TYPE_EXPORT_MESSAGE_ERROR_RECIPIENTS",
|
|
13657
13701
|
"TASK_TYPE_EXPORT_EMAIL_SUPPRESSIONS",
|
|
13658
|
-
"TASK_TYPE_EXPORT_API_TOKEN_USAGE"
|
|
13702
|
+
"TASK_TYPE_EXPORT_API_TOKEN_USAGE",
|
|
13703
|
+
"TASK_TYPE_EXPORT_CONTROL_GROUP_ANALYTICS"
|
|
13659
13704
|
]
|
|
13660
13705
|
},
|
|
13661
13706
|
"pushwoosh.export_messages.v2.ExportRequest": {
|
|
@@ -13756,6 +13801,9 @@ export const data = {
|
|
|
13756
13801
|
},
|
|
13757
13802
|
"exportApiTokenUsage": {
|
|
13758
13803
|
"type": "pushwoosh.export_messages.v2.ExportApiTokenUsageArgs"
|
|
13804
|
+
},
|
|
13805
|
+
"exportControlGroupAnalytics": {
|
|
13806
|
+
"type": "pushwoosh.export_messages.v2.ExportControlGroupAnalyticsArgs"
|
|
13759
13807
|
}
|
|
13760
13808
|
},
|
|
13761
13809
|
"oneofs": {
|
|
@@ -13791,7 +13839,8 @@ export const data = {
|
|
|
13791
13839
|
"exportMessageUnsubscribed",
|
|
13792
13840
|
"exportMessageErrorRecipients",
|
|
13793
13841
|
"exportEmailSuppressions",
|
|
13794
|
-
"exportApiTokenUsage"
|
|
13842
|
+
"exportApiTokenUsage",
|
|
13843
|
+
"exportControlGroupAnalytics"
|
|
13795
13844
|
]
|
|
13796
13845
|
}
|
|
13797
13846
|
}
|
|
@@ -13953,6 +14002,9 @@ export const data = {
|
|
|
13953
14002
|
},
|
|
13954
14003
|
"exportApiTokenUsageResult": {
|
|
13955
14004
|
"type": "pushwoosh.export_messages.v2.ExportApiTokenUsageResult"
|
|
14005
|
+
},
|
|
14006
|
+
"exportControlGroupAnalyticsResult": {
|
|
14007
|
+
"type": "pushwoosh.export_messages.v2.ExportControlGroupAnalyticsResult"
|
|
13956
14008
|
}
|
|
13957
14009
|
},
|
|
13958
14010
|
"oneofs": {
|
|
@@ -13989,7 +14041,8 @@ export const data = {
|
|
|
13989
14041
|
"exportMessageUnsubscribedResult",
|
|
13990
14042
|
"exportMessageErrorRecipientsResult",
|
|
13991
14043
|
"exportEmailSuppressionsResult",
|
|
13992
|
-
"exportApiTokenUsageResult"
|
|
14044
|
+
"exportApiTokenUsageResult",
|
|
14045
|
+
"exportControlGroupAnalyticsResult"
|
|
13993
14046
|
]
|
|
13994
14047
|
}
|
|
13995
14048
|
}
|
|
@@ -14135,6 +14188,9 @@ export const data = {
|
|
|
14135
14188
|
"exportApiTokenUsage": {
|
|
14136
14189
|
"type": "pushwoosh.export_messages.v2.ExportApiTokenUsageArgs"
|
|
14137
14190
|
},
|
|
14191
|
+
"exportControlGroupAnalytics": {
|
|
14192
|
+
"type": "pushwoosh.export_messages.v2.ExportControlGroupAnalyticsArgs"
|
|
14193
|
+
},
|
|
14138
14194
|
"failedTask": {
|
|
14139
14195
|
"type": "pushwoosh.export_messages.v2.TaskFailed"
|
|
14140
14196
|
},
|
|
@@ -14221,6 +14277,9 @@ export const data = {
|
|
|
14221
14277
|
},
|
|
14222
14278
|
"exportApiTokenUsageResult": {
|
|
14223
14279
|
"type": "pushwoosh.export_messages.v2.ExportApiTokenUsageResult"
|
|
14280
|
+
},
|
|
14281
|
+
"exportControlGroupAnalyticsResult": {
|
|
14282
|
+
"type": "pushwoosh.export_messages.v2.ExportControlGroupAnalyticsResult"
|
|
14224
14283
|
}
|
|
14225
14284
|
},
|
|
14226
14285
|
"oneofs": {
|
|
@@ -14253,7 +14312,8 @@ export const data = {
|
|
|
14253
14312
|
"exportMessageUnsubscribed",
|
|
14254
14313
|
"exportMessageErrorRecipients",
|
|
14255
14314
|
"exportEmailSuppressions",
|
|
14256
|
-
"exportApiTokenUsage"
|
|
14315
|
+
"exportApiTokenUsage",
|
|
14316
|
+
"exportControlGroupAnalytics"
|
|
14257
14317
|
]
|
|
14258
14318
|
},
|
|
14259
14319
|
"result": {
|
|
@@ -14286,7 +14346,8 @@ export const data = {
|
|
|
14286
14346
|
"exportMessageUnsubscribedResult",
|
|
14287
14347
|
"exportMessageErrorRecipientsResult",
|
|
14288
14348
|
"exportEmailSuppressionsResult",
|
|
14289
|
-
"exportApiTokenUsageResult"
|
|
14349
|
+
"exportApiTokenUsageResult",
|
|
14350
|
+
"exportControlGroupAnalyticsResult"
|
|
14290
14351
|
]
|
|
14291
14352
|
}
|
|
14292
14353
|
}
|
|
@@ -15328,6 +15389,37 @@ export const data = {
|
|
|
15328
15389
|
}
|
|
15329
15390
|
}
|
|
15330
15391
|
},
|
|
15392
|
+
"pushwoosh.export_messages.v2.ExportControlGroupAnalyticsArgs": {
|
|
15393
|
+
"type": "I",
|
|
15394
|
+
"fields": {
|
|
15395
|
+
"applicationCode": {
|
|
15396
|
+
"type": "string"
|
|
15397
|
+
},
|
|
15398
|
+
"dateFrom": {
|
|
15399
|
+
"type": "string"
|
|
15400
|
+
},
|
|
15401
|
+
"dateTo": {
|
|
15402
|
+
"type": "string"
|
|
15403
|
+
},
|
|
15404
|
+
"campaign": {
|
|
15405
|
+
"type": "string"
|
|
15406
|
+
},
|
|
15407
|
+
"journey": {
|
|
15408
|
+
"type": "string"
|
|
15409
|
+
}
|
|
15410
|
+
}
|
|
15411
|
+
},
|
|
15412
|
+
"pushwoosh.export_messages.v2.ExportControlGroupAnalyticsResult": {
|
|
15413
|
+
"type": "I",
|
|
15414
|
+
"fields": {
|
|
15415
|
+
"file": {
|
|
15416
|
+
"type": "string"
|
|
15417
|
+
},
|
|
15418
|
+
"fileUrl": {
|
|
15419
|
+
"type": "string"
|
|
15420
|
+
}
|
|
15421
|
+
}
|
|
15422
|
+
},
|
|
15331
15423
|
"pushwoosh.export_messages.v2.ExportMessageErrorRecipientsArgs": {
|
|
15332
15424
|
"type": "I",
|
|
15333
15425
|
"fields": {
|
|
@@ -15658,6 +15750,10 @@ export const data = {
|
|
|
15658
15750
|
},
|
|
15659
15751
|
"messageType": {
|
|
15660
15752
|
"type": "string"
|
|
15753
|
+
},
|
|
15754
|
+
"applications": {
|
|
15755
|
+
"type": "string",
|
|
15756
|
+
"array": true
|
|
15661
15757
|
}
|
|
15662
15758
|
}
|
|
15663
15759
|
},
|
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;
|