@seekora-ai/search-sdk 0.2.3 → 0.2.4
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/dist/analytics-v3-api.d.ts +52 -0
- package/dist/analytics-v3-api.js +104 -0
- package/dist/analytics-v3-types.d.ts +257 -0
- package/dist/analytics-v3-types.js +8 -0
- package/dist/client.d.ts +9 -63
- package/dist/client.js +11 -5
- package/dist/generated/api.d.ts +1287 -62
- package/dist/generated/api.js +28 -2
- package/dist/generated/base.js +1 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.js +5 -1
- package/package.json +3 -3
package/dist/generated/api.d.ts
CHANGED
|
@@ -13,6 +13,48 @@ import type { Configuration } from './configuration';
|
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import type { RequestArgs } from './base';
|
|
15
15
|
import { BaseAPI } from './base';
|
|
16
|
+
export interface AnalyticsABTestRequest {
|
|
17
|
+
'end_date': string;
|
|
18
|
+
'experiment_id'?: string;
|
|
19
|
+
'model_ids'?: Array<string>;
|
|
20
|
+
'start_date': string;
|
|
21
|
+
'xstoreid'?: string;
|
|
22
|
+
}
|
|
23
|
+
export interface AnalyticsABTestResponse {
|
|
24
|
+
'control_variant'?: string;
|
|
25
|
+
'end_date'?: string;
|
|
26
|
+
'experiment_id'?: string;
|
|
27
|
+
'start_date'?: string;
|
|
28
|
+
'statistics'?: AnalyticsABTestStatistics;
|
|
29
|
+
/**
|
|
30
|
+
* running, completed, stopped
|
|
31
|
+
*/
|
|
32
|
+
'status'?: string;
|
|
33
|
+
'variants'?: Array<AnalyticsABTestVariant>;
|
|
34
|
+
}
|
|
35
|
+
export interface AnalyticsABTestStatistics {
|
|
36
|
+
'confidence_level'?: number;
|
|
37
|
+
'conversion_lift_percent'?: number;
|
|
38
|
+
'ctr_lift_percent'?: number;
|
|
39
|
+
'is_significant'?: boolean;
|
|
40
|
+
'recommended_winner'?: string;
|
|
41
|
+
'revenue_lift_percent'?: number;
|
|
42
|
+
'sample_size_adequate'?: boolean;
|
|
43
|
+
}
|
|
44
|
+
export interface AnalyticsABTestVariant {
|
|
45
|
+
'conversion_rate'?: number;
|
|
46
|
+
'ctr'?: number;
|
|
47
|
+
'model_id'?: string;
|
|
48
|
+
'revenue_per_user'?: number;
|
|
49
|
+
'total_clicks'?: number;
|
|
50
|
+
'total_conversions'?: number;
|
|
51
|
+
'total_impressions'?: number;
|
|
52
|
+
'total_requests'?: number;
|
|
53
|
+
'total_revenue'?: number;
|
|
54
|
+
'traffic_percent'?: number;
|
|
55
|
+
'unique_users'?: number;
|
|
56
|
+
'variant_id'?: string;
|
|
57
|
+
}
|
|
16
58
|
export interface AnalyticsAPIResponse {
|
|
17
59
|
'data'?: any;
|
|
18
60
|
'error'?: string;
|
|
@@ -172,6 +214,51 @@ export interface AnalyticsArrayPositionAnalytic {
|
|
|
172
214
|
export interface AnalyticsBatchPostRequest {
|
|
173
215
|
'events'?: Array<DataTypesEventPayload>;
|
|
174
216
|
}
|
|
217
|
+
export interface AnalyticsBestModel {
|
|
218
|
+
'by_conversion_rate'?: string;
|
|
219
|
+
'by_ctr'?: string;
|
|
220
|
+
'by_latency'?: string;
|
|
221
|
+
'by_revenue'?: string;
|
|
222
|
+
}
|
|
223
|
+
export interface AnalyticsCTRRequestBody {
|
|
224
|
+
'end_date': string;
|
|
225
|
+
/**
|
|
226
|
+
* hour, day, week, month
|
|
227
|
+
*/
|
|
228
|
+
'granularity'?: string;
|
|
229
|
+
'max_position'?: number;
|
|
230
|
+
'page'?: number;
|
|
231
|
+
'page_size'?: number;
|
|
232
|
+
'start_date': string;
|
|
233
|
+
'surface'?: string;
|
|
234
|
+
'xstoreid'?: string;
|
|
235
|
+
}
|
|
236
|
+
export interface AnalyticsClickMetrics {
|
|
237
|
+
'attributed_clicks'?: number;
|
|
238
|
+
'attribution_rate'?: number;
|
|
239
|
+
'avg_position'?: number;
|
|
240
|
+
'clicks_by_subtype'?: {
|
|
241
|
+
[key: string]: number;
|
|
242
|
+
};
|
|
243
|
+
'time_series'?: Array<SeekoraGoSrcServicesAnalyticsTimeSeriesPoint>;
|
|
244
|
+
'total_clicks'?: number;
|
|
245
|
+
'unique_items'?: number;
|
|
246
|
+
'unique_sessions'?: number;
|
|
247
|
+
'unique_users'?: number;
|
|
248
|
+
}
|
|
249
|
+
export interface AnalyticsClickMetricsRequestBody {
|
|
250
|
+
'click_subtype'?: string;
|
|
251
|
+
'end_date': string;
|
|
252
|
+
/**
|
|
253
|
+
* hour, day, week, month
|
|
254
|
+
*/
|
|
255
|
+
'granularity'?: string;
|
|
256
|
+
'page'?: number;
|
|
257
|
+
'page_size'?: number;
|
|
258
|
+
'start_date': string;
|
|
259
|
+
'surface'?: string;
|
|
260
|
+
'xstoreid'?: string;
|
|
261
|
+
}
|
|
175
262
|
export interface AnalyticsClickPositionBucket {
|
|
176
263
|
'click_rate'?: number;
|
|
177
264
|
'clicks'?: number;
|
|
@@ -185,6 +272,55 @@ export interface AnalyticsClickPositionBucket {
|
|
|
185
272
|
*/
|
|
186
273
|
'share'?: number;
|
|
187
274
|
}
|
|
275
|
+
export interface AnalyticsCohort {
|
|
276
|
+
'cohort_date'?: string;
|
|
277
|
+
'initial_users'?: number;
|
|
278
|
+
/**
|
|
279
|
+
* absolute numbers retained
|
|
280
|
+
*/
|
|
281
|
+
'retained'?: Array<number>;
|
|
282
|
+
/**
|
|
283
|
+
* retention % for each period
|
|
284
|
+
*/
|
|
285
|
+
'retention'?: Array<number>;
|
|
286
|
+
}
|
|
287
|
+
export interface AnalyticsCohortBehavior {
|
|
288
|
+
'cohort_date'?: string;
|
|
289
|
+
'initial_users'?: number;
|
|
290
|
+
'metric_value'?: number;
|
|
291
|
+
'total_events'?: number;
|
|
292
|
+
}
|
|
293
|
+
export interface AnalyticsCohortBehaviorRequestBody {
|
|
294
|
+
'behavior_metric'?: string;
|
|
295
|
+
'cohort_by'?: string;
|
|
296
|
+
'cohort_event'?: string;
|
|
297
|
+
'end_date': string;
|
|
298
|
+
'start_date': string;
|
|
299
|
+
'xstoreid'?: string;
|
|
300
|
+
}
|
|
301
|
+
export interface AnalyticsCohortBehaviorResult {
|
|
302
|
+
'cohort_by'?: string;
|
|
303
|
+
'cohorts'?: Array<AnalyticsCohortBehavior>;
|
|
304
|
+
'metric'?: string;
|
|
305
|
+
}
|
|
306
|
+
export interface AnalyticsCohortRetentionRequestBody {
|
|
307
|
+
'cohort_by'?: string;
|
|
308
|
+
'cohort_event'?: string;
|
|
309
|
+
'end_date': string;
|
|
310
|
+
'periods'?: number;
|
|
311
|
+
'retention_event'?: string;
|
|
312
|
+
'start_date': string;
|
|
313
|
+
'xstoreid'?: string;
|
|
314
|
+
}
|
|
315
|
+
export interface AnalyticsCohortRetentionResult {
|
|
316
|
+
'cohort_by'?: string;
|
|
317
|
+
'cohorts'?: Array<AnalyticsCohort>;
|
|
318
|
+
/**
|
|
319
|
+
* [\"Period 0\", \"Period 1\", ...]
|
|
320
|
+
*/
|
|
321
|
+
'period_names'?: Array<string>;
|
|
322
|
+
'periods'?: number;
|
|
323
|
+
}
|
|
188
324
|
export interface AnalyticsComparisonMeta {
|
|
189
325
|
/**
|
|
190
326
|
* Human readable comparison period
|
|
@@ -207,6 +343,48 @@ export interface AnalyticsComparisonMeta {
|
|
|
207
343
|
*/
|
|
208
344
|
'mode'?: boolean;
|
|
209
345
|
}
|
|
346
|
+
export interface AnalyticsCondition {
|
|
347
|
+
'field'?: string;
|
|
348
|
+
/**
|
|
349
|
+
* =, !=, >, <, >=, <=, contains, not_contains, in, not_in
|
|
350
|
+
*/
|
|
351
|
+
'operator'?: string;
|
|
352
|
+
'value'?: any;
|
|
353
|
+
}
|
|
354
|
+
export interface AnalyticsConversionMetrics {
|
|
355
|
+
'attributed_conversions'?: number;
|
|
356
|
+
'attribution_rate'?: number;
|
|
357
|
+
'avg_order_value'?: number;
|
|
358
|
+
'conversions_by_type'?: {
|
|
359
|
+
[key: string]: number;
|
|
360
|
+
};
|
|
361
|
+
'time_series'?: Array<SeekoraGoSrcServicesAnalyticsTimeSeriesPoint>;
|
|
362
|
+
'total_conversions'?: number;
|
|
363
|
+
'total_quantity'?: number;
|
|
364
|
+
'total_revenue'?: number;
|
|
365
|
+
'unique_orders'?: number;
|
|
366
|
+
'unique_users'?: number;
|
|
367
|
+
}
|
|
368
|
+
export interface AnalyticsConversionMetricsRequestBody {
|
|
369
|
+
'conversion_type'?: string;
|
|
370
|
+
'end_date': string;
|
|
371
|
+
/**
|
|
372
|
+
* hour, day, week, month
|
|
373
|
+
*/
|
|
374
|
+
'granularity'?: string;
|
|
375
|
+
'page'?: number;
|
|
376
|
+
'page_size'?: number;
|
|
377
|
+
'start_date': string;
|
|
378
|
+
'xstoreid'?: string;
|
|
379
|
+
}
|
|
380
|
+
export interface AnalyticsCreateFunnelRequestBody {
|
|
381
|
+
'conversion_window_hours'?: number;
|
|
382
|
+
'count_type'?: string;
|
|
383
|
+
'description'?: string;
|
|
384
|
+
'name': string;
|
|
385
|
+
'steps': Array<SeekoraGoSrcServicesAnalyticsFunnelStep>;
|
|
386
|
+
'store_id'?: number;
|
|
387
|
+
}
|
|
210
388
|
export interface AnalyticsCustomQueryRequest {
|
|
211
389
|
'end_time'?: string;
|
|
212
390
|
'granularity'?: string;
|
|
@@ -379,7 +557,7 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
379
557
|
'top_filters'?: number;
|
|
380
558
|
'total'?: number;
|
|
381
559
|
'trends'?: {
|
|
382
|
-
[key: string]: Array<
|
|
560
|
+
[key: string]: Array<SeekoraGoSrcAnalyticsTimeSeriesPoint>;
|
|
383
561
|
};
|
|
384
562
|
'xstoreid'?: string;
|
|
385
563
|
}
|
|
@@ -390,7 +568,7 @@ export interface AnalyticsFilterUsageStatistics {
|
|
|
390
568
|
'filter_key'?: string;
|
|
391
569
|
'filter_values'?: Array<AnalyticsFilterValueStatistic>;
|
|
392
570
|
'total_usage'?: number;
|
|
393
|
-
'trend_data'?: Array<
|
|
571
|
+
'trend_data'?: Array<SeekoraGoSrcAnalyticsTimeSeriesPoint>;
|
|
394
572
|
'unique_searches'?: number;
|
|
395
573
|
'unique_users'?: number;
|
|
396
574
|
'usage_percentage'?: number;
|
|
@@ -450,6 +628,80 @@ export interface AnalyticsFilterValueUsage {
|
|
|
450
628
|
*/
|
|
451
629
|
'value_type'?: string;
|
|
452
630
|
}
|
|
631
|
+
export interface AnalyticsFunnel {
|
|
632
|
+
'conversion_window_hours'?: number;
|
|
633
|
+
/**
|
|
634
|
+
* unique_users, total_events
|
|
635
|
+
*/
|
|
636
|
+
'count_type'?: string;
|
|
637
|
+
'created_at'?: string;
|
|
638
|
+
'description'?: string;
|
|
639
|
+
'id'?: string;
|
|
640
|
+
'is_active'?: boolean;
|
|
641
|
+
'name'?: string;
|
|
642
|
+
'org_id'?: number;
|
|
643
|
+
'orgcode'?: string;
|
|
644
|
+
'steps'?: Array<SeekoraGoSrcServicesAnalyticsFunnelStep>;
|
|
645
|
+
'store_id'?: number;
|
|
646
|
+
'updated_at'?: string;
|
|
647
|
+
}
|
|
648
|
+
export interface AnalyticsFunnelAnalysisRequestBody {
|
|
649
|
+
'conversion_window_hours'?: number;
|
|
650
|
+
'end_date': string;
|
|
651
|
+
'start_date': string;
|
|
652
|
+
'steps'?: Array<SeekoraGoSrcServicesAnalyticsFunnelStep>;
|
|
653
|
+
'xstoreid'?: string;
|
|
654
|
+
}
|
|
655
|
+
export interface AnalyticsFunnelData {
|
|
656
|
+
'overall_conversion_rate'?: number;
|
|
657
|
+
'steps'?: Array<AnalyticsFunnelStepResult>;
|
|
658
|
+
}
|
|
659
|
+
export interface AnalyticsFunnelDataPoint {
|
|
660
|
+
'converted_users'?: number;
|
|
661
|
+
'date'?: string;
|
|
662
|
+
'overall_conversion'?: number;
|
|
663
|
+
'total_users'?: number;
|
|
664
|
+
}
|
|
665
|
+
export interface AnalyticsFunnelRequestBody {
|
|
666
|
+
'end_date': string;
|
|
667
|
+
'funnel_steps'?: Array<string>;
|
|
668
|
+
/**
|
|
669
|
+
* hour, day, week, month
|
|
670
|
+
*/
|
|
671
|
+
'granularity'?: string;
|
|
672
|
+
'page'?: number;
|
|
673
|
+
'page_size'?: number;
|
|
674
|
+
'start_date': string;
|
|
675
|
+
'xstoreid'?: string;
|
|
676
|
+
}
|
|
677
|
+
export interface AnalyticsFunnelResult {
|
|
678
|
+
'analysis_window'?: AnalyticsTimeWindow;
|
|
679
|
+
'avg_time_to_convert_hours'?: number;
|
|
680
|
+
'funnel_id'?: string;
|
|
681
|
+
'funnel_name'?: string;
|
|
682
|
+
'overall_conversion'?: number;
|
|
683
|
+
'steps'?: Array<AnalyticsStepResult>;
|
|
684
|
+
'total_users'?: number;
|
|
685
|
+
}
|
|
686
|
+
export interface AnalyticsFunnelStepResult {
|
|
687
|
+
'conversion_rate_from_previous'?: number;
|
|
688
|
+
'count'?: number;
|
|
689
|
+
'dropoff_rate'?: number;
|
|
690
|
+
'name'?: string;
|
|
691
|
+
'unique_users'?: number;
|
|
692
|
+
}
|
|
693
|
+
export interface AnalyticsFunnelTrend {
|
|
694
|
+
'data_points'?: Array<AnalyticsFunnelDataPoint>;
|
|
695
|
+
'funnel_id'?: string;
|
|
696
|
+
'funnel_name'?: string;
|
|
697
|
+
'granularity'?: string;
|
|
698
|
+
}
|
|
699
|
+
export interface AnalyticsFunnelTrendRequestBody {
|
|
700
|
+
'end_date': string;
|
|
701
|
+
'granularity'?: string;
|
|
702
|
+
'start_date': string;
|
|
703
|
+
'xstoreid'?: string;
|
|
704
|
+
}
|
|
453
705
|
export interface AnalyticsGeoAnalytic {
|
|
454
706
|
'city'?: string;
|
|
455
707
|
'click_through_rate'?: number;
|
|
@@ -860,6 +1112,18 @@ export interface AnalyticsItemInsights {
|
|
|
860
1112
|
'unique_searches'?: number;
|
|
861
1113
|
'unique_users'?: number;
|
|
862
1114
|
}
|
|
1115
|
+
export interface AnalyticsItemPerformance {
|
|
1116
|
+
'avg_position'?: number;
|
|
1117
|
+
'clicks'?: number;
|
|
1118
|
+
'conversion_rate'?: number;
|
|
1119
|
+
'conversions'?: number;
|
|
1120
|
+
'ctr'?: number;
|
|
1121
|
+
'impressions'?: number;
|
|
1122
|
+
'item_id'?: string;
|
|
1123
|
+
'revenue'?: number;
|
|
1124
|
+
'revenue_per_click'?: number;
|
|
1125
|
+
'unique_users'?: number;
|
|
1126
|
+
}
|
|
863
1127
|
export interface AnalyticsItemPerformanceMetrics {
|
|
864
1128
|
'avg_position'?: number;
|
|
865
1129
|
'avg_score'?: number;
|
|
@@ -887,6 +1151,23 @@ export interface AnalyticsItemPerformanceMetrics {
|
|
|
887
1151
|
'unique_sorts'?: number;
|
|
888
1152
|
'unique_users'?: number;
|
|
889
1153
|
}
|
|
1154
|
+
export interface AnalyticsItemPerformanceRequest {
|
|
1155
|
+
'end_date': string;
|
|
1156
|
+
'limit'?: number;
|
|
1157
|
+
/**
|
|
1158
|
+
* clicks, conversions, revenue, ctr, impressions
|
|
1159
|
+
*/
|
|
1160
|
+
'order_by'?: string;
|
|
1161
|
+
'recommendation_type'?: string;
|
|
1162
|
+
'start_date': string;
|
|
1163
|
+
'surface'?: string;
|
|
1164
|
+
'xstoreid'?: string;
|
|
1165
|
+
}
|
|
1166
|
+
export interface AnalyticsItemPerformanceResponse {
|
|
1167
|
+
'items'?: Array<AnalyticsItemPerformance>;
|
|
1168
|
+
'summary'?: AnalyticsItemSummary;
|
|
1169
|
+
'total_count'?: number;
|
|
1170
|
+
}
|
|
890
1171
|
export interface AnalyticsItemPerformanceTrend {
|
|
891
1172
|
'item_id'?: string;
|
|
892
1173
|
'item_name'?: string;
|
|
@@ -1087,6 +1368,14 @@ export interface AnalyticsItemQueryDiscovery {
|
|
|
1087
1368
|
*/
|
|
1088
1369
|
'share'?: number;
|
|
1089
1370
|
}
|
|
1371
|
+
export interface AnalyticsItemSummary {
|
|
1372
|
+
'avg_conversion_rate'?: number;
|
|
1373
|
+
'avg_ctr'?: number;
|
|
1374
|
+
'total_clicks'?: number;
|
|
1375
|
+
'total_conversions'?: number;
|
|
1376
|
+
'total_impressions'?: number;
|
|
1377
|
+
'total_revenue'?: number;
|
|
1378
|
+
}
|
|
1090
1379
|
export interface AnalyticsItemTrendData {
|
|
1091
1380
|
'avg_position'?: number;
|
|
1092
1381
|
'clicks'?: number;
|
|
@@ -1095,6 +1384,23 @@ export interface AnalyticsItemTrendData {
|
|
|
1095
1384
|
'revenue'?: number;
|
|
1096
1385
|
'unique_users'?: number;
|
|
1097
1386
|
}
|
|
1387
|
+
export interface AnalyticsJourneyEvent {
|
|
1388
|
+
'event_id'?: string;
|
|
1389
|
+
'event_ts'?: string;
|
|
1390
|
+
'event_type'?: string;
|
|
1391
|
+
'is_attributed'?: boolean;
|
|
1392
|
+
'item_id'?: string;
|
|
1393
|
+
'position'?: number;
|
|
1394
|
+
'query'?: string;
|
|
1395
|
+
'search_id'?: string;
|
|
1396
|
+
'session_id'?: string;
|
|
1397
|
+
'surface'?: string;
|
|
1398
|
+
'value'?: number;
|
|
1399
|
+
}
|
|
1400
|
+
export interface AnalyticsKPIAnalyticsData {
|
|
1401
|
+
'kpi_analytics'?: AnalyticsExtendedKPIResponse;
|
|
1402
|
+
'pagination'?: AnalyticsPaginationInfo;
|
|
1403
|
+
}
|
|
1098
1404
|
export interface AnalyticsKPIMetrics {
|
|
1099
1405
|
'add_to_cart_rate'?: number;
|
|
1100
1406
|
/**
|
|
@@ -1165,6 +1471,86 @@ export interface AnalyticsKPIPointExtended {
|
|
|
1165
1471
|
'time_bucket'?: string;
|
|
1166
1472
|
'unique_users'?: number;
|
|
1167
1473
|
}
|
|
1474
|
+
export interface AnalyticsMergeProfilesRequestBody {
|
|
1475
|
+
'anonymous_id': string;
|
|
1476
|
+
'authenticated_id': string;
|
|
1477
|
+
'xstoreid'?: string;
|
|
1478
|
+
}
|
|
1479
|
+
export interface AnalyticsModelComparisonRequest {
|
|
1480
|
+
'end_date': string;
|
|
1481
|
+
'model_ids'?: Array<string>;
|
|
1482
|
+
'start_date': string;
|
|
1483
|
+
'xstoreid'?: string;
|
|
1484
|
+
}
|
|
1485
|
+
export interface AnalyticsModelComparisonResponse {
|
|
1486
|
+
'best_performing'?: AnalyticsBestModel;
|
|
1487
|
+
'models'?: Array<AnalyticsModelPerformance>;
|
|
1488
|
+
}
|
|
1489
|
+
export interface AnalyticsModelPerformance {
|
|
1490
|
+
'avg_inference_ms'?: number;
|
|
1491
|
+
'avg_latency_ms'?: number;
|
|
1492
|
+
'avg_recs_per_request'?: number;
|
|
1493
|
+
'conversion_rate'?: number;
|
|
1494
|
+
'ctr'?: number;
|
|
1495
|
+
'fallback_rate'?: number;
|
|
1496
|
+
'model_id'?: string;
|
|
1497
|
+
'model_version'?: string;
|
|
1498
|
+
'revenue_per_request'?: number;
|
|
1499
|
+
'total_clicks'?: number;
|
|
1500
|
+
'total_conversions'?: number;
|
|
1501
|
+
'total_impressions'?: number;
|
|
1502
|
+
'total_requests'?: number;
|
|
1503
|
+
'total_revenue'?: number;
|
|
1504
|
+
}
|
|
1505
|
+
export interface AnalyticsOverviewComparison {
|
|
1506
|
+
'conversion_rate'?: AnalyticsPeriodComparison;
|
|
1507
|
+
'ctr'?: AnalyticsPeriodComparison;
|
|
1508
|
+
'requests'?: AnalyticsPeriodComparison;
|
|
1509
|
+
'revenue'?: AnalyticsPeriodComparison;
|
|
1510
|
+
}
|
|
1511
|
+
export interface AnalyticsPaginationInfo {
|
|
1512
|
+
'has_more'?: boolean;
|
|
1513
|
+
'limit'?: number;
|
|
1514
|
+
'offset'?: number;
|
|
1515
|
+
'total'?: number;
|
|
1516
|
+
}
|
|
1517
|
+
export interface AnalyticsPerformanceBySurfaceRequest {
|
|
1518
|
+
'end_date': string;
|
|
1519
|
+
'granularity'?: string;
|
|
1520
|
+
'recommendation_type'?: string;
|
|
1521
|
+
'start_date': string;
|
|
1522
|
+
'xstoreid'?: string;
|
|
1523
|
+
}
|
|
1524
|
+
export interface AnalyticsPerformanceBySurfaceResponse {
|
|
1525
|
+
'summary'?: AnalyticsSurfaceMetrics;
|
|
1526
|
+
'surfaces'?: Array<AnalyticsSurfacePerformance>;
|
|
1527
|
+
}
|
|
1528
|
+
export interface AnalyticsPerformanceByTypeRequest {
|
|
1529
|
+
'end_date': string;
|
|
1530
|
+
'granularity'?: string;
|
|
1531
|
+
'start_date': string;
|
|
1532
|
+
'surface'?: string;
|
|
1533
|
+
'xstoreid'?: string;
|
|
1534
|
+
}
|
|
1535
|
+
export interface AnalyticsPerformanceByTypeResponse {
|
|
1536
|
+
'summary'?: AnalyticsTypeMetrics;
|
|
1537
|
+
'types'?: Array<AnalyticsTypePerformance>;
|
|
1538
|
+
}
|
|
1539
|
+
export interface AnalyticsPeriodComparison {
|
|
1540
|
+
'change_percent'?: number;
|
|
1541
|
+
'current_value'?: number;
|
|
1542
|
+
'previous_value'?: number;
|
|
1543
|
+
/**
|
|
1544
|
+
* up, down, stable
|
|
1545
|
+
*/
|
|
1546
|
+
'trend'?: string;
|
|
1547
|
+
}
|
|
1548
|
+
export interface AnalyticsPositionCTR {
|
|
1549
|
+
'clicks'?: number;
|
|
1550
|
+
'ctr'?: number;
|
|
1551
|
+
'impressions'?: number;
|
|
1552
|
+
'position'?: number;
|
|
1553
|
+
}
|
|
1168
1554
|
export interface AnalyticsQueryAnalytic {
|
|
1169
1555
|
'add_to_carts'?: number;
|
|
1170
1556
|
'avg_click_position'?: number;
|
|
@@ -1183,6 +1569,12 @@ export interface AnalyticsQueryAnalytic {
|
|
|
1183
1569
|
'searches'?: number;
|
|
1184
1570
|
'unique_users'?: number;
|
|
1185
1571
|
}
|
|
1572
|
+
export interface AnalyticsQueryAnalyticsData {
|
|
1573
|
+
'pagination'?: AnalyticsPaginationInfo;
|
|
1574
|
+
'query_analytics'?: AnalyticsQueryResponse;
|
|
1575
|
+
'sort_by'?: string;
|
|
1576
|
+
'sort_order'?: string;
|
|
1577
|
+
}
|
|
1186
1578
|
export interface AnalyticsQueryFilterAnalytics {
|
|
1187
1579
|
/**
|
|
1188
1580
|
* NEW: Individual array element insights
|
|
@@ -1221,7 +1613,7 @@ export interface AnalyticsQueryFilterTrend {
|
|
|
1221
1613
|
* \"increasing\", \"decreasing\", \"stable\"
|
|
1222
1614
|
*/
|
|
1223
1615
|
'trend'?: string;
|
|
1224
|
-
'trend_data'?: Array<
|
|
1616
|
+
'trend_data'?: Array<SeekoraGoSrcAnalyticsTimeSeriesPoint>;
|
|
1225
1617
|
}
|
|
1226
1618
|
export interface AnalyticsQueryFilterUsage {
|
|
1227
1619
|
/**
|
|
@@ -1359,6 +1751,19 @@ export interface AnalyticsQueryInsights {
|
|
|
1359
1751
|
'total_searches'?: number;
|
|
1360
1752
|
'unique_users'?: number;
|
|
1361
1753
|
}
|
|
1754
|
+
export interface AnalyticsQueryMetric {
|
|
1755
|
+
'avg_latency_ms'?: number;
|
|
1756
|
+
'avg_results'?: number;
|
|
1757
|
+
'click_count'?: number;
|
|
1758
|
+
'conversion_count'?: number;
|
|
1759
|
+
'conversion_rate'?: number;
|
|
1760
|
+
'ctr'?: number;
|
|
1761
|
+
'normalized_query'?: string;
|
|
1762
|
+
'query'?: string;
|
|
1763
|
+
'search_count'?: number;
|
|
1764
|
+
'unique_users'?: number;
|
|
1765
|
+
'zero_result_count'?: number;
|
|
1766
|
+
}
|
|
1362
1767
|
export interface AnalyticsQueryPerformanceAnalytics {
|
|
1363
1768
|
'avg_results'?: number;
|
|
1364
1769
|
'avg_search_duration_ms'?: number;
|
|
@@ -1694,7 +2099,7 @@ export interface AnalyticsQuerySuggestionsInsight {
|
|
|
1694
2099
|
'requests_with_dropdown'?: number;
|
|
1695
2100
|
'requests_with_filtered_tabs'?: number;
|
|
1696
2101
|
'start_time'?: string;
|
|
1697
|
-
'time_series'?: Array<
|
|
2102
|
+
'time_series'?: Array<SeekoraGoSrcAnalyticsTimePoint>;
|
|
1698
2103
|
/**
|
|
1699
2104
|
* Clicks on suggestions (linked by correlation_id)
|
|
1700
2105
|
*/
|
|
@@ -1759,6 +2164,191 @@ export interface AnalyticsQuerySuggestionsResponse {
|
|
|
1759
2164
|
'total'?: number;
|
|
1760
2165
|
'xstoreid'?: string;
|
|
1761
2166
|
}
|
|
2167
|
+
export interface AnalyticsRecommendationCTR {
|
|
2168
|
+
'clicks'?: number;
|
|
2169
|
+
'conversion_rate'?: number;
|
|
2170
|
+
'conversions'?: number;
|
|
2171
|
+
'ctr'?: number;
|
|
2172
|
+
'impressions'?: number;
|
|
2173
|
+
'recommendation_type'?: string;
|
|
2174
|
+
'surface'?: string;
|
|
2175
|
+
}
|
|
2176
|
+
export interface AnalyticsRecommendationCTRRequestBody {
|
|
2177
|
+
'end_date': string;
|
|
2178
|
+
/**
|
|
2179
|
+
* hour, day, week, month
|
|
2180
|
+
*/
|
|
2181
|
+
'granularity'?: string;
|
|
2182
|
+
'max_position'?: number;
|
|
2183
|
+
'page'?: number;
|
|
2184
|
+
'page_size'?: number;
|
|
2185
|
+
'recommendation_type'?: string;
|
|
2186
|
+
'start_date': string;
|
|
2187
|
+
'surface'?: string;
|
|
2188
|
+
'xstoreid'?: string;
|
|
2189
|
+
}
|
|
2190
|
+
export interface AnalyticsRecommendationFunnelRequest {
|
|
2191
|
+
'end_date': string;
|
|
2192
|
+
'recommendation_type'?: string;
|
|
2193
|
+
'start_date': string;
|
|
2194
|
+
'surface'?: string;
|
|
2195
|
+
'xstoreid'?: string;
|
|
2196
|
+
}
|
|
2197
|
+
export interface AnalyticsRecommendationFunnelResponse {
|
|
2198
|
+
'avg_time_to_click_seconds'?: number;
|
|
2199
|
+
'avg_time_to_convert_seconds'?: number;
|
|
2200
|
+
'click_to_convert_rate'?: number;
|
|
2201
|
+
'overall_conversion_rate'?: number;
|
|
2202
|
+
'request_to_click_rate'?: number;
|
|
2203
|
+
'steps'?: Array<SeekoraGoSrcRoutesAnalyticsFunnelStep>;
|
|
2204
|
+
}
|
|
2205
|
+
export interface AnalyticsRecommendationMetrics {
|
|
2206
|
+
'avg_latency_ms'?: number;
|
|
2207
|
+
'avg_recs_per_request'?: number;
|
|
2208
|
+
'fallback_rate'?: number;
|
|
2209
|
+
'p95_latency_ms'?: number;
|
|
2210
|
+
'requests_by_surface'?: {
|
|
2211
|
+
[key: string]: number;
|
|
2212
|
+
};
|
|
2213
|
+
'requests_by_type'?: {
|
|
2214
|
+
[key: string]: number;
|
|
2215
|
+
};
|
|
2216
|
+
'time_series'?: Array<SeekoraGoSrcServicesAnalyticsTimeSeriesPoint>;
|
|
2217
|
+
'total_recommendations'?: number;
|
|
2218
|
+
'total_requests'?: number;
|
|
2219
|
+
'unique_users'?: number;
|
|
2220
|
+
}
|
|
2221
|
+
export interface AnalyticsRecommendationMetricsRequestBody {
|
|
2222
|
+
'end_date': string;
|
|
2223
|
+
/**
|
|
2224
|
+
* hour, day, week, month
|
|
2225
|
+
*/
|
|
2226
|
+
'granularity'?: string;
|
|
2227
|
+
'page'?: number;
|
|
2228
|
+
'page_size'?: number;
|
|
2229
|
+
'recommendation_type'?: string;
|
|
2230
|
+
'start_date': string;
|
|
2231
|
+
'surface'?: string;
|
|
2232
|
+
'xstoreid'?: string;
|
|
2233
|
+
}
|
|
2234
|
+
export interface AnalyticsRecommendationOverviewRequest {
|
|
2235
|
+
'compare_with_previous'?: boolean;
|
|
2236
|
+
'end_date': string;
|
|
2237
|
+
/**
|
|
2238
|
+
* daily, weekly, monthly
|
|
2239
|
+
*/
|
|
2240
|
+
'granularity'?: string;
|
|
2241
|
+
/**
|
|
2242
|
+
* fbt, similar, personalized, trending
|
|
2243
|
+
*/
|
|
2244
|
+
'recommendation_type'?: string;
|
|
2245
|
+
'start_date': string;
|
|
2246
|
+
'surface'?: string;
|
|
2247
|
+
'xstoreid'?: string;
|
|
2248
|
+
}
|
|
2249
|
+
export interface AnalyticsRecommendationOverviewResponse {
|
|
2250
|
+
'avg_latency_ms'?: number;
|
|
2251
|
+
'avg_recs_per_request'?: number;
|
|
2252
|
+
'breakdown_by_surface'?: {
|
|
2253
|
+
[key: string]: AnalyticsSurfaceMetrics;
|
|
2254
|
+
};
|
|
2255
|
+
/**
|
|
2256
|
+
* Breakdown by dimensions
|
|
2257
|
+
*/
|
|
2258
|
+
'breakdown_by_type'?: {
|
|
2259
|
+
[key: string]: AnalyticsTypeMetrics;
|
|
2260
|
+
};
|
|
2261
|
+
/**
|
|
2262
|
+
* Period comparison (if requested)
|
|
2263
|
+
*/
|
|
2264
|
+
'comparison'?: AnalyticsOverviewComparison;
|
|
2265
|
+
'conversion_rate'?: number;
|
|
2266
|
+
'ctr'?: number;
|
|
2267
|
+
'fallback_rate'?: number;
|
|
2268
|
+
'p95_latency_ms'?: number;
|
|
2269
|
+
'revenue_per_request'?: number;
|
|
2270
|
+
/**
|
|
2271
|
+
* Time series data
|
|
2272
|
+
*/
|
|
2273
|
+
'time_series'?: Array<SeekoraGoSrcRoutesAnalyticsTimePoint>;
|
|
2274
|
+
'total_clicks'?: number;
|
|
2275
|
+
'total_conversions'?: number;
|
|
2276
|
+
'total_impressions'?: number;
|
|
2277
|
+
'total_requests'?: number;
|
|
2278
|
+
'total_revenue'?: number;
|
|
2279
|
+
'unique_users'?: number;
|
|
2280
|
+
}
|
|
2281
|
+
export interface AnalyticsResolveAlertRequest {
|
|
2282
|
+
'resolution'?: string;
|
|
2283
|
+
}
|
|
2284
|
+
export interface AnalyticsRevenueAttribution {
|
|
2285
|
+
'attributed_revenue'?: number;
|
|
2286
|
+
'attribution_rate'?: number;
|
|
2287
|
+
'avg_order_value'?: number;
|
|
2288
|
+
'reco_attributed_revenue'?: number;
|
|
2289
|
+
'search_attributed_revenue'?: number;
|
|
2290
|
+
'time_series'?: Array<SeekoraGoSrcServicesAnalyticsTimeSeriesPoint>;
|
|
2291
|
+
'total_revenue'?: number;
|
|
2292
|
+
}
|
|
2293
|
+
export interface AnalyticsRevenueAttributionRequest {
|
|
2294
|
+
'end_date': string;
|
|
2295
|
+
'granularity'?: string;
|
|
2296
|
+
'recommendation_type'?: string;
|
|
2297
|
+
'start_date': string;
|
|
2298
|
+
'surface'?: string;
|
|
2299
|
+
'xstoreid'?: string;
|
|
2300
|
+
}
|
|
2301
|
+
export interface AnalyticsRevenueAttributionResponse {
|
|
2302
|
+
'assisted_revenue'?: number;
|
|
2303
|
+
'attributed_revenue'?: number;
|
|
2304
|
+
'attribution'?: AnalyticsRevenueBreakdown;
|
|
2305
|
+
'attribution_rate'?: number;
|
|
2306
|
+
'avg_attributed_order_value'?: number;
|
|
2307
|
+
'avg_order_value'?: number;
|
|
2308
|
+
'direct_revenue'?: number;
|
|
2309
|
+
'revenue_by_surface'?: {
|
|
2310
|
+
[key: string]: number;
|
|
2311
|
+
};
|
|
2312
|
+
'revenue_by_type'?: {
|
|
2313
|
+
[key: string]: number;
|
|
2314
|
+
};
|
|
2315
|
+
'time_series'?: Array<AnalyticsRevenueTimePoint>;
|
|
2316
|
+
'total_revenue'?: number;
|
|
2317
|
+
}
|
|
2318
|
+
export interface AnalyticsRevenueBreakdown {
|
|
2319
|
+
'first_click'?: number;
|
|
2320
|
+
'last_click'?: number;
|
|
2321
|
+
'linear'?: number;
|
|
2322
|
+
'time_decay'?: number;
|
|
2323
|
+
}
|
|
2324
|
+
export interface AnalyticsRevenueRequestBody {
|
|
2325
|
+
'attributed_only'?: boolean;
|
|
2326
|
+
'end_date': string;
|
|
2327
|
+
/**
|
|
2328
|
+
* hour, day, week, month
|
|
2329
|
+
*/
|
|
2330
|
+
'granularity'?: string;
|
|
2331
|
+
'page'?: number;
|
|
2332
|
+
'page_size'?: number;
|
|
2333
|
+
'start_date': string;
|
|
2334
|
+
'xstoreid'?: string;
|
|
2335
|
+
}
|
|
2336
|
+
export interface AnalyticsRevenueTimePoint {
|
|
2337
|
+
'attributed_revenue'?: number;
|
|
2338
|
+
'orders'?: number;
|
|
2339
|
+
'timestamp'?: string;
|
|
2340
|
+
'total_revenue'?: number;
|
|
2341
|
+
}
|
|
2342
|
+
export declare const AnalyticsRuleType: {
|
|
2343
|
+
readonly RuleTypeFreshness: "freshness";
|
|
2344
|
+
readonly RuleTypeVolume: "volume";
|
|
2345
|
+
readonly RuleTypeSchema: "schema";
|
|
2346
|
+
readonly RuleTypeAnomaly: "anomaly";
|
|
2347
|
+
readonly RuleTypeCardinality: "cardinality";
|
|
2348
|
+
readonly RuleTypeCompleteness: "completeness";
|
|
2349
|
+
readonly RuleTypeCustom: "custom";
|
|
2350
|
+
};
|
|
2351
|
+
export type AnalyticsRuleType = typeof AnalyticsRuleType[keyof typeof AnalyticsRuleType];
|
|
1762
2352
|
export interface AnalyticsSearchCount {
|
|
1763
2353
|
'count'?: number;
|
|
1764
2354
|
'date'?: string;
|
|
@@ -1768,6 +2358,31 @@ export interface AnalyticsSearchCountResponse {
|
|
|
1768
2358
|
'message'?: string;
|
|
1769
2359
|
'status'?: number;
|
|
1770
2360
|
}
|
|
2361
|
+
export interface AnalyticsSearchMetrics {
|
|
2362
|
+
'avg_latency_ms'?: number;
|
|
2363
|
+
'avg_results_per_search'?: number;
|
|
2364
|
+
'p95_latency_ms'?: number;
|
|
2365
|
+
'p99_latency_ms'?: number;
|
|
2366
|
+
'time_series'?: Array<SeekoraGoSrcServicesAnalyticsTimeSeriesPoint>;
|
|
2367
|
+
'total_results'?: number;
|
|
2368
|
+
'total_searches'?: number;
|
|
2369
|
+
'unique_sessions'?: number;
|
|
2370
|
+
'unique_users'?: number;
|
|
2371
|
+
'zero_result_rate'?: number;
|
|
2372
|
+
'zero_result_searches'?: number;
|
|
2373
|
+
}
|
|
2374
|
+
export interface AnalyticsSearchMetricsRequestBody {
|
|
2375
|
+
'end_date': string;
|
|
2376
|
+
/**
|
|
2377
|
+
* hour, day, week, month
|
|
2378
|
+
*/
|
|
2379
|
+
'granularity'?: string;
|
|
2380
|
+
'page'?: number;
|
|
2381
|
+
'page_size'?: number;
|
|
2382
|
+
'start_date': string;
|
|
2383
|
+
'surface'?: string;
|
|
2384
|
+
'xstoreid'?: string;
|
|
2385
|
+
}
|
|
1771
2386
|
export interface AnalyticsSharedQueryAnalysis {
|
|
1772
2387
|
'competitor_id'?: string;
|
|
1773
2388
|
'competitor_position'?: number;
|
|
@@ -1776,6 +2391,21 @@ export interface AnalyticsSharedQueryAnalysis {
|
|
|
1776
2391
|
'query'?: string;
|
|
1777
2392
|
'this_item_position'?: number;
|
|
1778
2393
|
}
|
|
2394
|
+
export interface AnalyticsStepResult {
|
|
2395
|
+
'avg_time_from_prev_hours'?: number;
|
|
2396
|
+
/**
|
|
2397
|
+
* from previous step
|
|
2398
|
+
*/
|
|
2399
|
+
'conversion_rate'?: number;
|
|
2400
|
+
/**
|
|
2401
|
+
* users who dropped off at this step
|
|
2402
|
+
*/
|
|
2403
|
+
'dropoff_rate'?: number;
|
|
2404
|
+
'event_name'?: string;
|
|
2405
|
+
'event_type'?: string;
|
|
2406
|
+
'step_order'?: number;
|
|
2407
|
+
'users'?: number;
|
|
2408
|
+
}
|
|
1779
2409
|
export interface AnalyticsStoreBreakdown {
|
|
1780
2410
|
'compare_summary'?: AnalyticsKPIMetrics;
|
|
1781
2411
|
'store_id'?: number;
|
|
@@ -1807,17 +2437,119 @@ export interface AnalyticsStoreQueryBreakdown {
|
|
|
1807
2437
|
'total'?: number;
|
|
1808
2438
|
'xstoreid'?: string;
|
|
1809
2439
|
}
|
|
1810
|
-
export interface
|
|
1811
|
-
'
|
|
1812
|
-
'
|
|
2440
|
+
export interface AnalyticsSuggestionCTRResponse {
|
|
2441
|
+
'by_click_type'?: Array<AnalyticsSuggestionCTRResponseByClickTypeInner>;
|
|
2442
|
+
'clicks'?: number;
|
|
2443
|
+
'ctr'?: number;
|
|
2444
|
+
'end_time'?: string;
|
|
2445
|
+
'impressions'?: number;
|
|
2446
|
+
'org_code'?: string;
|
|
2447
|
+
'start_time'?: string;
|
|
2448
|
+
'xstoreid'?: string;
|
|
2449
|
+
}
|
|
2450
|
+
export interface AnalyticsSuggestionCTRResponseByClickTypeInner {
|
|
2451
|
+
'click_type'?: string;
|
|
2452
|
+
'clicks'?: number;
|
|
2453
|
+
'ctr'?: number;
|
|
2454
|
+
}
|
|
2455
|
+
export interface AnalyticsSuggestionClickStat {
|
|
2456
|
+
'avg_position'?: number;
|
|
2457
|
+
'click_type'?: string;
|
|
2458
|
+
'clicks'?: number;
|
|
2459
|
+
'section'?: string;
|
|
2460
|
+
'unique_users'?: number;
|
|
2461
|
+
}
|
|
2462
|
+
export interface AnalyticsSuggestionClicksResponse {
|
|
2463
|
+
'data'?: Array<AnalyticsSuggestionClickStat>;
|
|
2464
|
+
'end_time'?: string;
|
|
2465
|
+
'limit'?: number;
|
|
2466
|
+
'org_code'?: string;
|
|
2467
|
+
'page'?: number;
|
|
2468
|
+
'start_time'?: string;
|
|
2469
|
+
'total'?: number;
|
|
2470
|
+
'xstoreid'?: string;
|
|
2471
|
+
}
|
|
2472
|
+
export interface AnalyticsSuggestionImpressionStat {
|
|
2473
|
+
'avg_suggestions'?: number;
|
|
2474
|
+
'date'?: string;
|
|
2475
|
+
'impressions'?: number;
|
|
2476
|
+
'unique_users'?: number;
|
|
2477
|
+
'with_categories'?: number;
|
|
2478
|
+
'with_products'?: number;
|
|
2479
|
+
}
|
|
2480
|
+
export interface AnalyticsSuggestionImpressionsResponse {
|
|
2481
|
+
'data'?: Array<AnalyticsSuggestionImpressionStat>;
|
|
2482
|
+
'end_time'?: string;
|
|
2483
|
+
'limit'?: number;
|
|
2484
|
+
'org_code'?: string;
|
|
2485
|
+
'page'?: number;
|
|
2486
|
+
'start_time'?: string;
|
|
2487
|
+
'total'?: number;
|
|
2488
|
+
'xstoreid'?: string;
|
|
2489
|
+
}
|
|
2490
|
+
export interface AnalyticsSurfaceMetrics {
|
|
2491
|
+
'clicks'?: number;
|
|
2492
|
+
'conversion_rate'?: number;
|
|
2493
|
+
'conversions'?: number;
|
|
2494
|
+
'ctr'?: number;
|
|
2495
|
+
'impressions'?: number;
|
|
1813
2496
|
'requests'?: number;
|
|
1814
|
-
'
|
|
1815
|
-
'total_suggestions_returned'?: number;
|
|
2497
|
+
'revenue'?: number;
|
|
1816
2498
|
}
|
|
1817
|
-
export interface
|
|
1818
|
-
'
|
|
1819
|
-
'
|
|
1820
|
-
'
|
|
2499
|
+
export interface AnalyticsSurfacePerformance {
|
|
2500
|
+
'metrics'?: AnalyticsSurfaceMetrics;
|
|
2501
|
+
'surface'?: string;
|
|
2502
|
+
'time_series'?: Array<SeekoraGoSrcRoutesAnalyticsTimePoint>;
|
|
2503
|
+
}
|
|
2504
|
+
export declare const AnalyticsThresholdType: {
|
|
2505
|
+
readonly ThresholdMin: "min";
|
|
2506
|
+
readonly ThresholdMax: "max";
|
|
2507
|
+
readonly ThresholdRange: "range";
|
|
2508
|
+
readonly ThresholdStdDev: "stddev";
|
|
2509
|
+
};
|
|
2510
|
+
export type AnalyticsThresholdType = typeof AnalyticsThresholdType[keyof typeof AnalyticsThresholdType];
|
|
2511
|
+
export interface AnalyticsTimeWindow {
|
|
2512
|
+
'end_date'?: string;
|
|
2513
|
+
'start_date'?: string;
|
|
2514
|
+
}
|
|
2515
|
+
export interface AnalyticsTopQueriesRequestBody {
|
|
2516
|
+
'end_date': string;
|
|
2517
|
+
/**
|
|
2518
|
+
* hour, day, week, month
|
|
2519
|
+
*/
|
|
2520
|
+
'granularity'?: string;
|
|
2521
|
+
'limit'?: number;
|
|
2522
|
+
'min_count'?: number;
|
|
2523
|
+
'page'?: number;
|
|
2524
|
+
'page_size'?: number;
|
|
2525
|
+
'sort_by'?: string;
|
|
2526
|
+
'start_date': string;
|
|
2527
|
+
'surface'?: string;
|
|
2528
|
+
'xstoreid'?: string;
|
|
2529
|
+
}
|
|
2530
|
+
export interface AnalyticsTypeMetrics {
|
|
2531
|
+
'avg_latency_ms'?: number;
|
|
2532
|
+
'clicks'?: number;
|
|
2533
|
+
'conversion_rate'?: number;
|
|
2534
|
+
'conversions'?: number;
|
|
2535
|
+
'ctr'?: number;
|
|
2536
|
+
'impressions'?: number;
|
|
2537
|
+
'requests'?: number;
|
|
2538
|
+
'revenue'?: number;
|
|
2539
|
+
}
|
|
2540
|
+
export interface AnalyticsTypePerformance {
|
|
2541
|
+
'metrics'?: AnalyticsTypeMetrics;
|
|
2542
|
+
'recommendation_type'?: string;
|
|
2543
|
+
'time_series'?: Array<SeekoraGoSrcRoutesAnalyticsTimePoint>;
|
|
2544
|
+
'top_items'?: Array<string>;
|
|
2545
|
+
}
|
|
2546
|
+
export interface AnalyticsUpdateFunnelRequestBody {
|
|
2547
|
+
'conversion_window_hours'?: number;
|
|
2548
|
+
'count_type'?: string;
|
|
2549
|
+
'description'?: string;
|
|
2550
|
+
'is_active'?: boolean;
|
|
2551
|
+
'name'?: string;
|
|
2552
|
+
'steps'?: Array<SeekoraGoSrcServicesAnalyticsFunnelStep>;
|
|
1821
2553
|
}
|
|
1822
2554
|
export interface AnalyticsWidgetData {
|
|
1823
2555
|
'id'?: string;
|
|
@@ -1826,6 +2558,25 @@ export interface AnalyticsWidgetData {
|
|
|
1826
2558
|
'secondary_text'?: string;
|
|
1827
2559
|
'tertiary_text'?: string;
|
|
1828
2560
|
}
|
|
2561
|
+
export interface AnalyticsZeroResultQuery {
|
|
2562
|
+
'count'?: number;
|
|
2563
|
+
'last_seen'?: string;
|
|
2564
|
+
'query'?: string;
|
|
2565
|
+
'unique_users'?: number;
|
|
2566
|
+
}
|
|
2567
|
+
export interface AnalyticsZeroResultRequestBody {
|
|
2568
|
+
'end_date': string;
|
|
2569
|
+
/**
|
|
2570
|
+
* hour, day, week, month
|
|
2571
|
+
*/
|
|
2572
|
+
'granularity'?: string;
|
|
2573
|
+
'limit'?: number;
|
|
2574
|
+
'min_count'?: number;
|
|
2575
|
+
'page'?: number;
|
|
2576
|
+
'page_size'?: number;
|
|
2577
|
+
'start_date': string;
|
|
2578
|
+
'xstoreid'?: string;
|
|
2579
|
+
}
|
|
1829
2580
|
export interface BatchRecordResult {
|
|
1830
2581
|
'errors'?: Array<string>;
|
|
1831
2582
|
'record'?: {
|
|
@@ -1922,6 +2673,37 @@ export interface BillingServiceTrialEligibilityResponse {
|
|
|
1922
2673
|
'trial_subscription_id'?: number;
|
|
1923
2674
|
'trial_used_at'?: string;
|
|
1924
2675
|
}
|
|
2676
|
+
export interface ConnectorsCreateConnectorRequest {
|
|
2677
|
+
'config': {
|
|
2678
|
+
[key: string]: any;
|
|
2679
|
+
};
|
|
2680
|
+
'connector_name': string;
|
|
2681
|
+
'connector_type': ConnectorsCreateConnectorRequestConnectorTypeEnum;
|
|
2682
|
+
'event_filter'?: {
|
|
2683
|
+
[key: string]: any;
|
|
2684
|
+
};
|
|
2685
|
+
'is_active'?: boolean;
|
|
2686
|
+
'provider': string;
|
|
2687
|
+
'store_id'?: number;
|
|
2688
|
+
'sync_frequency'?: string;
|
|
2689
|
+
}
|
|
2690
|
+
export declare const ConnectorsCreateConnectorRequestConnectorTypeEnum: {
|
|
2691
|
+
readonly import: "import";
|
|
2692
|
+
readonly export: "export";
|
|
2693
|
+
};
|
|
2694
|
+
export type ConnectorsCreateConnectorRequestConnectorTypeEnum = typeof ConnectorsCreateConnectorRequestConnectorTypeEnum[keyof typeof ConnectorsCreateConnectorRequestConnectorTypeEnum];
|
|
2695
|
+
export interface ConnectorsUpdateConnectorRequest {
|
|
2696
|
+
'config'?: {
|
|
2697
|
+
[key: string]: any;
|
|
2698
|
+
};
|
|
2699
|
+
'connector_name'?: string;
|
|
2700
|
+
'event_filter'?: {
|
|
2701
|
+
[key: string]: any;
|
|
2702
|
+
};
|
|
2703
|
+
'is_active'?: boolean;
|
|
2704
|
+
'is_paused'?: boolean;
|
|
2705
|
+
'sync_frequency'?: string;
|
|
2706
|
+
}
|
|
1925
2707
|
export interface DataTypesAPICall {
|
|
1926
2708
|
/**
|
|
1927
2709
|
* Primary key
|
|
@@ -3352,132 +4134,149 @@ export interface DataTypesErrorMetaResponse {
|
|
|
3352
4134
|
}
|
|
3353
4135
|
export interface DataTypesEventPayload {
|
|
3354
4136
|
/**
|
|
3355
|
-
*
|
|
4137
|
+
* ============================================================================ Analytics & Metadata ============================================================================
|
|
3356
4138
|
*/
|
|
3357
4139
|
'analytics_tags'?: Array<string>;
|
|
3358
4140
|
/**
|
|
3359
|
-
*
|
|
4141
|
+
* V3 anonymous user ID
|
|
3360
4142
|
*/
|
|
3361
|
-
'
|
|
4143
|
+
'anonymous_id'?: string;
|
|
4144
|
+
'brands_count'?: number;
|
|
3362
4145
|
'browser_language'?: string;
|
|
3363
4146
|
/**
|
|
3364
|
-
* Browser Context
|
|
4147
|
+
* Browser Context
|
|
3365
4148
|
*/
|
|
3366
4149
|
'browser_name'?: string;
|
|
3367
4150
|
'browser_version'?: string;
|
|
4151
|
+
'categories_count'?: number;
|
|
3368
4152
|
'city'?: string;
|
|
3369
4153
|
/**
|
|
3370
|
-
*
|
|
4154
|
+
* query, product, category, brand, trending, recent
|
|
4155
|
+
*/
|
|
4156
|
+
'click_type'?: string;
|
|
4157
|
+
/**
|
|
4158
|
+
* ============================================================================ Click/Interaction Event Fields (V3) ============================================================================
|
|
3371
4159
|
*/
|
|
3372
4160
|
'clicked_item_id'?: string;
|
|
4161
|
+
'clicked_value'?: string;
|
|
3373
4162
|
'color_depth'?: number;
|
|
3374
4163
|
'connection_downlink'?: number;
|
|
3375
4164
|
'connection_effective_type'?: string;
|
|
3376
4165
|
/**
|
|
3377
|
-
* Connection Context
|
|
4166
|
+
* Connection Context
|
|
3378
4167
|
*/
|
|
3379
4168
|
'connection_type'?: string;
|
|
3380
|
-
/**
|
|
3381
|
-
* Primary journey key across search → clicks → conversions
|
|
3382
|
-
*/
|
|
3383
4169
|
'correlation_id'?: string;
|
|
3384
4170
|
/**
|
|
3385
|
-
*
|
|
4171
|
+
* ============================================================================ Geo Context (V3) ============================================================================
|
|
3386
4172
|
*/
|
|
3387
4173
|
'country'?: string;
|
|
3388
|
-
|
|
3389
|
-
* ISO 3166-1 alpha-2 country code
|
|
3390
|
-
*/
|
|
3391
|
-
'country_code'?: string;
|
|
3392
|
-
/**
|
|
3393
|
-
* Currency for value
|
|
3394
|
-
*/
|
|
4174
|
+
'country_code'?: string;
|
|
3395
4175
|
'currency'?: string;
|
|
4176
|
+
'custom_json'?: string;
|
|
3396
4177
|
'device_fingerprint'?: string;
|
|
3397
4178
|
'device_type'?: string;
|
|
3398
4179
|
/**
|
|
3399
|
-
* Core Event Information
|
|
4180
|
+
* ============================================================================ Core Event Information (V3) ============================================================================
|
|
3400
4181
|
*/
|
|
3401
4182
|
'event_id'?: string;
|
|
3402
4183
|
'event_name'?: string;
|
|
3403
4184
|
/**
|
|
3404
|
-
*
|
|
4185
|
+
* V3 timestamp
|
|
3405
4186
|
*/
|
|
3406
|
-
'
|
|
3407
|
-
'
|
|
3408
|
-
'
|
|
3409
|
-
'
|
|
4187
|
+
'event_ts'?: string;
|
|
4188
|
+
'has_dropdown'?: number;
|
|
4189
|
+
'has_filtered_tabs'?: number;
|
|
4190
|
+
'impression_duration_ms'?: number;
|
|
3410
4191
|
/**
|
|
3411
|
-
*
|
|
4192
|
+
* ============================================================================ Device Context (V3) ============================================================================
|
|
3412
4193
|
*/
|
|
3413
|
-
'
|
|
4194
|
+
'ip'?: string;
|
|
4195
|
+
'is_attributed'?: number;
|
|
3414
4196
|
/**
|
|
3415
|
-
*
|
|
4197
|
+
* V3 sends 0/1; accept both number and bool via pointer to uint8 (0 = false, 1 = true)
|
|
3416
4198
|
*/
|
|
3417
|
-
'
|
|
4199
|
+
'is_mobile'?: number;
|
|
4200
|
+
'is_tablet'?: number;
|
|
4201
|
+
'is_touch_device'?: boolean;
|
|
3418
4202
|
/**
|
|
3419
|
-
*
|
|
4203
|
+
* Request Linking (V3)
|
|
3420
4204
|
*/
|
|
4205
|
+
'journey_id'?: string;
|
|
4206
|
+
'latency_ms'?: number;
|
|
3421
4207
|
'metadata'?: {
|
|
3422
4208
|
[key: string]: any;
|
|
3423
4209
|
};
|
|
3424
|
-
|
|
4210
|
+
/**
|
|
4211
|
+
* ============================================================================ Suggestion Impression Fields (V3) ============================================================================
|
|
4212
|
+
*/
|
|
4213
|
+
'normalized_query'?: string;
|
|
4214
|
+
/**
|
|
4215
|
+
* Organization Context (V3 naming)
|
|
4216
|
+
*/
|
|
4217
|
+
'orgcode'?: string;
|
|
4218
|
+
'original_query'?: string;
|
|
3425
4219
|
'page_path'?: string;
|
|
3426
4220
|
'page_referrer'?: string;
|
|
3427
4221
|
'page_title'?: string;
|
|
3428
4222
|
/**
|
|
3429
|
-
* Page Context
|
|
4223
|
+
* Page Context
|
|
3430
4224
|
*/
|
|
3431
4225
|
'page_url'?: string;
|
|
3432
4226
|
'pixel_ratio'?: number;
|
|
3433
|
-
/**
|
|
3434
|
-
* web, ios, android
|
|
3435
|
-
*/
|
|
3436
4227
|
'platform'?: string;
|
|
4228
|
+
'position'?: number;
|
|
4229
|
+
'products_count'?: number;
|
|
3437
4230
|
/**
|
|
3438
|
-
* Search Event Fields
|
|
4231
|
+
* ============================================================================ Search Event Fields ============================================================================
|
|
3439
4232
|
*/
|
|
3440
4233
|
'query'?: string;
|
|
4234
|
+
'recent_count'?: number;
|
|
3441
4235
|
'region'?: string;
|
|
4236
|
+
'request_id'?: string;
|
|
3442
4237
|
'results_count'?: number;
|
|
3443
4238
|
'screen_height'?: number;
|
|
3444
|
-
/**
|
|
3445
|
-
* Enhanced Device/Screen Context (from SDK)
|
|
3446
|
-
*/
|
|
3447
4239
|
'screen_width'?: number;
|
|
3448
|
-
/**
|
|
3449
|
-
* Optional search-scoped identifier (mirrors correlation_id when you have a natural search key)
|
|
3450
|
-
*/
|
|
3451
4240
|
'search_id'?: string;
|
|
3452
4241
|
/**
|
|
3453
|
-
*
|
|
4242
|
+
* suggestions, products, categories, brands, tabs
|
|
3454
4243
|
*/
|
|
4244
|
+
'section'?: string;
|
|
3455
4245
|
'session_id'?: string;
|
|
3456
|
-
|
|
3457
|
-
|
|
3458
|
-
|
|
3459
|
-
'
|
|
3460
|
-
'
|
|
4246
|
+
'suggestion_id'?: string;
|
|
4247
|
+
'suggestion_popularity'?: number;
|
|
4248
|
+
'suggestion_source'?: string;
|
|
4249
|
+
'suggestion_type'?: string;
|
|
4250
|
+
'suggestions_count'?: number;
|
|
4251
|
+
'tab_filter'?: string;
|
|
4252
|
+
'tab_id'?: string;
|
|
4253
|
+
'tab_label'?: string;
|
|
3461
4254
|
'timezone'?: string;
|
|
3462
4255
|
'timezone_offset'?: number;
|
|
4256
|
+
'total_suggestions'?: number;
|
|
4257
|
+
'trending_count'?: number;
|
|
3463
4258
|
/**
|
|
3464
|
-
* User Context
|
|
4259
|
+
* User Context (V3 naming)
|
|
3465
4260
|
*/
|
|
3466
4261
|
'user_id'?: string;
|
|
3467
4262
|
'utm_campaign'?: string;
|
|
3468
4263
|
'utm_content'?: string;
|
|
3469
4264
|
'utm_medium'?: string;
|
|
3470
4265
|
/**
|
|
3471
|
-
* UTM Parameters
|
|
4266
|
+
* ============================================================================ UTM Parameters ============================================================================
|
|
3472
4267
|
*/
|
|
3473
4268
|
'utm_source'?: string;
|
|
3474
4269
|
'utm_term'?: string;
|
|
3475
4270
|
/**
|
|
3476
|
-
* Business Context
|
|
4271
|
+
* ============================================================================ Business Context ============================================================================
|
|
3477
4272
|
*/
|
|
3478
4273
|
'value'?: number;
|
|
3479
4274
|
'viewport_height'?: number;
|
|
3480
4275
|
'viewport_width'?: number;
|
|
4276
|
+
/**
|
|
4277
|
+
* V3 store identifier
|
|
4278
|
+
*/
|
|
4279
|
+
'xstoreid'?: string;
|
|
3481
4280
|
}
|
|
3482
4281
|
export interface DataTypesFacetRange {
|
|
3483
4282
|
/**
|
|
@@ -3721,11 +4520,136 @@ export interface DataTypesGenerateInvoiceReceiptResponse {
|
|
|
3721
4520
|
'receipt_id'?: number;
|
|
3722
4521
|
'success'?: boolean;
|
|
3723
4522
|
}
|
|
4523
|
+
export interface DataTypesGenericResponseAnalyticsABTestResponse {
|
|
4524
|
+
'data'?: AnalyticsABTestResponse;
|
|
4525
|
+
'message'?: string;
|
|
4526
|
+
'status'?: number;
|
|
4527
|
+
}
|
|
4528
|
+
export interface DataTypesGenericResponseAnalyticsClickMetrics {
|
|
4529
|
+
'data'?: AnalyticsClickMetrics;
|
|
4530
|
+
'message'?: string;
|
|
4531
|
+
'status'?: number;
|
|
4532
|
+
}
|
|
4533
|
+
export interface DataTypesGenericResponseAnalyticsCohortBehaviorResult {
|
|
4534
|
+
'data'?: AnalyticsCohortBehaviorResult;
|
|
4535
|
+
'message'?: string;
|
|
4536
|
+
'status'?: number;
|
|
4537
|
+
}
|
|
4538
|
+
export interface DataTypesGenericResponseAnalyticsCohortRetentionResult {
|
|
4539
|
+
'data'?: AnalyticsCohortRetentionResult;
|
|
4540
|
+
'message'?: string;
|
|
4541
|
+
'status'?: number;
|
|
4542
|
+
}
|
|
4543
|
+
export interface DataTypesGenericResponseAnalyticsConversionMetrics {
|
|
4544
|
+
'data'?: AnalyticsConversionMetrics;
|
|
4545
|
+
'message'?: string;
|
|
4546
|
+
'status'?: number;
|
|
4547
|
+
}
|
|
4548
|
+
export interface DataTypesGenericResponseAnalyticsFunnel {
|
|
4549
|
+
'data'?: AnalyticsFunnel;
|
|
4550
|
+
'message'?: string;
|
|
4551
|
+
'status'?: number;
|
|
4552
|
+
}
|
|
4553
|
+
export interface DataTypesGenericResponseAnalyticsFunnelData {
|
|
4554
|
+
'data'?: AnalyticsFunnelData;
|
|
4555
|
+
'message'?: string;
|
|
4556
|
+
'status'?: number;
|
|
4557
|
+
}
|
|
4558
|
+
export interface DataTypesGenericResponseAnalyticsFunnelResult {
|
|
4559
|
+
'data'?: AnalyticsFunnelResult;
|
|
4560
|
+
'message'?: string;
|
|
4561
|
+
'status'?: number;
|
|
4562
|
+
}
|
|
4563
|
+
export interface DataTypesGenericResponseAnalyticsFunnelTrend {
|
|
4564
|
+
'data'?: AnalyticsFunnelTrend;
|
|
4565
|
+
'message'?: string;
|
|
4566
|
+
'status'?: number;
|
|
4567
|
+
}
|
|
4568
|
+
export interface DataTypesGenericResponseAnalyticsItemPerformanceResponse {
|
|
4569
|
+
'data'?: AnalyticsItemPerformanceResponse;
|
|
4570
|
+
'message'?: string;
|
|
4571
|
+
'status'?: number;
|
|
4572
|
+
}
|
|
4573
|
+
export interface DataTypesGenericResponseAnalyticsModelComparisonResponse {
|
|
4574
|
+
'data'?: AnalyticsModelComparisonResponse;
|
|
4575
|
+
'message'?: string;
|
|
4576
|
+
'status'?: number;
|
|
4577
|
+
}
|
|
4578
|
+
export interface DataTypesGenericResponseAnalyticsPerformanceBySurfaceResponse {
|
|
4579
|
+
'data'?: AnalyticsPerformanceBySurfaceResponse;
|
|
4580
|
+
'message'?: string;
|
|
4581
|
+
'status'?: number;
|
|
4582
|
+
}
|
|
4583
|
+
export interface DataTypesGenericResponseAnalyticsPerformanceByTypeResponse {
|
|
4584
|
+
'data'?: AnalyticsPerformanceByTypeResponse;
|
|
4585
|
+
'message'?: string;
|
|
4586
|
+
'status'?: number;
|
|
4587
|
+
}
|
|
4588
|
+
export interface DataTypesGenericResponseAnalyticsRecommendationFunnelResponse {
|
|
4589
|
+
'data'?: AnalyticsRecommendationFunnelResponse;
|
|
4590
|
+
'message'?: string;
|
|
4591
|
+
'status'?: number;
|
|
4592
|
+
}
|
|
4593
|
+
export interface DataTypesGenericResponseAnalyticsRecommendationMetrics {
|
|
4594
|
+
'data'?: AnalyticsRecommendationMetrics;
|
|
4595
|
+
'message'?: string;
|
|
4596
|
+
'status'?: number;
|
|
4597
|
+
}
|
|
4598
|
+
export interface DataTypesGenericResponseAnalyticsRecommendationOverviewResponse {
|
|
4599
|
+
'data'?: AnalyticsRecommendationOverviewResponse;
|
|
4600
|
+
'message'?: string;
|
|
4601
|
+
'status'?: number;
|
|
4602
|
+
}
|
|
4603
|
+
export interface DataTypesGenericResponseAnalyticsRevenueAttribution {
|
|
4604
|
+
'data'?: AnalyticsRevenueAttribution;
|
|
4605
|
+
'message'?: string;
|
|
4606
|
+
'status'?: number;
|
|
4607
|
+
}
|
|
4608
|
+
export interface DataTypesGenericResponseAnalyticsRevenueAttributionResponse {
|
|
4609
|
+
'data'?: AnalyticsRevenueAttributionResponse;
|
|
4610
|
+
'message'?: string;
|
|
4611
|
+
'status'?: number;
|
|
4612
|
+
}
|
|
4613
|
+
export interface DataTypesGenericResponseAnalyticsSearchMetrics {
|
|
4614
|
+
'data'?: AnalyticsSearchMetrics;
|
|
4615
|
+
'message'?: string;
|
|
4616
|
+
'status'?: number;
|
|
4617
|
+
}
|
|
3724
4618
|
export interface DataTypesGenericResponseAny {
|
|
3725
4619
|
'data'?: any;
|
|
3726
4620
|
'message'?: string;
|
|
3727
4621
|
'status'?: number;
|
|
3728
4622
|
}
|
|
4623
|
+
export interface DataTypesGenericResponseArrayAnalyticsFunnel {
|
|
4624
|
+
'data'?: Array<AnalyticsFunnel>;
|
|
4625
|
+
'message'?: string;
|
|
4626
|
+
'status'?: number;
|
|
4627
|
+
}
|
|
4628
|
+
export interface DataTypesGenericResponseArrayAnalyticsJourneyEvent {
|
|
4629
|
+
'data'?: Array<AnalyticsJourneyEvent>;
|
|
4630
|
+
'message'?: string;
|
|
4631
|
+
'status'?: number;
|
|
4632
|
+
}
|
|
4633
|
+
export interface DataTypesGenericResponseArrayAnalyticsPositionCTR {
|
|
4634
|
+
'data'?: Array<AnalyticsPositionCTR>;
|
|
4635
|
+
'message'?: string;
|
|
4636
|
+
'status'?: number;
|
|
4637
|
+
}
|
|
4638
|
+
export interface DataTypesGenericResponseArrayAnalyticsQueryMetric {
|
|
4639
|
+
'data'?: Array<AnalyticsQueryMetric>;
|
|
4640
|
+
'message'?: string;
|
|
4641
|
+
'status'?: number;
|
|
4642
|
+
}
|
|
4643
|
+
export interface DataTypesGenericResponseArrayAnalyticsRecommendationCTR {
|
|
4644
|
+
'data'?: Array<AnalyticsRecommendationCTR>;
|
|
4645
|
+
'message'?: string;
|
|
4646
|
+
'status'?: number;
|
|
4647
|
+
}
|
|
4648
|
+
export interface DataTypesGenericResponseArrayAnalyticsZeroResultQuery {
|
|
4649
|
+
'data'?: Array<AnalyticsZeroResultQuery>;
|
|
4650
|
+
'message'?: string;
|
|
4651
|
+
'status'?: number;
|
|
4652
|
+
}
|
|
3729
4653
|
export interface DataTypesGenericResponseArrayBillingServiceCancelledSubscriptionInfo {
|
|
3730
4654
|
'data'?: Array<BillingServiceCancelledSubscriptionInfo>;
|
|
3731
4655
|
'message'?: string;
|
|
@@ -3751,6 +4675,11 @@ export interface DataTypesGenericResponseArrayDataTypesUserWithPermissions {
|
|
|
3751
4675
|
'message'?: string;
|
|
3752
4676
|
'status'?: number;
|
|
3753
4677
|
}
|
|
4678
|
+
export interface DataTypesGenericResponseArrayModelsSimilarUser {
|
|
4679
|
+
'data'?: Array<ModelsSimilarUser>;
|
|
4680
|
+
'message'?: string;
|
|
4681
|
+
'status'?: number;
|
|
4682
|
+
}
|
|
3754
4683
|
export interface DataTypesGenericResponseArrayString {
|
|
3755
4684
|
'data'?: Array<string>;
|
|
3756
4685
|
'message'?: string;
|
|
@@ -3886,6 +4815,26 @@ export interface DataTypesGenericResponseMenuRoutesAddMenuResponse {
|
|
|
3886
4815
|
'message'?: string;
|
|
3887
4816
|
'status'?: number;
|
|
3888
4817
|
}
|
|
4818
|
+
export interface DataTypesGenericResponseModelsMergeProfilesResponse {
|
|
4819
|
+
'data'?: ModelsMergeProfilesResponse;
|
|
4820
|
+
'message'?: string;
|
|
4821
|
+
'status'?: number;
|
|
4822
|
+
}
|
|
4823
|
+
export interface DataTypesGenericResponseModelsPersonalizationContext {
|
|
4824
|
+
'data'?: ModelsPersonalizationContext;
|
|
4825
|
+
'message'?: string;
|
|
4826
|
+
'status'?: number;
|
|
4827
|
+
}
|
|
4828
|
+
export interface DataTypesGenericResponseModelsUserEventsResponse {
|
|
4829
|
+
'data'?: ModelsUserEventsResponse;
|
|
4830
|
+
'message'?: string;
|
|
4831
|
+
'status'?: number;
|
|
4832
|
+
}
|
|
4833
|
+
export interface DataTypesGenericResponseModelsUserProfile {
|
|
4834
|
+
'data'?: ModelsUserProfile;
|
|
4835
|
+
'message'?: string;
|
|
4836
|
+
'status'?: number;
|
|
4837
|
+
}
|
|
3889
4838
|
export interface DataTypesGenericResponsePaymentGatewayCreditProrationResult {
|
|
3890
4839
|
'data'?: PaymentGatewayCreditProrationResult;
|
|
3891
4840
|
'message'?: string;
|
|
@@ -5379,11 +6328,26 @@ export interface DataTypesOrgMemberWithUser {
|
|
|
5379
6328
|
'email'?: string;
|
|
5380
6329
|
'first_name'?: string;
|
|
5381
6330
|
'is_active'?: boolean;
|
|
6331
|
+
/**
|
|
6332
|
+
* True if user has custom/user-specific role
|
|
6333
|
+
*/
|
|
6334
|
+
'is_user_specific'?: boolean;
|
|
5382
6335
|
'joined_at'?: string;
|
|
5383
6336
|
'last_name'?: string;
|
|
5384
6337
|
'member_id'?: number;
|
|
6338
|
+
/**
|
|
6339
|
+
* Org-level: owner, admin, member
|
|
6340
|
+
*/
|
|
5385
6341
|
'member_role'?: string;
|
|
5386
6342
|
'org_id'?: number;
|
|
6343
|
+
/**
|
|
6344
|
+
* Role ID from mrole
|
|
6345
|
+
*/
|
|
6346
|
+
'role_id'?: number;
|
|
6347
|
+
/**
|
|
6348
|
+
* Actual role from mrole (e.g. Admin, Content Editor)
|
|
6349
|
+
*/
|
|
6350
|
+
'role_name'?: string;
|
|
5387
6351
|
/**
|
|
5388
6352
|
* Number of stores user has access to
|
|
5389
6353
|
*/
|
|
@@ -8422,6 +9386,220 @@ export interface MgDocumentTypesCreateArticleRequestDto {
|
|
|
8422
9386
|
'tags'?: Array<string>;
|
|
8423
9387
|
'title'?: string;
|
|
8424
9388
|
}
|
|
9389
|
+
export interface ModelsAffinityScore {
|
|
9390
|
+
'name'?: string;
|
|
9391
|
+
'score'?: number;
|
|
9392
|
+
}
|
|
9393
|
+
export interface ModelsCreateCustomEventFieldRequest {
|
|
9394
|
+
'allowed_values'?: Array<string>;
|
|
9395
|
+
'default_value'?: string;
|
|
9396
|
+
'description'?: string;
|
|
9397
|
+
'display_name'?: string;
|
|
9398
|
+
'field_name': string;
|
|
9399
|
+
'field_slot': number;
|
|
9400
|
+
'field_type': ModelsCreateCustomEventFieldRequestFieldTypeEnum;
|
|
9401
|
+
/**
|
|
9402
|
+
* defaults to false
|
|
9403
|
+
*/
|
|
9404
|
+
'is_indexed'?: boolean;
|
|
9405
|
+
/**
|
|
9406
|
+
* defaults to false
|
|
9407
|
+
*/
|
|
9408
|
+
'is_required'?: boolean;
|
|
9409
|
+
'max_length'?: number;
|
|
9410
|
+
'max_value'?: number;
|
|
9411
|
+
'min_value'?: number;
|
|
9412
|
+
'validation_regex'?: string;
|
|
9413
|
+
}
|
|
9414
|
+
export declare const ModelsCreateCustomEventFieldRequestFieldTypeEnum: {
|
|
9415
|
+
readonly string: "string";
|
|
9416
|
+
readonly number: "number";
|
|
9417
|
+
readonly boolean: "boolean";
|
|
9418
|
+
readonly datetime: "datetime";
|
|
9419
|
+
readonly array: "array";
|
|
9420
|
+
};
|
|
9421
|
+
export type ModelsCreateCustomEventFieldRequestFieldTypeEnum = typeof ModelsCreateCustomEventFieldRequestFieldTypeEnum[keyof typeof ModelsCreateCustomEventFieldRequestFieldTypeEnum];
|
|
9422
|
+
export interface ModelsCreateCustomEventTypeRequest {
|
|
9423
|
+
'description'?: string;
|
|
9424
|
+
'display_name'?: string;
|
|
9425
|
+
/**
|
|
9426
|
+
* defaults to \"custom\"
|
|
9427
|
+
*/
|
|
9428
|
+
'event_category'?: string;
|
|
9429
|
+
'event_name': string;
|
|
9430
|
+
/**
|
|
9431
|
+
* defaults to true
|
|
9432
|
+
*/
|
|
9433
|
+
'is_active'?: boolean;
|
|
9434
|
+
/**
|
|
9435
|
+
* defaults to 100000
|
|
9436
|
+
*/
|
|
9437
|
+
'max_daily_events'?: number;
|
|
9438
|
+
'store_id'?: number;
|
|
9439
|
+
}
|
|
9440
|
+
export interface ModelsMergeProfilesResponse {
|
|
9441
|
+
'events_merged'?: number;
|
|
9442
|
+
'merged_user_key'?: string;
|
|
9443
|
+
'profiles_affected'?: number;
|
|
9444
|
+
'success'?: boolean;
|
|
9445
|
+
}
|
|
9446
|
+
export interface ModelsPersonalizationContext {
|
|
9447
|
+
'avg_order_value'?: number;
|
|
9448
|
+
'commerce_score'?: number;
|
|
9449
|
+
/**
|
|
9450
|
+
* Scores
|
|
9451
|
+
*/
|
|
9452
|
+
'engagement_score'?: number;
|
|
9453
|
+
'frequency_score'?: number;
|
|
9454
|
+
'is_authenticated'?: boolean;
|
|
9455
|
+
'is_new_user'?: boolean;
|
|
9456
|
+
/**
|
|
9457
|
+
* Behavioral insights
|
|
9458
|
+
*/
|
|
9459
|
+
'preferred_device_type'?: string;
|
|
9460
|
+
'preferred_time_of_day'?: string;
|
|
9461
|
+
'recency_score'?: number;
|
|
9462
|
+
'recent_clicked_items'?: Array<string>;
|
|
9463
|
+
'recent_purchased_items'?: Array<string>;
|
|
9464
|
+
/**
|
|
9465
|
+
* Recent activity
|
|
9466
|
+
*/
|
|
9467
|
+
'recent_search_terms'?: Array<string>;
|
|
9468
|
+
'recent_viewed_items'?: Array<string>;
|
|
9469
|
+
/**
|
|
9470
|
+
* Segments
|
|
9471
|
+
*/
|
|
9472
|
+
'segments'?: Array<string>;
|
|
9473
|
+
'top_brands'?: Array<ModelsAffinityScore>;
|
|
9474
|
+
/**
|
|
9475
|
+
* Affinities (top N)
|
|
9476
|
+
*/
|
|
9477
|
+
'top_categories'?: Array<ModelsAffinityScore>;
|
|
9478
|
+
'user_key'?: string;
|
|
9479
|
+
}
|
|
9480
|
+
export interface ModelsSimilarUser {
|
|
9481
|
+
'common_brands'?: Array<string>;
|
|
9482
|
+
'common_categories'?: Array<string>;
|
|
9483
|
+
'similarity_score'?: number;
|
|
9484
|
+
'user_key'?: string;
|
|
9485
|
+
}
|
|
9486
|
+
export interface ModelsUpdateCustomEventFieldRequest {
|
|
9487
|
+
'allowed_values'?: Array<string>;
|
|
9488
|
+
'default_value'?: string;
|
|
9489
|
+
'description'?: string;
|
|
9490
|
+
'display_name'?: string;
|
|
9491
|
+
'field_name'?: string;
|
|
9492
|
+
'is_indexed'?: boolean;
|
|
9493
|
+
'is_required'?: boolean;
|
|
9494
|
+
'max_length'?: number;
|
|
9495
|
+
'max_value'?: number;
|
|
9496
|
+
'min_value'?: number;
|
|
9497
|
+
'validation_regex'?: string;
|
|
9498
|
+
}
|
|
9499
|
+
export interface ModelsUpdateCustomEventTypeRequest {
|
|
9500
|
+
'description'?: string;
|
|
9501
|
+
'display_name'?: string;
|
|
9502
|
+
'event_category'?: string;
|
|
9503
|
+
'is_active'?: boolean;
|
|
9504
|
+
'max_daily_events'?: number;
|
|
9505
|
+
}
|
|
9506
|
+
export interface ModelsUserEvent {
|
|
9507
|
+
'country'?: string;
|
|
9508
|
+
'device_type'?: string;
|
|
9509
|
+
'event_id'?: string;
|
|
9510
|
+
'event_subtype'?: string;
|
|
9511
|
+
'event_ts'?: string;
|
|
9512
|
+
'event_type'?: string;
|
|
9513
|
+
'is_attributed'?: boolean;
|
|
9514
|
+
'item_id'?: string;
|
|
9515
|
+
'position'?: number;
|
|
9516
|
+
'query'?: string;
|
|
9517
|
+
'recommendation_id'?: string;
|
|
9518
|
+
'search_id'?: string;
|
|
9519
|
+
'session_id'?: string;
|
|
9520
|
+
'surface'?: string;
|
|
9521
|
+
'value'?: number;
|
|
9522
|
+
}
|
|
9523
|
+
export interface ModelsUserEventsResponse {
|
|
9524
|
+
'events'?: Array<ModelsUserEvent>;
|
|
9525
|
+
'page'?: number;
|
|
9526
|
+
'page_size'?: number;
|
|
9527
|
+
'total'?: number;
|
|
9528
|
+
'total_pages'?: number;
|
|
9529
|
+
}
|
|
9530
|
+
export interface ModelsUserProfile {
|
|
9531
|
+
'anonymous_id'?: string;
|
|
9532
|
+
'authenticated_user_id'?: string;
|
|
9533
|
+
'avg_clicks_per_search'?: number;
|
|
9534
|
+
'avg_order_value'?: number;
|
|
9535
|
+
'avg_searches_per_session'?: number;
|
|
9536
|
+
/**
|
|
9537
|
+
* Behavioral signals
|
|
9538
|
+
*/
|
|
9539
|
+
'avg_session_duration_ms'?: number;
|
|
9540
|
+
'brand_affinities'?: {
|
|
9541
|
+
[key: string]: number;
|
|
9542
|
+
};
|
|
9543
|
+
/**
|
|
9544
|
+
* Affinity scores (for personalization)
|
|
9545
|
+
*/
|
|
9546
|
+
'category_affinities'?: {
|
|
9547
|
+
[key: string]: number;
|
|
9548
|
+
};
|
|
9549
|
+
'commerce_score'?: number;
|
|
9550
|
+
'conversion_rate'?: number;
|
|
9551
|
+
/**
|
|
9552
|
+
* Device info
|
|
9553
|
+
*/
|
|
9554
|
+
'device_fingerprints'?: Array<string>;
|
|
9555
|
+
/**
|
|
9556
|
+
* Computed traits (0-100 scores)
|
|
9557
|
+
*/
|
|
9558
|
+
'engagement_score'?: number;
|
|
9559
|
+
/**
|
|
9560
|
+
* Timestamps
|
|
9561
|
+
*/
|
|
9562
|
+
'first_seen_at'?: string;
|
|
9563
|
+
'frequency_score'?: number;
|
|
9564
|
+
'last_seen_at'?: string;
|
|
9565
|
+
'last_updated_at'?: string;
|
|
9566
|
+
'orgcode'?: string;
|
|
9567
|
+
'primary_browser'?: string;
|
|
9568
|
+
'primary_city'?: string;
|
|
9569
|
+
/**
|
|
9570
|
+
* Geo
|
|
9571
|
+
*/
|
|
9572
|
+
'primary_country'?: string;
|
|
9573
|
+
'primary_device_type'?: string;
|
|
9574
|
+
'primary_platform'?: string;
|
|
9575
|
+
'recency_score'?: number;
|
|
9576
|
+
/**
|
|
9577
|
+
* Recent activity
|
|
9578
|
+
*/
|
|
9579
|
+
'recent_searches'?: Array<string>;
|
|
9580
|
+
'recently_clicked_items'?: Array<string>;
|
|
9581
|
+
'recently_purchased_items'?: Array<string>;
|
|
9582
|
+
'recently_viewed_items'?: Array<string>;
|
|
9583
|
+
'total_clicks'?: number;
|
|
9584
|
+
'total_conversions'?: number;
|
|
9585
|
+
'total_revenue'?: number;
|
|
9586
|
+
'total_searches'?: number;
|
|
9587
|
+
/**
|
|
9588
|
+
* Aggregated stats
|
|
9589
|
+
*/
|
|
9590
|
+
'total_sessions'?: number;
|
|
9591
|
+
'user_id'?: string;
|
|
9592
|
+
/**
|
|
9593
|
+
* Identity
|
|
9594
|
+
*/
|
|
9595
|
+
'user_key'?: string;
|
|
9596
|
+
'xstoreid'?: string;
|
|
9597
|
+
}
|
|
9598
|
+
export interface ModelsValidatePayloadRequest {
|
|
9599
|
+
'payload': {
|
|
9600
|
+
[key: string]: any;
|
|
9601
|
+
};
|
|
9602
|
+
}
|
|
8425
9603
|
export interface PaymentGatewayCreditProrationResult {
|
|
8426
9604
|
'change_type'?: string;
|
|
8427
9605
|
'credits_remaining'?: number;
|
|
@@ -9504,12 +10682,59 @@ export interface SeekoraGoSrcAnalyticsPaginationMeta {
|
|
|
9504
10682
|
'total_items'?: number;
|
|
9505
10683
|
'total_pages'?: number;
|
|
9506
10684
|
}
|
|
10685
|
+
export interface SeekoraGoSrcAnalyticsTimePoint {
|
|
10686
|
+
'avg_processing_time_ms'?: number;
|
|
10687
|
+
'avg_suggestions_per_request'?: number;
|
|
10688
|
+
'requests'?: number;
|
|
10689
|
+
'time'?: string;
|
|
10690
|
+
'total_suggestions_returned'?: number;
|
|
10691
|
+
}
|
|
10692
|
+
export interface SeekoraGoSrcAnalyticsTimeSeriesPoint {
|
|
10693
|
+
'percentage'?: number;
|
|
10694
|
+
'timestamp'?: string;
|
|
10695
|
+
'value'?: number;
|
|
10696
|
+
}
|
|
10697
|
+
export interface SeekoraGoSrcRoutesAnalyticsFunnelStep {
|
|
10698
|
+
'conversion_rate'?: number;
|
|
10699
|
+
'count'?: number;
|
|
10700
|
+
'dropoff_rate'?: number;
|
|
10701
|
+
'name'?: string;
|
|
10702
|
+
'unique_users'?: number;
|
|
10703
|
+
}
|
|
9507
10704
|
export interface SeekoraGoSrcRoutesAnalyticsPaginationMeta {
|
|
9508
10705
|
'page'?: number;
|
|
9509
10706
|
'per_page'?: number;
|
|
9510
10707
|
'total_count'?: number;
|
|
9511
10708
|
'total_pages'?: number;
|
|
9512
10709
|
}
|
|
10710
|
+
export interface SeekoraGoSrcRoutesAnalyticsTimePoint {
|
|
10711
|
+
'clicks'?: number;
|
|
10712
|
+
'conversion_rate'?: number;
|
|
10713
|
+
'conversions'?: number;
|
|
10714
|
+
'ctr'?: number;
|
|
10715
|
+
'impressions'?: number;
|
|
10716
|
+
'requests'?: number;
|
|
10717
|
+
'revenue'?: number;
|
|
10718
|
+
'timestamp'?: string;
|
|
10719
|
+
}
|
|
10720
|
+
export interface SeekoraGoSrcServicesAnalyticsFunnelStep {
|
|
10721
|
+
'conditions'?: Array<AnalyticsCondition>;
|
|
10722
|
+
'event_name'?: string;
|
|
10723
|
+
/**
|
|
10724
|
+
* search, click, conversion, view, recommendation, custom
|
|
10725
|
+
*/
|
|
10726
|
+
'event_type'?: string;
|
|
10727
|
+
'step_order'?: number;
|
|
10728
|
+
/**
|
|
10729
|
+
* time allowed to reach next step (0 = use funnel default)
|
|
10730
|
+
*/
|
|
10731
|
+
'window_hours'?: number;
|
|
10732
|
+
}
|
|
10733
|
+
export interface SeekoraGoSrcServicesAnalyticsTimeSeriesPoint {
|
|
10734
|
+
'count'?: number;
|
|
10735
|
+
'timestamp'?: string;
|
|
10736
|
+
'value'?: number;
|
|
10737
|
+
}
|
|
9513
10738
|
export interface StoreRouteAPIUsageDetailResponse {
|
|
9514
10739
|
'data'?: StoreRouteAPIUsageLogEntry;
|
|
9515
10740
|
'message'?: string;
|