@seekora-ai/admin-api 1.1.84 → 1.1.85
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/README.md +21 -2
- package/api.ts +1387 -0
- package/dist/api.d.ts +971 -0
- package/dist/api.js +778 -10
- package/dist/esm/api.d.ts +971 -0
- package/dist/esm/api.js +764 -0
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.85.tgz +0 -0
- package/seekora-ai-admin-api-1.1.84.tgz +0 -0
package/dist/esm/api.d.ts
CHANGED
|
@@ -13667,6 +13667,97 @@ export declare const DataTypesCreateCustomWordListRequestTypeEnum: {
|
|
|
13667
13667
|
readonly Synonyms: "synonyms";
|
|
13668
13668
|
};
|
|
13669
13669
|
export type DataTypesCreateCustomWordListRequestTypeEnum = typeof DataTypesCreateCustomWordListRequestTypeEnum[keyof typeof DataTypesCreateCustomWordListRequestTypeEnum];
|
|
13670
|
+
/**
|
|
13671
|
+
*
|
|
13672
|
+
* @export
|
|
13673
|
+
* @interface DataTypesCreateExperimentRequest
|
|
13674
|
+
*/
|
|
13675
|
+
export interface DataTypesCreateExperimentRequest {
|
|
13676
|
+
/**
|
|
13677
|
+
*
|
|
13678
|
+
* @type {object}
|
|
13679
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
13680
|
+
*/
|
|
13681
|
+
'audience_filter'?: object;
|
|
13682
|
+
/**
|
|
13683
|
+
*
|
|
13684
|
+
* @type {string}
|
|
13685
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
13686
|
+
*/
|
|
13687
|
+
'description'?: string;
|
|
13688
|
+
/**
|
|
13689
|
+
*
|
|
13690
|
+
* @type {string}
|
|
13691
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
13692
|
+
*/
|
|
13693
|
+
'experiment_id': string;
|
|
13694
|
+
/**
|
|
13695
|
+
*
|
|
13696
|
+
* @type {DataTypesExperimentType}
|
|
13697
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
13698
|
+
*/
|
|
13699
|
+
'experiment_type': DataTypesExperimentType;
|
|
13700
|
+
/**
|
|
13701
|
+
*
|
|
13702
|
+
* @type {string}
|
|
13703
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
13704
|
+
*/
|
|
13705
|
+
'hypothesis'?: string;
|
|
13706
|
+
/**
|
|
13707
|
+
*
|
|
13708
|
+
* @type {number}
|
|
13709
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
13710
|
+
*/
|
|
13711
|
+
'max_duration_days'?: number;
|
|
13712
|
+
/**
|
|
13713
|
+
*
|
|
13714
|
+
* @type {number}
|
|
13715
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
13716
|
+
*/
|
|
13717
|
+
'min_sample_size'?: number;
|
|
13718
|
+
/**
|
|
13719
|
+
*
|
|
13720
|
+
* @type {string}
|
|
13721
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
13722
|
+
*/
|
|
13723
|
+
'name': string;
|
|
13724
|
+
/**
|
|
13725
|
+
*
|
|
13726
|
+
* @type {string}
|
|
13727
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
13728
|
+
*/
|
|
13729
|
+
'primary_metric': string;
|
|
13730
|
+
/**
|
|
13731
|
+
*
|
|
13732
|
+
* @type {string}
|
|
13733
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
13734
|
+
*/
|
|
13735
|
+
'scheduled_end_at'?: string;
|
|
13736
|
+
/**
|
|
13737
|
+
*
|
|
13738
|
+
* @type {string}
|
|
13739
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
13740
|
+
*/
|
|
13741
|
+
'scheduled_start_at'?: string;
|
|
13742
|
+
/**
|
|
13743
|
+
*
|
|
13744
|
+
* @type {Array<string>}
|
|
13745
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
13746
|
+
*/
|
|
13747
|
+
'secondary_metrics'?: Array<string>;
|
|
13748
|
+
/**
|
|
13749
|
+
*
|
|
13750
|
+
* @type {number}
|
|
13751
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
13752
|
+
*/
|
|
13753
|
+
'traffic_percentage'?: number;
|
|
13754
|
+
/**
|
|
13755
|
+
*
|
|
13756
|
+
* @type {Array<DataTypesExperimentVariant>}
|
|
13757
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
13758
|
+
*/
|
|
13759
|
+
'variants': Array<DataTypesExperimentVariant>;
|
|
13760
|
+
}
|
|
13670
13761
|
/**
|
|
13671
13762
|
*
|
|
13672
13763
|
* @export
|
|
@@ -16887,6 +16978,427 @@ export interface DataTypesEventPayload {
|
|
|
16887
16978
|
*/
|
|
16888
16979
|
'xstoreid'?: string;
|
|
16889
16980
|
}
|
|
16981
|
+
/**
|
|
16982
|
+
*
|
|
16983
|
+
* @export
|
|
16984
|
+
* @interface DataTypesExperiment
|
|
16985
|
+
*/
|
|
16986
|
+
export interface DataTypesExperiment {
|
|
16987
|
+
/**
|
|
16988
|
+
*
|
|
16989
|
+
* @type {object}
|
|
16990
|
+
* @memberof DataTypesExperiment
|
|
16991
|
+
*/
|
|
16992
|
+
'audience_filter'?: object;
|
|
16993
|
+
/**
|
|
16994
|
+
*
|
|
16995
|
+
* @type {number}
|
|
16996
|
+
* @memberof DataTypesExperiment
|
|
16997
|
+
*/
|
|
16998
|
+
'confidence_level'?: number;
|
|
16999
|
+
/**
|
|
17000
|
+
*
|
|
17001
|
+
* @type {string}
|
|
17002
|
+
* @memberof DataTypesExperiment
|
|
17003
|
+
*/
|
|
17004
|
+
'created_at'?: string;
|
|
17005
|
+
/**
|
|
17006
|
+
*
|
|
17007
|
+
* @type {number}
|
|
17008
|
+
* @memberof DataTypesExperiment
|
|
17009
|
+
*/
|
|
17010
|
+
'created_by'?: number;
|
|
17011
|
+
/**
|
|
17012
|
+
*
|
|
17013
|
+
* @type {string}
|
|
17014
|
+
* @memberof DataTypesExperiment
|
|
17015
|
+
*/
|
|
17016
|
+
'description'?: string;
|
|
17017
|
+
/**
|
|
17018
|
+
*
|
|
17019
|
+
* @type {string}
|
|
17020
|
+
* @memberof DataTypesExperiment
|
|
17021
|
+
*/
|
|
17022
|
+
'ended_at'?: string;
|
|
17023
|
+
/**
|
|
17024
|
+
*
|
|
17025
|
+
* @type {string}
|
|
17026
|
+
* @memberof DataTypesExperiment
|
|
17027
|
+
*/
|
|
17028
|
+
'experiment_id'?: string;
|
|
17029
|
+
/**
|
|
17030
|
+
*
|
|
17031
|
+
* @type {DataTypesExperimentType}
|
|
17032
|
+
* @memberof DataTypesExperiment
|
|
17033
|
+
*/
|
|
17034
|
+
'experiment_type'?: DataTypesExperimentType;
|
|
17035
|
+
/**
|
|
17036
|
+
*
|
|
17037
|
+
* @type {object}
|
|
17038
|
+
* @memberof DataTypesExperiment
|
|
17039
|
+
*/
|
|
17040
|
+
'final_results'?: object;
|
|
17041
|
+
/**
|
|
17042
|
+
*
|
|
17043
|
+
* @type {string}
|
|
17044
|
+
* @memberof DataTypesExperiment
|
|
17045
|
+
*/
|
|
17046
|
+
'hypothesis'?: string;
|
|
17047
|
+
/**
|
|
17048
|
+
*
|
|
17049
|
+
* @type {number}
|
|
17050
|
+
* @memberof DataTypesExperiment
|
|
17051
|
+
*/
|
|
17052
|
+
'id'?: number;
|
|
17053
|
+
/**
|
|
17054
|
+
*
|
|
17055
|
+
* @type {number}
|
|
17056
|
+
* @memberof DataTypesExperiment
|
|
17057
|
+
*/
|
|
17058
|
+
'max_duration_days'?: number;
|
|
17059
|
+
/**
|
|
17060
|
+
*
|
|
17061
|
+
* @type {number}
|
|
17062
|
+
* @memberof DataTypesExperiment
|
|
17063
|
+
*/
|
|
17064
|
+
'min_sample_size'?: number;
|
|
17065
|
+
/**
|
|
17066
|
+
*
|
|
17067
|
+
* @type {string}
|
|
17068
|
+
* @memberof DataTypesExperiment
|
|
17069
|
+
*/
|
|
17070
|
+
'name'?: string;
|
|
17071
|
+
/**
|
|
17072
|
+
*
|
|
17073
|
+
* @type {number}
|
|
17074
|
+
* @memberof DataTypesExperiment
|
|
17075
|
+
*/
|
|
17076
|
+
'org_id'?: number;
|
|
17077
|
+
/**
|
|
17078
|
+
*
|
|
17079
|
+
* @type {string}
|
|
17080
|
+
* @memberof DataTypesExperiment
|
|
17081
|
+
*/
|
|
17082
|
+
'primary_metric'?: string;
|
|
17083
|
+
/**
|
|
17084
|
+
*
|
|
17085
|
+
* @type {string}
|
|
17086
|
+
* @memberof DataTypesExperiment
|
|
17087
|
+
*/
|
|
17088
|
+
'scheduled_end_at'?: string;
|
|
17089
|
+
/**
|
|
17090
|
+
*
|
|
17091
|
+
* @type {string}
|
|
17092
|
+
* @memberof DataTypesExperiment
|
|
17093
|
+
*/
|
|
17094
|
+
'scheduled_start_at'?: string;
|
|
17095
|
+
/**
|
|
17096
|
+
*
|
|
17097
|
+
* @type {Array<string>}
|
|
17098
|
+
* @memberof DataTypesExperiment
|
|
17099
|
+
*/
|
|
17100
|
+
'secondary_metrics'?: Array<string>;
|
|
17101
|
+
/**
|
|
17102
|
+
*
|
|
17103
|
+
* @type {string}
|
|
17104
|
+
* @memberof DataTypesExperiment
|
|
17105
|
+
*/
|
|
17106
|
+
'started_at'?: string;
|
|
17107
|
+
/**
|
|
17108
|
+
*
|
|
17109
|
+
* @type {number}
|
|
17110
|
+
* @memberof DataTypesExperiment
|
|
17111
|
+
*/
|
|
17112
|
+
'statistical_significance'?: number;
|
|
17113
|
+
/**
|
|
17114
|
+
*
|
|
17115
|
+
* @type {DataTypesExperimentStatus}
|
|
17116
|
+
* @memberof DataTypesExperiment
|
|
17117
|
+
*/
|
|
17118
|
+
'status'?: DataTypesExperimentStatus;
|
|
17119
|
+
/**
|
|
17120
|
+
*
|
|
17121
|
+
* @type {number}
|
|
17122
|
+
* @memberof DataTypesExperiment
|
|
17123
|
+
*/
|
|
17124
|
+
'store_id'?: number;
|
|
17125
|
+
/**
|
|
17126
|
+
*
|
|
17127
|
+
* @type {number}
|
|
17128
|
+
* @memberof DataTypesExperiment
|
|
17129
|
+
*/
|
|
17130
|
+
'traffic_percentage'?: number;
|
|
17131
|
+
/**
|
|
17132
|
+
*
|
|
17133
|
+
* @type {string}
|
|
17134
|
+
* @memberof DataTypesExperiment
|
|
17135
|
+
*/
|
|
17136
|
+
'updated_at'?: string;
|
|
17137
|
+
/**
|
|
17138
|
+
*
|
|
17139
|
+
* @type {number}
|
|
17140
|
+
* @memberof DataTypesExperiment
|
|
17141
|
+
*/
|
|
17142
|
+
'updated_by'?: number;
|
|
17143
|
+
/**
|
|
17144
|
+
*
|
|
17145
|
+
* @type {Array<DataTypesExperimentVariant>}
|
|
17146
|
+
* @memberof DataTypesExperiment
|
|
17147
|
+
*/
|
|
17148
|
+
'variants'?: Array<DataTypesExperimentVariant>;
|
|
17149
|
+
/**
|
|
17150
|
+
*
|
|
17151
|
+
* @type {string}
|
|
17152
|
+
* @memberof DataTypesExperiment
|
|
17153
|
+
*/
|
|
17154
|
+
'winner_variant'?: string;
|
|
17155
|
+
}
|
|
17156
|
+
/**
|
|
17157
|
+
*
|
|
17158
|
+
* @export
|
|
17159
|
+
* @interface DataTypesExperimentAssignment
|
|
17160
|
+
*/
|
|
17161
|
+
export interface DataTypesExperimentAssignment {
|
|
17162
|
+
/**
|
|
17163
|
+
*
|
|
17164
|
+
* @type {string}
|
|
17165
|
+
* @memberof DataTypesExperimentAssignment
|
|
17166
|
+
*/
|
|
17167
|
+
'experiment_id'?: string;
|
|
17168
|
+
/**
|
|
17169
|
+
*
|
|
17170
|
+
* @type {{ [key: string]: any; }}
|
|
17171
|
+
* @memberof DataTypesExperimentAssignment
|
|
17172
|
+
*/
|
|
17173
|
+
'variant_config'?: {
|
|
17174
|
+
[key: string]: any;
|
|
17175
|
+
};
|
|
17176
|
+
/**
|
|
17177
|
+
*
|
|
17178
|
+
* @type {string}
|
|
17179
|
+
* @memberof DataTypesExperimentAssignment
|
|
17180
|
+
*/
|
|
17181
|
+
'variant_id'?: string;
|
|
17182
|
+
}
|
|
17183
|
+
/**
|
|
17184
|
+
*
|
|
17185
|
+
* @export
|
|
17186
|
+
* @interface DataTypesExperimentResults
|
|
17187
|
+
*/
|
|
17188
|
+
export interface DataTypesExperimentResults {
|
|
17189
|
+
/**
|
|
17190
|
+
*
|
|
17191
|
+
* @type {number}
|
|
17192
|
+
* @memberof DataTypesExperimentResults
|
|
17193
|
+
*/
|
|
17194
|
+
'confidence_level'?: number;
|
|
17195
|
+
/**
|
|
17196
|
+
*
|
|
17197
|
+
* @type {number}
|
|
17198
|
+
* @memberof DataTypesExperimentResults
|
|
17199
|
+
*/
|
|
17200
|
+
'conversion_lift'?: number;
|
|
17201
|
+
/**
|
|
17202
|
+
*
|
|
17203
|
+
* @type {number}
|
|
17204
|
+
* @memberof DataTypesExperimentResults
|
|
17205
|
+
*/
|
|
17206
|
+
'ctr_lift'?: number;
|
|
17207
|
+
/**
|
|
17208
|
+
*
|
|
17209
|
+
* @type {string}
|
|
17210
|
+
* @memberof DataTypesExperimentResults
|
|
17211
|
+
*/
|
|
17212
|
+
'ended_at'?: string;
|
|
17213
|
+
/**
|
|
17214
|
+
*
|
|
17215
|
+
* @type {string}
|
|
17216
|
+
* @memberof DataTypesExperimentResults
|
|
17217
|
+
*/
|
|
17218
|
+
'experiment_id'?: string;
|
|
17219
|
+
/**
|
|
17220
|
+
*
|
|
17221
|
+
* @type {boolean}
|
|
17222
|
+
* @memberof DataTypesExperimentResults
|
|
17223
|
+
*/
|
|
17224
|
+
'is_significant'?: boolean;
|
|
17225
|
+
/**
|
|
17226
|
+
*
|
|
17227
|
+
* @type {string}
|
|
17228
|
+
* @memberof DataTypesExperimentResults
|
|
17229
|
+
*/
|
|
17230
|
+
'name'?: string;
|
|
17231
|
+
/**
|
|
17232
|
+
*
|
|
17233
|
+
* @type {number}
|
|
17234
|
+
* @memberof DataTypesExperimentResults
|
|
17235
|
+
*/
|
|
17236
|
+
'revenue_lift'?: number;
|
|
17237
|
+
/**
|
|
17238
|
+
*
|
|
17239
|
+
* @type {string}
|
|
17240
|
+
* @memberof DataTypesExperimentResults
|
|
17241
|
+
*/
|
|
17242
|
+
'started_at'?: string;
|
|
17243
|
+
/**
|
|
17244
|
+
*
|
|
17245
|
+
* @type {DataTypesExperimentStatus}
|
|
17246
|
+
* @memberof DataTypesExperimentResults
|
|
17247
|
+
*/
|
|
17248
|
+
'status'?: DataTypesExperimentStatus;
|
|
17249
|
+
/**
|
|
17250
|
+
*
|
|
17251
|
+
* @type {Array<DataTypesExperimentVariantResult>}
|
|
17252
|
+
* @memberof DataTypesExperimentResults
|
|
17253
|
+
*/
|
|
17254
|
+
'variants'?: Array<DataTypesExperimentVariantResult>;
|
|
17255
|
+
/**
|
|
17256
|
+
*
|
|
17257
|
+
* @type {string}
|
|
17258
|
+
* @memberof DataTypesExperimentResults
|
|
17259
|
+
*/
|
|
17260
|
+
'winner'?: string;
|
|
17261
|
+
}
|
|
17262
|
+
/**
|
|
17263
|
+
*
|
|
17264
|
+
* @export
|
|
17265
|
+
* @enum {string}
|
|
17266
|
+
*/
|
|
17267
|
+
export declare const DataTypesExperimentStatus: {
|
|
17268
|
+
readonly ExperimentStatusDraft: "draft";
|
|
17269
|
+
readonly ExperimentStatusScheduled: "scheduled";
|
|
17270
|
+
readonly ExperimentStatusRunning: "running";
|
|
17271
|
+
readonly ExperimentStatusPaused: "paused";
|
|
17272
|
+
readonly ExperimentStatusCompleted: "completed";
|
|
17273
|
+
readonly ExperimentStatusArchived: "archived";
|
|
17274
|
+
};
|
|
17275
|
+
export type DataTypesExperimentStatus = typeof DataTypesExperimentStatus[keyof typeof DataTypesExperimentStatus];
|
|
17276
|
+
/**
|
|
17277
|
+
*
|
|
17278
|
+
* @export
|
|
17279
|
+
* @enum {string}
|
|
17280
|
+
*/
|
|
17281
|
+
export declare const DataTypesExperimentType: {
|
|
17282
|
+
readonly ExperimentTypeSearchRanking: "search_ranking";
|
|
17283
|
+
readonly ExperimentTypeRecommendation: "recommendation";
|
|
17284
|
+
readonly ExperimentTypePersonalization: "personalization";
|
|
17285
|
+
readonly ExperimentTypeUI: "ui";
|
|
17286
|
+
readonly ExperimentTypePricing: "pricing";
|
|
17287
|
+
readonly ExperimentTypeOther: "other";
|
|
17288
|
+
};
|
|
17289
|
+
export type DataTypesExperimentType = typeof DataTypesExperimentType[keyof typeof DataTypesExperimentType];
|
|
17290
|
+
/**
|
|
17291
|
+
*
|
|
17292
|
+
* @export
|
|
17293
|
+
* @interface DataTypesExperimentVariant
|
|
17294
|
+
*/
|
|
17295
|
+
export interface DataTypesExperimentVariant {
|
|
17296
|
+
/**
|
|
17297
|
+
*
|
|
17298
|
+
* @type {{ [key: string]: any; }}
|
|
17299
|
+
* @memberof DataTypesExperimentVariant
|
|
17300
|
+
*/
|
|
17301
|
+
'config'?: {
|
|
17302
|
+
[key: string]: any;
|
|
17303
|
+
};
|
|
17304
|
+
/**
|
|
17305
|
+
*
|
|
17306
|
+
* @type {string}
|
|
17307
|
+
* @memberof DataTypesExperimentVariant
|
|
17308
|
+
*/
|
|
17309
|
+
'id'?: string;
|
|
17310
|
+
/**
|
|
17311
|
+
*
|
|
17312
|
+
* @type {string}
|
|
17313
|
+
* @memberof DataTypesExperimentVariant
|
|
17314
|
+
*/
|
|
17315
|
+
'name'?: string;
|
|
17316
|
+
/**
|
|
17317
|
+
* Traffic weight percentage (e.g., 50 = 50%)
|
|
17318
|
+
* @type {number}
|
|
17319
|
+
* @memberof DataTypesExperimentVariant
|
|
17320
|
+
*/
|
|
17321
|
+
'weight'?: number;
|
|
17322
|
+
}
|
|
17323
|
+
/**
|
|
17324
|
+
*
|
|
17325
|
+
* @export
|
|
17326
|
+
* @interface DataTypesExperimentVariantResult
|
|
17327
|
+
*/
|
|
17328
|
+
export interface DataTypesExperimentVariantResult {
|
|
17329
|
+
/**
|
|
17330
|
+
*
|
|
17331
|
+
* @type {number}
|
|
17332
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17333
|
+
*/
|
|
17334
|
+
'avg_latency_ms'?: number;
|
|
17335
|
+
/**
|
|
17336
|
+
*
|
|
17337
|
+
* @type {number}
|
|
17338
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17339
|
+
*/
|
|
17340
|
+
'conversion_rate'?: number;
|
|
17341
|
+
/**
|
|
17342
|
+
*
|
|
17343
|
+
* @type {number}
|
|
17344
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17345
|
+
*/
|
|
17346
|
+
'conversions'?: number;
|
|
17347
|
+
/**
|
|
17348
|
+
*
|
|
17349
|
+
* @type {number}
|
|
17350
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17351
|
+
*/
|
|
17352
|
+
'ctr'?: number;
|
|
17353
|
+
/**
|
|
17354
|
+
*
|
|
17355
|
+
* @type {number}
|
|
17356
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17357
|
+
*/
|
|
17358
|
+
'revenue'?: number;
|
|
17359
|
+
/**
|
|
17360
|
+
*
|
|
17361
|
+
* @type {number}
|
|
17362
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17363
|
+
*/
|
|
17364
|
+
'revenue_per_user'?: number;
|
|
17365
|
+
/**
|
|
17366
|
+
*
|
|
17367
|
+
* @type {number}
|
|
17368
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17369
|
+
*/
|
|
17370
|
+
'total_clicks'?: number;
|
|
17371
|
+
/**
|
|
17372
|
+
*
|
|
17373
|
+
* @type {number}
|
|
17374
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17375
|
+
*/
|
|
17376
|
+
'total_searches'?: number;
|
|
17377
|
+
/**
|
|
17378
|
+
*
|
|
17379
|
+
* @type {number}
|
|
17380
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17381
|
+
*/
|
|
17382
|
+
'unique_users'?: number;
|
|
17383
|
+
/**
|
|
17384
|
+
*
|
|
17385
|
+
* @type {string}
|
|
17386
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17387
|
+
*/
|
|
17388
|
+
'variant_id'?: string;
|
|
17389
|
+
/**
|
|
17390
|
+
*
|
|
17391
|
+
* @type {string}
|
|
17392
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17393
|
+
*/
|
|
17394
|
+
'variant_name'?: string;
|
|
17395
|
+
/**
|
|
17396
|
+
*
|
|
17397
|
+
* @type {number}
|
|
17398
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17399
|
+
*/
|
|
17400
|
+
'zero_result_rate'?: number;
|
|
17401
|
+
}
|
|
16890
17402
|
/**
|
|
16891
17403
|
*
|
|
16892
17404
|
* @export
|
|
@@ -31314,6 +31826,85 @@ export interface DataTypesUpdateCustomWordListRequest {
|
|
|
31314
31826
|
*/
|
|
31315
31827
|
'words'?: Array<string>;
|
|
31316
31828
|
}
|
|
31829
|
+
/**
|
|
31830
|
+
*
|
|
31831
|
+
* @export
|
|
31832
|
+
* @interface DataTypesUpdateExperimentRequest
|
|
31833
|
+
*/
|
|
31834
|
+
export interface DataTypesUpdateExperimentRequest {
|
|
31835
|
+
/**
|
|
31836
|
+
*
|
|
31837
|
+
* @type {object}
|
|
31838
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
31839
|
+
*/
|
|
31840
|
+
'audience_filter'?: object;
|
|
31841
|
+
/**
|
|
31842
|
+
*
|
|
31843
|
+
* @type {string}
|
|
31844
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
31845
|
+
*/
|
|
31846
|
+
'description'?: string;
|
|
31847
|
+
/**
|
|
31848
|
+
*
|
|
31849
|
+
* @type {string}
|
|
31850
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
31851
|
+
*/
|
|
31852
|
+
'hypothesis'?: string;
|
|
31853
|
+
/**
|
|
31854
|
+
*
|
|
31855
|
+
* @type {number}
|
|
31856
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
31857
|
+
*/
|
|
31858
|
+
'max_duration_days'?: number;
|
|
31859
|
+
/**
|
|
31860
|
+
*
|
|
31861
|
+
* @type {number}
|
|
31862
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
31863
|
+
*/
|
|
31864
|
+
'min_sample_size'?: number;
|
|
31865
|
+
/**
|
|
31866
|
+
*
|
|
31867
|
+
* @type {string}
|
|
31868
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
31869
|
+
*/
|
|
31870
|
+
'name'?: string;
|
|
31871
|
+
/**
|
|
31872
|
+
*
|
|
31873
|
+
* @type {string}
|
|
31874
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
31875
|
+
*/
|
|
31876
|
+
'primary_metric'?: string;
|
|
31877
|
+
/**
|
|
31878
|
+
*
|
|
31879
|
+
* @type {string}
|
|
31880
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
31881
|
+
*/
|
|
31882
|
+
'scheduled_end_at'?: string;
|
|
31883
|
+
/**
|
|
31884
|
+
*
|
|
31885
|
+
* @type {string}
|
|
31886
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
31887
|
+
*/
|
|
31888
|
+
'scheduled_start_at'?: string;
|
|
31889
|
+
/**
|
|
31890
|
+
*
|
|
31891
|
+
* @type {Array<string>}
|
|
31892
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
31893
|
+
*/
|
|
31894
|
+
'secondary_metrics'?: Array<string>;
|
|
31895
|
+
/**
|
|
31896
|
+
*
|
|
31897
|
+
* @type {number}
|
|
31898
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
31899
|
+
*/
|
|
31900
|
+
'traffic_percentage'?: number;
|
|
31901
|
+
/**
|
|
31902
|
+
*
|
|
31903
|
+
* @type {Array<DataTypesExperimentVariant>}
|
|
31904
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
31905
|
+
*/
|
|
31906
|
+
'variants'?: Array<DataTypesExperimentVariant>;
|
|
31907
|
+
}
|
|
31317
31908
|
/**
|
|
31318
31909
|
*
|
|
31319
31910
|
* @export
|
|
@@ -50543,6 +51134,386 @@ export declare class DocumentsApi extends BaseAPI {
|
|
|
50543
51134
|
*/
|
|
50544
51135
|
adminStoresXStoreIDUploadPost(xStoreID: string, file: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayString, any, {}>>;
|
|
50545
51136
|
}
|
|
51137
|
+
/**
|
|
51138
|
+
* ExperimentsApi - axios parameter creator
|
|
51139
|
+
* @export
|
|
51140
|
+
*/
|
|
51141
|
+
export declare const ExperimentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
51142
|
+
/**
|
|
51143
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
51144
|
+
* @summary List all experiments
|
|
51145
|
+
* @param {*} [options] Override http request option.
|
|
51146
|
+
* @throws {RequiredError}
|
|
51147
|
+
*/
|
|
51148
|
+
v1AdminExperimentsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51149
|
+
/**
|
|
51150
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
51151
|
+
* @summary Complete an experiment
|
|
51152
|
+
* @param {string} id Experiment ID (slug)
|
|
51153
|
+
* @param {object} [body] Optional winner variant ID
|
|
51154
|
+
* @param {*} [options] Override http request option.
|
|
51155
|
+
* @throws {RequiredError}
|
|
51156
|
+
*/
|
|
51157
|
+
v1AdminExperimentsIdCompletePost: (id: string, body?: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51158
|
+
/**
|
|
51159
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
51160
|
+
* @summary Delete a draft experiment
|
|
51161
|
+
* @param {string} id Experiment ID (slug)
|
|
51162
|
+
* @param {*} [options] Override http request option.
|
|
51163
|
+
* @throws {RequiredError}
|
|
51164
|
+
*/
|
|
51165
|
+
v1AdminExperimentsIdDelete: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51166
|
+
/**
|
|
51167
|
+
* Returns a single experiment by its experiment_id slug.
|
|
51168
|
+
* @summary Get experiment by ID
|
|
51169
|
+
* @param {string} id Experiment ID (slug)
|
|
51170
|
+
* @param {*} [options] Override http request option.
|
|
51171
|
+
* @throws {RequiredError}
|
|
51172
|
+
*/
|
|
51173
|
+
v1AdminExperimentsIdGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51174
|
+
/**
|
|
51175
|
+
* Transitions a running experiment to paused status.
|
|
51176
|
+
* @summary Pause an experiment
|
|
51177
|
+
* @param {string} id Experiment ID (slug)
|
|
51178
|
+
* @param {*} [options] Override http request option.
|
|
51179
|
+
* @throws {RequiredError}
|
|
51180
|
+
*/
|
|
51181
|
+
v1AdminExperimentsIdPausePost: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51182
|
+
/**
|
|
51183
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
51184
|
+
* @summary Update an experiment
|
|
51185
|
+
* @param {string} id Experiment ID (slug)
|
|
51186
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
51187
|
+
* @param {*} [options] Override http request option.
|
|
51188
|
+
* @throws {RequiredError}
|
|
51189
|
+
*/
|
|
51190
|
+
v1AdminExperimentsIdPut: (id: string, dataTypesUpdateExperimentRequest: DataTypesUpdateExperimentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51191
|
+
/**
|
|
51192
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
51193
|
+
* @summary Get experiment results
|
|
51194
|
+
* @param {string} id Experiment ID (slug)
|
|
51195
|
+
* @param {*} [options] Override http request option.
|
|
51196
|
+
* @throws {RequiredError}
|
|
51197
|
+
*/
|
|
51198
|
+
v1AdminExperimentsIdResultsGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51199
|
+
/**
|
|
51200
|
+
* Transitions a draft or paused experiment to running status.
|
|
51201
|
+
* @summary Start an experiment
|
|
51202
|
+
* @param {string} id Experiment ID (slug)
|
|
51203
|
+
* @param {*} [options] Override http request option.
|
|
51204
|
+
* @throws {RequiredError}
|
|
51205
|
+
*/
|
|
51206
|
+
v1AdminExperimentsIdStartPost: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51207
|
+
/**
|
|
51208
|
+
* Creates a new A/B test experiment in draft status.
|
|
51209
|
+
* @summary Create a new experiment
|
|
51210
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
51211
|
+
* @param {*} [options] Override http request option.
|
|
51212
|
+
* @throws {RequiredError}
|
|
51213
|
+
*/
|
|
51214
|
+
v1AdminExperimentsPost: (dataTypesCreateExperimentRequest: DataTypesCreateExperimentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51215
|
+
/**
|
|
51216
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
51217
|
+
* @summary Get experiment assignments for a user
|
|
51218
|
+
* @param {string} xStoreid Store ID
|
|
51219
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
51220
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
51221
|
+
* @param {*} [options] Override http request option.
|
|
51222
|
+
* @throws {RequiredError}
|
|
51223
|
+
*/
|
|
51224
|
+
v1ExperimentsAssignmentGet: (xStoreid: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51225
|
+
};
|
|
51226
|
+
/**
|
|
51227
|
+
* ExperimentsApi - functional programming interface
|
|
51228
|
+
* @export
|
|
51229
|
+
*/
|
|
51230
|
+
export declare const ExperimentsApiFp: (configuration?: Configuration) => {
|
|
51231
|
+
/**
|
|
51232
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
51233
|
+
* @summary List all experiments
|
|
51234
|
+
* @param {*} [options] Override http request option.
|
|
51235
|
+
* @throws {RequiredError}
|
|
51236
|
+
*/
|
|
51237
|
+
v1AdminExperimentsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
51238
|
+
[key: string]: Array<DataTypesExperiment>;
|
|
51239
|
+
}>>;
|
|
51240
|
+
/**
|
|
51241
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
51242
|
+
* @summary Complete an experiment
|
|
51243
|
+
* @param {string} id Experiment ID (slug)
|
|
51244
|
+
* @param {object} [body] Optional winner variant ID
|
|
51245
|
+
* @param {*} [options] Override http request option.
|
|
51246
|
+
* @throws {RequiredError}
|
|
51247
|
+
*/
|
|
51248
|
+
v1AdminExperimentsIdCompletePost(id: string, body?: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
51249
|
+
/**
|
|
51250
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
51251
|
+
* @summary Delete a draft experiment
|
|
51252
|
+
* @param {string} id Experiment ID (slug)
|
|
51253
|
+
* @param {*} [options] Override http request option.
|
|
51254
|
+
* @throws {RequiredError}
|
|
51255
|
+
*/
|
|
51256
|
+
v1AdminExperimentsIdDelete(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
51257
|
+
/**
|
|
51258
|
+
* Returns a single experiment by its experiment_id slug.
|
|
51259
|
+
* @summary Get experiment by ID
|
|
51260
|
+
* @param {string} id Experiment ID (slug)
|
|
51261
|
+
* @param {*} [options] Override http request option.
|
|
51262
|
+
* @throws {RequiredError}
|
|
51263
|
+
*/
|
|
51264
|
+
v1AdminExperimentsIdGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesExperiment>>;
|
|
51265
|
+
/**
|
|
51266
|
+
* Transitions a running experiment to paused status.
|
|
51267
|
+
* @summary Pause an experiment
|
|
51268
|
+
* @param {string} id Experiment ID (slug)
|
|
51269
|
+
* @param {*} [options] Override http request option.
|
|
51270
|
+
* @throws {RequiredError}
|
|
51271
|
+
*/
|
|
51272
|
+
v1AdminExperimentsIdPausePost(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
51273
|
+
/**
|
|
51274
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
51275
|
+
* @summary Update an experiment
|
|
51276
|
+
* @param {string} id Experiment ID (slug)
|
|
51277
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
51278
|
+
* @param {*} [options] Override http request option.
|
|
51279
|
+
* @throws {RequiredError}
|
|
51280
|
+
*/
|
|
51281
|
+
v1AdminExperimentsIdPut(id: string, dataTypesUpdateExperimentRequest: DataTypesUpdateExperimentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesExperiment>>;
|
|
51282
|
+
/**
|
|
51283
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
51284
|
+
* @summary Get experiment results
|
|
51285
|
+
* @param {string} id Experiment ID (slug)
|
|
51286
|
+
* @param {*} [options] Override http request option.
|
|
51287
|
+
* @throws {RequiredError}
|
|
51288
|
+
*/
|
|
51289
|
+
v1AdminExperimentsIdResultsGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesExperimentResults>>;
|
|
51290
|
+
/**
|
|
51291
|
+
* Transitions a draft or paused experiment to running status.
|
|
51292
|
+
* @summary Start an experiment
|
|
51293
|
+
* @param {string} id Experiment ID (slug)
|
|
51294
|
+
* @param {*} [options] Override http request option.
|
|
51295
|
+
* @throws {RequiredError}
|
|
51296
|
+
*/
|
|
51297
|
+
v1AdminExperimentsIdStartPost(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
51298
|
+
/**
|
|
51299
|
+
* Creates a new A/B test experiment in draft status.
|
|
51300
|
+
* @summary Create a new experiment
|
|
51301
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
51302
|
+
* @param {*} [options] Override http request option.
|
|
51303
|
+
* @throws {RequiredError}
|
|
51304
|
+
*/
|
|
51305
|
+
v1AdminExperimentsPost(dataTypesCreateExperimentRequest: DataTypesCreateExperimentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesExperiment>>;
|
|
51306
|
+
/**
|
|
51307
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
51308
|
+
* @summary Get experiment assignments for a user
|
|
51309
|
+
* @param {string} xStoreid Store ID
|
|
51310
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
51311
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
51312
|
+
* @param {*} [options] Override http request option.
|
|
51313
|
+
* @throws {RequiredError}
|
|
51314
|
+
*/
|
|
51315
|
+
v1ExperimentsAssignmentGet(xStoreid: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
51316
|
+
[key: string]: Array<DataTypesExperimentAssignment>;
|
|
51317
|
+
}>>;
|
|
51318
|
+
};
|
|
51319
|
+
/**
|
|
51320
|
+
* ExperimentsApi - factory interface
|
|
51321
|
+
* @export
|
|
51322
|
+
*/
|
|
51323
|
+
export declare const ExperimentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
51324
|
+
/**
|
|
51325
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
51326
|
+
* @summary List all experiments
|
|
51327
|
+
* @param {*} [options] Override http request option.
|
|
51328
|
+
* @throws {RequiredError}
|
|
51329
|
+
*/
|
|
51330
|
+
v1AdminExperimentsGet(options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
51331
|
+
[key: string]: Array<DataTypesExperiment>;
|
|
51332
|
+
}>;
|
|
51333
|
+
/**
|
|
51334
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
51335
|
+
* @summary Complete an experiment
|
|
51336
|
+
* @param {string} id Experiment ID (slug)
|
|
51337
|
+
* @param {object} [body] Optional winner variant ID
|
|
51338
|
+
* @param {*} [options] Override http request option.
|
|
51339
|
+
* @throws {RequiredError}
|
|
51340
|
+
*/
|
|
51341
|
+
v1AdminExperimentsIdCompletePost(id: string, body?: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
51342
|
+
/**
|
|
51343
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
51344
|
+
* @summary Delete a draft experiment
|
|
51345
|
+
* @param {string} id Experiment ID (slug)
|
|
51346
|
+
* @param {*} [options] Override http request option.
|
|
51347
|
+
* @throws {RequiredError}
|
|
51348
|
+
*/
|
|
51349
|
+
v1AdminExperimentsIdDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
51350
|
+
/**
|
|
51351
|
+
* Returns a single experiment by its experiment_id slug.
|
|
51352
|
+
* @summary Get experiment by ID
|
|
51353
|
+
* @param {string} id Experiment ID (slug)
|
|
51354
|
+
* @param {*} [options] Override http request option.
|
|
51355
|
+
* @throws {RequiredError}
|
|
51356
|
+
*/
|
|
51357
|
+
v1AdminExperimentsIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesExperiment>;
|
|
51358
|
+
/**
|
|
51359
|
+
* Transitions a running experiment to paused status.
|
|
51360
|
+
* @summary Pause an experiment
|
|
51361
|
+
* @param {string} id Experiment ID (slug)
|
|
51362
|
+
* @param {*} [options] Override http request option.
|
|
51363
|
+
* @throws {RequiredError}
|
|
51364
|
+
*/
|
|
51365
|
+
v1AdminExperimentsIdPausePost(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
51366
|
+
/**
|
|
51367
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
51368
|
+
* @summary Update an experiment
|
|
51369
|
+
* @param {string} id Experiment ID (slug)
|
|
51370
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
51371
|
+
* @param {*} [options] Override http request option.
|
|
51372
|
+
* @throws {RequiredError}
|
|
51373
|
+
*/
|
|
51374
|
+
v1AdminExperimentsIdPut(id: string, dataTypesUpdateExperimentRequest: DataTypesUpdateExperimentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesExperiment>;
|
|
51375
|
+
/**
|
|
51376
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
51377
|
+
* @summary Get experiment results
|
|
51378
|
+
* @param {string} id Experiment ID (slug)
|
|
51379
|
+
* @param {*} [options] Override http request option.
|
|
51380
|
+
* @throws {RequiredError}
|
|
51381
|
+
*/
|
|
51382
|
+
v1AdminExperimentsIdResultsGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesExperimentResults>;
|
|
51383
|
+
/**
|
|
51384
|
+
* Transitions a draft or paused experiment to running status.
|
|
51385
|
+
* @summary Start an experiment
|
|
51386
|
+
* @param {string} id Experiment ID (slug)
|
|
51387
|
+
* @param {*} [options] Override http request option.
|
|
51388
|
+
* @throws {RequiredError}
|
|
51389
|
+
*/
|
|
51390
|
+
v1AdminExperimentsIdStartPost(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
51391
|
+
/**
|
|
51392
|
+
* Creates a new A/B test experiment in draft status.
|
|
51393
|
+
* @summary Create a new experiment
|
|
51394
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
51395
|
+
* @param {*} [options] Override http request option.
|
|
51396
|
+
* @throws {RequiredError}
|
|
51397
|
+
*/
|
|
51398
|
+
v1AdminExperimentsPost(dataTypesCreateExperimentRequest: DataTypesCreateExperimentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesExperiment>;
|
|
51399
|
+
/**
|
|
51400
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
51401
|
+
* @summary Get experiment assignments for a user
|
|
51402
|
+
* @param {string} xStoreid Store ID
|
|
51403
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
51404
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
51405
|
+
* @param {*} [options] Override http request option.
|
|
51406
|
+
* @throws {RequiredError}
|
|
51407
|
+
*/
|
|
51408
|
+
v1ExperimentsAssignmentGet(xStoreid: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
51409
|
+
[key: string]: Array<DataTypesExperimentAssignment>;
|
|
51410
|
+
}>;
|
|
51411
|
+
};
|
|
51412
|
+
/**
|
|
51413
|
+
* ExperimentsApi - object-oriented interface
|
|
51414
|
+
* @export
|
|
51415
|
+
* @class ExperimentsApi
|
|
51416
|
+
* @extends {BaseAPI}
|
|
51417
|
+
*/
|
|
51418
|
+
export declare class ExperimentsApi extends BaseAPI {
|
|
51419
|
+
/**
|
|
51420
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
51421
|
+
* @summary List all experiments
|
|
51422
|
+
* @param {*} [options] Override http request option.
|
|
51423
|
+
* @throws {RequiredError}
|
|
51424
|
+
* @memberof ExperimentsApi
|
|
51425
|
+
*/
|
|
51426
|
+
v1AdminExperimentsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
51427
|
+
[key: string]: DataTypesExperiment[];
|
|
51428
|
+
}, any, {}>>;
|
|
51429
|
+
/**
|
|
51430
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
51431
|
+
* @summary Complete an experiment
|
|
51432
|
+
* @param {string} id Experiment ID (slug)
|
|
51433
|
+
* @param {object} [body] Optional winner variant ID
|
|
51434
|
+
* @param {*} [options] Override http request option.
|
|
51435
|
+
* @throws {RequiredError}
|
|
51436
|
+
* @memberof ExperimentsApi
|
|
51437
|
+
*/
|
|
51438
|
+
v1AdminExperimentsIdCompletePost(id: string, body?: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
51439
|
+
/**
|
|
51440
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
51441
|
+
* @summary Delete a draft experiment
|
|
51442
|
+
* @param {string} id Experiment ID (slug)
|
|
51443
|
+
* @param {*} [options] Override http request option.
|
|
51444
|
+
* @throws {RequiredError}
|
|
51445
|
+
* @memberof ExperimentsApi
|
|
51446
|
+
*/
|
|
51447
|
+
v1AdminExperimentsIdDelete(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
51448
|
+
/**
|
|
51449
|
+
* Returns a single experiment by its experiment_id slug.
|
|
51450
|
+
* @summary Get experiment by ID
|
|
51451
|
+
* @param {string} id Experiment ID (slug)
|
|
51452
|
+
* @param {*} [options] Override http request option.
|
|
51453
|
+
* @throws {RequiredError}
|
|
51454
|
+
* @memberof ExperimentsApi
|
|
51455
|
+
*/
|
|
51456
|
+
v1AdminExperimentsIdGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesExperiment, any, {}>>;
|
|
51457
|
+
/**
|
|
51458
|
+
* Transitions a running experiment to paused status.
|
|
51459
|
+
* @summary Pause an experiment
|
|
51460
|
+
* @param {string} id Experiment ID (slug)
|
|
51461
|
+
* @param {*} [options] Override http request option.
|
|
51462
|
+
* @throws {RequiredError}
|
|
51463
|
+
* @memberof ExperimentsApi
|
|
51464
|
+
*/
|
|
51465
|
+
v1AdminExperimentsIdPausePost(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
51466
|
+
/**
|
|
51467
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
51468
|
+
* @summary Update an experiment
|
|
51469
|
+
* @param {string} id Experiment ID (slug)
|
|
51470
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
51471
|
+
* @param {*} [options] Override http request option.
|
|
51472
|
+
* @throws {RequiredError}
|
|
51473
|
+
* @memberof ExperimentsApi
|
|
51474
|
+
*/
|
|
51475
|
+
v1AdminExperimentsIdPut(id: string, dataTypesUpdateExperimentRequest: DataTypesUpdateExperimentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesExperiment, any, {}>>;
|
|
51476
|
+
/**
|
|
51477
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
51478
|
+
* @summary Get experiment results
|
|
51479
|
+
* @param {string} id Experiment ID (slug)
|
|
51480
|
+
* @param {*} [options] Override http request option.
|
|
51481
|
+
* @throws {RequiredError}
|
|
51482
|
+
* @memberof ExperimentsApi
|
|
51483
|
+
*/
|
|
51484
|
+
v1AdminExperimentsIdResultsGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesExperimentResults, any, {}>>;
|
|
51485
|
+
/**
|
|
51486
|
+
* Transitions a draft or paused experiment to running status.
|
|
51487
|
+
* @summary Start an experiment
|
|
51488
|
+
* @param {string} id Experiment ID (slug)
|
|
51489
|
+
* @param {*} [options] Override http request option.
|
|
51490
|
+
* @throws {RequiredError}
|
|
51491
|
+
* @memberof ExperimentsApi
|
|
51492
|
+
*/
|
|
51493
|
+
v1AdminExperimentsIdStartPost(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
51494
|
+
/**
|
|
51495
|
+
* Creates a new A/B test experiment in draft status.
|
|
51496
|
+
* @summary Create a new experiment
|
|
51497
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
51498
|
+
* @param {*} [options] Override http request option.
|
|
51499
|
+
* @throws {RequiredError}
|
|
51500
|
+
* @memberof ExperimentsApi
|
|
51501
|
+
*/
|
|
51502
|
+
v1AdminExperimentsPost(dataTypesCreateExperimentRequest: DataTypesCreateExperimentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesExperiment, any, {}>>;
|
|
51503
|
+
/**
|
|
51504
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
51505
|
+
* @summary Get experiment assignments for a user
|
|
51506
|
+
* @param {string} xStoreid Store ID
|
|
51507
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
51508
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
51509
|
+
* @param {*} [options] Override http request option.
|
|
51510
|
+
* @throws {RequiredError}
|
|
51511
|
+
* @memberof ExperimentsApi
|
|
51512
|
+
*/
|
|
51513
|
+
v1ExperimentsAssignmentGet(xStoreid: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
51514
|
+
[key: string]: DataTypesExperimentAssignment[];
|
|
51515
|
+
}, any, {}>>;
|
|
51516
|
+
}
|
|
50546
51517
|
/**
|
|
50547
51518
|
* ExternalAPINotificationsApi - axios parameter creator
|
|
50548
51519
|
* @export
|