@seekora-ai/admin-api 1.0.45 → 1.0.47
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 +20 -3
- package/api.ts +1915 -141
- package/dist/api.d.ts +1442 -133
- package/dist/api.js +971 -74
- package/dist/esm/api.d.ts +1442 -133
- package/dist/esm/api.js +963 -70
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.47.tgz +0 -0
- package/seekora-ai-admin-api-1.0.45.tgz +0 -0
package/api.ts
CHANGED
|
@@ -29,6 +29,12 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM
|
|
|
29
29
|
* @interface AdminAnalyticsStoreXStoreIDCustomPost200Response
|
|
30
30
|
*/
|
|
31
31
|
export interface AdminAnalyticsStoreXStoreIDCustomPost200Response {
|
|
32
|
+
/**
|
|
33
|
+
* Comparison metadata when in compare mode
|
|
34
|
+
* @type {AnalyticsComparisonMeta}
|
|
35
|
+
* @memberof AdminAnalyticsStoreXStoreIDCustomPost200Response
|
|
36
|
+
*/
|
|
37
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
32
38
|
/**
|
|
33
39
|
*
|
|
34
40
|
* @type {AnalyticsCustomQueryResponse}
|
|
@@ -66,6 +72,12 @@ export interface AdminAnalyticsStoreXStoreIDCustomPost200Response {
|
|
|
66
72
|
* @interface AdminAnalyticsStoreXStoreIDFiltersCombinationsGet200Response
|
|
67
73
|
*/
|
|
68
74
|
export interface AdminAnalyticsStoreXStoreIDFiltersCombinationsGet200Response {
|
|
75
|
+
/**
|
|
76
|
+
* Comparison metadata when in compare mode
|
|
77
|
+
* @type {AnalyticsComparisonMeta}
|
|
78
|
+
* @memberof AdminAnalyticsStoreXStoreIDFiltersCombinationsGet200Response
|
|
79
|
+
*/
|
|
80
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
69
81
|
/**
|
|
70
82
|
*
|
|
71
83
|
* @type {Array<AnalyticsFilterCombination>}
|
|
@@ -103,6 +115,12 @@ export interface AdminAnalyticsStoreXStoreIDFiltersCombinationsGet200Response {
|
|
|
103
115
|
* @interface AdminAnalyticsStoreXStoreIDFiltersEffectivenessGet200Response
|
|
104
116
|
*/
|
|
105
117
|
export interface AdminAnalyticsStoreXStoreIDFiltersEffectivenessGet200Response {
|
|
118
|
+
/**
|
|
119
|
+
* Comparison metadata when in compare mode
|
|
120
|
+
* @type {AnalyticsComparisonMeta}
|
|
121
|
+
* @memberof AdminAnalyticsStoreXStoreIDFiltersEffectivenessGet200Response
|
|
122
|
+
*/
|
|
123
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
106
124
|
/**
|
|
107
125
|
*
|
|
108
126
|
* @type {AnalyticsFilterEffectivenessAnalysis}
|
|
@@ -140,6 +158,12 @@ export interface AdminAnalyticsStoreXStoreIDFiltersEffectivenessGet200Response {
|
|
|
140
158
|
* @interface AdminAnalyticsStoreXStoreIDFiltersGet200Response
|
|
141
159
|
*/
|
|
142
160
|
export interface AdminAnalyticsStoreXStoreIDFiltersGet200Response {
|
|
161
|
+
/**
|
|
162
|
+
* Comparison metadata when in compare mode
|
|
163
|
+
* @type {AnalyticsComparisonMeta}
|
|
164
|
+
* @memberof AdminAnalyticsStoreXStoreIDFiltersGet200Response
|
|
165
|
+
*/
|
|
166
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
143
167
|
/**
|
|
144
168
|
*
|
|
145
169
|
* @type {AnalyticsFilterAnalyticsResponse}
|
|
@@ -177,6 +201,12 @@ export interface AdminAnalyticsStoreXStoreIDFiltersGet200Response {
|
|
|
177
201
|
* @interface AdminAnalyticsStoreXStoreIDFiltersTrendsGet200Response
|
|
178
202
|
*/
|
|
179
203
|
export interface AdminAnalyticsStoreXStoreIDFiltersTrendsGet200Response {
|
|
204
|
+
/**
|
|
205
|
+
* Comparison metadata when in compare mode
|
|
206
|
+
* @type {AnalyticsComparisonMeta}
|
|
207
|
+
* @memberof AdminAnalyticsStoreXStoreIDFiltersTrendsGet200Response
|
|
208
|
+
*/
|
|
209
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
180
210
|
/**
|
|
181
211
|
*
|
|
182
212
|
* @type {AnalyticsFilterTrendsResponse}
|
|
@@ -214,6 +244,12 @@ export interface AdminAnalyticsStoreXStoreIDFiltersTrendsGet200Response {
|
|
|
214
244
|
* @interface AdminAnalyticsStoreXStoreIDGeoGet200Response
|
|
215
245
|
*/
|
|
216
246
|
export interface AdminAnalyticsStoreXStoreIDGeoGet200Response {
|
|
247
|
+
/**
|
|
248
|
+
* Comparison metadata when in compare mode
|
|
249
|
+
* @type {AnalyticsComparisonMeta}
|
|
250
|
+
* @memberof AdminAnalyticsStoreXStoreIDGeoGet200Response
|
|
251
|
+
*/
|
|
252
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
217
253
|
/**
|
|
218
254
|
*
|
|
219
255
|
* @type {AnalyticsGeoResponse}
|
|
@@ -251,6 +287,12 @@ export interface AdminAnalyticsStoreXStoreIDGeoGet200Response {
|
|
|
251
287
|
* @interface AdminAnalyticsStoreXStoreIDItemsComparisonGet200Response
|
|
252
288
|
*/
|
|
253
289
|
export interface AdminAnalyticsStoreXStoreIDItemsComparisonGet200Response {
|
|
290
|
+
/**
|
|
291
|
+
* Comparison metadata when in compare mode
|
|
292
|
+
* @type {AnalyticsComparisonMeta}
|
|
293
|
+
* @memberof AdminAnalyticsStoreXStoreIDItemsComparisonGet200Response
|
|
294
|
+
*/
|
|
295
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
254
296
|
/**
|
|
255
297
|
*
|
|
256
298
|
* @type {AnalyticsItemComparisonAnalytics}
|
|
@@ -288,6 +330,12 @@ export interface AdminAnalyticsStoreXStoreIDItemsComparisonGet200Response {
|
|
|
288
330
|
* @interface AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response
|
|
289
331
|
*/
|
|
290
332
|
export interface AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response {
|
|
333
|
+
/**
|
|
334
|
+
* Comparison metadata when in compare mode
|
|
335
|
+
* @type {AnalyticsComparisonMeta}
|
|
336
|
+
* @memberof AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response
|
|
337
|
+
*/
|
|
338
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
291
339
|
/**
|
|
292
340
|
*
|
|
293
341
|
* @type {Array<AnalyticsItemDiscoveryAnalytics>}
|
|
@@ -325,6 +373,12 @@ export interface AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response {
|
|
|
325
373
|
* @interface AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response
|
|
326
374
|
*/
|
|
327
375
|
export interface AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response {
|
|
376
|
+
/**
|
|
377
|
+
* Comparison metadata when in compare mode
|
|
378
|
+
* @type {AnalyticsComparisonMeta}
|
|
379
|
+
* @memberof AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response
|
|
380
|
+
*/
|
|
381
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
328
382
|
/**
|
|
329
383
|
*
|
|
330
384
|
* @type {Array<AnalyticsItemPerformanceMetrics>}
|
|
@@ -362,6 +416,12 @@ export interface AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response {
|
|
|
362
416
|
* @interface AdminAnalyticsStoreXStoreIDItemsTrendsGet200Response
|
|
363
417
|
*/
|
|
364
418
|
export interface AdminAnalyticsStoreXStoreIDItemsTrendsGet200Response {
|
|
419
|
+
/**
|
|
420
|
+
* Comparison metadata when in compare mode
|
|
421
|
+
* @type {AnalyticsComparisonMeta}
|
|
422
|
+
* @memberof AdminAnalyticsStoreXStoreIDItemsTrendsGet200Response
|
|
423
|
+
*/
|
|
424
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
365
425
|
/**
|
|
366
426
|
*
|
|
367
427
|
* @type {Array<AnalyticsItemPerformanceTrend>}
|
|
@@ -399,6 +459,12 @@ export interface AdminAnalyticsStoreXStoreIDItemsTrendsGet200Response {
|
|
|
399
459
|
* @interface AdminAnalyticsStoreXStoreIDKpiGet200Response
|
|
400
460
|
*/
|
|
401
461
|
export interface AdminAnalyticsStoreXStoreIDKpiGet200Response {
|
|
462
|
+
/**
|
|
463
|
+
* Comparison metadata when in compare mode
|
|
464
|
+
* @type {AnalyticsComparisonMeta}
|
|
465
|
+
* @memberof AdminAnalyticsStoreXStoreIDKpiGet200Response
|
|
466
|
+
*/
|
|
467
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
402
468
|
/**
|
|
403
469
|
*
|
|
404
470
|
* @type {AnalyticsExtendedKPIResponse}
|
|
@@ -436,6 +502,12 @@ export interface AdminAnalyticsStoreXStoreIDKpiGet200Response {
|
|
|
436
502
|
* @interface AdminAnalyticsStoreXStoreIDQueriesGet200Response
|
|
437
503
|
*/
|
|
438
504
|
export interface AdminAnalyticsStoreXStoreIDQueriesGet200Response {
|
|
505
|
+
/**
|
|
506
|
+
* Comparison metadata when in compare mode
|
|
507
|
+
* @type {AnalyticsComparisonMeta}
|
|
508
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesGet200Response
|
|
509
|
+
*/
|
|
510
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
439
511
|
/**
|
|
440
512
|
*
|
|
441
513
|
* @type {AnalyticsQueryResponse}
|
|
@@ -473,6 +545,12 @@ export interface AdminAnalyticsStoreXStoreIDQueriesGet200Response {
|
|
|
473
545
|
* @interface AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGet200Response
|
|
474
546
|
*/
|
|
475
547
|
export interface AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGet200Response {
|
|
548
|
+
/**
|
|
549
|
+
* Comparison metadata when in compare mode
|
|
550
|
+
* @type {AnalyticsComparisonMeta}
|
|
551
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGet200Response
|
|
552
|
+
*/
|
|
553
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
476
554
|
/**
|
|
477
555
|
*
|
|
478
556
|
* @type {Array<AnalyticsQueryPerformanceAnalytics>}
|
|
@@ -510,6 +588,12 @@ export interface AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGet200Response
|
|
|
510
588
|
* @interface AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response
|
|
511
589
|
*/
|
|
512
590
|
export interface AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response {
|
|
591
|
+
/**
|
|
592
|
+
* Comparison metadata when in compare mode
|
|
593
|
+
* @type {AnalyticsComparisonMeta}
|
|
594
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response
|
|
595
|
+
*/
|
|
596
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
513
597
|
/**
|
|
514
598
|
*
|
|
515
599
|
* @type {{ [key: string]: any; }}
|
|
@@ -547,6 +631,12 @@ export interface AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response {
|
|
|
547
631
|
* @interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
548
632
|
*/
|
|
549
633
|
export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
|
|
634
|
+
/**
|
|
635
|
+
* Comparison metadata when in compare mode
|
|
636
|
+
* @type {AnalyticsComparisonMeta}
|
|
637
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
638
|
+
*/
|
|
639
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
550
640
|
/**
|
|
551
641
|
*
|
|
552
642
|
* @type {AnalyticsQueryInsights}
|
|
@@ -584,6 +674,12 @@ export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
|
|
|
584
674
|
* @interface AnalyticsAnalyticsAPIResponse
|
|
585
675
|
*/
|
|
586
676
|
export interface AnalyticsAnalyticsAPIResponse {
|
|
677
|
+
/**
|
|
678
|
+
* Comparison metadata when in compare mode
|
|
679
|
+
* @type {AnalyticsComparisonMeta}
|
|
680
|
+
* @memberof AnalyticsAnalyticsAPIResponse
|
|
681
|
+
*/
|
|
682
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
587
683
|
/**
|
|
588
684
|
*
|
|
589
685
|
* @type {object}
|
|
@@ -799,6 +895,43 @@ export interface AnalyticsClickPositionBucket {
|
|
|
799
895
|
*/
|
|
800
896
|
'share'?: number;
|
|
801
897
|
}
|
|
898
|
+
/**
|
|
899
|
+
*
|
|
900
|
+
* @export
|
|
901
|
+
* @interface AnalyticsComparisonMeta
|
|
902
|
+
*/
|
|
903
|
+
export interface AnalyticsComparisonMeta {
|
|
904
|
+
/**
|
|
905
|
+
* Human readable comparison period
|
|
906
|
+
* @type {string}
|
|
907
|
+
* @memberof AnalyticsComparisonMeta
|
|
908
|
+
*/
|
|
909
|
+
'comparison_period'?: string;
|
|
910
|
+
/**
|
|
911
|
+
* Analytics tags for comparison period
|
|
912
|
+
* @type {Array<string>}
|
|
913
|
+
* @memberof AnalyticsComparisonMeta
|
|
914
|
+
*/
|
|
915
|
+
'comparison_tags'?: Array<string>;
|
|
916
|
+
/**
|
|
917
|
+
* Human readable current period
|
|
918
|
+
* @type {string}
|
|
919
|
+
* @memberof AnalyticsComparisonMeta
|
|
920
|
+
*/
|
|
921
|
+
'current_period'?: string;
|
|
922
|
+
/**
|
|
923
|
+
* Analytics tags for current period
|
|
924
|
+
* @type {Array<string>}
|
|
925
|
+
* @memberof AnalyticsComparisonMeta
|
|
926
|
+
*/
|
|
927
|
+
'current_tags'?: Array<string>;
|
|
928
|
+
/**
|
|
929
|
+
* Whether comparison mode is enabled
|
|
930
|
+
* @type {boolean}
|
|
931
|
+
* @memberof AnalyticsComparisonMeta
|
|
932
|
+
*/
|
|
933
|
+
'mode'?: boolean;
|
|
934
|
+
}
|
|
802
935
|
/**
|
|
803
936
|
*
|
|
804
937
|
* @export
|
|
@@ -876,27 +1009,33 @@ export interface AnalyticsCustomQueryResponse {
|
|
|
876
1009
|
/**
|
|
877
1010
|
*
|
|
878
1011
|
* @export
|
|
879
|
-
* @interface
|
|
1012
|
+
* @interface AnalyticsEnrichedItemResultWithWidget
|
|
880
1013
|
*/
|
|
881
|
-
export interface
|
|
1014
|
+
export interface AnalyticsEnrichedItemResultWithWidget {
|
|
882
1015
|
/**
|
|
883
1016
|
* Analytics data
|
|
884
1017
|
* @type {AnalyticsItemPerformanceMetrics}
|
|
885
|
-
* @memberof
|
|
1018
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
886
1019
|
*/
|
|
887
1020
|
'analytics'?: AnalyticsItemPerformanceMetrics;
|
|
888
1021
|
/**
|
|
889
1022
|
* Document data from Typesense index
|
|
890
1023
|
* @type {{ [key: string]: any; }}
|
|
891
|
-
* @memberof
|
|
1024
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
892
1025
|
*/
|
|
893
1026
|
'document'?: { [key: string]: any; };
|
|
894
1027
|
/**
|
|
895
1028
|
* Error if document fetch failed
|
|
896
1029
|
* @type {string}
|
|
897
|
-
* @memberof
|
|
1030
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
898
1031
|
*/
|
|
899
1032
|
'document_fetch_error'?: string;
|
|
1033
|
+
/**
|
|
1034
|
+
* Widget display data for UI presentation
|
|
1035
|
+
* @type {AnalyticsWidgetData}
|
|
1036
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1037
|
+
*/
|
|
1038
|
+
'widget'?: AnalyticsWidgetData;
|
|
900
1039
|
}
|
|
901
1040
|
/**
|
|
902
1041
|
*
|
|
@@ -904,6 +1043,30 @@ export interface AnalyticsEnrichedItemResult {
|
|
|
904
1043
|
* @interface AnalyticsExtendedKPIResponse
|
|
905
1044
|
*/
|
|
906
1045
|
export interface AnalyticsExtendedKPIResponse {
|
|
1046
|
+
/**
|
|
1047
|
+
*
|
|
1048
|
+
* @type {Array<AnalyticsKPIPointExtended>}
|
|
1049
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
1050
|
+
*/
|
|
1051
|
+
'compare_data'?: Array<AnalyticsKPIPointExtended>;
|
|
1052
|
+
/**
|
|
1053
|
+
*
|
|
1054
|
+
* @type {string}
|
|
1055
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
1056
|
+
*/
|
|
1057
|
+
'compare_end_time'?: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* Comparison mode data
|
|
1060
|
+
* @type {string}
|
|
1061
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
1062
|
+
*/
|
|
1063
|
+
'compare_start_time'?: string;
|
|
1064
|
+
/**
|
|
1065
|
+
*
|
|
1066
|
+
* @type {AnalyticsKPIMetrics}
|
|
1067
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
1068
|
+
*/
|
|
1069
|
+
'compare_summary'?: AnalyticsKPIMetrics;
|
|
907
1070
|
/**
|
|
908
1071
|
*
|
|
909
1072
|
* @type {Array<AnalyticsKPIPointExtended>}
|
|
@@ -941,11 +1104,11 @@ export interface AnalyticsExtendedKPIResponse {
|
|
|
941
1104
|
*/
|
|
942
1105
|
'store_id'?: string;
|
|
943
1106
|
/**
|
|
944
|
-
*
|
|
945
|
-
* @type {
|
|
1107
|
+
* Can be KPIMetrics or ComparisonMetrics
|
|
1108
|
+
* @type {object}
|
|
946
1109
|
* @memberof AnalyticsExtendedKPIResponse
|
|
947
1110
|
*/
|
|
948
|
-
'summary'?:
|
|
1111
|
+
'summary'?: object;
|
|
949
1112
|
}
|
|
950
1113
|
/**
|
|
951
1114
|
*
|
|
@@ -1582,7 +1745,31 @@ export interface AnalyticsGeoResponse {
|
|
|
1582
1745
|
* @type {Array<AnalyticsGeoAnalytic>}
|
|
1583
1746
|
* @memberof AnalyticsGeoResponse
|
|
1584
1747
|
*/
|
|
1585
|
-
'
|
|
1748
|
+
'compare_data'?: Array<AnalyticsGeoAnalytic>;
|
|
1749
|
+
/**
|
|
1750
|
+
*
|
|
1751
|
+
* @type {string}
|
|
1752
|
+
* @memberof AnalyticsGeoResponse
|
|
1753
|
+
*/
|
|
1754
|
+
'compare_end_time'?: string;
|
|
1755
|
+
/**
|
|
1756
|
+
* Comparison mode data
|
|
1757
|
+
* @type {string}
|
|
1758
|
+
* @memberof AnalyticsGeoResponse
|
|
1759
|
+
*/
|
|
1760
|
+
'compare_start_time'?: string;
|
|
1761
|
+
/**
|
|
1762
|
+
*
|
|
1763
|
+
* @type {number}
|
|
1764
|
+
* @memberof AnalyticsGeoResponse
|
|
1765
|
+
*/
|
|
1766
|
+
'compare_total'?: number;
|
|
1767
|
+
/**
|
|
1768
|
+
* Can be []GeoAnalytic or []ComparisonMetrics
|
|
1769
|
+
* @type {object}
|
|
1770
|
+
* @memberof AnalyticsGeoResponse
|
|
1771
|
+
*/
|
|
1772
|
+
'data'?: object;
|
|
1586
1773
|
/**
|
|
1587
1774
|
*
|
|
1588
1775
|
* @type {string}
|
|
@@ -1920,6 +2107,133 @@ export interface AnalyticsItemPerformanceTrend {
|
|
|
1920
2107
|
*/
|
|
1921
2108
|
'trend_data'?: Array<AnalyticsItemTrendData>;
|
|
1922
2109
|
}
|
|
2110
|
+
/**
|
|
2111
|
+
*
|
|
2112
|
+
* @export
|
|
2113
|
+
* @interface AnalyticsItemPerformanceWithWidget
|
|
2114
|
+
*/
|
|
2115
|
+
export interface AnalyticsItemPerformanceWithWidget {
|
|
2116
|
+
/**
|
|
2117
|
+
*
|
|
2118
|
+
* @type {number}
|
|
2119
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2120
|
+
*/
|
|
2121
|
+
'avg_position'?: number;
|
|
2122
|
+
/**
|
|
2123
|
+
*
|
|
2124
|
+
* @type {number}
|
|
2125
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2126
|
+
*/
|
|
2127
|
+
'avg_score'?: number;
|
|
2128
|
+
/**
|
|
2129
|
+
* Calculated metrics
|
|
2130
|
+
* @type {number}
|
|
2131
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2132
|
+
*/
|
|
2133
|
+
'click_through_rate'?: number;
|
|
2134
|
+
/**
|
|
2135
|
+
* Future click and conversion metrics
|
|
2136
|
+
* @type {number}
|
|
2137
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2138
|
+
*/
|
|
2139
|
+
'clicks'?: number;
|
|
2140
|
+
/**
|
|
2141
|
+
*
|
|
2142
|
+
* @type {number}
|
|
2143
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2144
|
+
*/
|
|
2145
|
+
'conversion_rate'?: number;
|
|
2146
|
+
/**
|
|
2147
|
+
*
|
|
2148
|
+
* @type {number}
|
|
2149
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2150
|
+
*/
|
|
2151
|
+
'conversions'?: number;
|
|
2152
|
+
/**
|
|
2153
|
+
*
|
|
2154
|
+
* @type {number}
|
|
2155
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2156
|
+
*/
|
|
2157
|
+
'impressions'?: number;
|
|
2158
|
+
/**
|
|
2159
|
+
*
|
|
2160
|
+
* @type {string}
|
|
2161
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2162
|
+
*/
|
|
2163
|
+
'item_id'?: string;
|
|
2164
|
+
/**
|
|
2165
|
+
*
|
|
2166
|
+
* @type {string}
|
|
2167
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2168
|
+
*/
|
|
2169
|
+
'item_name'?: string;
|
|
2170
|
+
/**
|
|
2171
|
+
*
|
|
2172
|
+
* @type {number}
|
|
2173
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2174
|
+
*/
|
|
2175
|
+
'revenue'?: number;
|
|
2176
|
+
/**
|
|
2177
|
+
*
|
|
2178
|
+
* @type {number}
|
|
2179
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2180
|
+
*/
|
|
2181
|
+
'revenue_per_item'?: number;
|
|
2182
|
+
/**
|
|
2183
|
+
*
|
|
2184
|
+
* @type {number}
|
|
2185
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2186
|
+
*/
|
|
2187
|
+
'top_10_impressions'?: number;
|
|
2188
|
+
/**
|
|
2189
|
+
*
|
|
2190
|
+
* @type {number}
|
|
2191
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2192
|
+
*/
|
|
2193
|
+
'top_3_impression_rate'?: number;
|
|
2194
|
+
/**
|
|
2195
|
+
*
|
|
2196
|
+
* @type {number}
|
|
2197
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2198
|
+
*/
|
|
2199
|
+
'top_3_impressions'?: number;
|
|
2200
|
+
/**
|
|
2201
|
+
*
|
|
2202
|
+
* @type {number}
|
|
2203
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2204
|
+
*/
|
|
2205
|
+
'unique_filters'?: number;
|
|
2206
|
+
/**
|
|
2207
|
+
*
|
|
2208
|
+
* @type {number}
|
|
2209
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2210
|
+
*/
|
|
2211
|
+
'unique_queries'?: number;
|
|
2212
|
+
/**
|
|
2213
|
+
*
|
|
2214
|
+
* @type {number}
|
|
2215
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2216
|
+
*/
|
|
2217
|
+
'unique_searches'?: number;
|
|
2218
|
+
/**
|
|
2219
|
+
*
|
|
2220
|
+
* @type {number}
|
|
2221
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2222
|
+
*/
|
|
2223
|
+
'unique_sorts'?: number;
|
|
2224
|
+
/**
|
|
2225
|
+
*
|
|
2226
|
+
* @type {number}
|
|
2227
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2228
|
+
*/
|
|
2229
|
+
'unique_users'?: number;
|
|
2230
|
+
/**
|
|
2231
|
+
* Widget display data for UI presentation
|
|
2232
|
+
* @type {AnalyticsWidgetData}
|
|
2233
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2234
|
+
*/
|
|
2235
|
+
'widget'?: AnalyticsWidgetData;
|
|
2236
|
+
}
|
|
1923
2237
|
/**
|
|
1924
2238
|
*
|
|
1925
2239
|
* @export
|
|
@@ -2708,7 +3022,31 @@ export interface AnalyticsQueryResponse {
|
|
|
2708
3022
|
* @type {Array<AnalyticsQueryAnalytic>}
|
|
2709
3023
|
* @memberof AnalyticsQueryResponse
|
|
2710
3024
|
*/
|
|
2711
|
-
'
|
|
3025
|
+
'compare_data'?: Array<AnalyticsQueryAnalytic>;
|
|
3026
|
+
/**
|
|
3027
|
+
*
|
|
3028
|
+
* @type {string}
|
|
3029
|
+
* @memberof AnalyticsQueryResponse
|
|
3030
|
+
*/
|
|
3031
|
+
'compare_end_time'?: string;
|
|
3032
|
+
/**
|
|
3033
|
+
* Comparison mode data
|
|
3034
|
+
* @type {string}
|
|
3035
|
+
* @memberof AnalyticsQueryResponse
|
|
3036
|
+
*/
|
|
3037
|
+
'compare_start_time'?: string;
|
|
3038
|
+
/**
|
|
3039
|
+
*
|
|
3040
|
+
* @type {number}
|
|
3041
|
+
* @memberof AnalyticsQueryResponse
|
|
3042
|
+
*/
|
|
3043
|
+
'compare_total'?: number;
|
|
3044
|
+
/**
|
|
3045
|
+
* Can be []QueryAnalytic or []ComparisonMetrics
|
|
3046
|
+
* @type {object}
|
|
3047
|
+
* @memberof AnalyticsQueryResponse
|
|
3048
|
+
*/
|
|
3049
|
+
'data'?: object;
|
|
2712
3050
|
/**
|
|
2713
3051
|
*
|
|
2714
3052
|
* @type {string}
|
|
@@ -2786,34 +3124,71 @@ export interface AnalyticsTimeSeriesPoint {
|
|
|
2786
3124
|
/**
|
|
2787
3125
|
*
|
|
2788
3126
|
* @export
|
|
2789
|
-
* @interface
|
|
3127
|
+
* @interface AnalyticsWidgetData
|
|
2790
3128
|
*/
|
|
2791
|
-
export interface
|
|
3129
|
+
export interface AnalyticsWidgetData {
|
|
2792
3130
|
/**
|
|
2793
3131
|
*
|
|
2794
|
-
* @type {
|
|
2795
|
-
* @memberof
|
|
3132
|
+
* @type {string}
|
|
3133
|
+
* @memberof AnalyticsWidgetData
|
|
2796
3134
|
*/
|
|
2797
|
-
'
|
|
2798
|
-
}
|
|
2799
|
-
/**
|
|
2800
|
-
*
|
|
2801
|
-
* @export
|
|
2802
|
-
* @interface ApiSearchHighlight
|
|
2803
|
-
*/
|
|
2804
|
-
export interface ApiSearchHighlight {
|
|
3135
|
+
'id'?: string;
|
|
2805
3136
|
/**
|
|
2806
3137
|
*
|
|
2807
3138
|
* @type {string}
|
|
2808
|
-
* @memberof
|
|
3139
|
+
* @memberof AnalyticsWidgetData
|
|
2809
3140
|
*/
|
|
2810
|
-
'
|
|
2811
|
-
/**
|
|
2812
|
-
*
|
|
2813
|
-
* @type {
|
|
2814
|
-
* @memberof
|
|
2815
|
-
*/
|
|
2816
|
-
'
|
|
3141
|
+
'image_url'?: string;
|
|
3142
|
+
/**
|
|
3143
|
+
*
|
|
3144
|
+
* @type {string}
|
|
3145
|
+
* @memberof AnalyticsWidgetData
|
|
3146
|
+
*/
|
|
3147
|
+
'primary_text'?: string;
|
|
3148
|
+
/**
|
|
3149
|
+
*
|
|
3150
|
+
* @type {string}
|
|
3151
|
+
* @memberof AnalyticsWidgetData
|
|
3152
|
+
*/
|
|
3153
|
+
'secondary_text'?: string;
|
|
3154
|
+
/**
|
|
3155
|
+
*
|
|
3156
|
+
* @type {string}
|
|
3157
|
+
* @memberof AnalyticsWidgetData
|
|
3158
|
+
*/
|
|
3159
|
+
'tertiary_text'?: string;
|
|
3160
|
+
}
|
|
3161
|
+
/**
|
|
3162
|
+
*
|
|
3163
|
+
* @export
|
|
3164
|
+
* @interface ApiAnalyticsBatchPostRequest
|
|
3165
|
+
*/
|
|
3166
|
+
export interface ApiAnalyticsBatchPostRequest {
|
|
3167
|
+
/**
|
|
3168
|
+
*
|
|
3169
|
+
* @type {Array<DataTypesEventPayload>}
|
|
3170
|
+
* @memberof ApiAnalyticsBatchPostRequest
|
|
3171
|
+
*/
|
|
3172
|
+
'events'?: Array<DataTypesEventPayload>;
|
|
3173
|
+
}
|
|
3174
|
+
/**
|
|
3175
|
+
*
|
|
3176
|
+
* @export
|
|
3177
|
+
* @interface ApiSearchHighlight
|
|
3178
|
+
*/
|
|
3179
|
+
export interface ApiSearchHighlight {
|
|
3180
|
+
/**
|
|
3181
|
+
*
|
|
3182
|
+
* @type {string}
|
|
3183
|
+
* @memberof ApiSearchHighlight
|
|
3184
|
+
*/
|
|
3185
|
+
'field'?: string;
|
|
3186
|
+
/**
|
|
3187
|
+
* Indices The indices property will be present only for string[] fields and will contain the corresponding indices of the snippets in the search field
|
|
3188
|
+
* @type {Array<number>}
|
|
3189
|
+
* @memberof ApiSearchHighlight
|
|
3190
|
+
*/
|
|
3191
|
+
'indices'?: Array<number>;
|
|
2817
3192
|
/**
|
|
2818
3193
|
*
|
|
2819
3194
|
* @type {Array<object>}
|
|
@@ -3841,6 +4216,173 @@ export interface DataTypesCreateOrganizationRequest {
|
|
|
3841
4216
|
*/
|
|
3842
4217
|
'ZipCode'?: string;
|
|
3843
4218
|
}
|
|
4219
|
+
/**
|
|
4220
|
+
*
|
|
4221
|
+
* @export
|
|
4222
|
+
* @interface DataTypesCreatePaymentOrderRequest
|
|
4223
|
+
*/
|
|
4224
|
+
export interface DataTypesCreatePaymentOrderRequest {
|
|
4225
|
+
/**
|
|
4226
|
+
* Optional for subscription/credit (uses plan price)
|
|
4227
|
+
* @type {number}
|
|
4228
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4229
|
+
*/
|
|
4230
|
+
'amount'?: number;
|
|
4231
|
+
/**
|
|
4232
|
+
*
|
|
4233
|
+
* @type {boolean}
|
|
4234
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4235
|
+
*/
|
|
4236
|
+
'auto_renewal'?: boolean;
|
|
4237
|
+
/**
|
|
4238
|
+
* Fields for credit top-up
|
|
4239
|
+
* @type {number}
|
|
4240
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4241
|
+
*/
|
|
4242
|
+
'credit_plan_id'?: number;
|
|
4243
|
+
/**
|
|
4244
|
+
*
|
|
4245
|
+
* @type {string}
|
|
4246
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4247
|
+
*/
|
|
4248
|
+
'currency': string;
|
|
4249
|
+
/**
|
|
4250
|
+
*
|
|
4251
|
+
* @type {DataTypesCustomerInfoDto}
|
|
4252
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4253
|
+
*/
|
|
4254
|
+
'customer_info': DataTypesCustomerInfoDto;
|
|
4255
|
+
/**
|
|
4256
|
+
* Optional, auto-generated if not provided
|
|
4257
|
+
* @type {string}
|
|
4258
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4259
|
+
*/
|
|
4260
|
+
'description'?: string;
|
|
4261
|
+
/**
|
|
4262
|
+
* Optional, uses default if not specified
|
|
4263
|
+
* @type {string}
|
|
4264
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4265
|
+
*/
|
|
4266
|
+
'gateway'?: string;
|
|
4267
|
+
/**
|
|
4268
|
+
*
|
|
4269
|
+
* @type {{ [key: string]: any; }}
|
|
4270
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4271
|
+
*/
|
|
4272
|
+
'metadata'?: { [key: string]: any; };
|
|
4273
|
+
/**
|
|
4274
|
+
* Fields for subscription payments
|
|
4275
|
+
* @type {number}
|
|
4276
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4277
|
+
*/
|
|
4278
|
+
'org_id'?: number;
|
|
4279
|
+
/**
|
|
4280
|
+
*
|
|
4281
|
+
* @type {string}
|
|
4282
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4283
|
+
*/
|
|
4284
|
+
'payment_method'?: string;
|
|
4285
|
+
/**
|
|
4286
|
+
*
|
|
4287
|
+
* @type {string}
|
|
4288
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4289
|
+
*/
|
|
4290
|
+
'payment_type': DataTypesCreatePaymentOrderRequestPaymentTypeEnum;
|
|
4291
|
+
/**
|
|
4292
|
+
*
|
|
4293
|
+
* @type {number}
|
|
4294
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4295
|
+
*/
|
|
4296
|
+
'plan_id'?: number;
|
|
4297
|
+
/**
|
|
4298
|
+
*
|
|
4299
|
+
* @type {string}
|
|
4300
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4301
|
+
*/
|
|
4302
|
+
'return_url'?: string;
|
|
4303
|
+
/**
|
|
4304
|
+
* Required for generic payments
|
|
4305
|
+
* @type {number}
|
|
4306
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4307
|
+
*/
|
|
4308
|
+
'subs_id'?: number;
|
|
4309
|
+
}
|
|
4310
|
+
|
|
4311
|
+
export const DataTypesCreatePaymentOrderRequestPaymentTypeEnum = {
|
|
4312
|
+
Generic: 'generic',
|
|
4313
|
+
Subscription: 'subscription',
|
|
4314
|
+
CreditTopup: 'credit_topup'
|
|
4315
|
+
} as const;
|
|
4316
|
+
|
|
4317
|
+
export type DataTypesCreatePaymentOrderRequestPaymentTypeEnum = typeof DataTypesCreatePaymentOrderRequestPaymentTypeEnum[keyof typeof DataTypesCreatePaymentOrderRequestPaymentTypeEnum];
|
|
4318
|
+
|
|
4319
|
+
/**
|
|
4320
|
+
*
|
|
4321
|
+
* @export
|
|
4322
|
+
* @interface DataTypesCreatePaymentOrderResponse
|
|
4323
|
+
*/
|
|
4324
|
+
export interface DataTypesCreatePaymentOrderResponse {
|
|
4325
|
+
/**
|
|
4326
|
+
*
|
|
4327
|
+
* @type {number}
|
|
4328
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4329
|
+
*/
|
|
4330
|
+
'amount'?: number;
|
|
4331
|
+
/**
|
|
4332
|
+
*
|
|
4333
|
+
* @type {string}
|
|
4334
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4335
|
+
*/
|
|
4336
|
+
'created_at'?: string;
|
|
4337
|
+
/**
|
|
4338
|
+
*
|
|
4339
|
+
* @type {string}
|
|
4340
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4341
|
+
*/
|
|
4342
|
+
'currency'?: string;
|
|
4343
|
+
/**
|
|
4344
|
+
*
|
|
4345
|
+
* @type {string}
|
|
4346
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4347
|
+
*/
|
|
4348
|
+
'expires_at'?: string;
|
|
4349
|
+
/**
|
|
4350
|
+
*
|
|
4351
|
+
* @type {string}
|
|
4352
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4353
|
+
*/
|
|
4354
|
+
'gateway'?: string;
|
|
4355
|
+
/**
|
|
4356
|
+
*
|
|
4357
|
+
* @type {{ [key: string]: any; }}
|
|
4358
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4359
|
+
*/
|
|
4360
|
+
'gateway_response'?: { [key: string]: any; };
|
|
4361
|
+
/**
|
|
4362
|
+
*
|
|
4363
|
+
* @type {string}
|
|
4364
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4365
|
+
*/
|
|
4366
|
+
'order_id'?: string;
|
|
4367
|
+
/**
|
|
4368
|
+
*
|
|
4369
|
+
* @type {string}
|
|
4370
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4371
|
+
*/
|
|
4372
|
+
'payment_id'?: string;
|
|
4373
|
+
/**
|
|
4374
|
+
*
|
|
4375
|
+
* @type {string}
|
|
4376
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4377
|
+
*/
|
|
4378
|
+
'payment_url'?: string;
|
|
4379
|
+
/**
|
|
4380
|
+
*
|
|
4381
|
+
* @type {string}
|
|
4382
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4383
|
+
*/
|
|
4384
|
+
'status'?: string;
|
|
4385
|
+
}
|
|
3844
4386
|
/**
|
|
3845
4387
|
*
|
|
3846
4388
|
* @export
|
|
@@ -4977,6 +5519,37 @@ export interface DataTypesCustomWordWithStatus {
|
|
|
4977
5519
|
*/
|
|
4978
5520
|
'word'?: string;
|
|
4979
5521
|
}
|
|
5522
|
+
/**
|
|
5523
|
+
*
|
|
5524
|
+
* @export
|
|
5525
|
+
* @interface DataTypesCustomerInfoDto
|
|
5526
|
+
*/
|
|
5527
|
+
export interface DataTypesCustomerInfoDto {
|
|
5528
|
+
/**
|
|
5529
|
+
*
|
|
5530
|
+
* @type {string}
|
|
5531
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5532
|
+
*/
|
|
5533
|
+
'address'?: string;
|
|
5534
|
+
/**
|
|
5535
|
+
*
|
|
5536
|
+
* @type {string}
|
|
5537
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5538
|
+
*/
|
|
5539
|
+
'email': string;
|
|
5540
|
+
/**
|
|
5541
|
+
*
|
|
5542
|
+
* @type {string}
|
|
5543
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5544
|
+
*/
|
|
5545
|
+
'name': string;
|
|
5546
|
+
/**
|
|
5547
|
+
*
|
|
5548
|
+
* @type {string}
|
|
5549
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5550
|
+
*/
|
|
5551
|
+
'phone': string;
|
|
5552
|
+
}
|
|
4980
5553
|
/**
|
|
4981
5554
|
*
|
|
4982
5555
|
* @export
|
|
@@ -5567,6 +6140,50 @@ export interface DataTypesFieldMetadata {
|
|
|
5567
6140
|
*/
|
|
5568
6141
|
'type'?: string;
|
|
5569
6142
|
}
|
|
6143
|
+
/**
|
|
6144
|
+
*
|
|
6145
|
+
* @export
|
|
6146
|
+
* @interface DataTypesGatewayInfo
|
|
6147
|
+
*/
|
|
6148
|
+
export interface DataTypesGatewayInfo {
|
|
6149
|
+
/**
|
|
6150
|
+
*
|
|
6151
|
+
* @type {Array<string>}
|
|
6152
|
+
* @memberof DataTypesGatewayInfo
|
|
6153
|
+
*/
|
|
6154
|
+
'features'?: Array<string>;
|
|
6155
|
+
/**
|
|
6156
|
+
*
|
|
6157
|
+
* @type {boolean}
|
|
6158
|
+
* @memberof DataTypesGatewayInfo
|
|
6159
|
+
*/
|
|
6160
|
+
'is_active'?: boolean;
|
|
6161
|
+
/**
|
|
6162
|
+
*
|
|
6163
|
+
* @type {boolean}
|
|
6164
|
+
* @memberof DataTypesGatewayInfo
|
|
6165
|
+
*/
|
|
6166
|
+
'is_default'?: boolean;
|
|
6167
|
+
/**
|
|
6168
|
+
*
|
|
6169
|
+
* @type {string}
|
|
6170
|
+
* @memberof DataTypesGatewayInfo
|
|
6171
|
+
*/
|
|
6172
|
+
'name'?: string;
|
|
6173
|
+
}
|
|
6174
|
+
/**
|
|
6175
|
+
*
|
|
6176
|
+
* @export
|
|
6177
|
+
* @interface DataTypesGatewayListResponse
|
|
6178
|
+
*/
|
|
6179
|
+
export interface DataTypesGatewayListResponse {
|
|
6180
|
+
/**
|
|
6181
|
+
*
|
|
6182
|
+
* @type {Array<DataTypesGatewayInfo>}
|
|
6183
|
+
* @memberof DataTypesGatewayListResponse
|
|
6184
|
+
*/
|
|
6185
|
+
'gateways'?: Array<DataTypesGatewayInfo>;
|
|
6186
|
+
}
|
|
5570
6187
|
/**
|
|
5571
6188
|
*
|
|
5572
6189
|
* @export
|
|
@@ -8130,60 +8747,121 @@ export interface DataTypesPaymentResponse {
|
|
|
8130
8747
|
/**
|
|
8131
8748
|
*
|
|
8132
8749
|
* @export
|
|
8133
|
-
* @interface
|
|
8750
|
+
* @interface DataTypesPaymentStatusResponse
|
|
8134
8751
|
*/
|
|
8135
|
-
export interface
|
|
8752
|
+
export interface DataTypesPaymentStatusResponse {
|
|
8136
8753
|
/**
|
|
8137
8754
|
*
|
|
8138
|
-
* @type {
|
|
8139
|
-
* @memberof
|
|
8755
|
+
* @type {number}
|
|
8756
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8140
8757
|
*/
|
|
8141
|
-
'
|
|
8758
|
+
'amount'?: number;
|
|
8142
8759
|
/**
|
|
8143
8760
|
*
|
|
8144
8761
|
* @type {string}
|
|
8145
|
-
* @memberof
|
|
8762
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8146
8763
|
*/
|
|
8147
|
-
'
|
|
8764
|
+
'currency'?: string;
|
|
8148
8765
|
/**
|
|
8149
8766
|
*
|
|
8150
|
-
* @type {
|
|
8151
|
-
* @memberof
|
|
8152
|
-
*/
|
|
8153
|
-
'status'?: number;
|
|
8154
|
-
}
|
|
8155
|
-
/**
|
|
8156
|
-
*
|
|
8157
|
-
* @export
|
|
8158
|
-
* @interface DataTypesPlan
|
|
8159
|
-
*/
|
|
8160
|
-
export interface DataTypesPlan {
|
|
8161
|
-
/**
|
|
8162
|
-
* JSON key remains \"BillingCycle\"
|
|
8163
|
-
* @type {number}
|
|
8164
|
-
* @memberof DataTypesPlan
|
|
8767
|
+
* @type {string}
|
|
8768
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8165
8769
|
*/
|
|
8166
|
-
'
|
|
8770
|
+
'failure_reason'?: string;
|
|
8167
8771
|
/**
|
|
8168
|
-
*
|
|
8772
|
+
*
|
|
8169
8773
|
* @type {string}
|
|
8170
|
-
* @memberof
|
|
8774
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8171
8775
|
*/
|
|
8172
|
-
'
|
|
8776
|
+
'gateway'?: string;
|
|
8173
8777
|
/**
|
|
8174
|
-
*
|
|
8175
|
-
* @type {
|
|
8176
|
-
* @memberof
|
|
8778
|
+
*
|
|
8779
|
+
* @type {{ [key: string]: any; }}
|
|
8780
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8177
8781
|
*/
|
|
8178
|
-
'
|
|
8782
|
+
'gateway_data'?: { [key: string]: any; };
|
|
8179
8783
|
/**
|
|
8180
|
-
*
|
|
8181
|
-
* @type {
|
|
8182
|
-
* @memberof
|
|
8784
|
+
*
|
|
8785
|
+
* @type {string}
|
|
8786
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8183
8787
|
*/
|
|
8184
|
-
'
|
|
8788
|
+
'order_id'?: string;
|
|
8185
8789
|
/**
|
|
8186
|
-
*
|
|
8790
|
+
*
|
|
8791
|
+
* @type {string}
|
|
8792
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8793
|
+
*/
|
|
8794
|
+
'payment_id'?: string;
|
|
8795
|
+
/**
|
|
8796
|
+
*
|
|
8797
|
+
* @type {string}
|
|
8798
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8799
|
+
*/
|
|
8800
|
+
'status'?: string;
|
|
8801
|
+
/**
|
|
8802
|
+
*
|
|
8803
|
+
* @type {string}
|
|
8804
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8805
|
+
*/
|
|
8806
|
+
'updated_at'?: string;
|
|
8807
|
+
}
|
|
8808
|
+
/**
|
|
8809
|
+
*
|
|
8810
|
+
* @export
|
|
8811
|
+
* @interface DataTypesPaymentsListResponse
|
|
8812
|
+
*/
|
|
8813
|
+
export interface DataTypesPaymentsListResponse {
|
|
8814
|
+
/**
|
|
8815
|
+
*
|
|
8816
|
+
* @type {Array<DataTypesPayment>}
|
|
8817
|
+
* @memberof DataTypesPaymentsListResponse
|
|
8818
|
+
*/
|
|
8819
|
+
'data'?: Array<DataTypesPayment>;
|
|
8820
|
+
/**
|
|
8821
|
+
*
|
|
8822
|
+
* @type {string}
|
|
8823
|
+
* @memberof DataTypesPaymentsListResponse
|
|
8824
|
+
*/
|
|
8825
|
+
'message'?: string;
|
|
8826
|
+
/**
|
|
8827
|
+
*
|
|
8828
|
+
* @type {number}
|
|
8829
|
+
* @memberof DataTypesPaymentsListResponse
|
|
8830
|
+
*/
|
|
8831
|
+
'status'?: number;
|
|
8832
|
+
}
|
|
8833
|
+
/**
|
|
8834
|
+
*
|
|
8835
|
+
* @export
|
|
8836
|
+
* @interface DataTypesPlan
|
|
8837
|
+
*/
|
|
8838
|
+
export interface DataTypesPlan {
|
|
8839
|
+
/**
|
|
8840
|
+
* JSON key remains \"BillingCycle\"
|
|
8841
|
+
* @type {number}
|
|
8842
|
+
* @memberof DataTypesPlan
|
|
8843
|
+
*/
|
|
8844
|
+
'BillingCycle'?: number;
|
|
8845
|
+
/**
|
|
8846
|
+
* JSON key remains \"CreatedAt\"
|
|
8847
|
+
* @type {string}
|
|
8848
|
+
* @memberof DataTypesPlan
|
|
8849
|
+
*/
|
|
8850
|
+
'CreatedAt'?: string;
|
|
8851
|
+
/**
|
|
8852
|
+
* JSON key remains \"CreatedBy\", can be NULL
|
|
8853
|
+
* @type {number}
|
|
8854
|
+
* @memberof DataTypesPlan
|
|
8855
|
+
*/
|
|
8856
|
+
'CreatedBy'?: number;
|
|
8857
|
+
/**
|
|
8858
|
+
* JSON key remains \"IsActive\"
|
|
8859
|
+
* @type {boolean}
|
|
8860
|
+
* @memberof DataTypesPlan
|
|
8861
|
+
*/
|
|
8862
|
+
'IsActive'?: boolean;
|
|
8863
|
+
/**
|
|
8864
|
+
* JSON key remains \"ModifiedAt\"
|
|
8187
8865
|
* @type {string}
|
|
8188
8866
|
* @memberof DataTypesPlan
|
|
8189
8867
|
*/
|
|
@@ -8650,6 +9328,92 @@ export interface DataTypesPurchaseCreditsResponse {
|
|
|
8650
9328
|
*/
|
|
8651
9329
|
'updated_balance'?: DataTypesCreditBalance;
|
|
8652
9330
|
}
|
|
9331
|
+
/**
|
|
9332
|
+
*
|
|
9333
|
+
* @export
|
|
9334
|
+
* @interface DataTypesRefundRequestDto
|
|
9335
|
+
*/
|
|
9336
|
+
export interface DataTypesRefundRequestDto {
|
|
9337
|
+
/**
|
|
9338
|
+
*
|
|
9339
|
+
* @type {number}
|
|
9340
|
+
* @memberof DataTypesRefundRequestDto
|
|
9341
|
+
*/
|
|
9342
|
+
'amount': number;
|
|
9343
|
+
/**
|
|
9344
|
+
*
|
|
9345
|
+
* @type {string}
|
|
9346
|
+
* @memberof DataTypesRefundRequestDto
|
|
9347
|
+
*/
|
|
9348
|
+
'gateway': string;
|
|
9349
|
+
/**
|
|
9350
|
+
*
|
|
9351
|
+
* @type {{ [key: string]: any; }}
|
|
9352
|
+
* @memberof DataTypesRefundRequestDto
|
|
9353
|
+
*/
|
|
9354
|
+
'metadata'?: { [key: string]: any; };
|
|
9355
|
+
/**
|
|
9356
|
+
*
|
|
9357
|
+
* @type {string}
|
|
9358
|
+
* @memberof DataTypesRefundRequestDto
|
|
9359
|
+
*/
|
|
9360
|
+
'payment_id': string;
|
|
9361
|
+
/**
|
|
9362
|
+
*
|
|
9363
|
+
* @type {string}
|
|
9364
|
+
* @memberof DataTypesRefundRequestDto
|
|
9365
|
+
*/
|
|
9366
|
+
'reason': string;
|
|
9367
|
+
}
|
|
9368
|
+
/**
|
|
9369
|
+
*
|
|
9370
|
+
* @export
|
|
9371
|
+
* @interface DataTypesRefundResponseDto
|
|
9372
|
+
*/
|
|
9373
|
+
export interface DataTypesRefundResponseDto {
|
|
9374
|
+
/**
|
|
9375
|
+
*
|
|
9376
|
+
* @type {number}
|
|
9377
|
+
* @memberof DataTypesRefundResponseDto
|
|
9378
|
+
*/
|
|
9379
|
+
'amount'?: number;
|
|
9380
|
+
/**
|
|
9381
|
+
*
|
|
9382
|
+
* @type {string}
|
|
9383
|
+
* @memberof DataTypesRefundResponseDto
|
|
9384
|
+
*/
|
|
9385
|
+
'created_at'?: string;
|
|
9386
|
+
/**
|
|
9387
|
+
*
|
|
9388
|
+
* @type {string}
|
|
9389
|
+
* @memberof DataTypesRefundResponseDto
|
|
9390
|
+
*/
|
|
9391
|
+
'gateway'?: string;
|
|
9392
|
+
/**
|
|
9393
|
+
*
|
|
9394
|
+
* @type {{ [key: string]: any; }}
|
|
9395
|
+
* @memberof DataTypesRefundResponseDto
|
|
9396
|
+
*/
|
|
9397
|
+
'gateway_response'?: { [key: string]: any; };
|
|
9398
|
+
/**
|
|
9399
|
+
*
|
|
9400
|
+
* @type {string}
|
|
9401
|
+
* @memberof DataTypesRefundResponseDto
|
|
9402
|
+
*/
|
|
9403
|
+
'payment_id'?: string;
|
|
9404
|
+
/**
|
|
9405
|
+
*
|
|
9406
|
+
* @type {string}
|
|
9407
|
+
* @memberof DataTypesRefundResponseDto
|
|
9408
|
+
*/
|
|
9409
|
+
'refund_id'?: string;
|
|
9410
|
+
/**
|
|
9411
|
+
*
|
|
9412
|
+
* @type {string}
|
|
9413
|
+
* @memberof DataTypesRefundResponseDto
|
|
9414
|
+
*/
|
|
9415
|
+
'status'?: string;
|
|
9416
|
+
}
|
|
8653
9417
|
/**
|
|
8654
9418
|
*
|
|
8655
9419
|
* @export
|
|
@@ -11100,6 +11864,25 @@ export interface DataTypesVerifyOTPResponseWrapper {
|
|
|
11100
11864
|
*/
|
|
11101
11865
|
'status'?: number;
|
|
11102
11866
|
}
|
|
11867
|
+
/**
|
|
11868
|
+
*
|
|
11869
|
+
* @export
|
|
11870
|
+
* @interface DataTypesVerifyPaymentRequest
|
|
11871
|
+
*/
|
|
11872
|
+
export interface DataTypesVerifyPaymentRequest {
|
|
11873
|
+
/**
|
|
11874
|
+
*
|
|
11875
|
+
* @type {string}
|
|
11876
|
+
* @memberof DataTypesVerifyPaymentRequest
|
|
11877
|
+
*/
|
|
11878
|
+
'gateway': string;
|
|
11879
|
+
/**
|
|
11880
|
+
*
|
|
11881
|
+
* @type {string}
|
|
11882
|
+
* @memberof DataTypesVerifyPaymentRequest
|
|
11883
|
+
*/
|
|
11884
|
+
'payment_id': string;
|
|
11885
|
+
}
|
|
11103
11886
|
/**
|
|
11104
11887
|
*
|
|
11105
11888
|
* @export
|
|
@@ -12981,7 +13764,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
12981
13764
|
};
|
|
12982
13765
|
},
|
|
12983
13766
|
/**
|
|
12984
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
13767
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
12985
13768
|
* @summary Get Geographic Analytics
|
|
12986
13769
|
* @param {string} xStoreID Store ID
|
|
12987
13770
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12992,6 +13775,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
12992
13775
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12993
13776
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12994
13777
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13778
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13779
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13780
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13781
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13782
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13783
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13784
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13785
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12995
13786
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12996
13787
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12997
13788
|
* @param {number} [page] Page number for pagination
|
|
@@ -13002,7 +13793,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13002
13793
|
* @param {*} [options] Override http request option.
|
|
13003
13794
|
* @throws {RequiredError}
|
|
13004
13795
|
*/
|
|
13005
|
-
adminAnalyticsStoreXStoreIDGeoGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13796
|
+
adminAnalyticsStoreXStoreIDGeoGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13006
13797
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
13007
13798
|
assertParamExists('adminAnalyticsStoreXStoreIDGeoGet', 'xStoreID', xStoreID)
|
|
13008
13799
|
const localVarPath = `/admin/analytics/store/{xStoreID}/geo`
|
|
@@ -13053,6 +13844,38 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13053
13844
|
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
13054
13845
|
}
|
|
13055
13846
|
|
|
13847
|
+
if (compareMode !== undefined) {
|
|
13848
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
13849
|
+
}
|
|
13850
|
+
|
|
13851
|
+
if (compareStartTime !== undefined) {
|
|
13852
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
13853
|
+
}
|
|
13854
|
+
|
|
13855
|
+
if (compareEndTime !== undefined) {
|
|
13856
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
13857
|
+
}
|
|
13858
|
+
|
|
13859
|
+
if (compareAnalyticsTags !== undefined) {
|
|
13860
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
13861
|
+
}
|
|
13862
|
+
|
|
13863
|
+
if (compareTagsMatchMode !== undefined) {
|
|
13864
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
13865
|
+
}
|
|
13866
|
+
|
|
13867
|
+
if (compareTagsExclude !== undefined) {
|
|
13868
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
13869
|
+
}
|
|
13870
|
+
|
|
13871
|
+
if (compareTagKeyFilter !== undefined) {
|
|
13872
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
13873
|
+
}
|
|
13874
|
+
|
|
13875
|
+
if (compareTagValueFilter !== undefined) {
|
|
13876
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
13877
|
+
}
|
|
13878
|
+
|
|
13056
13879
|
if (limit !== undefined) {
|
|
13057
13880
|
localVarQueryParameter['limit'] = limit;
|
|
13058
13881
|
}
|
|
@@ -13130,7 +13953,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13130
13953
|
};
|
|
13131
13954
|
},
|
|
13132
13955
|
/**
|
|
13133
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
13956
|
+
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators and comparison mode between different timelines and tag sets.
|
|
13134
13957
|
* @summary Get KPI Analytics
|
|
13135
13958
|
* @param {string} xStoreID Store ID
|
|
13136
13959
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -13141,6 +13964,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13141
13964
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13142
13965
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13143
13966
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13967
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13968
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13969
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13970
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13971
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13972
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13973
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13974
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13144
13975
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13145
13976
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13146
13977
|
* @param {number} [page] Page number for pagination
|
|
@@ -13148,7 +13979,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13148
13979
|
* @param {*} [options] Override http request option.
|
|
13149
13980
|
* @throws {RequiredError}
|
|
13150
13981
|
*/
|
|
13151
|
-
adminAnalyticsStoreXStoreIDKpiGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13982
|
+
adminAnalyticsStoreXStoreIDKpiGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13152
13983
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
13153
13984
|
assertParamExists('adminAnalyticsStoreXStoreIDKpiGet', 'xStoreID', xStoreID)
|
|
13154
13985
|
const localVarPath = `/admin/analytics/store/{xStoreID}/kpi`
|
|
@@ -13199,6 +14030,38 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13199
14030
|
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
13200
14031
|
}
|
|
13201
14032
|
|
|
14033
|
+
if (compareMode !== undefined) {
|
|
14034
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
14035
|
+
}
|
|
14036
|
+
|
|
14037
|
+
if (compareStartTime !== undefined) {
|
|
14038
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
14039
|
+
}
|
|
14040
|
+
|
|
14041
|
+
if (compareEndTime !== undefined) {
|
|
14042
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
14043
|
+
}
|
|
14044
|
+
|
|
14045
|
+
if (compareAnalyticsTags !== undefined) {
|
|
14046
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
14047
|
+
}
|
|
14048
|
+
|
|
14049
|
+
if (compareTagsMatchMode !== undefined) {
|
|
14050
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
14051
|
+
}
|
|
14052
|
+
|
|
14053
|
+
if (compareTagsExclude !== undefined) {
|
|
14054
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
14055
|
+
}
|
|
14056
|
+
|
|
14057
|
+
if (compareTagKeyFilter !== undefined) {
|
|
14058
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
14059
|
+
}
|
|
14060
|
+
|
|
14061
|
+
if (compareTagValueFilter !== undefined) {
|
|
14062
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
14063
|
+
}
|
|
14064
|
+
|
|
13202
14065
|
if (limit !== undefined) {
|
|
13203
14066
|
localVarQueryParameter['limit'] = limit;
|
|
13204
14067
|
}
|
|
@@ -13264,7 +14127,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13264
14127
|
};
|
|
13265
14128
|
},
|
|
13266
14129
|
/**
|
|
13267
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
14130
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
13268
14131
|
* @summary Get Query Analytics
|
|
13269
14132
|
* @param {string} xStoreID Store ID
|
|
13270
14133
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -13276,6 +14139,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13276
14139
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13277
14140
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13278
14141
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14142
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14143
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14144
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14145
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14146
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14147
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14148
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14149
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13279
14150
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13280
14151
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13281
14152
|
* @param {number} [page] Page number for pagination
|
|
@@ -13287,7 +14158,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13287
14158
|
* @param {*} [options] Override http request option.
|
|
13288
14159
|
* @throws {RequiredError}
|
|
13289
14160
|
*/
|
|
13290
|
-
adminAnalyticsStoreXStoreIDQueriesGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14161
|
+
adminAnalyticsStoreXStoreIDQueriesGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13291
14162
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
13292
14163
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesGet', 'xStoreID', xStoreID)
|
|
13293
14164
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries`
|
|
@@ -13342,6 +14213,38 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13342
14213
|
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
13343
14214
|
}
|
|
13344
14215
|
|
|
14216
|
+
if (compareMode !== undefined) {
|
|
14217
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
14218
|
+
}
|
|
14219
|
+
|
|
14220
|
+
if (compareStartTime !== undefined) {
|
|
14221
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
14222
|
+
}
|
|
14223
|
+
|
|
14224
|
+
if (compareEndTime !== undefined) {
|
|
14225
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
14226
|
+
}
|
|
14227
|
+
|
|
14228
|
+
if (compareAnalyticsTags !== undefined) {
|
|
14229
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
14230
|
+
}
|
|
14231
|
+
|
|
14232
|
+
if (compareTagsMatchMode !== undefined) {
|
|
14233
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
14234
|
+
}
|
|
14235
|
+
|
|
14236
|
+
if (compareTagsExclude !== undefined) {
|
|
14237
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
14238
|
+
}
|
|
14239
|
+
|
|
14240
|
+
if (compareTagKeyFilter !== undefined) {
|
|
14241
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
14242
|
+
}
|
|
14243
|
+
|
|
14244
|
+
if (compareTagValueFilter !== undefined) {
|
|
14245
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
14246
|
+
}
|
|
14247
|
+
|
|
13345
14248
|
if (limit !== undefined) {
|
|
13346
14249
|
localVarQueryParameter['limit'] = limit;
|
|
13347
14250
|
}
|
|
@@ -13386,11 +14289,25 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13386
14289
|
};
|
|
13387
14290
|
},
|
|
13388
14291
|
/**
|
|
13389
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
14292
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
13390
14293
|
* @summary Get No-Clicks Queries
|
|
13391
14294
|
* @param {string} xStoreID Store ID
|
|
13392
14295
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13393
14296
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14297
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
14298
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
14299
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
14300
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14301
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14302
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14303
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14304
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14305
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14306
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14307
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14308
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14309
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14310
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13394
14311
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13395
14312
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13396
14313
|
* @param {number} [page] Page number for pagination
|
|
@@ -13401,7 +14318,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13401
14318
|
* @param {*} [options] Override http request option.
|
|
13402
14319
|
* @throws {RequiredError}
|
|
13403
14320
|
*/
|
|
13404
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet: async (xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14321
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet: async (xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13405
14322
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
13406
14323
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoClicksGet', 'xStoreID', xStoreID)
|
|
13407
14324
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-clicks`
|
|
@@ -13428,6 +14345,62 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13428
14345
|
localVarQueryParameter['end_time'] = endTime;
|
|
13429
14346
|
}
|
|
13430
14347
|
|
|
14348
|
+
if (search !== undefined) {
|
|
14349
|
+
localVarQueryParameter['search'] = search;
|
|
14350
|
+
}
|
|
14351
|
+
|
|
14352
|
+
if (analyticsTags !== undefined) {
|
|
14353
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
14354
|
+
}
|
|
14355
|
+
|
|
14356
|
+
if (tagsMatchMode !== undefined) {
|
|
14357
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
14358
|
+
}
|
|
14359
|
+
|
|
14360
|
+
if (tagsExclude !== undefined) {
|
|
14361
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
14362
|
+
}
|
|
14363
|
+
|
|
14364
|
+
if (tagKeyFilter !== undefined) {
|
|
14365
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
14366
|
+
}
|
|
14367
|
+
|
|
14368
|
+
if (tagValueFilter !== undefined) {
|
|
14369
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
14370
|
+
}
|
|
14371
|
+
|
|
14372
|
+
if (compareMode !== undefined) {
|
|
14373
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
14374
|
+
}
|
|
14375
|
+
|
|
14376
|
+
if (compareStartTime !== undefined) {
|
|
14377
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
14378
|
+
}
|
|
14379
|
+
|
|
14380
|
+
if (compareEndTime !== undefined) {
|
|
14381
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
14382
|
+
}
|
|
14383
|
+
|
|
14384
|
+
if (compareAnalyticsTags !== undefined) {
|
|
14385
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
14386
|
+
}
|
|
14387
|
+
|
|
14388
|
+
if (compareTagsMatchMode !== undefined) {
|
|
14389
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
14390
|
+
}
|
|
14391
|
+
|
|
14392
|
+
if (compareTagsExclude !== undefined) {
|
|
14393
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
14394
|
+
}
|
|
14395
|
+
|
|
14396
|
+
if (compareTagKeyFilter !== undefined) {
|
|
14397
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
14398
|
+
}
|
|
14399
|
+
|
|
14400
|
+
if (compareTagValueFilter !== undefined) {
|
|
14401
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
14402
|
+
}
|
|
14403
|
+
|
|
13431
14404
|
if (limit !== undefined) {
|
|
13432
14405
|
localVarQueryParameter['limit'] = limit;
|
|
13433
14406
|
}
|
|
@@ -13468,11 +14441,25 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13468
14441
|
};
|
|
13469
14442
|
},
|
|
13470
14443
|
/**
|
|
13471
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
14444
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
13472
14445
|
* @summary Get No-Results Queries
|
|
13473
14446
|
* @param {string} xStoreID Store ID
|
|
13474
14447
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13475
14448
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14449
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
14450
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
14451
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
14452
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14453
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14454
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14455
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14456
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14457
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14458
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14459
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14460
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14461
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14462
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13476
14463
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13477
14464
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13478
14465
|
* @param {number} [page] Page number for pagination
|
|
@@ -13483,7 +14470,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13483
14470
|
* @param {*} [options] Override http request option.
|
|
13484
14471
|
* @throws {RequiredError}
|
|
13485
14472
|
*/
|
|
13486
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: async (xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14473
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: async (xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13487
14474
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
13488
14475
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoResultsGet', 'xStoreID', xStoreID)
|
|
13489
14476
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-results`
|
|
@@ -13510,16 +14497,72 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13510
14497
|
localVarQueryParameter['end_time'] = endTime;
|
|
13511
14498
|
}
|
|
13512
14499
|
|
|
13513
|
-
if (
|
|
13514
|
-
localVarQueryParameter['
|
|
14500
|
+
if (search !== undefined) {
|
|
14501
|
+
localVarQueryParameter['search'] = search;
|
|
13515
14502
|
}
|
|
13516
14503
|
|
|
13517
|
-
if (
|
|
13518
|
-
localVarQueryParameter['
|
|
14504
|
+
if (analyticsTags !== undefined) {
|
|
14505
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
13519
14506
|
}
|
|
13520
14507
|
|
|
13521
|
-
if (
|
|
13522
|
-
localVarQueryParameter['
|
|
14508
|
+
if (tagsMatchMode !== undefined) {
|
|
14509
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
14510
|
+
}
|
|
14511
|
+
|
|
14512
|
+
if (tagsExclude !== undefined) {
|
|
14513
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
14514
|
+
}
|
|
14515
|
+
|
|
14516
|
+
if (tagKeyFilter !== undefined) {
|
|
14517
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
14518
|
+
}
|
|
14519
|
+
|
|
14520
|
+
if (tagValueFilter !== undefined) {
|
|
14521
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
14522
|
+
}
|
|
14523
|
+
|
|
14524
|
+
if (compareMode !== undefined) {
|
|
14525
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
14526
|
+
}
|
|
14527
|
+
|
|
14528
|
+
if (compareStartTime !== undefined) {
|
|
14529
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
14530
|
+
}
|
|
14531
|
+
|
|
14532
|
+
if (compareEndTime !== undefined) {
|
|
14533
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
14534
|
+
}
|
|
14535
|
+
|
|
14536
|
+
if (compareAnalyticsTags !== undefined) {
|
|
14537
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
14538
|
+
}
|
|
14539
|
+
|
|
14540
|
+
if (compareTagsMatchMode !== undefined) {
|
|
14541
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
14542
|
+
}
|
|
14543
|
+
|
|
14544
|
+
if (compareTagsExclude !== undefined) {
|
|
14545
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
14546
|
+
}
|
|
14547
|
+
|
|
14548
|
+
if (compareTagKeyFilter !== undefined) {
|
|
14549
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
14550
|
+
}
|
|
14551
|
+
|
|
14552
|
+
if (compareTagValueFilter !== undefined) {
|
|
14553
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
14554
|
+
}
|
|
14555
|
+
|
|
14556
|
+
if (limit !== undefined) {
|
|
14557
|
+
localVarQueryParameter['limit'] = limit;
|
|
14558
|
+
}
|
|
14559
|
+
|
|
14560
|
+
if (offset !== undefined) {
|
|
14561
|
+
localVarQueryParameter['offset'] = offset;
|
|
14562
|
+
}
|
|
14563
|
+
|
|
14564
|
+
if (page !== undefined) {
|
|
14565
|
+
localVarQueryParameter['page'] = page;
|
|
13523
14566
|
}
|
|
13524
14567
|
|
|
13525
14568
|
if (pageSize !== undefined) {
|
|
@@ -13601,17 +14644,31 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13601
14644
|
};
|
|
13602
14645
|
},
|
|
13603
14646
|
/**
|
|
13604
|
-
* Retrieve analytics for top performing search results with
|
|
14647
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
13605
14648
|
* @summary Get Top Results Analytics
|
|
13606
14649
|
* @param {string} xStoreID Store ID
|
|
13607
14650
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13608
14651
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13609
14652
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
14653
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
14654
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
14655
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14656
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14657
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14658
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14659
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14660
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14661
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14662
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14663
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14664
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14665
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13610
14666
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
13611
14667
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
13612
14668
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
13613
14669
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
13614
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
14670
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
14671
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
13615
14672
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13616
14673
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13617
14674
|
* @param {number} [page] Page number for pagination
|
|
@@ -13619,7 +14676,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13619
14676
|
* @param {*} [options] Override http request option.
|
|
13620
14677
|
* @throws {RequiredError}
|
|
13621
14678
|
*/
|
|
13622
|
-
adminAnalyticsStoreXStoreIDResultsGet: async (xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14679
|
+
adminAnalyticsStoreXStoreIDResultsGet: async (xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13623
14680
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
13624
14681
|
assertParamExists('adminAnalyticsStoreXStoreIDResultsGet', 'xStoreID', xStoreID)
|
|
13625
14682
|
const localVarPath = `/admin/analytics/store/{xStoreID}/results`
|
|
@@ -13650,6 +14707,58 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13650
14707
|
localVarQueryParameter['item_ids'] = itemIds;
|
|
13651
14708
|
}
|
|
13652
14709
|
|
|
14710
|
+
if (analyticsTags !== undefined) {
|
|
14711
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
14712
|
+
}
|
|
14713
|
+
|
|
14714
|
+
if (tagsMatchMode !== undefined) {
|
|
14715
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
14716
|
+
}
|
|
14717
|
+
|
|
14718
|
+
if (tagsExclude !== undefined) {
|
|
14719
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
14720
|
+
}
|
|
14721
|
+
|
|
14722
|
+
if (tagKeyFilter !== undefined) {
|
|
14723
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
14724
|
+
}
|
|
14725
|
+
|
|
14726
|
+
if (tagValueFilter !== undefined) {
|
|
14727
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
14728
|
+
}
|
|
14729
|
+
|
|
14730
|
+
if (compareMode !== undefined) {
|
|
14731
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
14732
|
+
}
|
|
14733
|
+
|
|
14734
|
+
if (compareStartTime !== undefined) {
|
|
14735
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
14736
|
+
}
|
|
14737
|
+
|
|
14738
|
+
if (compareEndTime !== undefined) {
|
|
14739
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
14740
|
+
}
|
|
14741
|
+
|
|
14742
|
+
if (compareAnalyticsTags !== undefined) {
|
|
14743
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
14744
|
+
}
|
|
14745
|
+
|
|
14746
|
+
if (compareTagsMatchMode !== undefined) {
|
|
14747
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
14748
|
+
}
|
|
14749
|
+
|
|
14750
|
+
if (compareTagsExclude !== undefined) {
|
|
14751
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
14752
|
+
}
|
|
14753
|
+
|
|
14754
|
+
if (compareTagKeyFilter !== undefined) {
|
|
14755
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
14756
|
+
}
|
|
14757
|
+
|
|
14758
|
+
if (compareTagValueFilter !== undefined) {
|
|
14759
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
14760
|
+
}
|
|
14761
|
+
|
|
13653
14762
|
if (minImpressions !== undefined) {
|
|
13654
14763
|
localVarQueryParameter['min_impressions'] = minImpressions;
|
|
13655
14764
|
}
|
|
@@ -13670,6 +14779,10 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13670
14779
|
localVarQueryParameter['include_documents'] = includeDocuments;
|
|
13671
14780
|
}
|
|
13672
14781
|
|
|
14782
|
+
if (includeWidget !== undefined) {
|
|
14783
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
14784
|
+
}
|
|
14785
|
+
|
|
13673
14786
|
if (limit !== undefined) {
|
|
13674
14787
|
localVarQueryParameter['limit'] = limit;
|
|
13675
14788
|
}
|
|
@@ -14009,7 +15122,7 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14009
15122
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14010
15123
|
},
|
|
14011
15124
|
/**
|
|
14012
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
15125
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
14013
15126
|
* @summary Get Geographic Analytics
|
|
14014
15127
|
* @param {string} xStoreID Store ID
|
|
14015
15128
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -14020,6 +15133,14 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14020
15133
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14021
15134
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14022
15135
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15136
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15137
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15138
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15139
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15140
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15141
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15142
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15143
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14023
15144
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14024
15145
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14025
15146
|
* @param {number} [page] Page number for pagination
|
|
@@ -14030,8 +15151,8 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14030
15151
|
* @param {*} [options] Override http request option.
|
|
14031
15152
|
* @throws {RequiredError}
|
|
14032
15153
|
*/
|
|
14033
|
-
async adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDGeoGet200Response>> {
|
|
14034
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
15154
|
+
async adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDGeoGet200Response>> {
|
|
15155
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
14035
15156
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14036
15157
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDGeoGet']?.[localVarOperationServerIndex]?.url;
|
|
14037
15158
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -14050,7 +15171,7 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14050
15171
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14051
15172
|
},
|
|
14052
15173
|
/**
|
|
14053
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
15174
|
+
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators and comparison mode between different timelines and tag sets.
|
|
14054
15175
|
* @summary Get KPI Analytics
|
|
14055
15176
|
* @param {string} xStoreID Store ID
|
|
14056
15177
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -14061,6 +15182,14 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14061
15182
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14062
15183
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14063
15184
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15185
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15186
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15187
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15188
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15189
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15190
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15191
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15192
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14064
15193
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14065
15194
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14066
15195
|
* @param {number} [page] Page number for pagination
|
|
@@ -14068,8 +15197,8 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14068
15197
|
* @param {*} [options] Override http request option.
|
|
14069
15198
|
* @throws {RequiredError}
|
|
14070
15199
|
*/
|
|
14071
|
-
async adminAnalyticsStoreXStoreIDKpiGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDKpiGet200Response>> {
|
|
14072
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options);
|
|
15200
|
+
async adminAnalyticsStoreXStoreIDKpiGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDKpiGet200Response>> {
|
|
15201
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options);
|
|
14073
15202
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14074
15203
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDKpiGet']?.[localVarOperationServerIndex]?.url;
|
|
14075
15204
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -14088,7 +15217,7 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14088
15217
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14089
15218
|
},
|
|
14090
15219
|
/**
|
|
14091
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
15220
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
14092
15221
|
* @summary Get Query Analytics
|
|
14093
15222
|
* @param {string} xStoreID Store ID
|
|
14094
15223
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -14100,6 +15229,14 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14100
15229
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14101
15230
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14102
15231
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15232
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15233
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15234
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15235
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15236
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15237
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15238
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15239
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14103
15240
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14104
15241
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14105
15242
|
* @param {number} [page] Page number for pagination
|
|
@@ -14111,18 +15248,32 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14111
15248
|
* @param {*} [options] Override http request option.
|
|
14112
15249
|
* @throws {RequiredError}
|
|
14113
15250
|
*/
|
|
14114
|
-
async adminAnalyticsStoreXStoreIDQueriesGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesGet200Response>> {
|
|
14115
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options);
|
|
15251
|
+
async adminAnalyticsStoreXStoreIDQueriesGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesGet200Response>> {
|
|
15252
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options);
|
|
14116
15253
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14117
15254
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesGet']?.[localVarOperationServerIndex]?.url;
|
|
14118
15255
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14119
15256
|
},
|
|
14120
15257
|
/**
|
|
14121
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
15258
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
14122
15259
|
* @summary Get No-Clicks Queries
|
|
14123
15260
|
* @param {string} xStoreID Store ID
|
|
14124
15261
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14125
15262
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15263
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
15264
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15265
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15266
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15267
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15268
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15269
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15270
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15271
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15272
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15273
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15274
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15275
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15276
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14126
15277
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14127
15278
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14128
15279
|
* @param {number} [page] Page number for pagination
|
|
@@ -14133,18 +15284,32 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14133
15284
|
* @param {*} [options] Override http request option.
|
|
14134
15285
|
* @throws {RequiredError}
|
|
14135
15286
|
*/
|
|
14136
|
-
async adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>> {
|
|
14137
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
15287
|
+
async adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>> {
|
|
15288
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
14138
15289
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14139
15290
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoClicksGet']?.[localVarOperationServerIndex]?.url;
|
|
14140
15291
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14141
15292
|
},
|
|
14142
15293
|
/**
|
|
14143
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
15294
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
14144
15295
|
* @summary Get No-Results Queries
|
|
14145
15296
|
* @param {string} xStoreID Store ID
|
|
14146
15297
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14147
15298
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15299
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
15300
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15301
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15302
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15303
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15304
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15305
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15306
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15307
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15308
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15309
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15310
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15311
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15312
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14148
15313
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14149
15314
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14150
15315
|
* @param {number} [page] Page number for pagination
|
|
@@ -14155,8 +15320,8 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14155
15320
|
* @param {*} [options] Override http request option.
|
|
14156
15321
|
* @throws {RequiredError}
|
|
14157
15322
|
*/
|
|
14158
|
-
async adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>> {
|
|
14159
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
15323
|
+
async adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>> {
|
|
15324
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
14160
15325
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14161
15326
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoResultsGet']?.[localVarOperationServerIndex]?.url;
|
|
14162
15327
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -14178,17 +15343,31 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14178
15343
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14179
15344
|
},
|
|
14180
15345
|
/**
|
|
14181
|
-
* Retrieve analytics for top performing search results with
|
|
15346
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
14182
15347
|
* @summary Get Top Results Analytics
|
|
14183
15348
|
* @param {string} xStoreID Store ID
|
|
14184
15349
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14185
15350
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14186
15351
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
15352
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15353
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15354
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15355
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15356
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15357
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15358
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15359
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15360
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15361
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15362
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15363
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15364
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14187
15365
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
14188
15366
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
14189
15367
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
14190
15368
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
14191
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
15369
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
15370
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
14192
15371
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14193
15372
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14194
15373
|
* @param {number} [page] Page number for pagination
|
|
@@ -14196,8 +15375,8 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14196
15375
|
* @param {*} [options] Override http request option.
|
|
14197
15376
|
* @throws {RequiredError}
|
|
14198
15377
|
*/
|
|
14199
|
-
async adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response>> {
|
|
14200
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options);
|
|
15378
|
+
async adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response>> {
|
|
15379
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options);
|
|
14201
15380
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14202
15381
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDResultsGet']?.[localVarOperationServerIndex]?.url;
|
|
14203
15382
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -14366,7 +15545,7 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
14366
15545
|
return localVarFp.adminAnalyticsStoreXStoreIDFiltersTrendsGet(xStoreID, startTime, endTime, granularity, filterKey, topFilters, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
14367
15546
|
},
|
|
14368
15547
|
/**
|
|
14369
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
15548
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
14370
15549
|
* @summary Get Geographic Analytics
|
|
14371
15550
|
* @param {string} xStoreID Store ID
|
|
14372
15551
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -14377,6 +15556,14 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
14377
15556
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14378
15557
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14379
15558
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15559
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15560
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15561
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15562
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15563
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15564
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15565
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15566
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14380
15567
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14381
15568
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14382
15569
|
* @param {number} [page] Page number for pagination
|
|
@@ -14387,8 +15574,8 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
14387
15574
|
* @param {*} [options] Override http request option.
|
|
14388
15575
|
* @throws {RequiredError}
|
|
14389
15576
|
*/
|
|
14390
|
-
adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDGeoGet200Response> {
|
|
14391
|
-
return localVarFp.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
15577
|
+
adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDGeoGet200Response> {
|
|
15578
|
+
return localVarFp.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
14392
15579
|
},
|
|
14393
15580
|
/**
|
|
14394
15581
|
* Check the health status of analytics service and ClickHouse connection
|
|
@@ -14401,7 +15588,7 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
14401
15588
|
return localVarFp.adminAnalyticsStoreXStoreIDHealthGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
14402
15589
|
},
|
|
14403
15590
|
/**
|
|
14404
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
15591
|
+
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators and comparison mode between different timelines and tag sets.
|
|
14405
15592
|
* @summary Get KPI Analytics
|
|
14406
15593
|
* @param {string} xStoreID Store ID
|
|
14407
15594
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -14412,6 +15599,14 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
14412
15599
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14413
15600
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14414
15601
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15602
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15603
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15604
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15605
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15606
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15607
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15608
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15609
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14415
15610
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14416
15611
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14417
15612
|
* @param {number} [page] Page number for pagination
|
|
@@ -14419,8 +15614,8 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
14419
15614
|
* @param {*} [options] Override http request option.
|
|
14420
15615
|
* @throws {RequiredError}
|
|
14421
15616
|
*/
|
|
14422
|
-
adminAnalyticsStoreXStoreIDKpiGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDKpiGet200Response> {
|
|
14423
|
-
return localVarFp.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
15617
|
+
adminAnalyticsStoreXStoreIDKpiGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDKpiGet200Response> {
|
|
15618
|
+
return localVarFp.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
14424
15619
|
},
|
|
14425
15620
|
/**
|
|
14426
15621
|
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
@@ -14433,7 +15628,7 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
14433
15628
|
return localVarFp.adminAnalyticsStoreXStoreIDKpiRealtimeGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
14434
15629
|
},
|
|
14435
15630
|
/**
|
|
14436
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
15631
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
14437
15632
|
* @summary Get Query Analytics
|
|
14438
15633
|
* @param {string} xStoreID Store ID
|
|
14439
15634
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -14445,6 +15640,14 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
14445
15640
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14446
15641
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14447
15642
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15643
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15644
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15645
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15646
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15647
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15648
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15649
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15650
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14448
15651
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14449
15652
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14450
15653
|
* @param {number} [page] Page number for pagination
|
|
@@ -14456,15 +15659,29 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
14456
15659
|
* @param {*} [options] Override http request option.
|
|
14457
15660
|
* @throws {RequiredError}
|
|
14458
15661
|
*/
|
|
14459
|
-
adminAnalyticsStoreXStoreIDQueriesGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesGet200Response> {
|
|
14460
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
15662
|
+
adminAnalyticsStoreXStoreIDQueriesGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesGet200Response> {
|
|
15663
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
14461
15664
|
},
|
|
14462
15665
|
/**
|
|
14463
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
15666
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
14464
15667
|
* @summary Get No-Clicks Queries
|
|
14465
15668
|
* @param {string} xStoreID Store ID
|
|
14466
15669
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14467
15670
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15671
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
15672
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15673
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15674
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15675
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15676
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15677
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15678
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15679
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15680
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15681
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15682
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15683
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15684
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14468
15685
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14469
15686
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14470
15687
|
* @param {number} [page] Page number for pagination
|
|
@@ -14475,15 +15692,29 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
14475
15692
|
* @param {*} [options] Override http request option.
|
|
14476
15693
|
* @throws {RequiredError}
|
|
14477
15694
|
*/
|
|
14478
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response> {
|
|
14479
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
15695
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response> {
|
|
15696
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
14480
15697
|
},
|
|
14481
15698
|
/**
|
|
14482
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
15699
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
14483
15700
|
* @summary Get No-Results Queries
|
|
14484
15701
|
* @param {string} xStoreID Store ID
|
|
14485
15702
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14486
15703
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15704
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
15705
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15706
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15707
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15708
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15709
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15710
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15711
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15712
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15713
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15714
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15715
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15716
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15717
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14487
15718
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14488
15719
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14489
15720
|
* @param {number} [page] Page number for pagination
|
|
@@ -14494,8 +15725,8 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
14494
15725
|
* @param {*} [options] Override http request option.
|
|
14495
15726
|
* @throws {RequiredError}
|
|
14496
15727
|
*/
|
|
14497
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response> {
|
|
14498
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
15728
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response> {
|
|
15729
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
14499
15730
|
},
|
|
14500
15731
|
/**
|
|
14501
15732
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
@@ -14511,17 +15742,31 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
14511
15742
|
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
14512
15743
|
},
|
|
14513
15744
|
/**
|
|
14514
|
-
* Retrieve analytics for top performing search results with
|
|
15745
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
14515
15746
|
* @summary Get Top Results Analytics
|
|
14516
15747
|
* @param {string} xStoreID Store ID
|
|
14517
15748
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14518
15749
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14519
15750
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
15751
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15752
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15753
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15754
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15755
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15756
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15757
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15758
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15759
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15760
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15761
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15762
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15763
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14520
15764
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
14521
15765
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
14522
15766
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
14523
15767
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
14524
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
15768
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
15769
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
14525
15770
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14526
15771
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14527
15772
|
* @param {number} [page] Page number for pagination
|
|
@@ -14529,8 +15774,8 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
14529
15774
|
* @param {*} [options] Override http request option.
|
|
14530
15775
|
* @throws {RequiredError}
|
|
14531
15776
|
*/
|
|
14532
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response> {
|
|
14533
|
-
return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
15777
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response> {
|
|
15778
|
+
return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
14534
15779
|
},
|
|
14535
15780
|
/**
|
|
14536
15781
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -14702,7 +15947,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
14702
15947
|
}
|
|
14703
15948
|
|
|
14704
15949
|
/**
|
|
14705
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
15950
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
14706
15951
|
* @summary Get Geographic Analytics
|
|
14707
15952
|
* @param {string} xStoreID Store ID
|
|
14708
15953
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -14713,6 +15958,14 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
14713
15958
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14714
15959
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14715
15960
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15961
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15962
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15963
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15964
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15965
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15966
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15967
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15968
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14716
15969
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14717
15970
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14718
15971
|
* @param {number} [page] Page number for pagination
|
|
@@ -14724,8 +15977,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
14724
15977
|
* @throws {RequiredError}
|
|
14725
15978
|
* @memberof AnalyticsApi
|
|
14726
15979
|
*/
|
|
14727
|
-
public adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
|
|
14728
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
15980
|
+
public adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
|
|
15981
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
14729
15982
|
}
|
|
14730
15983
|
|
|
14731
15984
|
/**
|
|
@@ -14741,7 +15994,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
14741
15994
|
}
|
|
14742
15995
|
|
|
14743
15996
|
/**
|
|
14744
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
15997
|
+
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators and comparison mode between different timelines and tag sets.
|
|
14745
15998
|
* @summary Get KPI Analytics
|
|
14746
15999
|
* @param {string} xStoreID Store ID
|
|
14747
16000
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -14752,6 +16005,14 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
14752
16005
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14753
16006
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14754
16007
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
16008
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
16009
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
16010
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
16011
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
16012
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
16013
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
16014
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
16015
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14755
16016
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14756
16017
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14757
16018
|
* @param {number} [page] Page number for pagination
|
|
@@ -14760,8 +16021,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
14760
16021
|
* @throws {RequiredError}
|
|
14761
16022
|
* @memberof AnalyticsApi
|
|
14762
16023
|
*/
|
|
14763
|
-
public adminAnalyticsStoreXStoreIDKpiGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) {
|
|
14764
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
16024
|
+
public adminAnalyticsStoreXStoreIDKpiGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) {
|
|
16025
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
14765
16026
|
}
|
|
14766
16027
|
|
|
14767
16028
|
/**
|
|
@@ -14777,7 +16038,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
14777
16038
|
}
|
|
14778
16039
|
|
|
14779
16040
|
/**
|
|
14780
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
16041
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
14781
16042
|
* @summary Get Query Analytics
|
|
14782
16043
|
* @param {string} xStoreID Store ID
|
|
14783
16044
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -14789,6 +16050,14 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
14789
16050
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14790
16051
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14791
16052
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
16053
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
16054
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
16055
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
16056
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
16057
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
16058
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
16059
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
16060
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14792
16061
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14793
16062
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14794
16063
|
* @param {number} [page] Page number for pagination
|
|
@@ -14801,16 +16070,30 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
14801
16070
|
* @throws {RequiredError}
|
|
14802
16071
|
* @memberof AnalyticsApi
|
|
14803
16072
|
*/
|
|
14804
|
-
public adminAnalyticsStoreXStoreIDQueriesGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
|
|
14805
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
16073
|
+
public adminAnalyticsStoreXStoreIDQueriesGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
|
|
16074
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
14806
16075
|
}
|
|
14807
16076
|
|
|
14808
16077
|
/**
|
|
14809
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
16078
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
14810
16079
|
* @summary Get No-Clicks Queries
|
|
14811
16080
|
* @param {string} xStoreID Store ID
|
|
14812
16081
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14813
16082
|
* @param {string} [endTime] End time in RFC3339 format
|
|
16083
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
16084
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
16085
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
16086
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
16087
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
16088
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
16089
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
16090
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
16091
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
16092
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
16093
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
16094
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
16095
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
16096
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14814
16097
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14815
16098
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14816
16099
|
* @param {number} [page] Page number for pagination
|
|
@@ -14822,16 +16105,30 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
14822
16105
|
* @throws {RequiredError}
|
|
14823
16106
|
* @memberof AnalyticsApi
|
|
14824
16107
|
*/
|
|
14825
|
-
public adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
|
|
14826
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
16108
|
+
public adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
|
|
16109
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
14827
16110
|
}
|
|
14828
16111
|
|
|
14829
16112
|
/**
|
|
14830
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
16113
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
14831
16114
|
* @summary Get No-Results Queries
|
|
14832
16115
|
* @param {string} xStoreID Store ID
|
|
14833
16116
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14834
16117
|
* @param {string} [endTime] End time in RFC3339 format
|
|
16118
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
16119
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
16120
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
16121
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
16122
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
16123
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
16124
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
16125
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
16126
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
16127
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
16128
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
16129
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
16130
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
16131
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14835
16132
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14836
16133
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14837
16134
|
* @param {number} [page] Page number for pagination
|
|
@@ -14843,8 +16140,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
14843
16140
|
* @throws {RequiredError}
|
|
14844
16141
|
* @memberof AnalyticsApi
|
|
14845
16142
|
*/
|
|
14846
|
-
public adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
|
|
14847
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
16143
|
+
public adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
|
|
16144
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
14848
16145
|
}
|
|
14849
16146
|
|
|
14850
16147
|
/**
|
|
@@ -14863,17 +16160,31 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
14863
16160
|
}
|
|
14864
16161
|
|
|
14865
16162
|
/**
|
|
14866
|
-
* Retrieve analytics for top performing search results with
|
|
16163
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
14867
16164
|
* @summary Get Top Results Analytics
|
|
14868
16165
|
* @param {string} xStoreID Store ID
|
|
14869
16166
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14870
16167
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14871
16168
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
16169
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
16170
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
16171
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
16172
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
16173
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
16174
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
16175
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
16176
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
16177
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
16178
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
16179
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
16180
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
16181
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14872
16182
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
14873
16183
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
14874
16184
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
14875
16185
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
14876
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
16186
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
16187
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
14877
16188
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
14878
16189
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
14879
16190
|
* @param {number} [page] Page number for pagination
|
|
@@ -14882,8 +16193,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
14882
16193
|
* @throws {RequiredError}
|
|
14883
16194
|
* @memberof AnalyticsApi
|
|
14884
16195
|
*/
|
|
14885
|
-
public adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) {
|
|
14886
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
16196
|
+
public adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) {
|
|
16197
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
14887
16198
|
}
|
|
14888
16199
|
|
|
14889
16200
|
/**
|
|
@@ -15050,6 +16361,14 @@ export const AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum = {
|
|
|
15050
16361
|
All: 'all'
|
|
15051
16362
|
} as const;
|
|
15052
16363
|
export type AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum];
|
|
16364
|
+
/**
|
|
16365
|
+
* @export
|
|
16366
|
+
*/
|
|
16367
|
+
export const AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum = {
|
|
16368
|
+
Any: 'any',
|
|
16369
|
+
All: 'all'
|
|
16370
|
+
} as const;
|
|
16371
|
+
export type AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum];
|
|
15053
16372
|
/**
|
|
15054
16373
|
* @export
|
|
15055
16374
|
*/
|
|
@@ -15091,6 +16410,14 @@ export const AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum = {
|
|
|
15091
16410
|
All: 'all'
|
|
15092
16411
|
} as const;
|
|
15093
16412
|
export type AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum];
|
|
16413
|
+
/**
|
|
16414
|
+
* @export
|
|
16415
|
+
*/
|
|
16416
|
+
export const AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum = {
|
|
16417
|
+
Any: 'any',
|
|
16418
|
+
All: 'all'
|
|
16419
|
+
} as const;
|
|
16420
|
+
export type AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum];
|
|
15094
16421
|
/**
|
|
15095
16422
|
* @export
|
|
15096
16423
|
*/
|
|
@@ -15112,6 +16439,14 @@ export const AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum = {
|
|
|
15112
16439
|
All: 'all'
|
|
15113
16440
|
} as const;
|
|
15114
16441
|
export type AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum];
|
|
16442
|
+
/**
|
|
16443
|
+
* @export
|
|
16444
|
+
*/
|
|
16445
|
+
export const AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum = {
|
|
16446
|
+
Any: 'any',
|
|
16447
|
+
All: 'all'
|
|
16448
|
+
} as const;
|
|
16449
|
+
export type AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum];
|
|
15115
16450
|
/**
|
|
15116
16451
|
* @export
|
|
15117
16452
|
*/
|
|
@@ -15132,6 +16467,22 @@ export const AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = {
|
|
|
15132
16467
|
Desc: 'desc'
|
|
15133
16468
|
} as const;
|
|
15134
16469
|
export type AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum];
|
|
16470
|
+
/**
|
|
16471
|
+
* @export
|
|
16472
|
+
*/
|
|
16473
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = {
|
|
16474
|
+
Any: 'any',
|
|
16475
|
+
All: 'all'
|
|
16476
|
+
} as const;
|
|
16477
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum];
|
|
16478
|
+
/**
|
|
16479
|
+
* @export
|
|
16480
|
+
*/
|
|
16481
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum = {
|
|
16482
|
+
Any: 'any',
|
|
16483
|
+
All: 'all'
|
|
16484
|
+
} as const;
|
|
16485
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum];
|
|
15135
16486
|
/**
|
|
15136
16487
|
* @export
|
|
15137
16488
|
*/
|
|
@@ -15149,6 +16500,22 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = {
|
|
|
15149
16500
|
Desc: 'desc'
|
|
15150
16501
|
} as const;
|
|
15151
16502
|
export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum];
|
|
16503
|
+
/**
|
|
16504
|
+
* @export
|
|
16505
|
+
*/
|
|
16506
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = {
|
|
16507
|
+
Any: 'any',
|
|
16508
|
+
All: 'all'
|
|
16509
|
+
} as const;
|
|
16510
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum];
|
|
16511
|
+
/**
|
|
16512
|
+
* @export
|
|
16513
|
+
*/
|
|
16514
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum = {
|
|
16515
|
+
Any: 'any',
|
|
16516
|
+
All: 'all'
|
|
16517
|
+
} as const;
|
|
16518
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum];
|
|
15152
16519
|
/**
|
|
15153
16520
|
* @export
|
|
15154
16521
|
*/
|
|
@@ -15166,6 +16533,22 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
15166
16533
|
Desc: 'desc'
|
|
15167
16534
|
} as const;
|
|
15168
16535
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
16536
|
+
/**
|
|
16537
|
+
* @export
|
|
16538
|
+
*/
|
|
16539
|
+
export const AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = {
|
|
16540
|
+
Any: 'any',
|
|
16541
|
+
All: 'all'
|
|
16542
|
+
} as const;
|
|
16543
|
+
export type AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum];
|
|
16544
|
+
/**
|
|
16545
|
+
* @export
|
|
16546
|
+
*/
|
|
16547
|
+
export const AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = {
|
|
16548
|
+
Any: 'any',
|
|
16549
|
+
All: 'all'
|
|
16550
|
+
} as const;
|
|
16551
|
+
export type AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum];
|
|
15169
16552
|
/**
|
|
15170
16553
|
* @export
|
|
15171
16554
|
*/
|
|
@@ -24039,6 +25422,397 @@ export class ParentMenusApi extends BaseAPI {
|
|
|
24039
25422
|
|
|
24040
25423
|
|
|
24041
25424
|
|
|
25425
|
+
/**
|
|
25426
|
+
* PaymentGatewayApi - axios parameter creator
|
|
25427
|
+
* @export
|
|
25428
|
+
*/
|
|
25429
|
+
export const PaymentGatewayApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
25430
|
+
return {
|
|
25431
|
+
/**
|
|
25432
|
+
* Creates a payment order using specified or default payment gateway
|
|
25433
|
+
* @summary Create a new payment order
|
|
25434
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
25435
|
+
* @param {*} [options] Override http request option.
|
|
25436
|
+
* @throws {RequiredError}
|
|
25437
|
+
*/
|
|
25438
|
+
paymentGatewayCreateOrderPost: async (order: DataTypesCreatePaymentOrderRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25439
|
+
// verify required parameter 'order' is not null or undefined
|
|
25440
|
+
assertParamExists('paymentGatewayCreateOrderPost', 'order', order)
|
|
25441
|
+
const localVarPath = `/payment-gateway/create-order`;
|
|
25442
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25443
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25444
|
+
let baseOptions;
|
|
25445
|
+
if (configuration) {
|
|
25446
|
+
baseOptions = configuration.baseOptions;
|
|
25447
|
+
}
|
|
25448
|
+
|
|
25449
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
25450
|
+
const localVarHeaderParameter = {} as any;
|
|
25451
|
+
const localVarQueryParameter = {} as any;
|
|
25452
|
+
|
|
25453
|
+
// authentication BearerAuth required
|
|
25454
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
25455
|
+
|
|
25456
|
+
|
|
25457
|
+
|
|
25458
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25459
|
+
|
|
25460
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25461
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25462
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25463
|
+
localVarRequestOptions.data = serializeDataIfNeeded(order, localVarRequestOptions, configuration)
|
|
25464
|
+
|
|
25465
|
+
return {
|
|
25466
|
+
url: toPathString(localVarUrlObj),
|
|
25467
|
+
options: localVarRequestOptions,
|
|
25468
|
+
};
|
|
25469
|
+
},
|
|
25470
|
+
/**
|
|
25471
|
+
* Returns list of all active credit plans for purchase
|
|
25472
|
+
* @summary Get available credit plans
|
|
25473
|
+
* @param {*} [options] Override http request option.
|
|
25474
|
+
* @throws {RequiredError}
|
|
25475
|
+
*/
|
|
25476
|
+
paymentGatewayCreditPlansGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25477
|
+
const localVarPath = `/payment-gateway/credit-plans`;
|
|
25478
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25479
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25480
|
+
let baseOptions;
|
|
25481
|
+
if (configuration) {
|
|
25482
|
+
baseOptions = configuration.baseOptions;
|
|
25483
|
+
}
|
|
25484
|
+
|
|
25485
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
25486
|
+
const localVarHeaderParameter = {} as any;
|
|
25487
|
+
const localVarQueryParameter = {} as any;
|
|
25488
|
+
|
|
25489
|
+
// authentication BearerAuth required
|
|
25490
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
25491
|
+
|
|
25492
|
+
|
|
25493
|
+
|
|
25494
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25495
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25496
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25497
|
+
|
|
25498
|
+
return {
|
|
25499
|
+
url: toPathString(localVarUrlObj),
|
|
25500
|
+
options: localVarRequestOptions,
|
|
25501
|
+
};
|
|
25502
|
+
},
|
|
25503
|
+
/**
|
|
25504
|
+
* Returns list of all available payment gateways
|
|
25505
|
+
* @summary Get available payment gateways
|
|
25506
|
+
* @param {*} [options] Override http request option.
|
|
25507
|
+
* @throws {RequiredError}
|
|
25508
|
+
*/
|
|
25509
|
+
paymentGatewayGatewaysGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25510
|
+
const localVarPath = `/payment-gateway/gateways`;
|
|
25511
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25512
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25513
|
+
let baseOptions;
|
|
25514
|
+
if (configuration) {
|
|
25515
|
+
baseOptions = configuration.baseOptions;
|
|
25516
|
+
}
|
|
25517
|
+
|
|
25518
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
25519
|
+
const localVarHeaderParameter = {} as any;
|
|
25520
|
+
const localVarQueryParameter = {} as any;
|
|
25521
|
+
|
|
25522
|
+
// authentication BearerAuth required
|
|
25523
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
25524
|
+
|
|
25525
|
+
|
|
25526
|
+
|
|
25527
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25528
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25529
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25530
|
+
|
|
25531
|
+
return {
|
|
25532
|
+
url: toPathString(localVarUrlObj),
|
|
25533
|
+
options: localVarRequestOptions,
|
|
25534
|
+
};
|
|
25535
|
+
},
|
|
25536
|
+
/**
|
|
25537
|
+
* Processes a refund for a completed payment
|
|
25538
|
+
* @summary Process payment refund
|
|
25539
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
25540
|
+
* @param {*} [options] Override http request option.
|
|
25541
|
+
* @throws {RequiredError}
|
|
25542
|
+
*/
|
|
25543
|
+
paymentGatewayRefundPost: async (refund: DataTypesRefundRequestDto, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25544
|
+
// verify required parameter 'refund' is not null or undefined
|
|
25545
|
+
assertParamExists('paymentGatewayRefundPost', 'refund', refund)
|
|
25546
|
+
const localVarPath = `/payment-gateway/refund`;
|
|
25547
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25548
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25549
|
+
let baseOptions;
|
|
25550
|
+
if (configuration) {
|
|
25551
|
+
baseOptions = configuration.baseOptions;
|
|
25552
|
+
}
|
|
25553
|
+
|
|
25554
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
25555
|
+
const localVarHeaderParameter = {} as any;
|
|
25556
|
+
const localVarQueryParameter = {} as any;
|
|
25557
|
+
|
|
25558
|
+
// authentication BearerAuth required
|
|
25559
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
25560
|
+
|
|
25561
|
+
|
|
25562
|
+
|
|
25563
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25564
|
+
|
|
25565
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25566
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25567
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25568
|
+
localVarRequestOptions.data = serializeDataIfNeeded(refund, localVarRequestOptions, configuration)
|
|
25569
|
+
|
|
25570
|
+
return {
|
|
25571
|
+
url: toPathString(localVarUrlObj),
|
|
25572
|
+
options: localVarRequestOptions,
|
|
25573
|
+
};
|
|
25574
|
+
},
|
|
25575
|
+
/**
|
|
25576
|
+
* Verifies the current status of a payment
|
|
25577
|
+
* @summary Verify payment status
|
|
25578
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
25579
|
+
* @param {*} [options] Override http request option.
|
|
25580
|
+
* @throws {RequiredError}
|
|
25581
|
+
*/
|
|
25582
|
+
paymentGatewayVerifyPost: async (verify: DataTypesVerifyPaymentRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25583
|
+
// verify required parameter 'verify' is not null or undefined
|
|
25584
|
+
assertParamExists('paymentGatewayVerifyPost', 'verify', verify)
|
|
25585
|
+
const localVarPath = `/payment-gateway/verify`;
|
|
25586
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25587
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25588
|
+
let baseOptions;
|
|
25589
|
+
if (configuration) {
|
|
25590
|
+
baseOptions = configuration.baseOptions;
|
|
25591
|
+
}
|
|
25592
|
+
|
|
25593
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
25594
|
+
const localVarHeaderParameter = {} as any;
|
|
25595
|
+
const localVarQueryParameter = {} as any;
|
|
25596
|
+
|
|
25597
|
+
// authentication BearerAuth required
|
|
25598
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
25599
|
+
|
|
25600
|
+
|
|
25601
|
+
|
|
25602
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25603
|
+
|
|
25604
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25605
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25606
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25607
|
+
localVarRequestOptions.data = serializeDataIfNeeded(verify, localVarRequestOptions, configuration)
|
|
25608
|
+
|
|
25609
|
+
return {
|
|
25610
|
+
url: toPathString(localVarUrlObj),
|
|
25611
|
+
options: localVarRequestOptions,
|
|
25612
|
+
};
|
|
25613
|
+
},
|
|
25614
|
+
}
|
|
25615
|
+
};
|
|
25616
|
+
|
|
25617
|
+
/**
|
|
25618
|
+
* PaymentGatewayApi - functional programming interface
|
|
25619
|
+
* @export
|
|
25620
|
+
*/
|
|
25621
|
+
export const PaymentGatewayApiFp = function(configuration?: Configuration) {
|
|
25622
|
+
const localVarAxiosParamCreator = PaymentGatewayApiAxiosParamCreator(configuration)
|
|
25623
|
+
return {
|
|
25624
|
+
/**
|
|
25625
|
+
* Creates a payment order using specified or default payment gateway
|
|
25626
|
+
* @summary Create a new payment order
|
|
25627
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
25628
|
+
* @param {*} [options] Override http request option.
|
|
25629
|
+
* @throws {RequiredError}
|
|
25630
|
+
*/
|
|
25631
|
+
async paymentGatewayCreateOrderPost(order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCreatePaymentOrderResponse>> {
|
|
25632
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayCreateOrderPost(order, options);
|
|
25633
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25634
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentGatewayApi.paymentGatewayCreateOrderPost']?.[localVarOperationServerIndex]?.url;
|
|
25635
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25636
|
+
},
|
|
25637
|
+
/**
|
|
25638
|
+
* Returns list of all active credit plans for purchase
|
|
25639
|
+
* @summary Get available credit plans
|
|
25640
|
+
* @param {*} [options] Override http request option.
|
|
25641
|
+
* @throws {RequiredError}
|
|
25642
|
+
*/
|
|
25643
|
+
async paymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DataTypesCreditPlan>>> {
|
|
25644
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayCreditPlansGet(options);
|
|
25645
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25646
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentGatewayApi.paymentGatewayCreditPlansGet']?.[localVarOperationServerIndex]?.url;
|
|
25647
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25648
|
+
},
|
|
25649
|
+
/**
|
|
25650
|
+
* Returns list of all available payment gateways
|
|
25651
|
+
* @summary Get available payment gateways
|
|
25652
|
+
* @param {*} [options] Override http request option.
|
|
25653
|
+
* @throws {RequiredError}
|
|
25654
|
+
*/
|
|
25655
|
+
async paymentGatewayGatewaysGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGatewayListResponse>> {
|
|
25656
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayGatewaysGet(options);
|
|
25657
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25658
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentGatewayApi.paymentGatewayGatewaysGet']?.[localVarOperationServerIndex]?.url;
|
|
25659
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25660
|
+
},
|
|
25661
|
+
/**
|
|
25662
|
+
* Processes a refund for a completed payment
|
|
25663
|
+
* @summary Process payment refund
|
|
25664
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
25665
|
+
* @param {*} [options] Override http request option.
|
|
25666
|
+
* @throws {RequiredError}
|
|
25667
|
+
*/
|
|
25668
|
+
async paymentGatewayRefundPost(refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRefundResponseDto>> {
|
|
25669
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayRefundPost(refund, options);
|
|
25670
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25671
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentGatewayApi.paymentGatewayRefundPost']?.[localVarOperationServerIndex]?.url;
|
|
25672
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25673
|
+
},
|
|
25674
|
+
/**
|
|
25675
|
+
* Verifies the current status of a payment
|
|
25676
|
+
* @summary Verify payment status
|
|
25677
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
25678
|
+
* @param {*} [options] Override http request option.
|
|
25679
|
+
* @throws {RequiredError}
|
|
25680
|
+
*/
|
|
25681
|
+
async paymentGatewayVerifyPost(verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPaymentStatusResponse>> {
|
|
25682
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayVerifyPost(verify, options);
|
|
25683
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25684
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentGatewayApi.paymentGatewayVerifyPost']?.[localVarOperationServerIndex]?.url;
|
|
25685
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25686
|
+
},
|
|
25687
|
+
}
|
|
25688
|
+
};
|
|
25689
|
+
|
|
25690
|
+
/**
|
|
25691
|
+
* PaymentGatewayApi - factory interface
|
|
25692
|
+
* @export
|
|
25693
|
+
*/
|
|
25694
|
+
export const PaymentGatewayApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
25695
|
+
const localVarFp = PaymentGatewayApiFp(configuration)
|
|
25696
|
+
return {
|
|
25697
|
+
/**
|
|
25698
|
+
* Creates a payment order using specified or default payment gateway
|
|
25699
|
+
* @summary Create a new payment order
|
|
25700
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
25701
|
+
* @param {*} [options] Override http request option.
|
|
25702
|
+
* @throws {RequiredError}
|
|
25703
|
+
*/
|
|
25704
|
+
paymentGatewayCreateOrderPost(order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCreatePaymentOrderResponse> {
|
|
25705
|
+
return localVarFp.paymentGatewayCreateOrderPost(order, options).then((request) => request(axios, basePath));
|
|
25706
|
+
},
|
|
25707
|
+
/**
|
|
25708
|
+
* Returns list of all active credit plans for purchase
|
|
25709
|
+
* @summary Get available credit plans
|
|
25710
|
+
* @param {*} [options] Override http request option.
|
|
25711
|
+
* @throws {RequiredError}
|
|
25712
|
+
*/
|
|
25713
|
+
paymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): AxiosPromise<Array<DataTypesCreditPlan>> {
|
|
25714
|
+
return localVarFp.paymentGatewayCreditPlansGet(options).then((request) => request(axios, basePath));
|
|
25715
|
+
},
|
|
25716
|
+
/**
|
|
25717
|
+
* Returns list of all available payment gateways
|
|
25718
|
+
* @summary Get available payment gateways
|
|
25719
|
+
* @param {*} [options] Override http request option.
|
|
25720
|
+
* @throws {RequiredError}
|
|
25721
|
+
*/
|
|
25722
|
+
paymentGatewayGatewaysGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGatewayListResponse> {
|
|
25723
|
+
return localVarFp.paymentGatewayGatewaysGet(options).then((request) => request(axios, basePath));
|
|
25724
|
+
},
|
|
25725
|
+
/**
|
|
25726
|
+
* Processes a refund for a completed payment
|
|
25727
|
+
* @summary Process payment refund
|
|
25728
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
25729
|
+
* @param {*} [options] Override http request option.
|
|
25730
|
+
* @throws {RequiredError}
|
|
25731
|
+
*/
|
|
25732
|
+
paymentGatewayRefundPost(refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRefundResponseDto> {
|
|
25733
|
+
return localVarFp.paymentGatewayRefundPost(refund, options).then((request) => request(axios, basePath));
|
|
25734
|
+
},
|
|
25735
|
+
/**
|
|
25736
|
+
* Verifies the current status of a payment
|
|
25737
|
+
* @summary Verify payment status
|
|
25738
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
25739
|
+
* @param {*} [options] Override http request option.
|
|
25740
|
+
* @throws {RequiredError}
|
|
25741
|
+
*/
|
|
25742
|
+
paymentGatewayVerifyPost(verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPaymentStatusResponse> {
|
|
25743
|
+
return localVarFp.paymentGatewayVerifyPost(verify, options).then((request) => request(axios, basePath));
|
|
25744
|
+
},
|
|
25745
|
+
};
|
|
25746
|
+
};
|
|
25747
|
+
|
|
25748
|
+
/**
|
|
25749
|
+
* PaymentGatewayApi - object-oriented interface
|
|
25750
|
+
* @export
|
|
25751
|
+
* @class PaymentGatewayApi
|
|
25752
|
+
* @extends {BaseAPI}
|
|
25753
|
+
*/
|
|
25754
|
+
export class PaymentGatewayApi extends BaseAPI {
|
|
25755
|
+
/**
|
|
25756
|
+
* Creates a payment order using specified or default payment gateway
|
|
25757
|
+
* @summary Create a new payment order
|
|
25758
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
25759
|
+
* @param {*} [options] Override http request option.
|
|
25760
|
+
* @throws {RequiredError}
|
|
25761
|
+
* @memberof PaymentGatewayApi
|
|
25762
|
+
*/
|
|
25763
|
+
public paymentGatewayCreateOrderPost(order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig) {
|
|
25764
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayCreateOrderPost(order, options).then((request) => request(this.axios, this.basePath));
|
|
25765
|
+
}
|
|
25766
|
+
|
|
25767
|
+
/**
|
|
25768
|
+
* Returns list of all active credit plans for purchase
|
|
25769
|
+
* @summary Get available credit plans
|
|
25770
|
+
* @param {*} [options] Override http request option.
|
|
25771
|
+
* @throws {RequiredError}
|
|
25772
|
+
* @memberof PaymentGatewayApi
|
|
25773
|
+
*/
|
|
25774
|
+
public paymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig) {
|
|
25775
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayCreditPlansGet(options).then((request) => request(this.axios, this.basePath));
|
|
25776
|
+
}
|
|
25777
|
+
|
|
25778
|
+
/**
|
|
25779
|
+
* Returns list of all available payment gateways
|
|
25780
|
+
* @summary Get available payment gateways
|
|
25781
|
+
* @param {*} [options] Override http request option.
|
|
25782
|
+
* @throws {RequiredError}
|
|
25783
|
+
* @memberof PaymentGatewayApi
|
|
25784
|
+
*/
|
|
25785
|
+
public paymentGatewayGatewaysGet(options?: RawAxiosRequestConfig) {
|
|
25786
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayGatewaysGet(options).then((request) => request(this.axios, this.basePath));
|
|
25787
|
+
}
|
|
25788
|
+
|
|
25789
|
+
/**
|
|
25790
|
+
* Processes a refund for a completed payment
|
|
25791
|
+
* @summary Process payment refund
|
|
25792
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
25793
|
+
* @param {*} [options] Override http request option.
|
|
25794
|
+
* @throws {RequiredError}
|
|
25795
|
+
* @memberof PaymentGatewayApi
|
|
25796
|
+
*/
|
|
25797
|
+
public paymentGatewayRefundPost(refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig) {
|
|
25798
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayRefundPost(refund, options).then((request) => request(this.axios, this.basePath));
|
|
25799
|
+
}
|
|
25800
|
+
|
|
25801
|
+
/**
|
|
25802
|
+
* Verifies the current status of a payment
|
|
25803
|
+
* @summary Verify payment status
|
|
25804
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
25805
|
+
* @param {*} [options] Override http request option.
|
|
25806
|
+
* @throws {RequiredError}
|
|
25807
|
+
* @memberof PaymentGatewayApi
|
|
25808
|
+
*/
|
|
25809
|
+
public paymentGatewayVerifyPost(verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig) {
|
|
25810
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayVerifyPost(verify, options).then((request) => request(this.axios, this.basePath));
|
|
25811
|
+
}
|
|
25812
|
+
}
|
|
25813
|
+
|
|
25814
|
+
|
|
25815
|
+
|
|
24042
25816
|
/**
|
|
24043
25817
|
* PaymentsApi - axios parameter creator
|
|
24044
25818
|
* @export
|