@seekora-ai/admin-api 1.0.45 → 1.0.46
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 +6 -3
- package/api.ts +839 -80
- package/dist/api.d.ts +649 -62
- package/dist/api.js +410 -74
- package/dist/esm/api.d.ts +649 -62
- package/dist/esm/api.js +406 -70
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.46.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
|
|
@@ -12144,7 +12519,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12144
12519
|
*/
|
|
12145
12520
|
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
12521
|
/**
|
|
12147
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
12522
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
12148
12523
|
* @summary Get Geographic Analytics
|
|
12149
12524
|
* @param {string} xStoreID Store ID
|
|
12150
12525
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12155,6 +12530,14 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12155
12530
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12156
12531
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12157
12532
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
12533
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12534
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12535
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
12536
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
12537
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
12538
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
12539
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
12540
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12158
12541
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12159
12542
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12160
12543
|
* @param {number} [page] Page number for pagination
|
|
@@ -12165,7 +12548,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12165
12548
|
* @param {*} [options] Override http request option.
|
|
12166
12549
|
* @throws {RequiredError}
|
|
12167
12550
|
*/
|
|
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>;
|
|
12551
|
+
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
12552
|
/**
|
|
12170
12553
|
* Check the health status of analytics service and ClickHouse connection
|
|
12171
12554
|
* @summary Analytics Health Check
|
|
@@ -12175,7 +12558,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12175
12558
|
*/
|
|
12176
12559
|
adminAnalyticsStoreXStoreIDHealthGet: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12177
12560
|
/**
|
|
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.
|
|
12561
|
+
* 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
12562
|
* @summary Get KPI Analytics
|
|
12180
12563
|
* @param {string} xStoreID Store ID
|
|
12181
12564
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12186,6 +12569,14 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12186
12569
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12187
12570
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12188
12571
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
12572
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12573
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12574
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
12575
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
12576
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
12577
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
12578
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
12579
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12189
12580
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12190
12581
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12191
12582
|
* @param {number} [page] Page number for pagination
|
|
@@ -12193,7 +12584,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12193
12584
|
* @param {*} [options] Override http request option.
|
|
12194
12585
|
* @throws {RequiredError}
|
|
12195
12586
|
*/
|
|
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>;
|
|
12587
|
+
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
12588
|
/**
|
|
12198
12589
|
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
12199
12590
|
* @summary Get Realtime KPI Analytics
|
|
@@ -12203,7 +12594,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12203
12594
|
*/
|
|
12204
12595
|
adminAnalyticsStoreXStoreIDKpiRealtimeGet: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12205
12596
|
/**
|
|
12206
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
12597
|
+
* 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
12598
|
* @summary Get Query Analytics
|
|
12208
12599
|
* @param {string} xStoreID Store ID
|
|
12209
12600
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12215,6 +12606,14 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12215
12606
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12216
12607
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12217
12608
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
12609
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12610
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12611
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
12612
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
12613
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
12614
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
12615
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
12616
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12218
12617
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12219
12618
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12220
12619
|
* @param {number} [page] Page number for pagination
|
|
@@ -12226,13 +12625,22 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12226
12625
|
* @param {*} [options] Override http request option.
|
|
12227
12626
|
* @throws {RequiredError}
|
|
12228
12627
|
*/
|
|
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>;
|
|
12628
|
+
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
12629
|
/**
|
|
12231
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
12630
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
12232
12631
|
* @summary Get No-Clicks Queries
|
|
12233
12632
|
* @param {string} xStoreID Store ID
|
|
12234
12633
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12235
12634
|
* @param {string} [endTime] End time in RFC3339 format
|
|
12635
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
12636
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12637
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12638
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
12639
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
12640
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
12641
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
12642
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
12643
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12236
12644
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12237
12645
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12238
12646
|
* @param {number} [page] Page number for pagination
|
|
@@ -12243,13 +12651,22 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12243
12651
|
* @param {*} [options] Override http request option.
|
|
12244
12652
|
* @throws {RequiredError}
|
|
12245
12653
|
*/
|
|
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>;
|
|
12654
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet: (xStoreID: string, startTime?: string, endTime?: string, search?: 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
12655
|
/**
|
|
12248
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
12656
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
12249
12657
|
* @summary Get No-Results Queries
|
|
12250
12658
|
* @param {string} xStoreID Store ID
|
|
12251
12659
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12252
12660
|
* @param {string} [endTime] End time in RFC3339 format
|
|
12661
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
12662
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12663
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12664
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
12665
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
12666
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
12667
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
12668
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
12669
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12253
12670
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12254
12671
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12255
12672
|
* @param {number} [page] Page number for pagination
|
|
@@ -12260,7 +12677,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12260
12677
|
* @param {*} [options] Override http request option.
|
|
12261
12678
|
* @throws {RequiredError}
|
|
12262
12679
|
*/
|
|
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>;
|
|
12680
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: (xStoreID: string, startTime?: string, endTime?: string, search?: 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
12681
|
/**
|
|
12265
12682
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
12266
12683
|
* @summary Get Query Insights
|
|
@@ -12273,7 +12690,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12273
12690
|
*/
|
|
12274
12691
|
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12275
12692
|
/**
|
|
12276
|
-
* Retrieve analytics for top performing search results with
|
|
12693
|
+
* 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.
|
|
12277
12694
|
* @summary Get Top Results Analytics
|
|
12278
12695
|
* @param {string} xStoreID Store ID
|
|
12279
12696
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12283,7 +12700,8 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12283
12700
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
12284
12701
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
12285
12702
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
12286
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
12703
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
12704
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
12287
12705
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12288
12706
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12289
12707
|
* @param {number} [page] Page number for pagination
|
|
@@ -12291,7 +12709,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12291
12709
|
* @param {*} [options] Override http request option.
|
|
12292
12710
|
* @throws {RequiredError}
|
|
12293
12711
|
*/
|
|
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>;
|
|
12712
|
+
adminAnalyticsStoreXStoreIDResultsGet: (xStoreID: string, startTime?: string, endTime?: string, itemIds?: 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
12713
|
/**
|
|
12296
12714
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
12297
12715
|
* @summary Get Analytics Tags
|
|
@@ -12430,7 +12848,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12430
12848
|
*/
|
|
12431
12849
|
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
12850
|
/**
|
|
12433
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
12851
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
12434
12852
|
* @summary Get Geographic Analytics
|
|
12435
12853
|
* @param {string} xStoreID Store ID
|
|
12436
12854
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12441,6 +12859,14 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12441
12859
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12442
12860
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12443
12861
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
12862
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12863
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12864
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
12865
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
12866
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
12867
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
12868
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
12869
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12444
12870
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12445
12871
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12446
12872
|
* @param {number} [page] Page number for pagination
|
|
@@ -12451,7 +12877,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12451
12877
|
* @param {*} [options] Override http request option.
|
|
12452
12878
|
* @throws {RequiredError}
|
|
12453
12879
|
*/
|
|
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>>;
|
|
12880
|
+
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
12881
|
/**
|
|
12456
12882
|
* Check the health status of analytics service and ClickHouse connection
|
|
12457
12883
|
* @summary Analytics Health Check
|
|
@@ -12461,7 +12887,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12461
12887
|
*/
|
|
12462
12888
|
adminAnalyticsStoreXStoreIDHealthGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>>;
|
|
12463
12889
|
/**
|
|
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.
|
|
12890
|
+
* 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
12891
|
* @summary Get KPI Analytics
|
|
12466
12892
|
* @param {string} xStoreID Store ID
|
|
12467
12893
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12472,6 +12898,14 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12472
12898
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12473
12899
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12474
12900
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
12901
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12902
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12903
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
12904
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
12905
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
12906
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
12907
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
12908
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12475
12909
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12476
12910
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12477
12911
|
* @param {number} [page] Page number for pagination
|
|
@@ -12479,7 +12913,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12479
12913
|
* @param {*} [options] Override http request option.
|
|
12480
12914
|
* @throws {RequiredError}
|
|
12481
12915
|
*/
|
|
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>>;
|
|
12916
|
+
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
12917
|
/**
|
|
12484
12918
|
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
12485
12919
|
* @summary Get Realtime KPI Analytics
|
|
@@ -12489,7 +12923,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12489
12923
|
*/
|
|
12490
12924
|
adminAnalyticsStoreXStoreIDKpiRealtimeGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>>;
|
|
12491
12925
|
/**
|
|
12492
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
12926
|
+
* 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
12927
|
* @summary Get Query Analytics
|
|
12494
12928
|
* @param {string} xStoreID Store ID
|
|
12495
12929
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12501,6 +12935,14 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12501
12935
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12502
12936
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12503
12937
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
12938
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12939
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12940
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
12941
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
12942
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
12943
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
12944
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
12945
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12504
12946
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12505
12947
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12506
12948
|
* @param {number} [page] Page number for pagination
|
|
@@ -12512,13 +12954,22 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12512
12954
|
* @param {*} [options] Override http request option.
|
|
12513
12955
|
* @throws {RequiredError}
|
|
12514
12956
|
*/
|
|
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>>;
|
|
12957
|
+
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
12958
|
/**
|
|
12517
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
12959
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
12518
12960
|
* @summary Get No-Clicks Queries
|
|
12519
12961
|
* @param {string} xStoreID Store ID
|
|
12520
12962
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12521
12963
|
* @param {string} [endTime] End time in RFC3339 format
|
|
12964
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
12965
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12966
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12967
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
12968
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
12969
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
12970
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
12971
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
12972
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12522
12973
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12523
12974
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12524
12975
|
* @param {number} [page] Page number for pagination
|
|
@@ -12529,13 +12980,22 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12529
12980
|
* @param {*} [options] Override http request option.
|
|
12530
12981
|
* @throws {RequiredError}
|
|
12531
12982
|
*/
|
|
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>>;
|
|
12983
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, search?: 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
12984
|
/**
|
|
12534
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
12985
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
12535
12986
|
* @summary Get No-Results Queries
|
|
12536
12987
|
* @param {string} xStoreID Store ID
|
|
12537
12988
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12538
12989
|
* @param {string} [endTime] End time in RFC3339 format
|
|
12990
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
12991
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12992
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12993
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
12994
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
12995
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
12996
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
12997
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
12998
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12539
12999
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12540
13000
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12541
13001
|
* @param {number} [page] Page number for pagination
|
|
@@ -12546,7 +13006,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12546
13006
|
* @param {*} [options] Override http request option.
|
|
12547
13007
|
* @throws {RequiredError}
|
|
12548
13008
|
*/
|
|
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>>;
|
|
13009
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: 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
13010
|
/**
|
|
12551
13011
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
12552
13012
|
* @summary Get Query Insights
|
|
@@ -12559,7 +13019,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12559
13019
|
*/
|
|
12560
13020
|
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>>;
|
|
12561
13021
|
/**
|
|
12562
|
-
* Retrieve analytics for top performing search results with
|
|
13022
|
+
* 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.
|
|
12563
13023
|
* @summary Get Top Results Analytics
|
|
12564
13024
|
* @param {string} xStoreID Store ID
|
|
12565
13025
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12569,7 +13029,8 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12569
13029
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
12570
13030
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
12571
13031
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
12572
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
13032
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
13033
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
12573
13034
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12574
13035
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12575
13036
|
* @param {number} [page] Page number for pagination
|
|
@@ -12577,7 +13038,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12577
13038
|
* @param {*} [options] Override http request option.
|
|
12578
13039
|
* @throws {RequiredError}
|
|
12579
13040
|
*/
|
|
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>>;
|
|
13041
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: 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
13042
|
/**
|
|
12582
13043
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
12583
13044
|
* @summary Get Analytics Tags
|
|
@@ -12716,7 +13177,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12716
13177
|
*/
|
|
12717
13178
|
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
13179
|
/**
|
|
12719
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
13180
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
12720
13181
|
* @summary Get Geographic Analytics
|
|
12721
13182
|
* @param {string} xStoreID Store ID
|
|
12722
13183
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12727,6 +13188,14 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12727
13188
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12728
13189
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12729
13190
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13191
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13192
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13193
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13194
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13195
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13196
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13197
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13198
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12730
13199
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12731
13200
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12732
13201
|
* @param {number} [page] Page number for pagination
|
|
@@ -12737,7 +13206,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12737
13206
|
* @param {*} [options] Override http request option.
|
|
12738
13207
|
* @throws {RequiredError}
|
|
12739
13208
|
*/
|
|
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>;
|
|
13209
|
+
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
13210
|
/**
|
|
12742
13211
|
* Check the health status of analytics service and ClickHouse connection
|
|
12743
13212
|
* @summary Analytics Health Check
|
|
@@ -12747,7 +13216,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12747
13216
|
*/
|
|
12748
13217
|
adminAnalyticsStoreXStoreIDHealthGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse>;
|
|
12749
13218
|
/**
|
|
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.
|
|
13219
|
+
* 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
13220
|
* @summary Get KPI Analytics
|
|
12752
13221
|
* @param {string} xStoreID Store ID
|
|
12753
13222
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12758,6 +13227,14 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12758
13227
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12759
13228
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12760
13229
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13230
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13231
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13232
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13233
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13234
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13235
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13236
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13237
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12761
13238
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12762
13239
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12763
13240
|
* @param {number} [page] Page number for pagination
|
|
@@ -12765,7 +13242,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12765
13242
|
* @param {*} [options] Override http request option.
|
|
12766
13243
|
* @throws {RequiredError}
|
|
12767
13244
|
*/
|
|
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>;
|
|
13245
|
+
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
13246
|
/**
|
|
12770
13247
|
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
12771
13248
|
* @summary Get Realtime KPI Analytics
|
|
@@ -12775,7 +13252,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12775
13252
|
*/
|
|
12776
13253
|
adminAnalyticsStoreXStoreIDKpiRealtimeGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse>;
|
|
12777
13254
|
/**
|
|
12778
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
13255
|
+
* 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
13256
|
* @summary Get Query Analytics
|
|
12780
13257
|
* @param {string} xStoreID Store ID
|
|
12781
13258
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12787,6 +13264,14 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12787
13264
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
12788
13265
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
12789
13266
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13267
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13268
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13269
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13270
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13271
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13272
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13273
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13274
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12790
13275
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12791
13276
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12792
13277
|
* @param {number} [page] Page number for pagination
|
|
@@ -12798,13 +13283,22 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12798
13283
|
* @param {*} [options] Override http request option.
|
|
12799
13284
|
* @throws {RequiredError}
|
|
12800
13285
|
*/
|
|
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>;
|
|
13286
|
+
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
13287
|
/**
|
|
12803
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
13288
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
12804
13289
|
* @summary Get No-Clicks Queries
|
|
12805
13290
|
* @param {string} xStoreID Store ID
|
|
12806
13291
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12807
13292
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13293
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13294
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13295
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13296
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13297
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13298
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13299
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13300
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13301
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12808
13302
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12809
13303
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12810
13304
|
* @param {number} [page] Page number for pagination
|
|
@@ -12815,13 +13309,22 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12815
13309
|
* @param {*} [options] Override http request option.
|
|
12816
13310
|
* @throws {RequiredError}
|
|
12817
13311
|
*/
|
|
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>;
|
|
13312
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, search?: 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
13313
|
/**
|
|
12820
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
13314
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
12821
13315
|
* @summary Get No-Results Queries
|
|
12822
13316
|
* @param {string} xStoreID Store ID
|
|
12823
13317
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12824
13318
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13319
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13320
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13321
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13322
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13323
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13324
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13325
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13326
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13327
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12825
13328
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12826
13329
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12827
13330
|
* @param {number} [page] Page number for pagination
|
|
@@ -12832,7 +13335,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12832
13335
|
* @param {*} [options] Override http request option.
|
|
12833
13336
|
* @throws {RequiredError}
|
|
12834
13337
|
*/
|
|
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>;
|
|
13338
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: 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
13339
|
/**
|
|
12837
13340
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
12838
13341
|
* @summary Get Query Insights
|
|
@@ -12845,7 +13348,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12845
13348
|
*/
|
|
12846
13349
|
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>;
|
|
12847
13350
|
/**
|
|
12848
|
-
* Retrieve analytics for top performing search results with
|
|
13351
|
+
* 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.
|
|
12849
13352
|
* @summary Get Top Results Analytics
|
|
12850
13353
|
* @param {string} xStoreID Store ID
|
|
12851
13354
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -12855,7 +13358,8 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12855
13358
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
12856
13359
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
12857
13360
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
12858
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
13361
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
13362
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
12859
13363
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
12860
13364
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
12861
13365
|
* @param {number} [page] Page number for pagination
|
|
@@ -12863,7 +13367,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
12863
13367
|
* @param {*} [options] Override http request option.
|
|
12864
13368
|
* @throws {RequiredError}
|
|
12865
13369
|
*/
|
|
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>;
|
|
13370
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: 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
13371
|
/**
|
|
12868
13372
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
12869
13373
|
* @summary Get Analytics Tags
|
|
@@ -13010,7 +13514,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13010
13514
|
*/
|
|
13011
13515
|
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
13516
|
/**
|
|
13013
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
13517
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
13014
13518
|
* @summary Get Geographic Analytics
|
|
13015
13519
|
* @param {string} xStoreID Store ID
|
|
13016
13520
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -13021,6 +13525,14 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13021
13525
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13022
13526
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13023
13527
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13528
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13529
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13530
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13531
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13532
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13533
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13534
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13535
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13024
13536
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13025
13537
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13026
13538
|
* @param {number} [page] Page number for pagination
|
|
@@ -13032,7 +13544,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13032
13544
|
* @throws {RequiredError}
|
|
13033
13545
|
* @memberof AnalyticsApi
|
|
13034
13546
|
*/
|
|
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>>;
|
|
13547
|
+
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
13548
|
/**
|
|
13037
13549
|
* Check the health status of analytics service and ClickHouse connection
|
|
13038
13550
|
* @summary Analytics Health Check
|
|
@@ -13043,7 +13555,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13043
13555
|
*/
|
|
13044
13556
|
adminAnalyticsStoreXStoreIDHealthGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsAnalyticsAPIResponse, any>>;
|
|
13045
13557
|
/**
|
|
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.
|
|
13558
|
+
* 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
13559
|
* @summary Get KPI Analytics
|
|
13048
13560
|
* @param {string} xStoreID Store ID
|
|
13049
13561
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -13054,6 +13566,14 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13054
13566
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13055
13567
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13056
13568
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13569
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13570
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13571
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13572
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13573
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13574
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13575
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13576
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13057
13577
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13058
13578
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13059
13579
|
* @param {number} [page] Page number for pagination
|
|
@@ -13062,7 +13582,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13062
13582
|
* @throws {RequiredError}
|
|
13063
13583
|
* @memberof AnalyticsApi
|
|
13064
13584
|
*/
|
|
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>>;
|
|
13585
|
+
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
13586
|
/**
|
|
13067
13587
|
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
13068
13588
|
* @summary Get Realtime KPI Analytics
|
|
@@ -13073,7 +13593,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13073
13593
|
*/
|
|
13074
13594
|
adminAnalyticsStoreXStoreIDKpiRealtimeGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsAnalyticsAPIResponse, any>>;
|
|
13075
13595
|
/**
|
|
13076
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
13596
|
+
* 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
13597
|
* @summary Get Query Analytics
|
|
13078
13598
|
* @param {string} xStoreID Store ID
|
|
13079
13599
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -13085,6 +13605,14 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13085
13605
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13086
13606
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13087
13607
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13608
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13609
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13610
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13611
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13612
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13613
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13614
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13615
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13088
13616
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13089
13617
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13090
13618
|
* @param {number} [page] Page number for pagination
|
|
@@ -13097,13 +13625,22 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13097
13625
|
* @throws {RequiredError}
|
|
13098
13626
|
* @memberof AnalyticsApi
|
|
13099
13627
|
*/
|
|
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>>;
|
|
13628
|
+
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
13629
|
/**
|
|
13102
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
13630
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
13103
13631
|
* @summary Get No-Clicks Queries
|
|
13104
13632
|
* @param {string} xStoreID Store ID
|
|
13105
13633
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13106
13634
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13635
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13636
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13637
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13638
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13639
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13640
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13641
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13642
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13643
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13107
13644
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13108
13645
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13109
13646
|
* @param {number} [page] Page number for pagination
|
|
@@ -13115,13 +13652,22 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13115
13652
|
* @throws {RequiredError}
|
|
13116
13653
|
* @memberof AnalyticsApi
|
|
13117
13654
|
*/
|
|
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>>;
|
|
13655
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, search?: 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
13656
|
/**
|
|
13120
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
13657
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
13121
13658
|
* @summary Get No-Results Queries
|
|
13122
13659
|
* @param {string} xStoreID Store ID
|
|
13123
13660
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13124
13661
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13662
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13663
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13664
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13665
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13666
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13667
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13668
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13669
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13670
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13125
13671
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13126
13672
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13127
13673
|
* @param {number} [page] Page number for pagination
|
|
@@ -13133,7 +13679,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13133
13679
|
* @throws {RequiredError}
|
|
13134
13680
|
* @memberof AnalyticsApi
|
|
13135
13681
|
*/
|
|
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>>;
|
|
13682
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: 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
13683
|
/**
|
|
13138
13684
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
13139
13685
|
* @summary Get Query Insights
|
|
@@ -13147,7 +13693,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13147
13693
|
*/
|
|
13148
13694
|
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any>>;
|
|
13149
13695
|
/**
|
|
13150
|
-
* Retrieve analytics for top performing search results with
|
|
13696
|
+
* 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.
|
|
13151
13697
|
* @summary Get Top Results Analytics
|
|
13152
13698
|
* @param {string} xStoreID Store ID
|
|
13153
13699
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -13157,7 +13703,8 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13157
13703
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
13158
13704
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
13159
13705
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
13160
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
13706
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
13707
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
13161
13708
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
13162
13709
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
13163
13710
|
* @param {number} [page] Page number for pagination
|
|
@@ -13166,7 +13713,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13166
13713
|
* @throws {RequiredError}
|
|
13167
13714
|
* @memberof AnalyticsApi
|
|
13168
13715
|
*/
|
|
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>>;
|
|
13716
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: 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
13717
|
/**
|
|
13171
13718
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
13172
13719
|
* @summary Get Analytics Tags
|
|
@@ -13325,6 +13872,14 @@ export declare const AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum: {
|
|
|
13325
13872
|
readonly All: "all";
|
|
13326
13873
|
};
|
|
13327
13874
|
export type AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum];
|
|
13875
|
+
/**
|
|
13876
|
+
* @export
|
|
13877
|
+
*/
|
|
13878
|
+
export declare const AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum: {
|
|
13879
|
+
readonly Any: "any";
|
|
13880
|
+
readonly All: "all";
|
|
13881
|
+
};
|
|
13882
|
+
export type AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum];
|
|
13328
13883
|
/**
|
|
13329
13884
|
* @export
|
|
13330
13885
|
*/
|
|
@@ -13366,6 +13921,14 @@ export declare const AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum: {
|
|
|
13366
13921
|
readonly All: "all";
|
|
13367
13922
|
};
|
|
13368
13923
|
export type AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum];
|
|
13924
|
+
/**
|
|
13925
|
+
* @export
|
|
13926
|
+
*/
|
|
13927
|
+
export declare const AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum: {
|
|
13928
|
+
readonly Any: "any";
|
|
13929
|
+
readonly All: "all";
|
|
13930
|
+
};
|
|
13931
|
+
export type AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum];
|
|
13369
13932
|
/**
|
|
13370
13933
|
* @export
|
|
13371
13934
|
*/
|
|
@@ -13387,6 +13950,14 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum: {
|
|
|
13387
13950
|
readonly All: "all";
|
|
13388
13951
|
};
|
|
13389
13952
|
export type AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum];
|
|
13953
|
+
/**
|
|
13954
|
+
* @export
|
|
13955
|
+
*/
|
|
13956
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum: {
|
|
13957
|
+
readonly Any: "any";
|
|
13958
|
+
readonly All: "all";
|
|
13959
|
+
};
|
|
13960
|
+
export type AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum];
|
|
13390
13961
|
/**
|
|
13391
13962
|
* @export
|
|
13392
13963
|
*/
|
|
@@ -13407,6 +13978,14 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum: {
|
|
|
13407
13978
|
readonly Desc: "desc";
|
|
13408
13979
|
};
|
|
13409
13980
|
export type AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum];
|
|
13981
|
+
/**
|
|
13982
|
+
* @export
|
|
13983
|
+
*/
|
|
13984
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum: {
|
|
13985
|
+
readonly Any: "any";
|
|
13986
|
+
readonly All: "all";
|
|
13987
|
+
};
|
|
13988
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum];
|
|
13410
13989
|
/**
|
|
13411
13990
|
* @export
|
|
13412
13991
|
*/
|
|
@@ -13424,6 +14003,14 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum:
|
|
|
13424
14003
|
readonly Desc: "desc";
|
|
13425
14004
|
};
|
|
13426
14005
|
export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum];
|
|
14006
|
+
/**
|
|
14007
|
+
* @export
|
|
14008
|
+
*/
|
|
14009
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum: {
|
|
14010
|
+
readonly Any: "any";
|
|
14011
|
+
readonly All: "all";
|
|
14012
|
+
};
|
|
14013
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum];
|
|
13427
14014
|
/**
|
|
13428
14015
|
* @export
|
|
13429
14016
|
*/
|