@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/dist/api.d.ts
CHANGED
|
@@ -19,6 +19,12 @@ import { BaseAPI } from './base';
|
|
|
19
19
|
* @interface AdminAnalyticsStoreXStoreIDCustomPost200Response
|
|
20
20
|
*/
|
|
21
21
|
export interface AdminAnalyticsStoreXStoreIDCustomPost200Response {
|
|
22
|
+
/**
|
|
23
|
+
* Comparison metadata when in compare mode
|
|
24
|
+
* @type {AnalyticsComparisonMeta}
|
|
25
|
+
* @memberof AdminAnalyticsStoreXStoreIDCustomPost200Response
|
|
26
|
+
*/
|
|
27
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
22
28
|
/**
|
|
23
29
|
*
|
|
24
30
|
* @type {AnalyticsCustomQueryResponse}
|
|
@@ -56,6 +62,12 @@ export interface AdminAnalyticsStoreXStoreIDCustomPost200Response {
|
|
|
56
62
|
* @interface AdminAnalyticsStoreXStoreIDFiltersCombinationsGet200Response
|
|
57
63
|
*/
|
|
58
64
|
export interface AdminAnalyticsStoreXStoreIDFiltersCombinationsGet200Response {
|
|
65
|
+
/**
|
|
66
|
+
* Comparison metadata when in compare mode
|
|
67
|
+
* @type {AnalyticsComparisonMeta}
|
|
68
|
+
* @memberof AdminAnalyticsStoreXStoreIDFiltersCombinationsGet200Response
|
|
69
|
+
*/
|
|
70
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
59
71
|
/**
|
|
60
72
|
*
|
|
61
73
|
* @type {Array<AnalyticsFilterCombination>}
|
|
@@ -93,6 +105,12 @@ export interface AdminAnalyticsStoreXStoreIDFiltersCombinationsGet200Response {
|
|
|
93
105
|
* @interface AdminAnalyticsStoreXStoreIDFiltersEffectivenessGet200Response
|
|
94
106
|
*/
|
|
95
107
|
export interface AdminAnalyticsStoreXStoreIDFiltersEffectivenessGet200Response {
|
|
108
|
+
/**
|
|
109
|
+
* Comparison metadata when in compare mode
|
|
110
|
+
* @type {AnalyticsComparisonMeta}
|
|
111
|
+
* @memberof AdminAnalyticsStoreXStoreIDFiltersEffectivenessGet200Response
|
|
112
|
+
*/
|
|
113
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
96
114
|
/**
|
|
97
115
|
*
|
|
98
116
|
* @type {AnalyticsFilterEffectivenessAnalysis}
|
|
@@ -130,6 +148,12 @@ export interface AdminAnalyticsStoreXStoreIDFiltersEffectivenessGet200Response {
|
|
|
130
148
|
* @interface AdminAnalyticsStoreXStoreIDFiltersGet200Response
|
|
131
149
|
*/
|
|
132
150
|
export interface AdminAnalyticsStoreXStoreIDFiltersGet200Response {
|
|
151
|
+
/**
|
|
152
|
+
* Comparison metadata when in compare mode
|
|
153
|
+
* @type {AnalyticsComparisonMeta}
|
|
154
|
+
* @memberof AdminAnalyticsStoreXStoreIDFiltersGet200Response
|
|
155
|
+
*/
|
|
156
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
133
157
|
/**
|
|
134
158
|
*
|
|
135
159
|
* @type {AnalyticsFilterAnalyticsResponse}
|
|
@@ -167,6 +191,12 @@ export interface AdminAnalyticsStoreXStoreIDFiltersGet200Response {
|
|
|
167
191
|
* @interface AdminAnalyticsStoreXStoreIDFiltersTrendsGet200Response
|
|
168
192
|
*/
|
|
169
193
|
export interface AdminAnalyticsStoreXStoreIDFiltersTrendsGet200Response {
|
|
194
|
+
/**
|
|
195
|
+
* Comparison metadata when in compare mode
|
|
196
|
+
* @type {AnalyticsComparisonMeta}
|
|
197
|
+
* @memberof AdminAnalyticsStoreXStoreIDFiltersTrendsGet200Response
|
|
198
|
+
*/
|
|
199
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
170
200
|
/**
|
|
171
201
|
*
|
|
172
202
|
* @type {AnalyticsFilterTrendsResponse}
|
|
@@ -204,6 +234,12 @@ export interface AdminAnalyticsStoreXStoreIDFiltersTrendsGet200Response {
|
|
|
204
234
|
* @interface AdminAnalyticsStoreXStoreIDGeoGet200Response
|
|
205
235
|
*/
|
|
206
236
|
export interface AdminAnalyticsStoreXStoreIDGeoGet200Response {
|
|
237
|
+
/**
|
|
238
|
+
* Comparison metadata when in compare mode
|
|
239
|
+
* @type {AnalyticsComparisonMeta}
|
|
240
|
+
* @memberof AdminAnalyticsStoreXStoreIDGeoGet200Response
|
|
241
|
+
*/
|
|
242
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
207
243
|
/**
|
|
208
244
|
*
|
|
209
245
|
* @type {AnalyticsGeoResponse}
|
|
@@ -241,6 +277,12 @@ export interface AdminAnalyticsStoreXStoreIDGeoGet200Response {
|
|
|
241
277
|
* @interface AdminAnalyticsStoreXStoreIDItemsComparisonGet200Response
|
|
242
278
|
*/
|
|
243
279
|
export interface AdminAnalyticsStoreXStoreIDItemsComparisonGet200Response {
|
|
280
|
+
/**
|
|
281
|
+
* Comparison metadata when in compare mode
|
|
282
|
+
* @type {AnalyticsComparisonMeta}
|
|
283
|
+
* @memberof AdminAnalyticsStoreXStoreIDItemsComparisonGet200Response
|
|
284
|
+
*/
|
|
285
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
244
286
|
/**
|
|
245
287
|
*
|
|
246
288
|
* @type {AnalyticsItemComparisonAnalytics}
|
|
@@ -278,6 +320,12 @@ export interface AdminAnalyticsStoreXStoreIDItemsComparisonGet200Response {
|
|
|
278
320
|
* @interface AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response
|
|
279
321
|
*/
|
|
280
322
|
export interface AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response {
|
|
323
|
+
/**
|
|
324
|
+
* Comparison metadata when in compare mode
|
|
325
|
+
* @type {AnalyticsComparisonMeta}
|
|
326
|
+
* @memberof AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response
|
|
327
|
+
*/
|
|
328
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
281
329
|
/**
|
|
282
330
|
*
|
|
283
331
|
* @type {Array<AnalyticsItemDiscoveryAnalytics>}
|
|
@@ -315,6 +363,12 @@ export interface AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response {
|
|
|
315
363
|
* @interface AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response
|
|
316
364
|
*/
|
|
317
365
|
export interface AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response {
|
|
366
|
+
/**
|
|
367
|
+
* Comparison metadata when in compare mode
|
|
368
|
+
* @type {AnalyticsComparisonMeta}
|
|
369
|
+
* @memberof AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response
|
|
370
|
+
*/
|
|
371
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
318
372
|
/**
|
|
319
373
|
*
|
|
320
374
|
* @type {Array<AnalyticsItemPerformanceMetrics>}
|
|
@@ -352,6 +406,12 @@ export interface AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response {
|
|
|
352
406
|
* @interface AdminAnalyticsStoreXStoreIDItemsTrendsGet200Response
|
|
353
407
|
*/
|
|
354
408
|
export interface AdminAnalyticsStoreXStoreIDItemsTrendsGet200Response {
|
|
409
|
+
/**
|
|
410
|
+
* Comparison metadata when in compare mode
|
|
411
|
+
* @type {AnalyticsComparisonMeta}
|
|
412
|
+
* @memberof AdminAnalyticsStoreXStoreIDItemsTrendsGet200Response
|
|
413
|
+
*/
|
|
414
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
355
415
|
/**
|
|
356
416
|
*
|
|
357
417
|
* @type {Array<AnalyticsItemPerformanceTrend>}
|
|
@@ -389,6 +449,12 @@ export interface AdminAnalyticsStoreXStoreIDItemsTrendsGet200Response {
|
|
|
389
449
|
* @interface AdminAnalyticsStoreXStoreIDKpiGet200Response
|
|
390
450
|
*/
|
|
391
451
|
export interface AdminAnalyticsStoreXStoreIDKpiGet200Response {
|
|
452
|
+
/**
|
|
453
|
+
* Comparison metadata when in compare mode
|
|
454
|
+
* @type {AnalyticsComparisonMeta}
|
|
455
|
+
* @memberof AdminAnalyticsStoreXStoreIDKpiGet200Response
|
|
456
|
+
*/
|
|
457
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
392
458
|
/**
|
|
393
459
|
*
|
|
394
460
|
* @type {AnalyticsExtendedKPIResponse}
|
|
@@ -426,6 +492,12 @@ export interface AdminAnalyticsStoreXStoreIDKpiGet200Response {
|
|
|
426
492
|
* @interface AdminAnalyticsStoreXStoreIDQueriesGet200Response
|
|
427
493
|
*/
|
|
428
494
|
export interface AdminAnalyticsStoreXStoreIDQueriesGet200Response {
|
|
495
|
+
/**
|
|
496
|
+
* Comparison metadata when in compare mode
|
|
497
|
+
* @type {AnalyticsComparisonMeta}
|
|
498
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesGet200Response
|
|
499
|
+
*/
|
|
500
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
429
501
|
/**
|
|
430
502
|
*
|
|
431
503
|
* @type {AnalyticsQueryResponse}
|
|
@@ -463,6 +535,12 @@ export interface AdminAnalyticsStoreXStoreIDQueriesGet200Response {
|
|
|
463
535
|
* @interface AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGet200Response
|
|
464
536
|
*/
|
|
465
537
|
export interface AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGet200Response {
|
|
538
|
+
/**
|
|
539
|
+
* Comparison metadata when in compare mode
|
|
540
|
+
* @type {AnalyticsComparisonMeta}
|
|
541
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGet200Response
|
|
542
|
+
*/
|
|
543
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
466
544
|
/**
|
|
467
545
|
*
|
|
468
546
|
* @type {Array<AnalyticsQueryPerformanceAnalytics>}
|
|
@@ -500,6 +578,12 @@ export interface AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGet200Response
|
|
|
500
578
|
* @interface AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response
|
|
501
579
|
*/
|
|
502
580
|
export interface AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response {
|
|
581
|
+
/**
|
|
582
|
+
* Comparison metadata when in compare mode
|
|
583
|
+
* @type {AnalyticsComparisonMeta}
|
|
584
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response
|
|
585
|
+
*/
|
|
586
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
503
587
|
/**
|
|
504
588
|
*
|
|
505
589
|
* @type {{ [key: string]: any; }}
|
|
@@ -539,6 +623,12 @@ export interface AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response {
|
|
|
539
623
|
* @interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
540
624
|
*/
|
|
541
625
|
export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
|
|
626
|
+
/**
|
|
627
|
+
* Comparison metadata when in compare mode
|
|
628
|
+
* @type {AnalyticsComparisonMeta}
|
|
629
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
630
|
+
*/
|
|
631
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
542
632
|
/**
|
|
543
633
|
*
|
|
544
634
|
* @type {AnalyticsQueryInsights}
|
|
@@ -576,6 +666,12 @@ export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
|
|
|
576
666
|
* @interface AnalyticsAnalyticsAPIResponse
|
|
577
667
|
*/
|
|
578
668
|
export interface AnalyticsAnalyticsAPIResponse {
|
|
669
|
+
/**
|
|
670
|
+
* Comparison metadata when in compare mode
|
|
671
|
+
* @type {AnalyticsComparisonMeta}
|
|
672
|
+
* @memberof AnalyticsAnalyticsAPIResponse
|
|
673
|
+
*/
|
|
674
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
579
675
|
/**
|
|
580
676
|
*
|
|
581
677
|
* @type {object}
|
|
@@ -791,6 +887,43 @@ export interface AnalyticsClickPositionBucket {
|
|
|
791
887
|
*/
|
|
792
888
|
'share'?: number;
|
|
793
889
|
}
|
|
890
|
+
/**
|
|
891
|
+
*
|
|
892
|
+
* @export
|
|
893
|
+
* @interface AnalyticsComparisonMeta
|
|
894
|
+
*/
|
|
895
|
+
export interface AnalyticsComparisonMeta {
|
|
896
|
+
/**
|
|
897
|
+
* Human readable comparison period
|
|
898
|
+
* @type {string}
|
|
899
|
+
* @memberof AnalyticsComparisonMeta
|
|
900
|
+
*/
|
|
901
|
+
'comparison_period'?: string;
|
|
902
|
+
/**
|
|
903
|
+
* Analytics tags for comparison period
|
|
904
|
+
* @type {Array<string>}
|
|
905
|
+
* @memberof AnalyticsComparisonMeta
|
|
906
|
+
*/
|
|
907
|
+
'comparison_tags'?: Array<string>;
|
|
908
|
+
/**
|
|
909
|
+
* Human readable current period
|
|
910
|
+
* @type {string}
|
|
911
|
+
* @memberof AnalyticsComparisonMeta
|
|
912
|
+
*/
|
|
913
|
+
'current_period'?: string;
|
|
914
|
+
/**
|
|
915
|
+
* Analytics tags for current period
|
|
916
|
+
* @type {Array<string>}
|
|
917
|
+
* @memberof AnalyticsComparisonMeta
|
|
918
|
+
*/
|
|
919
|
+
'current_tags'?: Array<string>;
|
|
920
|
+
/**
|
|
921
|
+
* Whether comparison mode is enabled
|
|
922
|
+
* @type {boolean}
|
|
923
|
+
* @memberof AnalyticsComparisonMeta
|
|
924
|
+
*/
|
|
925
|
+
'mode'?: boolean;
|
|
926
|
+
}
|
|
794
927
|
/**
|
|
795
928
|
*
|
|
796
929
|
* @export
|
|
@@ -872,19 +1005,19 @@ export interface AnalyticsCustomQueryResponse {
|
|
|
872
1005
|
/**
|
|
873
1006
|
*
|
|
874
1007
|
* @export
|
|
875
|
-
* @interface
|
|
1008
|
+
* @interface AnalyticsEnrichedItemResultWithWidget
|
|
876
1009
|
*/
|
|
877
|
-
export interface
|
|
1010
|
+
export interface AnalyticsEnrichedItemResultWithWidget {
|
|
878
1011
|
/**
|
|
879
1012
|
* Analytics data
|
|
880
1013
|
* @type {AnalyticsItemPerformanceMetrics}
|
|
881
|
-
* @memberof
|
|
1014
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
882
1015
|
*/
|
|
883
1016
|
'analytics'?: AnalyticsItemPerformanceMetrics;
|
|
884
1017
|
/**
|
|
885
1018
|
* Document data from Typesense index
|
|
886
1019
|
* @type {{ [key: string]: any; }}
|
|
887
|
-
* @memberof
|
|
1020
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
888
1021
|
*/
|
|
889
1022
|
'document'?: {
|
|
890
1023
|
[key: string]: any;
|
|
@@ -892,9 +1025,15 @@ export interface AnalyticsEnrichedItemResult {
|
|
|
892
1025
|
/**
|
|
893
1026
|
* Error if document fetch failed
|
|
894
1027
|
* @type {string}
|
|
895
|
-
* @memberof
|
|
1028
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
896
1029
|
*/
|
|
897
1030
|
'document_fetch_error'?: string;
|
|
1031
|
+
/**
|
|
1032
|
+
* Widget display data for UI presentation
|
|
1033
|
+
* @type {AnalyticsWidgetData}
|
|
1034
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1035
|
+
*/
|
|
1036
|
+
'widget'?: AnalyticsWidgetData;
|
|
898
1037
|
}
|
|
899
1038
|
/**
|
|
900
1039
|
*
|
|
@@ -902,6 +1041,30 @@ export interface AnalyticsEnrichedItemResult {
|
|
|
902
1041
|
* @interface AnalyticsExtendedKPIResponse
|
|
903
1042
|
*/
|
|
904
1043
|
export interface AnalyticsExtendedKPIResponse {
|
|
1044
|
+
/**
|
|
1045
|
+
*
|
|
1046
|
+
* @type {Array<AnalyticsKPIPointExtended>}
|
|
1047
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
1048
|
+
*/
|
|
1049
|
+
'compare_data'?: Array<AnalyticsKPIPointExtended>;
|
|
1050
|
+
/**
|
|
1051
|
+
*
|
|
1052
|
+
* @type {string}
|
|
1053
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
1054
|
+
*/
|
|
1055
|
+
'compare_end_time'?: string;
|
|
1056
|
+
/**
|
|
1057
|
+
* Comparison mode data
|
|
1058
|
+
* @type {string}
|
|
1059
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
1060
|
+
*/
|
|
1061
|
+
'compare_start_time'?: string;
|
|
1062
|
+
/**
|
|
1063
|
+
*
|
|
1064
|
+
* @type {AnalyticsKPIMetrics}
|
|
1065
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
1066
|
+
*/
|
|
1067
|
+
'compare_summary'?: AnalyticsKPIMetrics;
|
|
905
1068
|
/**
|
|
906
1069
|
*
|
|
907
1070
|
* @type {Array<AnalyticsKPIPointExtended>}
|
|
@@ -939,11 +1102,11 @@ export interface AnalyticsExtendedKPIResponse {
|
|
|
939
1102
|
*/
|
|
940
1103
|
'store_id'?: string;
|
|
941
1104
|
/**
|
|
942
|
-
*
|
|
943
|
-
* @type {
|
|
1105
|
+
* Can be KPIMetrics or ComparisonMetrics
|
|
1106
|
+
* @type {object}
|
|
944
1107
|
* @memberof AnalyticsExtendedKPIResponse
|
|
945
1108
|
*/
|
|
946
|
-
'summary'?:
|
|
1109
|
+
'summary'?: object;
|
|
947
1110
|
}
|
|
948
1111
|
/**
|
|
949
1112
|
*
|
|
@@ -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}
|
|
@@ -2783,6 +3121,43 @@ export interface AnalyticsTimeSeriesPoint {
|
|
|
2783
3121
|
*/
|
|
2784
3122
|
'value'?: number;
|
|
2785
3123
|
}
|
|
3124
|
+
/**
|
|
3125
|
+
*
|
|
3126
|
+
* @export
|
|
3127
|
+
* @interface AnalyticsWidgetData
|
|
3128
|
+
*/
|
|
3129
|
+
export interface AnalyticsWidgetData {
|
|
3130
|
+
/**
|
|
3131
|
+
*
|
|
3132
|
+
* @type {string}
|
|
3133
|
+
* @memberof AnalyticsWidgetData
|
|
3134
|
+
*/
|
|
3135
|
+
'id'?: string;
|
|
3136
|
+
/**
|
|
3137
|
+
*
|
|
3138
|
+
* @type {string}
|
|
3139
|
+
* @memberof AnalyticsWidgetData
|
|
3140
|
+
*/
|
|
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
|
+
}
|
|
2786
3161
|
/**
|
|
2787
3162
|
*
|
|
2788
3163
|
* @export
|
|
@@ -3735,122 +4110,290 @@ export interface DataTypesCreateMenuRequestDto {
|
|
|
3735
4110
|
* @type {number}
|
|
3736
4111
|
* @memberof DataTypesCreateMenuRequestDto
|
|
3737
4112
|
*/
|
|
3738
|
-
'orgId'?: number;
|
|
4113
|
+
'orgId'?: number;
|
|
4114
|
+
/**
|
|
4115
|
+
* INT, Foreign Key
|
|
4116
|
+
* @type {number}
|
|
4117
|
+
* @memberof DataTypesCreateMenuRequestDto
|
|
4118
|
+
*/
|
|
4119
|
+
'parentId'?: number;
|
|
4120
|
+
/**
|
|
4121
|
+
* VARCHAR(1000), nullable
|
|
4122
|
+
* @type {string}
|
|
4123
|
+
* @memberof DataTypesCreateMenuRequestDto
|
|
4124
|
+
*/
|
|
4125
|
+
'route'?: string;
|
|
4126
|
+
/**
|
|
4127
|
+
* INT, nullable
|
|
4128
|
+
* @type {number}
|
|
4129
|
+
* @memberof DataTypesCreateMenuRequestDto
|
|
4130
|
+
*/
|
|
4131
|
+
'sortOrder'?: number;
|
|
4132
|
+
/**
|
|
4133
|
+
*
|
|
4134
|
+
* @type {number}
|
|
4135
|
+
* @memberof DataTypesCreateMenuRequestDto
|
|
4136
|
+
*/
|
|
4137
|
+
'storeId'?: number;
|
|
4138
|
+
}
|
|
4139
|
+
/**
|
|
4140
|
+
*
|
|
4141
|
+
* @export
|
|
4142
|
+
* @interface DataTypesCreateOrganizationRequest
|
|
4143
|
+
*/
|
|
4144
|
+
export interface DataTypesCreateOrganizationRequest {
|
|
4145
|
+
/**
|
|
4146
|
+
*
|
|
4147
|
+
* @type {string}
|
|
4148
|
+
* @memberof DataTypesCreateOrganizationRequest
|
|
4149
|
+
*/
|
|
4150
|
+
'Address'?: string;
|
|
4151
|
+
/**
|
|
4152
|
+
*
|
|
4153
|
+
* @type {string}
|
|
4154
|
+
* @memberof DataTypesCreateOrganizationRequest
|
|
4155
|
+
*/
|
|
4156
|
+
'City'?: string;
|
|
4157
|
+
/**
|
|
4158
|
+
*
|
|
4159
|
+
* @type {string}
|
|
4160
|
+
* @memberof DataTypesCreateOrganizationRequest
|
|
4161
|
+
*/
|
|
4162
|
+
'Country'?: string;
|
|
4163
|
+
/**
|
|
4164
|
+
*
|
|
4165
|
+
* @type {string}
|
|
4166
|
+
* @memberof DataTypesCreateOrganizationRequest
|
|
4167
|
+
*/
|
|
4168
|
+
'EmailID'?: string;
|
|
4169
|
+
/**
|
|
4170
|
+
*
|
|
4171
|
+
* @type {string}
|
|
4172
|
+
* @memberof DataTypesCreateOrganizationRequest
|
|
4173
|
+
*/
|
|
4174
|
+
'Footer'?: string;
|
|
4175
|
+
/**
|
|
4176
|
+
*
|
|
4177
|
+
* @type {Array<number>}
|
|
4178
|
+
* @memberof DataTypesCreateOrganizationRequest
|
|
4179
|
+
*/
|
|
4180
|
+
'Logopath'?: Array<number>;
|
|
4181
|
+
/**
|
|
4182
|
+
*
|
|
4183
|
+
* @type {string}
|
|
4184
|
+
* @memberof DataTypesCreateOrganizationRequest
|
|
4185
|
+
*/
|
|
4186
|
+
'Note'?: string;
|
|
4187
|
+
/**
|
|
4188
|
+
*
|
|
4189
|
+
* @type {string}
|
|
4190
|
+
* @memberof DataTypesCreateOrganizationRequest
|
|
4191
|
+
*/
|
|
4192
|
+
'OrgCode'?: string;
|
|
4193
|
+
/**
|
|
4194
|
+
*
|
|
4195
|
+
* @type {string}
|
|
4196
|
+
* @memberof DataTypesCreateOrganizationRequest
|
|
4197
|
+
*/
|
|
4198
|
+
'OrgName'?: string;
|
|
4199
|
+
/**
|
|
4200
|
+
*
|
|
4201
|
+
* @type {string}
|
|
4202
|
+
* @memberof DataTypesCreateOrganizationRequest
|
|
4203
|
+
*/
|
|
4204
|
+
'PhoneNo'?: string;
|
|
4205
|
+
/**
|
|
4206
|
+
*
|
|
4207
|
+
* @type {string}
|
|
4208
|
+
* @memberof DataTypesCreateOrganizationRequest
|
|
4209
|
+
*/
|
|
4210
|
+
'RegistrationNo'?: string;
|
|
4211
|
+
/**
|
|
4212
|
+
*
|
|
4213
|
+
* @type {string}
|
|
4214
|
+
* @memberof DataTypesCreateOrganizationRequest
|
|
4215
|
+
*/
|
|
4216
|
+
'TIN'?: string;
|
|
4217
|
+
/**
|
|
4218
|
+
*
|
|
4219
|
+
* @type {string}
|
|
4220
|
+
* @memberof DataTypesCreateOrganizationRequest
|
|
4221
|
+
*/
|
|
4222
|
+
'Website'?: string;
|
|
4223
|
+
/**
|
|
4224
|
+
*
|
|
4225
|
+
* @type {string}
|
|
4226
|
+
* @memberof DataTypesCreateOrganizationRequest
|
|
4227
|
+
*/
|
|
4228
|
+
'ZipCode'?: string;
|
|
4229
|
+
}
|
|
4230
|
+
/**
|
|
4231
|
+
*
|
|
4232
|
+
* @export
|
|
4233
|
+
* @interface DataTypesCreatePaymentOrderRequest
|
|
4234
|
+
*/
|
|
4235
|
+
export interface DataTypesCreatePaymentOrderRequest {
|
|
4236
|
+
/**
|
|
4237
|
+
* Optional for subscription/credit (uses plan price)
|
|
4238
|
+
* @type {number}
|
|
4239
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4240
|
+
*/
|
|
4241
|
+
'amount'?: number;
|
|
4242
|
+
/**
|
|
4243
|
+
*
|
|
4244
|
+
* @type {boolean}
|
|
4245
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4246
|
+
*/
|
|
4247
|
+
'auto_renewal'?: boolean;
|
|
4248
|
+
/**
|
|
4249
|
+
* Fields for credit top-up
|
|
4250
|
+
* @type {number}
|
|
4251
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4252
|
+
*/
|
|
4253
|
+
'credit_plan_id'?: number;
|
|
4254
|
+
/**
|
|
4255
|
+
*
|
|
4256
|
+
* @type {string}
|
|
4257
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4258
|
+
*/
|
|
4259
|
+
'currency': string;
|
|
3739
4260
|
/**
|
|
3740
|
-
*
|
|
3741
|
-
* @type {
|
|
3742
|
-
* @memberof
|
|
4261
|
+
*
|
|
4262
|
+
* @type {DataTypesCustomerInfoDto}
|
|
4263
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
3743
4264
|
*/
|
|
3744
|
-
'
|
|
4265
|
+
'customer_info': DataTypesCustomerInfoDto;
|
|
3745
4266
|
/**
|
|
3746
|
-
*
|
|
4267
|
+
* Optional, auto-generated if not provided
|
|
3747
4268
|
* @type {string}
|
|
3748
|
-
* @memberof
|
|
4269
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
3749
4270
|
*/
|
|
3750
|
-
'
|
|
4271
|
+
'description'?: string;
|
|
3751
4272
|
/**
|
|
3752
|
-
*
|
|
3753
|
-
* @type {
|
|
3754
|
-
* @memberof
|
|
4273
|
+
* Optional, uses default if not specified
|
|
4274
|
+
* @type {string}
|
|
4275
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
3755
4276
|
*/
|
|
3756
|
-
'
|
|
4277
|
+
'gateway'?: string;
|
|
3757
4278
|
/**
|
|
3758
4279
|
*
|
|
4280
|
+
* @type {{ [key: string]: any; }}
|
|
4281
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4282
|
+
*/
|
|
4283
|
+
'metadata'?: {
|
|
4284
|
+
[key: string]: any;
|
|
4285
|
+
};
|
|
4286
|
+
/**
|
|
4287
|
+
* Fields for subscription payments
|
|
3759
4288
|
* @type {number}
|
|
3760
|
-
* @memberof
|
|
4289
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
3761
4290
|
*/
|
|
3762
|
-
'
|
|
3763
|
-
}
|
|
3764
|
-
/**
|
|
3765
|
-
*
|
|
3766
|
-
* @export
|
|
3767
|
-
* @interface DataTypesCreateOrganizationRequest
|
|
3768
|
-
*/
|
|
3769
|
-
export interface DataTypesCreateOrganizationRequest {
|
|
4291
|
+
'org_id'?: number;
|
|
3770
4292
|
/**
|
|
3771
4293
|
*
|
|
3772
4294
|
* @type {string}
|
|
3773
|
-
* @memberof
|
|
4295
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
3774
4296
|
*/
|
|
3775
|
-
'
|
|
4297
|
+
'payment_method'?: string;
|
|
3776
4298
|
/**
|
|
3777
4299
|
*
|
|
3778
4300
|
* @type {string}
|
|
3779
|
-
* @memberof
|
|
4301
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
3780
4302
|
*/
|
|
3781
|
-
'
|
|
4303
|
+
'payment_type': DataTypesCreatePaymentOrderRequestPaymentTypeEnum;
|
|
3782
4304
|
/**
|
|
3783
4305
|
*
|
|
3784
|
-
* @type {
|
|
3785
|
-
* @memberof
|
|
4306
|
+
* @type {number}
|
|
4307
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
3786
4308
|
*/
|
|
3787
|
-
'
|
|
4309
|
+
'plan_id'?: number;
|
|
3788
4310
|
/**
|
|
3789
4311
|
*
|
|
3790
4312
|
* @type {string}
|
|
3791
|
-
* @memberof
|
|
4313
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
3792
4314
|
*/
|
|
3793
|
-
'
|
|
4315
|
+
'return_url'?: string;
|
|
3794
4316
|
/**
|
|
3795
|
-
*
|
|
3796
|
-
* @type {
|
|
3797
|
-
* @memberof
|
|
4317
|
+
* Required for generic payments
|
|
4318
|
+
* @type {number}
|
|
4319
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
3798
4320
|
*/
|
|
3799
|
-
'
|
|
4321
|
+
'subs_id'?: number;
|
|
4322
|
+
}
|
|
4323
|
+
export declare const DataTypesCreatePaymentOrderRequestPaymentTypeEnum: {
|
|
4324
|
+
readonly Generic: "generic";
|
|
4325
|
+
readonly Subscription: "subscription";
|
|
4326
|
+
readonly CreditTopup: "credit_topup";
|
|
4327
|
+
};
|
|
4328
|
+
export type DataTypesCreatePaymentOrderRequestPaymentTypeEnum = typeof DataTypesCreatePaymentOrderRequestPaymentTypeEnum[keyof typeof DataTypesCreatePaymentOrderRequestPaymentTypeEnum];
|
|
4329
|
+
/**
|
|
4330
|
+
*
|
|
4331
|
+
* @export
|
|
4332
|
+
* @interface DataTypesCreatePaymentOrderResponse
|
|
4333
|
+
*/
|
|
4334
|
+
export interface DataTypesCreatePaymentOrderResponse {
|
|
3800
4335
|
/**
|
|
3801
4336
|
*
|
|
3802
|
-
* @type {
|
|
3803
|
-
* @memberof
|
|
4337
|
+
* @type {number}
|
|
4338
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
3804
4339
|
*/
|
|
3805
|
-
'
|
|
4340
|
+
'amount'?: number;
|
|
3806
4341
|
/**
|
|
3807
4342
|
*
|
|
3808
4343
|
* @type {string}
|
|
3809
|
-
* @memberof
|
|
4344
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
3810
4345
|
*/
|
|
3811
|
-
'
|
|
4346
|
+
'created_at'?: string;
|
|
3812
4347
|
/**
|
|
3813
4348
|
*
|
|
3814
4349
|
* @type {string}
|
|
3815
|
-
* @memberof
|
|
4350
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
3816
4351
|
*/
|
|
3817
|
-
'
|
|
4352
|
+
'currency'?: string;
|
|
3818
4353
|
/**
|
|
3819
4354
|
*
|
|
3820
4355
|
* @type {string}
|
|
3821
|
-
* @memberof
|
|
4356
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
3822
4357
|
*/
|
|
3823
|
-
'
|
|
4358
|
+
'expires_at'?: string;
|
|
3824
4359
|
/**
|
|
3825
4360
|
*
|
|
3826
4361
|
* @type {string}
|
|
3827
|
-
* @memberof
|
|
4362
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
3828
4363
|
*/
|
|
3829
|
-
'
|
|
4364
|
+
'gateway'?: string;
|
|
4365
|
+
/**
|
|
4366
|
+
*
|
|
4367
|
+
* @type {{ [key: string]: any; }}
|
|
4368
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4369
|
+
*/
|
|
4370
|
+
'gateway_response'?: {
|
|
4371
|
+
[key: string]: any;
|
|
4372
|
+
};
|
|
3830
4373
|
/**
|
|
3831
4374
|
*
|
|
3832
4375
|
* @type {string}
|
|
3833
|
-
* @memberof
|
|
4376
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
3834
4377
|
*/
|
|
3835
|
-
'
|
|
4378
|
+
'order_id'?: string;
|
|
3836
4379
|
/**
|
|
3837
4380
|
*
|
|
3838
4381
|
* @type {string}
|
|
3839
|
-
* @memberof
|
|
4382
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
3840
4383
|
*/
|
|
3841
|
-
'
|
|
4384
|
+
'payment_id'?: string;
|
|
3842
4385
|
/**
|
|
3843
4386
|
*
|
|
3844
4387
|
* @type {string}
|
|
3845
|
-
* @memberof
|
|
4388
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
3846
4389
|
*/
|
|
3847
|
-
'
|
|
4390
|
+
'payment_url'?: string;
|
|
3848
4391
|
/**
|
|
3849
4392
|
*
|
|
3850
4393
|
* @type {string}
|
|
3851
|
-
* @memberof
|
|
4394
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
3852
4395
|
*/
|
|
3853
|
-
'
|
|
4396
|
+
'status'?: string;
|
|
3854
4397
|
}
|
|
3855
4398
|
/**
|
|
3856
4399
|
*
|
|
@@ -4985,6 +5528,37 @@ export interface DataTypesCustomWordWithStatus {
|
|
|
4985
5528
|
*/
|
|
4986
5529
|
'word'?: string;
|
|
4987
5530
|
}
|
|
5531
|
+
/**
|
|
5532
|
+
*
|
|
5533
|
+
* @export
|
|
5534
|
+
* @interface DataTypesCustomerInfoDto
|
|
5535
|
+
*/
|
|
5536
|
+
export interface DataTypesCustomerInfoDto {
|
|
5537
|
+
/**
|
|
5538
|
+
*
|
|
5539
|
+
* @type {string}
|
|
5540
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5541
|
+
*/
|
|
5542
|
+
'address'?: string;
|
|
5543
|
+
/**
|
|
5544
|
+
*
|
|
5545
|
+
* @type {string}
|
|
5546
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5547
|
+
*/
|
|
5548
|
+
'email': string;
|
|
5549
|
+
/**
|
|
5550
|
+
*
|
|
5551
|
+
* @type {string}
|
|
5552
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5553
|
+
*/
|
|
5554
|
+
'name': string;
|
|
5555
|
+
/**
|
|
5556
|
+
*
|
|
5557
|
+
* @type {string}
|
|
5558
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5559
|
+
*/
|
|
5560
|
+
'phone': string;
|
|
5561
|
+
}
|
|
4988
5562
|
/**
|
|
4989
5563
|
*
|
|
4990
5564
|
* @export
|
|
@@ -5581,6 +6155,50 @@ export interface DataTypesFieldMetadata {
|
|
|
5581
6155
|
*/
|
|
5582
6156
|
'type'?: string;
|
|
5583
6157
|
}
|
|
6158
|
+
/**
|
|
6159
|
+
*
|
|
6160
|
+
* @export
|
|
6161
|
+
* @interface DataTypesGatewayInfo
|
|
6162
|
+
*/
|
|
6163
|
+
export interface DataTypesGatewayInfo {
|
|
6164
|
+
/**
|
|
6165
|
+
*
|
|
6166
|
+
* @type {Array<string>}
|
|
6167
|
+
* @memberof DataTypesGatewayInfo
|
|
6168
|
+
*/
|
|
6169
|
+
'features'?: Array<string>;
|
|
6170
|
+
/**
|
|
6171
|
+
*
|
|
6172
|
+
* @type {boolean}
|
|
6173
|
+
* @memberof DataTypesGatewayInfo
|
|
6174
|
+
*/
|
|
6175
|
+
'is_active'?: boolean;
|
|
6176
|
+
/**
|
|
6177
|
+
*
|
|
6178
|
+
* @type {boolean}
|
|
6179
|
+
* @memberof DataTypesGatewayInfo
|
|
6180
|
+
*/
|
|
6181
|
+
'is_default'?: boolean;
|
|
6182
|
+
/**
|
|
6183
|
+
*
|
|
6184
|
+
* @type {string}
|
|
6185
|
+
* @memberof DataTypesGatewayInfo
|
|
6186
|
+
*/
|
|
6187
|
+
'name'?: string;
|
|
6188
|
+
}
|
|
6189
|
+
/**
|
|
6190
|
+
*
|
|
6191
|
+
* @export
|
|
6192
|
+
* @interface DataTypesGatewayListResponse
|
|
6193
|
+
*/
|
|
6194
|
+
export interface DataTypesGatewayListResponse {
|
|
6195
|
+
/**
|
|
6196
|
+
*
|
|
6197
|
+
* @type {Array<DataTypesGatewayInfo>}
|
|
6198
|
+
* @memberof DataTypesGatewayListResponse
|
|
6199
|
+
*/
|
|
6200
|
+
'gateways'?: Array<DataTypesGatewayInfo>;
|
|
6201
|
+
}
|
|
5584
6202
|
/**
|
|
5585
6203
|
*
|
|
5586
6204
|
* @export
|
|
@@ -8151,6 +8769,69 @@ export interface DataTypesPaymentResponse {
|
|
|
8151
8769
|
*/
|
|
8152
8770
|
'status'?: number;
|
|
8153
8771
|
}
|
|
8772
|
+
/**
|
|
8773
|
+
*
|
|
8774
|
+
* @export
|
|
8775
|
+
* @interface DataTypesPaymentStatusResponse
|
|
8776
|
+
*/
|
|
8777
|
+
export interface DataTypesPaymentStatusResponse {
|
|
8778
|
+
/**
|
|
8779
|
+
*
|
|
8780
|
+
* @type {number}
|
|
8781
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8782
|
+
*/
|
|
8783
|
+
'amount'?: number;
|
|
8784
|
+
/**
|
|
8785
|
+
*
|
|
8786
|
+
* @type {string}
|
|
8787
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8788
|
+
*/
|
|
8789
|
+
'currency'?: string;
|
|
8790
|
+
/**
|
|
8791
|
+
*
|
|
8792
|
+
* @type {string}
|
|
8793
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8794
|
+
*/
|
|
8795
|
+
'failure_reason'?: string;
|
|
8796
|
+
/**
|
|
8797
|
+
*
|
|
8798
|
+
* @type {string}
|
|
8799
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8800
|
+
*/
|
|
8801
|
+
'gateway'?: string;
|
|
8802
|
+
/**
|
|
8803
|
+
*
|
|
8804
|
+
* @type {{ [key: string]: any; }}
|
|
8805
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8806
|
+
*/
|
|
8807
|
+
'gateway_data'?: {
|
|
8808
|
+
[key: string]: any;
|
|
8809
|
+
};
|
|
8810
|
+
/**
|
|
8811
|
+
*
|
|
8812
|
+
* @type {string}
|
|
8813
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8814
|
+
*/
|
|
8815
|
+
'order_id'?: string;
|
|
8816
|
+
/**
|
|
8817
|
+
*
|
|
8818
|
+
* @type {string}
|
|
8819
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8820
|
+
*/
|
|
8821
|
+
'payment_id'?: string;
|
|
8822
|
+
/**
|
|
8823
|
+
*
|
|
8824
|
+
* @type {string}
|
|
8825
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8826
|
+
*/
|
|
8827
|
+
'status'?: string;
|
|
8828
|
+
/**
|
|
8829
|
+
*
|
|
8830
|
+
* @type {string}
|
|
8831
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8832
|
+
*/
|
|
8833
|
+
'updated_at'?: string;
|
|
8834
|
+
}
|
|
8154
8835
|
/**
|
|
8155
8836
|
*
|
|
8156
8837
|
* @export
|
|
@@ -8634,45 +9315,135 @@ export interface DataTypesPurchaseCreditsRequest {
|
|
|
8634
9315
|
/**
|
|
8635
9316
|
*
|
|
8636
9317
|
* @export
|
|
8637
|
-
* @interface DataTypesPurchaseCreditsResponse
|
|
9318
|
+
* @interface DataTypesPurchaseCreditsResponse
|
|
9319
|
+
*/
|
|
9320
|
+
export interface DataTypesPurchaseCreditsResponse {
|
|
9321
|
+
/**
|
|
9322
|
+
*
|
|
9323
|
+
* @type {string}
|
|
9324
|
+
* @memberof DataTypesPurchaseCreditsResponse
|
|
9325
|
+
*/
|
|
9326
|
+
'message'?: string;
|
|
9327
|
+
/**
|
|
9328
|
+
*
|
|
9329
|
+
* @type {number}
|
|
9330
|
+
* @memberof DataTypesPurchaseCreditsResponse
|
|
9331
|
+
*/
|
|
9332
|
+
'payment_id'?: number;
|
|
9333
|
+
/**
|
|
9334
|
+
*
|
|
9335
|
+
* @type {number}
|
|
9336
|
+
* @memberof DataTypesPurchaseCreditsResponse
|
|
9337
|
+
*/
|
|
9338
|
+
'plan_id'?: number;
|
|
9339
|
+
/**
|
|
9340
|
+
*
|
|
9341
|
+
* @type {string}
|
|
9342
|
+
* @memberof DataTypesPurchaseCreditsResponse
|
|
9343
|
+
*/
|
|
9344
|
+
'purchase_date'?: string;
|
|
9345
|
+
/**
|
|
9346
|
+
*
|
|
9347
|
+
* @type {boolean}
|
|
9348
|
+
* @memberof DataTypesPurchaseCreditsResponse
|
|
9349
|
+
*/
|
|
9350
|
+
'success'?: boolean;
|
|
9351
|
+
/**
|
|
9352
|
+
*
|
|
9353
|
+
* @type {DataTypesCreditBalance}
|
|
9354
|
+
* @memberof DataTypesPurchaseCreditsResponse
|
|
9355
|
+
*/
|
|
9356
|
+
'updated_balance'?: DataTypesCreditBalance;
|
|
9357
|
+
}
|
|
9358
|
+
/**
|
|
9359
|
+
*
|
|
9360
|
+
* @export
|
|
9361
|
+
* @interface DataTypesRefundRequestDto
|
|
9362
|
+
*/
|
|
9363
|
+
export interface DataTypesRefundRequestDto {
|
|
9364
|
+
/**
|
|
9365
|
+
*
|
|
9366
|
+
* @type {number}
|
|
9367
|
+
* @memberof DataTypesRefundRequestDto
|
|
9368
|
+
*/
|
|
9369
|
+
'amount': number;
|
|
9370
|
+
/**
|
|
9371
|
+
*
|
|
9372
|
+
* @type {string}
|
|
9373
|
+
* @memberof DataTypesRefundRequestDto
|
|
9374
|
+
*/
|
|
9375
|
+
'gateway': string;
|
|
9376
|
+
/**
|
|
9377
|
+
*
|
|
9378
|
+
* @type {{ [key: string]: any; }}
|
|
9379
|
+
* @memberof DataTypesRefundRequestDto
|
|
9380
|
+
*/
|
|
9381
|
+
'metadata'?: {
|
|
9382
|
+
[key: string]: any;
|
|
9383
|
+
};
|
|
9384
|
+
/**
|
|
9385
|
+
*
|
|
9386
|
+
* @type {string}
|
|
9387
|
+
* @memberof DataTypesRefundRequestDto
|
|
9388
|
+
*/
|
|
9389
|
+
'payment_id': string;
|
|
9390
|
+
/**
|
|
9391
|
+
*
|
|
9392
|
+
* @type {string}
|
|
9393
|
+
* @memberof DataTypesRefundRequestDto
|
|
9394
|
+
*/
|
|
9395
|
+
'reason': string;
|
|
9396
|
+
}
|
|
9397
|
+
/**
|
|
9398
|
+
*
|
|
9399
|
+
* @export
|
|
9400
|
+
* @interface DataTypesRefundResponseDto
|
|
8638
9401
|
*/
|
|
8639
|
-
export interface
|
|
9402
|
+
export interface DataTypesRefundResponseDto {
|
|
9403
|
+
/**
|
|
9404
|
+
*
|
|
9405
|
+
* @type {number}
|
|
9406
|
+
* @memberof DataTypesRefundResponseDto
|
|
9407
|
+
*/
|
|
9408
|
+
'amount'?: number;
|
|
8640
9409
|
/**
|
|
8641
9410
|
*
|
|
8642
9411
|
* @type {string}
|
|
8643
|
-
* @memberof
|
|
9412
|
+
* @memberof DataTypesRefundResponseDto
|
|
8644
9413
|
*/
|
|
8645
|
-
'
|
|
9414
|
+
'created_at'?: string;
|
|
8646
9415
|
/**
|
|
8647
9416
|
*
|
|
8648
|
-
* @type {
|
|
8649
|
-
* @memberof
|
|
9417
|
+
* @type {string}
|
|
9418
|
+
* @memberof DataTypesRefundResponseDto
|
|
8650
9419
|
*/
|
|
8651
|
-
'
|
|
9420
|
+
'gateway'?: string;
|
|
8652
9421
|
/**
|
|
8653
9422
|
*
|
|
8654
|
-
* @type {
|
|
8655
|
-
* @memberof
|
|
9423
|
+
* @type {{ [key: string]: any; }}
|
|
9424
|
+
* @memberof DataTypesRefundResponseDto
|
|
8656
9425
|
*/
|
|
8657
|
-
'
|
|
9426
|
+
'gateway_response'?: {
|
|
9427
|
+
[key: string]: any;
|
|
9428
|
+
};
|
|
8658
9429
|
/**
|
|
8659
9430
|
*
|
|
8660
9431
|
* @type {string}
|
|
8661
|
-
* @memberof
|
|
9432
|
+
* @memberof DataTypesRefundResponseDto
|
|
8662
9433
|
*/
|
|
8663
|
-
'
|
|
9434
|
+
'payment_id'?: string;
|
|
8664
9435
|
/**
|
|
8665
9436
|
*
|
|
8666
|
-
* @type {
|
|
8667
|
-
* @memberof
|
|
9437
|
+
* @type {string}
|
|
9438
|
+
* @memberof DataTypesRefundResponseDto
|
|
8668
9439
|
*/
|
|
8669
|
-
'
|
|
9440
|
+
'refund_id'?: string;
|
|
8670
9441
|
/**
|
|
8671
9442
|
*
|
|
8672
|
-
* @type {
|
|
8673
|
-
* @memberof
|
|
9443
|
+
* @type {string}
|
|
9444
|
+
* @memberof DataTypesRefundResponseDto
|
|
8674
9445
|
*/
|
|
8675
|
-
'
|
|
9446
|
+
'status'?: string;
|
|
8676
9447
|
}
|
|
8677
9448
|
/**
|
|
8678
9449
|
*
|
|
@@ -11118,6 +11889,25 @@ export interface DataTypesVerifyOTPResponseWrapper {
|
|
|
11118
11889
|
*/
|
|
11119
11890
|
'status'?: number;
|
|
11120
11891
|
}
|
|
11892
|
+
/**
|
|
11893
|
+
*
|
|
11894
|
+
* @export
|
|
11895
|
+
* @interface DataTypesVerifyPaymentRequest
|
|
11896
|
+
*/
|
|
11897
|
+
export interface DataTypesVerifyPaymentRequest {
|
|
11898
|
+
/**
|
|
11899
|
+
*
|
|
11900
|
+
* @type {string}
|
|
11901
|
+
* @memberof DataTypesVerifyPaymentRequest
|
|
11902
|
+
*/
|
|
11903
|
+
'gateway': string;
|
|
11904
|
+
/**
|
|
11905
|
+
*
|
|
11906
|
+
* @type {string}
|
|
11907
|
+
* @memberof DataTypesVerifyPaymentRequest
|
|
11908
|
+
*/
|
|
11909
|
+
'payment_id': string;
|
|
11910
|
+
}
|
|
11121
11911
|
/**
|
|
11122
11912
|
*
|
|
11123
11913
|
* @export
|
|
@@ -12144,7 +12934,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12144
12934
|
*/
|
|
12145
12935
|
adminAnalyticsStoreXStoreIDFiltersTrendsGet: (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDFiltersTrendsGetGranularityEnum, filterKey?: string, topFilters?: number, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12146
12936
|
/**
|
|
12147
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
12937
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
12148
12938
|
* @summary Get Geographic Analytics
|
|
12149
12939
|
* @param {string} xStoreID Store ID
|
|
12150
12940
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12155,6 +12945,14 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12155
12945
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12156
12946
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12157
12947
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
12948
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12949
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12950
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
12951
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
12952
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
12953
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
12954
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
12955
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12158
12956
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12159
12957
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12160
12958
|
* @param {number} [page] Page number for pagination
|
|
@@ -12165,7 +12963,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12165
12963
|
* @param {*} [options] Override http request option.
|
|
12166
12964
|
* @throws {RequiredError}
|
|
12167
12965
|
*/
|
|
12168
|
-
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<RequestArgs>;
|
|
12966
|
+
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<RequestArgs>;
|
|
12169
12967
|
/**
|
|
12170
12968
|
* Check the health status of analytics service and ClickHouse connection
|
|
12171
12969
|
* @summary Analytics Health Check
|
|
@@ -12175,7 +12973,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12175
12973
|
*/
|
|
12176
12974
|
adminAnalyticsStoreXStoreIDHealthGet: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12177
12975
|
/**
|
|
12178
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
12976
|
+
* 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.
|
|
12179
12977
|
* @summary Get KPI Analytics
|
|
12180
12978
|
* @param {string} xStoreID Store ID
|
|
12181
12979
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12186,6 +12984,14 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12186
12984
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12187
12985
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12188
12986
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
12987
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12988
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12989
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
12990
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
12991
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
12992
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
12993
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
12994
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12189
12995
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12190
12996
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12191
12997
|
* @param {number} [page] Page number for pagination
|
|
@@ -12193,7 +12999,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12193
12999
|
* @param {*} [options] Override http request option.
|
|
12194
13000
|
* @throws {RequiredError}
|
|
12195
13001
|
*/
|
|
12196
|
-
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<RequestArgs>;
|
|
13002
|
+
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<RequestArgs>;
|
|
12197
13003
|
/**
|
|
12198
13004
|
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
12199
13005
|
* @summary Get Realtime KPI Analytics
|
|
@@ -12203,7 +13009,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12203
13009
|
*/
|
|
12204
13010
|
adminAnalyticsStoreXStoreIDKpiRealtimeGet: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12205
13011
|
/**
|
|
12206
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
13012
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
12207
13013
|
* @summary Get Query Analytics
|
|
12208
13014
|
* @param {string} xStoreID Store ID
|
|
12209
13015
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12215,6 +13021,14 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12215
13021
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12216
13022
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12217
13023
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13024
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13025
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13026
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13027
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13028
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13029
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13030
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13031
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12218
13032
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12219
13033
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12220
13034
|
* @param {number} [page] Page number for pagination
|
|
@@ -12226,13 +13040,27 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12226
13040
|
* @param {*} [options] Override http request option.
|
|
12227
13041
|
* @throws {RequiredError}
|
|
12228
13042
|
*/
|
|
12229
|
-
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<RequestArgs>;
|
|
13043
|
+
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<RequestArgs>;
|
|
12230
13044
|
/**
|
|
12231
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
13045
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
12232
13046
|
* @summary Get No-Clicks Queries
|
|
12233
13047
|
* @param {string} xStoreID Store ID
|
|
12234
13048
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12235
13049
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13050
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13051
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13052
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13053
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13054
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13055
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13056
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13057
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13058
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13059
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13060
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13061
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13062
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13063
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12236
13064
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12237
13065
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12238
13066
|
* @param {number} [page] Page number for pagination
|
|
@@ -12243,13 +13071,27 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12243
13071
|
* @param {*} [options] Override http request option.
|
|
12244
13072
|
* @throws {RequiredError}
|
|
12245
13073
|
*/
|
|
12246
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet: (xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13074
|
+
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<RequestArgs>;
|
|
12247
13075
|
/**
|
|
12248
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
13076
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
12249
13077
|
* @summary Get No-Results Queries
|
|
12250
13078
|
* @param {string} xStoreID Store ID
|
|
12251
13079
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12252
13080
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13081
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13082
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13083
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13084
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13085
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13086
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13087
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13088
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13089
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13090
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13091
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13092
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13093
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13094
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12253
13095
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12254
13096
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12255
13097
|
* @param {number} [page] Page number for pagination
|
|
@@ -12260,7 +13102,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12260
13102
|
* @param {*} [options] Override http request option.
|
|
12261
13103
|
* @throws {RequiredError}
|
|
12262
13104
|
*/
|
|
12263
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: (xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13105
|
+
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<RequestArgs>;
|
|
12264
13106
|
/**
|
|
12265
13107
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
12266
13108
|
* @summary Get Query Insights
|
|
@@ -12273,17 +13115,31 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12273
13115
|
*/
|
|
12274
13116
|
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12275
13117
|
/**
|
|
12276
|
-
* Retrieve analytics for top performing search results with
|
|
13118
|
+
* 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.
|
|
12277
13119
|
* @summary Get Top Results Analytics
|
|
12278
13120
|
* @param {string} xStoreID Store ID
|
|
12279
13121
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12280
13122
|
* @param {string} [endTime] End time in RFC3339 format
|
|
12281
13123
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
13124
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13125
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13126
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13127
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13128
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13129
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13130
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13131
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13132
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13133
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13134
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13135
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13136
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12282
13137
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
12283
13138
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
12284
13139
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
12285
13140
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
12286
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
13141
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
13142
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
12287
13143
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12288
13144
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12289
13145
|
* @param {number} [page] Page number for pagination
|
|
@@ -12291,7 +13147,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12291
13147
|
* @param {*} [options] Override http request option.
|
|
12292
13148
|
* @throws {RequiredError}
|
|
12293
13149
|
*/
|
|
12294
|
-
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<RequestArgs>;
|
|
13150
|
+
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<RequestArgs>;
|
|
12295
13151
|
/**
|
|
12296
13152
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
12297
13153
|
* @summary Get Analytics Tags
|
|
@@ -12430,7 +13286,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12430
13286
|
*/
|
|
12431
13287
|
adminAnalyticsStoreXStoreIDFiltersTrendsGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDFiltersTrendsGetGranularityEnum, filterKey?: string, topFilters?: number, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDFiltersTrendsGet200Response>>;
|
|
12432
13288
|
/**
|
|
12433
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
13289
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
12434
13290
|
* @summary Get Geographic Analytics
|
|
12435
13291
|
* @param {string} xStoreID Store ID
|
|
12436
13292
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12441,6 +13297,14 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12441
13297
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12442
13298
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12443
13299
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13300
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13301
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13302
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13303
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13304
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13305
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13306
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13307
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12444
13308
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12445
13309
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12446
13310
|
* @param {number} [page] Page number for pagination
|
|
@@ -12451,7 +13315,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12451
13315
|
* @param {*} [options] Override http request option.
|
|
12452
13316
|
* @throws {RequiredError}
|
|
12453
13317
|
*/
|
|
12454
|
-
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>>;
|
|
13318
|
+
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>>;
|
|
12455
13319
|
/**
|
|
12456
13320
|
* Check the health status of analytics service and ClickHouse connection
|
|
12457
13321
|
* @summary Analytics Health Check
|
|
@@ -12461,7 +13325,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12461
13325
|
*/
|
|
12462
13326
|
adminAnalyticsStoreXStoreIDHealthGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>>;
|
|
12463
13327
|
/**
|
|
12464
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
13328
|
+
* 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.
|
|
12465
13329
|
* @summary Get KPI Analytics
|
|
12466
13330
|
* @param {string} xStoreID Store ID
|
|
12467
13331
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12472,6 +13336,14 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12472
13336
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12473
13337
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12474
13338
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13339
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13340
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13341
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13342
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13343
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13344
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13345
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13346
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12475
13347
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12476
13348
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12477
13349
|
* @param {number} [page] Page number for pagination
|
|
@@ -12479,7 +13351,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12479
13351
|
* @param {*} [options] Override http request option.
|
|
12480
13352
|
* @throws {RequiredError}
|
|
12481
13353
|
*/
|
|
12482
|
-
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>>;
|
|
13354
|
+
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>>;
|
|
12483
13355
|
/**
|
|
12484
13356
|
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
12485
13357
|
* @summary Get Realtime KPI Analytics
|
|
@@ -12489,7 +13361,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12489
13361
|
*/
|
|
12490
13362
|
adminAnalyticsStoreXStoreIDKpiRealtimeGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>>;
|
|
12491
13363
|
/**
|
|
12492
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
13364
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
12493
13365
|
* @summary Get Query Analytics
|
|
12494
13366
|
* @param {string} xStoreID Store ID
|
|
12495
13367
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12501,6 +13373,14 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12501
13373
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12502
13374
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12503
13375
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13376
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13377
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13378
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13379
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13380
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13381
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13382
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13383
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12504
13384
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12505
13385
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12506
13386
|
* @param {number} [page] Page number for pagination
|
|
@@ -12512,13 +13392,27 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12512
13392
|
* @param {*} [options] Override http request option.
|
|
12513
13393
|
* @throws {RequiredError}
|
|
12514
13394
|
*/
|
|
12515
|
-
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>>;
|
|
13395
|
+
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>>;
|
|
12516
13396
|
/**
|
|
12517
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
13397
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
12518
13398
|
* @summary Get No-Clicks Queries
|
|
12519
13399
|
* @param {string} xStoreID Store ID
|
|
12520
13400
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12521
13401
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13402
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13403
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13404
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13405
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13406
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13407
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13408
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13409
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13410
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13411
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13412
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13413
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13414
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13415
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12522
13416
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12523
13417
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12524
13418
|
* @param {number} [page] Page number for pagination
|
|
@@ -12529,13 +13423,27 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12529
13423
|
* @param {*} [options] Override http request option.
|
|
12530
13424
|
* @throws {RequiredError}
|
|
12531
13425
|
*/
|
|
12532
|
-
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>>;
|
|
13426
|
+
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>>;
|
|
12533
13427
|
/**
|
|
12534
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
13428
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
12535
13429
|
* @summary Get No-Results Queries
|
|
12536
13430
|
* @param {string} xStoreID Store ID
|
|
12537
13431
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12538
13432
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13433
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13434
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13435
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13436
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13437
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13438
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13439
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13440
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13441
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13442
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13443
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13444
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13445
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13446
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12539
13447
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12540
13448
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12541
13449
|
* @param {number} [page] Page number for pagination
|
|
@@ -12546,7 +13454,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12546
13454
|
* @param {*} [options] Override http request option.
|
|
12547
13455
|
* @throws {RequiredError}
|
|
12548
13456
|
*/
|
|
12549
|
-
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>>;
|
|
13457
|
+
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>>;
|
|
12550
13458
|
/**
|
|
12551
13459
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
12552
13460
|
* @summary Get Query Insights
|
|
@@ -12559,17 +13467,31 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12559
13467
|
*/
|
|
12560
13468
|
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>>;
|
|
12561
13469
|
/**
|
|
12562
|
-
* Retrieve analytics for top performing search results with
|
|
13470
|
+
* 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.
|
|
12563
13471
|
* @summary Get Top Results Analytics
|
|
12564
13472
|
* @param {string} xStoreID Store ID
|
|
12565
13473
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12566
13474
|
* @param {string} [endTime] End time in RFC3339 format
|
|
12567
13475
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
13476
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13477
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13478
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13479
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13480
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13481
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13482
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13483
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13484
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13485
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13486
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13487
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13488
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12568
13489
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
12569
13490
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
12570
13491
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
12571
13492
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
12572
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
13493
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
13494
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
12573
13495
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12574
13496
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12575
13497
|
* @param {number} [page] Page number for pagination
|
|
@@ -12577,7 +13499,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12577
13499
|
* @param {*} [options] Override http request option.
|
|
12578
13500
|
* @throws {RequiredError}
|
|
12579
13501
|
*/
|
|
12580
|
-
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>>;
|
|
13502
|
+
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>>;
|
|
12581
13503
|
/**
|
|
12582
13504
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
12583
13505
|
* @summary Get Analytics Tags
|
|
@@ -12716,7 +13638,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12716
13638
|
*/
|
|
12717
13639
|
adminAnalyticsStoreXStoreIDFiltersTrendsGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDFiltersTrendsGetGranularityEnum, filterKey?: string, topFilters?: number, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDFiltersTrendsGet200Response>;
|
|
12718
13640
|
/**
|
|
12719
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
13641
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
12720
13642
|
* @summary Get Geographic Analytics
|
|
12721
13643
|
* @param {string} xStoreID Store ID
|
|
12722
13644
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12727,6 +13649,14 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12727
13649
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12728
13650
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12729
13651
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13652
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13653
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13654
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13655
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13656
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13657
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13658
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13659
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12730
13660
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12731
13661
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12732
13662
|
* @param {number} [page] Page number for pagination
|
|
@@ -12737,7 +13667,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12737
13667
|
* @param {*} [options] Override http request option.
|
|
12738
13668
|
* @throws {RequiredError}
|
|
12739
13669
|
*/
|
|
12740
|
-
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>;
|
|
13670
|
+
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>;
|
|
12741
13671
|
/**
|
|
12742
13672
|
* Check the health status of analytics service and ClickHouse connection
|
|
12743
13673
|
* @summary Analytics Health Check
|
|
@@ -12747,7 +13677,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12747
13677
|
*/
|
|
12748
13678
|
adminAnalyticsStoreXStoreIDHealthGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse>;
|
|
12749
13679
|
/**
|
|
12750
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
13680
|
+
* 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.
|
|
12751
13681
|
* @summary Get KPI Analytics
|
|
12752
13682
|
* @param {string} xStoreID Store ID
|
|
12753
13683
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12758,6 +13688,14 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12758
13688
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12759
13689
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12760
13690
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13691
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13692
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13693
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13694
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13695
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13696
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13697
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13698
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12761
13699
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12762
13700
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12763
13701
|
* @param {number} [page] Page number for pagination
|
|
@@ -12765,7 +13703,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12765
13703
|
* @param {*} [options] Override http request option.
|
|
12766
13704
|
* @throws {RequiredError}
|
|
12767
13705
|
*/
|
|
12768
|
-
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>;
|
|
13706
|
+
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>;
|
|
12769
13707
|
/**
|
|
12770
13708
|
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
12771
13709
|
* @summary Get Realtime KPI Analytics
|
|
@@ -12775,7 +13713,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12775
13713
|
*/
|
|
12776
13714
|
adminAnalyticsStoreXStoreIDKpiRealtimeGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse>;
|
|
12777
13715
|
/**
|
|
12778
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
13716
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
12779
13717
|
* @summary Get Query Analytics
|
|
12780
13718
|
* @param {string} xStoreID Store ID
|
|
12781
13719
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12787,6 +13725,14 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12787
13725
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12788
13726
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12789
13727
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13728
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13729
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13730
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13731
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13732
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13733
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13734
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13735
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12790
13736
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12791
13737
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12792
13738
|
* @param {number} [page] Page number for pagination
|
|
@@ -12798,13 +13744,27 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12798
13744
|
* @param {*} [options] Override http request option.
|
|
12799
13745
|
* @throws {RequiredError}
|
|
12800
13746
|
*/
|
|
12801
|
-
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>;
|
|
13747
|
+
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>;
|
|
12802
13748
|
/**
|
|
12803
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
13749
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
12804
13750
|
* @summary Get No-Clicks Queries
|
|
12805
13751
|
* @param {string} xStoreID Store ID
|
|
12806
13752
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12807
13753
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13754
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13755
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13756
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13757
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13758
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13759
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13760
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13761
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13762
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13763
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13764
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13765
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13766
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13767
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12808
13768
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12809
13769
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12810
13770
|
* @param {number} [page] Page number for pagination
|
|
@@ -12815,13 +13775,27 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12815
13775
|
* @param {*} [options] Override http request option.
|
|
12816
13776
|
* @throws {RequiredError}
|
|
12817
13777
|
*/
|
|
12818
|
-
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>;
|
|
13778
|
+
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>;
|
|
12819
13779
|
/**
|
|
12820
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
13780
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
12821
13781
|
* @summary Get No-Results Queries
|
|
12822
13782
|
* @param {string} xStoreID Store ID
|
|
12823
13783
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12824
13784
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13785
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13786
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13787
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13788
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13789
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13790
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13791
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13792
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13793
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13794
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13795
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13796
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13797
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13798
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12825
13799
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12826
13800
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12827
13801
|
* @param {number} [page] Page number for pagination
|
|
@@ -12832,7 +13806,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12832
13806
|
* @param {*} [options] Override http request option.
|
|
12833
13807
|
* @throws {RequiredError}
|
|
12834
13808
|
*/
|
|
12835
|
-
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>;
|
|
13809
|
+
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>;
|
|
12836
13810
|
/**
|
|
12837
13811
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
12838
13812
|
* @summary Get Query Insights
|
|
@@ -12845,17 +13819,31 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12845
13819
|
*/
|
|
12846
13820
|
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>;
|
|
12847
13821
|
/**
|
|
12848
|
-
* Retrieve analytics for top performing search results with
|
|
13822
|
+
* 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.
|
|
12849
13823
|
* @summary Get Top Results Analytics
|
|
12850
13824
|
* @param {string} xStoreID Store ID
|
|
12851
13825
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12852
13826
|
* @param {string} [endTime] End time in RFC3339 format
|
|
12853
13827
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
13828
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13829
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13830
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13831
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13832
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13833
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13834
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13835
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13836
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13837
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13838
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13839
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13840
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12854
13841
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
12855
13842
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
12856
13843
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
12857
13844
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
12858
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
13845
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
13846
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
12859
13847
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12860
13848
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12861
13849
|
* @param {number} [page] Page number for pagination
|
|
@@ -12863,7 +13851,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12863
13851
|
* @param {*} [options] Override http request option.
|
|
12864
13852
|
* @throws {RequiredError}
|
|
12865
13853
|
*/
|
|
12866
|
-
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>;
|
|
13854
|
+
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>;
|
|
12867
13855
|
/**
|
|
12868
13856
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
12869
13857
|
* @summary Get Analytics Tags
|
|
@@ -13010,7 +13998,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13010
13998
|
*/
|
|
13011
13999
|
adminAnalyticsStoreXStoreIDFiltersTrendsGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDFiltersTrendsGetGranularityEnum, filterKey?: string, topFilters?: number, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDFiltersTrendsGet200Response, any>>;
|
|
13012
14000
|
/**
|
|
13013
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
14001
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
13014
14002
|
* @summary Get Geographic Analytics
|
|
13015
14003
|
* @param {string} xStoreID Store ID
|
|
13016
14004
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -13021,6 +14009,14 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13021
14009
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13022
14010
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13023
14011
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14012
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14013
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14014
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14015
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14016
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14017
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14018
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14019
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13024
14020
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13025
14021
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13026
14022
|
* @param {number} [page] Page number for pagination
|
|
@@ -13032,7 +14028,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13032
14028
|
* @throws {RequiredError}
|
|
13033
14029
|
* @memberof AnalyticsApi
|
|
13034
14030
|
*/
|
|
13035
|
-
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDGeoGet200Response, any>>;
|
|
14031
|
+
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDGeoGet200Response, any>>;
|
|
13036
14032
|
/**
|
|
13037
14033
|
* Check the health status of analytics service and ClickHouse connection
|
|
13038
14034
|
* @summary Analytics Health Check
|
|
@@ -13043,7 +14039,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13043
14039
|
*/
|
|
13044
14040
|
adminAnalyticsStoreXStoreIDHealthGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsAnalyticsAPIResponse, any>>;
|
|
13045
14041
|
/**
|
|
13046
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
14042
|
+
* 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.
|
|
13047
14043
|
* @summary Get KPI Analytics
|
|
13048
14044
|
* @param {string} xStoreID Store ID
|
|
13049
14045
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -13054,6 +14050,14 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13054
14050
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13055
14051
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13056
14052
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14053
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14054
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14055
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14056
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14057
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14058
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14059
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14060
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13057
14061
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13058
14062
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13059
14063
|
* @param {number} [page] Page number for pagination
|
|
@@ -13062,7 +14066,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13062
14066
|
* @throws {RequiredError}
|
|
13063
14067
|
* @memberof AnalyticsApi
|
|
13064
14068
|
*/
|
|
13065
|
-
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDKpiGet200Response, any>>;
|
|
14069
|
+
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDKpiGet200Response, any>>;
|
|
13066
14070
|
/**
|
|
13067
14071
|
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
13068
14072
|
* @summary Get Realtime KPI Analytics
|
|
@@ -13073,7 +14077,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13073
14077
|
*/
|
|
13074
14078
|
adminAnalyticsStoreXStoreIDKpiRealtimeGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsAnalyticsAPIResponse, any>>;
|
|
13075
14079
|
/**
|
|
13076
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
14080
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
13077
14081
|
* @summary Get Query Analytics
|
|
13078
14082
|
* @param {string} xStoreID Store ID
|
|
13079
14083
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -13085,6 +14089,14 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13085
14089
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13086
14090
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13087
14091
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14092
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14093
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14094
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14095
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14096
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14097
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14098
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14099
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13088
14100
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13089
14101
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13090
14102
|
* @param {number} [page] Page number for pagination
|
|
@@ -13097,13 +14109,27 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13097
14109
|
* @throws {RequiredError}
|
|
13098
14110
|
* @memberof AnalyticsApi
|
|
13099
14111
|
*/
|
|
13100
|
-
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesGet200Response, any>>;
|
|
14112
|
+
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesGet200Response, any>>;
|
|
13101
14113
|
/**
|
|
13102
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
14114
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
13103
14115
|
* @summary Get No-Clicks Queries
|
|
13104
14116
|
* @param {string} xStoreID Store ID
|
|
13105
14117
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13106
14118
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14119
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
14120
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
14121
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
14122
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14123
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14124
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14125
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14126
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14127
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14128
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14129
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14130
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14131
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14132
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13107
14133
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13108
14134
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13109
14135
|
* @param {number} [page] Page number for pagination
|
|
@@ -13115,13 +14141,27 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13115
14141
|
* @throws {RequiredError}
|
|
13116
14142
|
* @memberof AnalyticsApi
|
|
13117
14143
|
*/
|
|
13118
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response, any>>;
|
|
14144
|
+
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response, any>>;
|
|
13119
14145
|
/**
|
|
13120
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
14146
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
13121
14147
|
* @summary Get No-Results Queries
|
|
13122
14148
|
* @param {string} xStoreID Store ID
|
|
13123
14149
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13124
14150
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14151
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
14152
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
14153
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
14154
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14155
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14156
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14157
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14158
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14159
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14160
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14161
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14162
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14163
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14164
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13125
14165
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13126
14166
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13127
14167
|
* @param {number} [page] Page number for pagination
|
|
@@ -13133,7 +14173,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13133
14173
|
* @throws {RequiredError}
|
|
13134
14174
|
* @memberof AnalyticsApi
|
|
13135
14175
|
*/
|
|
13136
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response, any>>;
|
|
14176
|
+
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response, any>>;
|
|
13137
14177
|
/**
|
|
13138
14178
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
13139
14179
|
* @summary Get Query Insights
|
|
@@ -13147,17 +14187,31 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13147
14187
|
*/
|
|
13148
14188
|
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any>>;
|
|
13149
14189
|
/**
|
|
13150
|
-
* Retrieve analytics for top performing search results with
|
|
14190
|
+
* 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.
|
|
13151
14191
|
* @summary Get Top Results Analytics
|
|
13152
14192
|
* @param {string} xStoreID Store ID
|
|
13153
14193
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13154
14194
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13155
14195
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
14196
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
14197
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
14198
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14199
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14200
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14201
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14202
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14203
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14204
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14205
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14206
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14207
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14208
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13156
14209
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
13157
14210
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
13158
14211
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
13159
14212
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
13160
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
14213
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
14214
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
13161
14215
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13162
14216
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13163
14217
|
* @param {number} [page] Page number for pagination
|
|
@@ -13166,7 +14220,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13166
14220
|
* @throws {RequiredError}
|
|
13167
14221
|
* @memberof AnalyticsApi
|
|
13168
14222
|
*/
|
|
13169
|
-
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response, any>>;
|
|
14223
|
+
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response, any>>;
|
|
13170
14224
|
/**
|
|
13171
14225
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
13172
14226
|
* @summary Get Analytics Tags
|
|
@@ -13325,6 +14379,14 @@ export declare const AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum: {
|
|
|
13325
14379
|
readonly All: "all";
|
|
13326
14380
|
};
|
|
13327
14381
|
export type AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum];
|
|
14382
|
+
/**
|
|
14383
|
+
* @export
|
|
14384
|
+
*/
|
|
14385
|
+
export declare const AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum: {
|
|
14386
|
+
readonly Any: "any";
|
|
14387
|
+
readonly All: "all";
|
|
14388
|
+
};
|
|
14389
|
+
export type AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum];
|
|
13328
14390
|
/**
|
|
13329
14391
|
* @export
|
|
13330
14392
|
*/
|
|
@@ -13366,6 +14428,14 @@ export declare const AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum: {
|
|
|
13366
14428
|
readonly All: "all";
|
|
13367
14429
|
};
|
|
13368
14430
|
export type AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum];
|
|
14431
|
+
/**
|
|
14432
|
+
* @export
|
|
14433
|
+
*/
|
|
14434
|
+
export declare const AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum: {
|
|
14435
|
+
readonly Any: "any";
|
|
14436
|
+
readonly All: "all";
|
|
14437
|
+
};
|
|
14438
|
+
export type AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum];
|
|
13369
14439
|
/**
|
|
13370
14440
|
* @export
|
|
13371
14441
|
*/
|
|
@@ -13387,6 +14457,14 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum: {
|
|
|
13387
14457
|
readonly All: "all";
|
|
13388
14458
|
};
|
|
13389
14459
|
export type AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum];
|
|
14460
|
+
/**
|
|
14461
|
+
* @export
|
|
14462
|
+
*/
|
|
14463
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum: {
|
|
14464
|
+
readonly Any: "any";
|
|
14465
|
+
readonly All: "all";
|
|
14466
|
+
};
|
|
14467
|
+
export type AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum];
|
|
13390
14468
|
/**
|
|
13391
14469
|
* @export
|
|
13392
14470
|
*/
|
|
@@ -13407,6 +14485,22 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum: {
|
|
|
13407
14485
|
readonly Desc: "desc";
|
|
13408
14486
|
};
|
|
13409
14487
|
export type AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum];
|
|
14488
|
+
/**
|
|
14489
|
+
* @export
|
|
14490
|
+
*/
|
|
14491
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum: {
|
|
14492
|
+
readonly Any: "any";
|
|
14493
|
+
readonly All: "all";
|
|
14494
|
+
};
|
|
14495
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum];
|
|
14496
|
+
/**
|
|
14497
|
+
* @export
|
|
14498
|
+
*/
|
|
14499
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum: {
|
|
14500
|
+
readonly Any: "any";
|
|
14501
|
+
readonly All: "all";
|
|
14502
|
+
};
|
|
14503
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum];
|
|
13410
14504
|
/**
|
|
13411
14505
|
* @export
|
|
13412
14506
|
*/
|
|
@@ -13424,6 +14518,22 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum:
|
|
|
13424
14518
|
readonly Desc: "desc";
|
|
13425
14519
|
};
|
|
13426
14520
|
export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum];
|
|
14521
|
+
/**
|
|
14522
|
+
* @export
|
|
14523
|
+
*/
|
|
14524
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum: {
|
|
14525
|
+
readonly Any: "any";
|
|
14526
|
+
readonly All: "all";
|
|
14527
|
+
};
|
|
14528
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum];
|
|
14529
|
+
/**
|
|
14530
|
+
* @export
|
|
14531
|
+
*/
|
|
14532
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum: {
|
|
14533
|
+
readonly Any: "any";
|
|
14534
|
+
readonly All: "all";
|
|
14535
|
+
};
|
|
14536
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum];
|
|
13427
14537
|
/**
|
|
13428
14538
|
* @export
|
|
13429
14539
|
*/
|
|
@@ -13441,6 +14551,22 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum
|
|
|
13441
14551
|
readonly Desc: "desc";
|
|
13442
14552
|
};
|
|
13443
14553
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
14554
|
+
/**
|
|
14555
|
+
* @export
|
|
14556
|
+
*/
|
|
14557
|
+
export declare const AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum: {
|
|
14558
|
+
readonly Any: "any";
|
|
14559
|
+
readonly All: "all";
|
|
14560
|
+
};
|
|
14561
|
+
export type AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum];
|
|
14562
|
+
/**
|
|
14563
|
+
* @export
|
|
14564
|
+
*/
|
|
14565
|
+
export declare const AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum: {
|
|
14566
|
+
readonly Any: "any";
|
|
14567
|
+
readonly All: "all";
|
|
14568
|
+
};
|
|
14569
|
+
export type AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum];
|
|
13444
14570
|
/**
|
|
13445
14571
|
* @export
|
|
13446
14572
|
*/
|
|
@@ -17758,6 +18884,189 @@ export declare class ParentMenusApi extends BaseAPI {
|
|
|
17758
18884
|
*/
|
|
17759
18885
|
miscParentMenusPost(parentMenu: DataTypesParentMenu, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
|
|
17760
18886
|
}
|
|
18887
|
+
/**
|
|
18888
|
+
* PaymentGatewayApi - axios parameter creator
|
|
18889
|
+
* @export
|
|
18890
|
+
*/
|
|
18891
|
+
export declare const PaymentGatewayApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
18892
|
+
/**
|
|
18893
|
+
* Creates a payment order using specified or default payment gateway
|
|
18894
|
+
* @summary Create a new payment order
|
|
18895
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
18896
|
+
* @param {*} [options] Override http request option.
|
|
18897
|
+
* @throws {RequiredError}
|
|
18898
|
+
*/
|
|
18899
|
+
paymentGatewayCreateOrderPost: (order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18900
|
+
/**
|
|
18901
|
+
* Returns list of all active credit plans for purchase
|
|
18902
|
+
* @summary Get available credit plans
|
|
18903
|
+
* @param {*} [options] Override http request option.
|
|
18904
|
+
* @throws {RequiredError}
|
|
18905
|
+
*/
|
|
18906
|
+
paymentGatewayCreditPlansGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18907
|
+
/**
|
|
18908
|
+
* Returns list of all available payment gateways
|
|
18909
|
+
* @summary Get available payment gateways
|
|
18910
|
+
* @param {*} [options] Override http request option.
|
|
18911
|
+
* @throws {RequiredError}
|
|
18912
|
+
*/
|
|
18913
|
+
paymentGatewayGatewaysGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18914
|
+
/**
|
|
18915
|
+
* Processes a refund for a completed payment
|
|
18916
|
+
* @summary Process payment refund
|
|
18917
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
18918
|
+
* @param {*} [options] Override http request option.
|
|
18919
|
+
* @throws {RequiredError}
|
|
18920
|
+
*/
|
|
18921
|
+
paymentGatewayRefundPost: (refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18922
|
+
/**
|
|
18923
|
+
* Verifies the current status of a payment
|
|
18924
|
+
* @summary Verify payment status
|
|
18925
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
18926
|
+
* @param {*} [options] Override http request option.
|
|
18927
|
+
* @throws {RequiredError}
|
|
18928
|
+
*/
|
|
18929
|
+
paymentGatewayVerifyPost: (verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18930
|
+
};
|
|
18931
|
+
/**
|
|
18932
|
+
* PaymentGatewayApi - functional programming interface
|
|
18933
|
+
* @export
|
|
18934
|
+
*/
|
|
18935
|
+
export declare const PaymentGatewayApiFp: (configuration?: Configuration) => {
|
|
18936
|
+
/**
|
|
18937
|
+
* Creates a payment order using specified or default payment gateway
|
|
18938
|
+
* @summary Create a new payment order
|
|
18939
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
18940
|
+
* @param {*} [options] Override http request option.
|
|
18941
|
+
* @throws {RequiredError}
|
|
18942
|
+
*/
|
|
18943
|
+
paymentGatewayCreateOrderPost(order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCreatePaymentOrderResponse>>;
|
|
18944
|
+
/**
|
|
18945
|
+
* Returns list of all active credit plans for purchase
|
|
18946
|
+
* @summary Get available credit plans
|
|
18947
|
+
* @param {*} [options] Override http request option.
|
|
18948
|
+
* @throws {RequiredError}
|
|
18949
|
+
*/
|
|
18950
|
+
paymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DataTypesCreditPlan>>>;
|
|
18951
|
+
/**
|
|
18952
|
+
* Returns list of all available payment gateways
|
|
18953
|
+
* @summary Get available payment gateways
|
|
18954
|
+
* @param {*} [options] Override http request option.
|
|
18955
|
+
* @throws {RequiredError}
|
|
18956
|
+
*/
|
|
18957
|
+
paymentGatewayGatewaysGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGatewayListResponse>>;
|
|
18958
|
+
/**
|
|
18959
|
+
* Processes a refund for a completed payment
|
|
18960
|
+
* @summary Process payment refund
|
|
18961
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
18962
|
+
* @param {*} [options] Override http request option.
|
|
18963
|
+
* @throws {RequiredError}
|
|
18964
|
+
*/
|
|
18965
|
+
paymentGatewayRefundPost(refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRefundResponseDto>>;
|
|
18966
|
+
/**
|
|
18967
|
+
* Verifies the current status of a payment
|
|
18968
|
+
* @summary Verify payment status
|
|
18969
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
18970
|
+
* @param {*} [options] Override http request option.
|
|
18971
|
+
* @throws {RequiredError}
|
|
18972
|
+
*/
|
|
18973
|
+
paymentGatewayVerifyPost(verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPaymentStatusResponse>>;
|
|
18974
|
+
};
|
|
18975
|
+
/**
|
|
18976
|
+
* PaymentGatewayApi - factory interface
|
|
18977
|
+
* @export
|
|
18978
|
+
*/
|
|
18979
|
+
export declare const PaymentGatewayApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
18980
|
+
/**
|
|
18981
|
+
* Creates a payment order using specified or default payment gateway
|
|
18982
|
+
* @summary Create a new payment order
|
|
18983
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
18984
|
+
* @param {*} [options] Override http request option.
|
|
18985
|
+
* @throws {RequiredError}
|
|
18986
|
+
*/
|
|
18987
|
+
paymentGatewayCreateOrderPost(order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCreatePaymentOrderResponse>;
|
|
18988
|
+
/**
|
|
18989
|
+
* Returns list of all active credit plans for purchase
|
|
18990
|
+
* @summary Get available credit plans
|
|
18991
|
+
* @param {*} [options] Override http request option.
|
|
18992
|
+
* @throws {RequiredError}
|
|
18993
|
+
*/
|
|
18994
|
+
paymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): AxiosPromise<Array<DataTypesCreditPlan>>;
|
|
18995
|
+
/**
|
|
18996
|
+
* Returns list of all available payment gateways
|
|
18997
|
+
* @summary Get available payment gateways
|
|
18998
|
+
* @param {*} [options] Override http request option.
|
|
18999
|
+
* @throws {RequiredError}
|
|
19000
|
+
*/
|
|
19001
|
+
paymentGatewayGatewaysGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGatewayListResponse>;
|
|
19002
|
+
/**
|
|
19003
|
+
* Processes a refund for a completed payment
|
|
19004
|
+
* @summary Process payment refund
|
|
19005
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
19006
|
+
* @param {*} [options] Override http request option.
|
|
19007
|
+
* @throws {RequiredError}
|
|
19008
|
+
*/
|
|
19009
|
+
paymentGatewayRefundPost(refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRefundResponseDto>;
|
|
19010
|
+
/**
|
|
19011
|
+
* Verifies the current status of a payment
|
|
19012
|
+
* @summary Verify payment status
|
|
19013
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
19014
|
+
* @param {*} [options] Override http request option.
|
|
19015
|
+
* @throws {RequiredError}
|
|
19016
|
+
*/
|
|
19017
|
+
paymentGatewayVerifyPost(verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPaymentStatusResponse>;
|
|
19018
|
+
};
|
|
19019
|
+
/**
|
|
19020
|
+
* PaymentGatewayApi - object-oriented interface
|
|
19021
|
+
* @export
|
|
19022
|
+
* @class PaymentGatewayApi
|
|
19023
|
+
* @extends {BaseAPI}
|
|
19024
|
+
*/
|
|
19025
|
+
export declare class PaymentGatewayApi extends BaseAPI {
|
|
19026
|
+
/**
|
|
19027
|
+
* Creates a payment order using specified or default payment gateway
|
|
19028
|
+
* @summary Create a new payment order
|
|
19029
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
19030
|
+
* @param {*} [options] Override http request option.
|
|
19031
|
+
* @throws {RequiredError}
|
|
19032
|
+
* @memberof PaymentGatewayApi
|
|
19033
|
+
*/
|
|
19034
|
+
paymentGatewayCreateOrderPost(order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCreatePaymentOrderResponse, any>>;
|
|
19035
|
+
/**
|
|
19036
|
+
* Returns list of all active credit plans for purchase
|
|
19037
|
+
* @summary Get available credit plans
|
|
19038
|
+
* @param {*} [options] Override http request option.
|
|
19039
|
+
* @throws {RequiredError}
|
|
19040
|
+
* @memberof PaymentGatewayApi
|
|
19041
|
+
*/
|
|
19042
|
+
paymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCreditPlan[], any>>;
|
|
19043
|
+
/**
|
|
19044
|
+
* Returns list of all available payment gateways
|
|
19045
|
+
* @summary Get available payment gateways
|
|
19046
|
+
* @param {*} [options] Override http request option.
|
|
19047
|
+
* @throws {RequiredError}
|
|
19048
|
+
* @memberof PaymentGatewayApi
|
|
19049
|
+
*/
|
|
19050
|
+
paymentGatewayGatewaysGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGatewayListResponse, any>>;
|
|
19051
|
+
/**
|
|
19052
|
+
* Processes a refund for a completed payment
|
|
19053
|
+
* @summary Process payment refund
|
|
19054
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
19055
|
+
* @param {*} [options] Override http request option.
|
|
19056
|
+
* @throws {RequiredError}
|
|
19057
|
+
* @memberof PaymentGatewayApi
|
|
19058
|
+
*/
|
|
19059
|
+
paymentGatewayRefundPost(refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesRefundResponseDto, any>>;
|
|
19060
|
+
/**
|
|
19061
|
+
* Verifies the current status of a payment
|
|
19062
|
+
* @summary Verify payment status
|
|
19063
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
19064
|
+
* @param {*} [options] Override http request option.
|
|
19065
|
+
* @throws {RequiredError}
|
|
19066
|
+
* @memberof PaymentGatewayApi
|
|
19067
|
+
*/
|
|
19068
|
+
paymentGatewayVerifyPost(verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesPaymentStatusResponse, any>>;
|
|
19069
|
+
}
|
|
17761
19070
|
/**
|
|
17762
19071
|
* PaymentsApi - axios parameter creator
|
|
17763
19072
|
* @export
|