@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/api.ts CHANGED
@@ -29,6 +29,12 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM
29
29
  * @interface AdminAnalyticsStoreXStoreIDCustomPost200Response
30
30
  */
31
31
  export interface AdminAnalyticsStoreXStoreIDCustomPost200Response {
32
+ /**
33
+ * Comparison metadata when in compare mode
34
+ * @type {AnalyticsComparisonMeta}
35
+ * @memberof AdminAnalyticsStoreXStoreIDCustomPost200Response
36
+ */
37
+ 'comparison'?: AnalyticsComparisonMeta;
32
38
  /**
33
39
  *
34
40
  * @type {AnalyticsCustomQueryResponse}
@@ -66,6 +72,12 @@ export interface AdminAnalyticsStoreXStoreIDCustomPost200Response {
66
72
  * @interface AdminAnalyticsStoreXStoreIDFiltersCombinationsGet200Response
67
73
  */
68
74
  export interface AdminAnalyticsStoreXStoreIDFiltersCombinationsGet200Response {
75
+ /**
76
+ * Comparison metadata when in compare mode
77
+ * @type {AnalyticsComparisonMeta}
78
+ * @memberof AdminAnalyticsStoreXStoreIDFiltersCombinationsGet200Response
79
+ */
80
+ 'comparison'?: AnalyticsComparisonMeta;
69
81
  /**
70
82
  *
71
83
  * @type {Array<AnalyticsFilterCombination>}
@@ -103,6 +115,12 @@ export interface AdminAnalyticsStoreXStoreIDFiltersCombinationsGet200Response {
103
115
  * @interface AdminAnalyticsStoreXStoreIDFiltersEffectivenessGet200Response
104
116
  */
105
117
  export interface AdminAnalyticsStoreXStoreIDFiltersEffectivenessGet200Response {
118
+ /**
119
+ * Comparison metadata when in compare mode
120
+ * @type {AnalyticsComparisonMeta}
121
+ * @memberof AdminAnalyticsStoreXStoreIDFiltersEffectivenessGet200Response
122
+ */
123
+ 'comparison'?: AnalyticsComparisonMeta;
106
124
  /**
107
125
  *
108
126
  * @type {AnalyticsFilterEffectivenessAnalysis}
@@ -140,6 +158,12 @@ export interface AdminAnalyticsStoreXStoreIDFiltersEffectivenessGet200Response {
140
158
  * @interface AdminAnalyticsStoreXStoreIDFiltersGet200Response
141
159
  */
142
160
  export interface AdminAnalyticsStoreXStoreIDFiltersGet200Response {
161
+ /**
162
+ * Comparison metadata when in compare mode
163
+ * @type {AnalyticsComparisonMeta}
164
+ * @memberof AdminAnalyticsStoreXStoreIDFiltersGet200Response
165
+ */
166
+ 'comparison'?: AnalyticsComparisonMeta;
143
167
  /**
144
168
  *
145
169
  * @type {AnalyticsFilterAnalyticsResponse}
@@ -177,6 +201,12 @@ export interface AdminAnalyticsStoreXStoreIDFiltersGet200Response {
177
201
  * @interface AdminAnalyticsStoreXStoreIDFiltersTrendsGet200Response
178
202
  */
179
203
  export interface AdminAnalyticsStoreXStoreIDFiltersTrendsGet200Response {
204
+ /**
205
+ * Comparison metadata when in compare mode
206
+ * @type {AnalyticsComparisonMeta}
207
+ * @memberof AdminAnalyticsStoreXStoreIDFiltersTrendsGet200Response
208
+ */
209
+ 'comparison'?: AnalyticsComparisonMeta;
180
210
  /**
181
211
  *
182
212
  * @type {AnalyticsFilterTrendsResponse}
@@ -214,6 +244,12 @@ export interface AdminAnalyticsStoreXStoreIDFiltersTrendsGet200Response {
214
244
  * @interface AdminAnalyticsStoreXStoreIDGeoGet200Response
215
245
  */
216
246
  export interface AdminAnalyticsStoreXStoreIDGeoGet200Response {
247
+ /**
248
+ * Comparison metadata when in compare mode
249
+ * @type {AnalyticsComparisonMeta}
250
+ * @memberof AdminAnalyticsStoreXStoreIDGeoGet200Response
251
+ */
252
+ 'comparison'?: AnalyticsComparisonMeta;
217
253
  /**
218
254
  *
219
255
  * @type {AnalyticsGeoResponse}
@@ -251,6 +287,12 @@ export interface AdminAnalyticsStoreXStoreIDGeoGet200Response {
251
287
  * @interface AdminAnalyticsStoreXStoreIDItemsComparisonGet200Response
252
288
  */
253
289
  export interface AdminAnalyticsStoreXStoreIDItemsComparisonGet200Response {
290
+ /**
291
+ * Comparison metadata when in compare mode
292
+ * @type {AnalyticsComparisonMeta}
293
+ * @memberof AdminAnalyticsStoreXStoreIDItemsComparisonGet200Response
294
+ */
295
+ 'comparison'?: AnalyticsComparisonMeta;
254
296
  /**
255
297
  *
256
298
  * @type {AnalyticsItemComparisonAnalytics}
@@ -288,6 +330,12 @@ export interface AdminAnalyticsStoreXStoreIDItemsComparisonGet200Response {
288
330
  * @interface AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response
289
331
  */
290
332
  export interface AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response {
333
+ /**
334
+ * Comparison metadata when in compare mode
335
+ * @type {AnalyticsComparisonMeta}
336
+ * @memberof AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response
337
+ */
338
+ 'comparison'?: AnalyticsComparisonMeta;
291
339
  /**
292
340
  *
293
341
  * @type {Array<AnalyticsItemDiscoveryAnalytics>}
@@ -325,6 +373,12 @@ export interface AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response {
325
373
  * @interface AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response
326
374
  */
327
375
  export interface AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response {
376
+ /**
377
+ * Comparison metadata when in compare mode
378
+ * @type {AnalyticsComparisonMeta}
379
+ * @memberof AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response
380
+ */
381
+ 'comparison'?: AnalyticsComparisonMeta;
328
382
  /**
329
383
  *
330
384
  * @type {Array<AnalyticsItemPerformanceMetrics>}
@@ -362,6 +416,12 @@ export interface AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response {
362
416
  * @interface AdminAnalyticsStoreXStoreIDItemsTrendsGet200Response
363
417
  */
364
418
  export interface AdminAnalyticsStoreXStoreIDItemsTrendsGet200Response {
419
+ /**
420
+ * Comparison metadata when in compare mode
421
+ * @type {AnalyticsComparisonMeta}
422
+ * @memberof AdminAnalyticsStoreXStoreIDItemsTrendsGet200Response
423
+ */
424
+ 'comparison'?: AnalyticsComparisonMeta;
365
425
  /**
366
426
  *
367
427
  * @type {Array<AnalyticsItemPerformanceTrend>}
@@ -399,6 +459,12 @@ export interface AdminAnalyticsStoreXStoreIDItemsTrendsGet200Response {
399
459
  * @interface AdminAnalyticsStoreXStoreIDKpiGet200Response
400
460
  */
401
461
  export interface AdminAnalyticsStoreXStoreIDKpiGet200Response {
462
+ /**
463
+ * Comparison metadata when in compare mode
464
+ * @type {AnalyticsComparisonMeta}
465
+ * @memberof AdminAnalyticsStoreXStoreIDKpiGet200Response
466
+ */
467
+ 'comparison'?: AnalyticsComparisonMeta;
402
468
  /**
403
469
  *
404
470
  * @type {AnalyticsExtendedKPIResponse}
@@ -436,6 +502,12 @@ export interface AdminAnalyticsStoreXStoreIDKpiGet200Response {
436
502
  * @interface AdminAnalyticsStoreXStoreIDQueriesGet200Response
437
503
  */
438
504
  export interface AdminAnalyticsStoreXStoreIDQueriesGet200Response {
505
+ /**
506
+ * Comparison metadata when in compare mode
507
+ * @type {AnalyticsComparisonMeta}
508
+ * @memberof AdminAnalyticsStoreXStoreIDQueriesGet200Response
509
+ */
510
+ 'comparison'?: AnalyticsComparisonMeta;
439
511
  /**
440
512
  *
441
513
  * @type {AnalyticsQueryResponse}
@@ -473,6 +545,12 @@ export interface AdminAnalyticsStoreXStoreIDQueriesGet200Response {
473
545
  * @interface AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGet200Response
474
546
  */
475
547
  export interface AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGet200Response {
548
+ /**
549
+ * Comparison metadata when in compare mode
550
+ * @type {AnalyticsComparisonMeta}
551
+ * @memberof AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGet200Response
552
+ */
553
+ 'comparison'?: AnalyticsComparisonMeta;
476
554
  /**
477
555
  *
478
556
  * @type {Array<AnalyticsQueryPerformanceAnalytics>}
@@ -510,6 +588,12 @@ export interface AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGet200Response
510
588
  * @interface AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response
511
589
  */
512
590
  export interface AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response {
591
+ /**
592
+ * Comparison metadata when in compare mode
593
+ * @type {AnalyticsComparisonMeta}
594
+ * @memberof AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response
595
+ */
596
+ 'comparison'?: AnalyticsComparisonMeta;
513
597
  /**
514
598
  *
515
599
  * @type {{ [key: string]: any; }}
@@ -547,6 +631,12 @@ export interface AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response {
547
631
  * @interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
548
632
  */
549
633
  export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
634
+ /**
635
+ * Comparison metadata when in compare mode
636
+ * @type {AnalyticsComparisonMeta}
637
+ * @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
638
+ */
639
+ 'comparison'?: AnalyticsComparisonMeta;
550
640
  /**
551
641
  *
552
642
  * @type {AnalyticsQueryInsights}
@@ -584,6 +674,12 @@ export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
584
674
  * @interface AnalyticsAnalyticsAPIResponse
585
675
  */
586
676
  export interface AnalyticsAnalyticsAPIResponse {
677
+ /**
678
+ * Comparison metadata when in compare mode
679
+ * @type {AnalyticsComparisonMeta}
680
+ * @memberof AnalyticsAnalyticsAPIResponse
681
+ */
682
+ 'comparison'?: AnalyticsComparisonMeta;
587
683
  /**
588
684
  *
589
685
  * @type {object}
@@ -799,6 +895,43 @@ export interface AnalyticsClickPositionBucket {
799
895
  */
800
896
  'share'?: number;
801
897
  }
898
+ /**
899
+ *
900
+ * @export
901
+ * @interface AnalyticsComparisonMeta
902
+ */
903
+ export interface AnalyticsComparisonMeta {
904
+ /**
905
+ * Human readable comparison period
906
+ * @type {string}
907
+ * @memberof AnalyticsComparisonMeta
908
+ */
909
+ 'comparison_period'?: string;
910
+ /**
911
+ * Analytics tags for comparison period
912
+ * @type {Array<string>}
913
+ * @memberof AnalyticsComparisonMeta
914
+ */
915
+ 'comparison_tags'?: Array<string>;
916
+ /**
917
+ * Human readable current period
918
+ * @type {string}
919
+ * @memberof AnalyticsComparisonMeta
920
+ */
921
+ 'current_period'?: string;
922
+ /**
923
+ * Analytics tags for current period
924
+ * @type {Array<string>}
925
+ * @memberof AnalyticsComparisonMeta
926
+ */
927
+ 'current_tags'?: Array<string>;
928
+ /**
929
+ * Whether comparison mode is enabled
930
+ * @type {boolean}
931
+ * @memberof AnalyticsComparisonMeta
932
+ */
933
+ 'mode'?: boolean;
934
+ }
802
935
  /**
803
936
  *
804
937
  * @export
@@ -876,27 +1009,33 @@ export interface AnalyticsCustomQueryResponse {
876
1009
  /**
877
1010
  *
878
1011
  * @export
879
- * @interface AnalyticsEnrichedItemResult
1012
+ * @interface AnalyticsEnrichedItemResultWithWidget
880
1013
  */
881
- export interface AnalyticsEnrichedItemResult {
1014
+ export interface AnalyticsEnrichedItemResultWithWidget {
882
1015
  /**
883
1016
  * Analytics data
884
1017
  * @type {AnalyticsItemPerformanceMetrics}
885
- * @memberof AnalyticsEnrichedItemResult
1018
+ * @memberof AnalyticsEnrichedItemResultWithWidget
886
1019
  */
887
1020
  'analytics'?: AnalyticsItemPerformanceMetrics;
888
1021
  /**
889
1022
  * Document data from Typesense index
890
1023
  * @type {{ [key: string]: any; }}
891
- * @memberof AnalyticsEnrichedItemResult
1024
+ * @memberof AnalyticsEnrichedItemResultWithWidget
892
1025
  */
893
1026
  'document'?: { [key: string]: any; };
894
1027
  /**
895
1028
  * Error if document fetch failed
896
1029
  * @type {string}
897
- * @memberof AnalyticsEnrichedItemResult
1030
+ * @memberof AnalyticsEnrichedItemResultWithWidget
898
1031
  */
899
1032
  'document_fetch_error'?: string;
1033
+ /**
1034
+ * Widget display data for UI presentation
1035
+ * @type {AnalyticsWidgetData}
1036
+ * @memberof AnalyticsEnrichedItemResultWithWidget
1037
+ */
1038
+ 'widget'?: AnalyticsWidgetData;
900
1039
  }
901
1040
  /**
902
1041
  *
@@ -904,6 +1043,30 @@ export interface AnalyticsEnrichedItemResult {
904
1043
  * @interface AnalyticsExtendedKPIResponse
905
1044
  */
906
1045
  export interface AnalyticsExtendedKPIResponse {
1046
+ /**
1047
+ *
1048
+ * @type {Array<AnalyticsKPIPointExtended>}
1049
+ * @memberof AnalyticsExtendedKPIResponse
1050
+ */
1051
+ 'compare_data'?: Array<AnalyticsKPIPointExtended>;
1052
+ /**
1053
+ *
1054
+ * @type {string}
1055
+ * @memberof AnalyticsExtendedKPIResponse
1056
+ */
1057
+ 'compare_end_time'?: string;
1058
+ /**
1059
+ * Comparison mode data
1060
+ * @type {string}
1061
+ * @memberof AnalyticsExtendedKPIResponse
1062
+ */
1063
+ 'compare_start_time'?: string;
1064
+ /**
1065
+ *
1066
+ * @type {AnalyticsKPIMetrics}
1067
+ * @memberof AnalyticsExtendedKPIResponse
1068
+ */
1069
+ 'compare_summary'?: AnalyticsKPIMetrics;
907
1070
  /**
908
1071
  *
909
1072
  * @type {Array<AnalyticsKPIPointExtended>}
@@ -941,11 +1104,11 @@ export interface AnalyticsExtendedKPIResponse {
941
1104
  */
942
1105
  'store_id'?: string;
943
1106
  /**
944
- *
945
- * @type {AnalyticsKPIMetrics}
1107
+ * Can be KPIMetrics or ComparisonMetrics
1108
+ * @type {object}
946
1109
  * @memberof AnalyticsExtendedKPIResponse
947
1110
  */
948
- 'summary'?: AnalyticsKPIMetrics;
1111
+ 'summary'?: object;
949
1112
  }
950
1113
  /**
951
1114
  *
@@ -1582,7 +1745,31 @@ export interface AnalyticsGeoResponse {
1582
1745
  * @type {Array<AnalyticsGeoAnalytic>}
1583
1746
  * @memberof AnalyticsGeoResponse
1584
1747
  */
1585
- 'data'?: Array<AnalyticsGeoAnalytic>;
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
- 'data'?: Array<AnalyticsQueryAnalytic>;
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
@@ -12981,7 +13356,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
12981
13356
  };
12982
13357
  },
12983
13358
  /**
12984
- * Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
13359
+ * Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
12985
13360
  * @summary Get Geographic Analytics
12986
13361
  * @param {string} xStoreID Store ID
12987
13362
  * @param {string} [startTime] Start time in RFC3339 format
@@ -12992,6 +13367,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
12992
13367
  * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
12993
13368
  * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
12994
13369
  * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
13370
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
13371
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
13372
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
13373
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
13374
+ * @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
13375
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
13376
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
13377
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
12995
13378
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
12996
13379
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
12997
13380
  * @param {number} [page] Page number for pagination
@@ -13002,7 +13385,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13002
13385
  * @param {*} [options] Override http request option.
13003
13386
  * @throws {RequiredError}
13004
13387
  */
13005
- adminAnalyticsStoreXStoreIDGeoGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13388
+ adminAnalyticsStoreXStoreIDGeoGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13006
13389
  // verify required parameter 'xStoreID' is not null or undefined
13007
13390
  assertParamExists('adminAnalyticsStoreXStoreIDGeoGet', 'xStoreID', xStoreID)
13008
13391
  const localVarPath = `/admin/analytics/store/{xStoreID}/geo`
@@ -13053,6 +13436,38 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13053
13436
  localVarQueryParameter['tag_value_filter'] = tagValueFilter;
13054
13437
  }
13055
13438
 
13439
+ if (compareMode !== undefined) {
13440
+ localVarQueryParameter['compare_mode'] = compareMode;
13441
+ }
13442
+
13443
+ if (compareStartTime !== undefined) {
13444
+ localVarQueryParameter['compare_start_time'] = compareStartTime;
13445
+ }
13446
+
13447
+ if (compareEndTime !== undefined) {
13448
+ localVarQueryParameter['compare_end_time'] = compareEndTime;
13449
+ }
13450
+
13451
+ if (compareAnalyticsTags !== undefined) {
13452
+ localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
13453
+ }
13454
+
13455
+ if (compareTagsMatchMode !== undefined) {
13456
+ localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
13457
+ }
13458
+
13459
+ if (compareTagsExclude !== undefined) {
13460
+ localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
13461
+ }
13462
+
13463
+ if (compareTagKeyFilter !== undefined) {
13464
+ localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
13465
+ }
13466
+
13467
+ if (compareTagValueFilter !== undefined) {
13468
+ localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
13469
+ }
13470
+
13056
13471
  if (limit !== undefined) {
13057
13472
  localVarQueryParameter['limit'] = limit;
13058
13473
  }
@@ -13130,7 +13545,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13130
13545
  };
13131
13546
  },
13132
13547
  /**
13133
- * Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
13548
+ * Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators and comparison mode between different timelines and tag sets.
13134
13549
  * @summary Get KPI Analytics
13135
13550
  * @param {string} xStoreID Store ID
13136
13551
  * @param {string} [startTime] Start time in RFC3339 format
@@ -13141,6 +13556,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13141
13556
  * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
13142
13557
  * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
13143
13558
  * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
13559
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
13560
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
13561
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
13562
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
13563
+ * @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
13564
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
13565
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
13566
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
13144
13567
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
13145
13568
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
13146
13569
  * @param {number} [page] Page number for pagination
@@ -13148,7 +13571,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13148
13571
  * @param {*} [options] Override http request option.
13149
13572
  * @throws {RequiredError}
13150
13573
  */
13151
- adminAnalyticsStoreXStoreIDKpiGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13574
+ adminAnalyticsStoreXStoreIDKpiGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13152
13575
  // verify required parameter 'xStoreID' is not null or undefined
13153
13576
  assertParamExists('adminAnalyticsStoreXStoreIDKpiGet', 'xStoreID', xStoreID)
13154
13577
  const localVarPath = `/admin/analytics/store/{xStoreID}/kpi`
@@ -13199,6 +13622,38 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13199
13622
  localVarQueryParameter['tag_value_filter'] = tagValueFilter;
13200
13623
  }
13201
13624
 
13625
+ if (compareMode !== undefined) {
13626
+ localVarQueryParameter['compare_mode'] = compareMode;
13627
+ }
13628
+
13629
+ if (compareStartTime !== undefined) {
13630
+ localVarQueryParameter['compare_start_time'] = compareStartTime;
13631
+ }
13632
+
13633
+ if (compareEndTime !== undefined) {
13634
+ localVarQueryParameter['compare_end_time'] = compareEndTime;
13635
+ }
13636
+
13637
+ if (compareAnalyticsTags !== undefined) {
13638
+ localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
13639
+ }
13640
+
13641
+ if (compareTagsMatchMode !== undefined) {
13642
+ localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
13643
+ }
13644
+
13645
+ if (compareTagsExclude !== undefined) {
13646
+ localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
13647
+ }
13648
+
13649
+ if (compareTagKeyFilter !== undefined) {
13650
+ localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
13651
+ }
13652
+
13653
+ if (compareTagValueFilter !== undefined) {
13654
+ localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
13655
+ }
13656
+
13202
13657
  if (limit !== undefined) {
13203
13658
  localVarQueryParameter['limit'] = limit;
13204
13659
  }
@@ -13264,7 +13719,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13264
13719
  };
13265
13720
  },
13266
13721
  /**
13267
- * Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
13722
+ * Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
13268
13723
  * @summary Get Query Analytics
13269
13724
  * @param {string} xStoreID Store ID
13270
13725
  * @param {string} [startTime] Start time in RFC3339 format
@@ -13276,6 +13731,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13276
13731
  * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
13277
13732
  * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
13278
13733
  * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
13734
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
13735
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
13736
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
13737
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
13738
+ * @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
13739
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
13740
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
13741
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
13279
13742
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
13280
13743
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
13281
13744
  * @param {number} [page] Page number for pagination
@@ -13287,7 +13750,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13287
13750
  * @param {*} [options] Override http request option.
13288
13751
  * @throws {RequiredError}
13289
13752
  */
13290
- adminAnalyticsStoreXStoreIDQueriesGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13753
+ adminAnalyticsStoreXStoreIDQueriesGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13291
13754
  // verify required parameter 'xStoreID' is not null or undefined
13292
13755
  assertParamExists('adminAnalyticsStoreXStoreIDQueriesGet', 'xStoreID', xStoreID)
13293
13756
  const localVarPath = `/admin/analytics/store/{xStoreID}/queries`
@@ -13342,6 +13805,38 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13342
13805
  localVarQueryParameter['tag_value_filter'] = tagValueFilter;
13343
13806
  }
13344
13807
 
13808
+ if (compareMode !== undefined) {
13809
+ localVarQueryParameter['compare_mode'] = compareMode;
13810
+ }
13811
+
13812
+ if (compareStartTime !== undefined) {
13813
+ localVarQueryParameter['compare_start_time'] = compareStartTime;
13814
+ }
13815
+
13816
+ if (compareEndTime !== undefined) {
13817
+ localVarQueryParameter['compare_end_time'] = compareEndTime;
13818
+ }
13819
+
13820
+ if (compareAnalyticsTags !== undefined) {
13821
+ localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
13822
+ }
13823
+
13824
+ if (compareTagsMatchMode !== undefined) {
13825
+ localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
13826
+ }
13827
+
13828
+ if (compareTagsExclude !== undefined) {
13829
+ localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
13830
+ }
13831
+
13832
+ if (compareTagKeyFilter !== undefined) {
13833
+ localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
13834
+ }
13835
+
13836
+ if (compareTagValueFilter !== undefined) {
13837
+ localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
13838
+ }
13839
+
13345
13840
  if (limit !== undefined) {
13346
13841
  localVarQueryParameter['limit'] = limit;
13347
13842
  }
@@ -13386,11 +13881,20 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13386
13881
  };
13387
13882
  },
13388
13883
  /**
13389
- * Retrieve queries that received searches but no user clicks, indicating poor result relevance
13884
+ * Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
13390
13885
  * @summary Get No-Clicks Queries
13391
13886
  * @param {string} xStoreID Store ID
13392
13887
  * @param {string} [startTime] Start time in RFC3339 format
13393
13888
  * @param {string} [endTime] End time in RFC3339 format
13889
+ * @param {string} [search] Search term to filter queries (case-insensitive partial match)
13890
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
13891
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
13892
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
13893
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
13894
+ * @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
13895
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
13896
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
13897
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
13394
13898
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
13395
13899
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
13396
13900
  * @param {number} [page] Page number for pagination
@@ -13401,7 +13905,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13401
13905
  * @param {*} [options] Override http request option.
13402
13906
  * @throws {RequiredError}
13403
13907
  */
13404
- adminAnalyticsStoreXStoreIDQueriesNoClicksGet: async (xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13908
+ adminAnalyticsStoreXStoreIDQueriesNoClicksGet: async (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> => {
13405
13909
  // verify required parameter 'xStoreID' is not null or undefined
13406
13910
  assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoClicksGet', 'xStoreID', xStoreID)
13407
13911
  const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-clicks`
@@ -13428,6 +13932,42 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13428
13932
  localVarQueryParameter['end_time'] = endTime;
13429
13933
  }
13430
13934
 
13935
+ if (search !== undefined) {
13936
+ localVarQueryParameter['search'] = search;
13937
+ }
13938
+
13939
+ if (compareMode !== undefined) {
13940
+ localVarQueryParameter['compare_mode'] = compareMode;
13941
+ }
13942
+
13943
+ if (compareStartTime !== undefined) {
13944
+ localVarQueryParameter['compare_start_time'] = compareStartTime;
13945
+ }
13946
+
13947
+ if (compareEndTime !== undefined) {
13948
+ localVarQueryParameter['compare_end_time'] = compareEndTime;
13949
+ }
13950
+
13951
+ if (compareAnalyticsTags !== undefined) {
13952
+ localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
13953
+ }
13954
+
13955
+ if (compareTagsMatchMode !== undefined) {
13956
+ localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
13957
+ }
13958
+
13959
+ if (compareTagsExclude !== undefined) {
13960
+ localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
13961
+ }
13962
+
13963
+ if (compareTagKeyFilter !== undefined) {
13964
+ localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
13965
+ }
13966
+
13967
+ if (compareTagValueFilter !== undefined) {
13968
+ localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
13969
+ }
13970
+
13431
13971
  if (limit !== undefined) {
13432
13972
  localVarQueryParameter['limit'] = limit;
13433
13973
  }
@@ -13468,11 +14008,20 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13468
14008
  };
13469
14009
  },
13470
14010
  /**
13471
- * Retrieve queries that returned no search results, useful for identifying content gaps
14011
+ * Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
13472
14012
  * @summary Get No-Results Queries
13473
14013
  * @param {string} xStoreID Store ID
13474
14014
  * @param {string} [startTime] Start time in RFC3339 format
13475
14015
  * @param {string} [endTime] End time in RFC3339 format
14016
+ * @param {string} [search] Search term to filter queries (case-insensitive partial match)
14017
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
14018
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
14019
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
14020
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
14021
+ * @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
14022
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
14023
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
14024
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
13476
14025
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
13477
14026
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
13478
14027
  * @param {number} [page] Page number for pagination
@@ -13483,7 +14032,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13483
14032
  * @param {*} [options] Override http request option.
13484
14033
  * @throws {RequiredError}
13485
14034
  */
13486
- adminAnalyticsStoreXStoreIDQueriesNoResultsGet: async (xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14035
+ adminAnalyticsStoreXStoreIDQueriesNoResultsGet: async (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> => {
13487
14036
  // verify required parameter 'xStoreID' is not null or undefined
13488
14037
  assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoResultsGet', 'xStoreID', xStoreID)
13489
14038
  const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-results`
@@ -13510,6 +14059,42 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13510
14059
  localVarQueryParameter['end_time'] = endTime;
13511
14060
  }
13512
14061
 
14062
+ if (search !== undefined) {
14063
+ localVarQueryParameter['search'] = search;
14064
+ }
14065
+
14066
+ if (compareMode !== undefined) {
14067
+ localVarQueryParameter['compare_mode'] = compareMode;
14068
+ }
14069
+
14070
+ if (compareStartTime !== undefined) {
14071
+ localVarQueryParameter['compare_start_time'] = compareStartTime;
14072
+ }
14073
+
14074
+ if (compareEndTime !== undefined) {
14075
+ localVarQueryParameter['compare_end_time'] = compareEndTime;
14076
+ }
14077
+
14078
+ if (compareAnalyticsTags !== undefined) {
14079
+ localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
14080
+ }
14081
+
14082
+ if (compareTagsMatchMode !== undefined) {
14083
+ localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
14084
+ }
14085
+
14086
+ if (compareTagsExclude !== undefined) {
14087
+ localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
14088
+ }
14089
+
14090
+ if (compareTagKeyFilter !== undefined) {
14091
+ localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
14092
+ }
14093
+
14094
+ if (compareTagValueFilter !== undefined) {
14095
+ localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
14096
+ }
14097
+
13513
14098
  if (limit !== undefined) {
13514
14099
  localVarQueryParameter['limit'] = limit;
13515
14100
  }
@@ -13601,7 +14186,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13601
14186
  };
13602
14187
  },
13603
14188
  /**
13604
- * Retrieve analytics for top performing search results with actual document data. Returns both performance metrics and the actual documents from the search index.
14189
+ * 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.
13605
14190
  * @summary Get Top Results Analytics
13606
14191
  * @param {string} xStoreID Store ID
13607
14192
  * @param {string} [startTime] Start time in RFC3339 format
@@ -13611,7 +14196,8 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13611
14196
  * @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
13612
14197
  * @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
13613
14198
  * @param {string} [sort] Combined sort parameter in format \&#39;field:direction\&#39;
13614
- * @param {boolean} [includeDocuments] Whether to include document data from search index
14199
+ * @param {boolean} [includeDocuments] Whether to include full document data from search index
14200
+ * @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
13615
14201
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
13616
14202
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
13617
14203
  * @param {number} [page] Page number for pagination
@@ -13619,7 +14205,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13619
14205
  * @param {*} [options] Override http request option.
13620
14206
  * @throws {RequiredError}
13621
14207
  */
13622
- adminAnalyticsStoreXStoreIDResultsGet: async (xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14208
+ adminAnalyticsStoreXStoreIDResultsGet: async (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> => {
13623
14209
  // verify required parameter 'xStoreID' is not null or undefined
13624
14210
  assertParamExists('adminAnalyticsStoreXStoreIDResultsGet', 'xStoreID', xStoreID)
13625
14211
  const localVarPath = `/admin/analytics/store/{xStoreID}/results`
@@ -13670,6 +14256,10 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
13670
14256
  localVarQueryParameter['include_documents'] = includeDocuments;
13671
14257
  }
13672
14258
 
14259
+ if (includeWidget !== undefined) {
14260
+ localVarQueryParameter['include_widget'] = includeWidget;
14261
+ }
14262
+
13673
14263
  if (limit !== undefined) {
13674
14264
  localVarQueryParameter['limit'] = limit;
13675
14265
  }
@@ -14009,7 +14599,7 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
14009
14599
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14010
14600
  },
14011
14601
  /**
14012
- * Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
14602
+ * Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
14013
14603
  * @summary Get Geographic Analytics
14014
14604
  * @param {string} xStoreID Store ID
14015
14605
  * @param {string} [startTime] Start time in RFC3339 format
@@ -14020,6 +14610,14 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
14020
14610
  * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
14021
14611
  * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
14022
14612
  * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
14613
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
14614
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
14615
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
14616
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
14617
+ * @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
14618
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
14619
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
14620
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14023
14621
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14024
14622
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14025
14623
  * @param {number} [page] Page number for pagination
@@ -14030,8 +14628,8 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
14030
14628
  * @param {*} [options] Override http request option.
14031
14629
  * @throws {RequiredError}
14032
14630
  */
14033
- async adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDGeoGet200Response>> {
14034
- const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
14631
+ async adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDGeoGet200Response>> {
14632
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
14035
14633
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14036
14634
  const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDGeoGet']?.[localVarOperationServerIndex]?.url;
14037
14635
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -14050,7 +14648,7 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
14050
14648
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14051
14649
  },
14052
14650
  /**
14053
- * Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
14651
+ * Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators and comparison mode between different timelines and tag sets.
14054
14652
  * @summary Get KPI Analytics
14055
14653
  * @param {string} xStoreID Store ID
14056
14654
  * @param {string} [startTime] Start time in RFC3339 format
@@ -14061,6 +14659,14 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
14061
14659
  * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
14062
14660
  * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
14063
14661
  * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
14662
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
14663
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
14664
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
14665
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
14666
+ * @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
14667
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
14668
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
14669
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14064
14670
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14065
14671
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14066
14672
  * @param {number} [page] Page number for pagination
@@ -14068,8 +14674,8 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
14068
14674
  * @param {*} [options] Override http request option.
14069
14675
  * @throws {RequiredError}
14070
14676
  */
14071
- async adminAnalyticsStoreXStoreIDKpiGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDKpiGet200Response>> {
14072
- const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options);
14677
+ async adminAnalyticsStoreXStoreIDKpiGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDKpiGet200Response>> {
14678
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options);
14073
14679
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14074
14680
  const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDKpiGet']?.[localVarOperationServerIndex]?.url;
14075
14681
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -14088,7 +14694,7 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
14088
14694
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14089
14695
  },
14090
14696
  /**
14091
- * Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
14697
+ * Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
14092
14698
  * @summary Get Query Analytics
14093
14699
  * @param {string} xStoreID Store ID
14094
14700
  * @param {string} [startTime] Start time in RFC3339 format
@@ -14100,6 +14706,14 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
14100
14706
  * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
14101
14707
  * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
14102
14708
  * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
14709
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
14710
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
14711
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
14712
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
14713
+ * @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
14714
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
14715
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
14716
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14103
14717
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14104
14718
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14105
14719
  * @param {number} [page] Page number for pagination
@@ -14111,18 +14725,27 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
14111
14725
  * @param {*} [options] Override http request option.
14112
14726
  * @throws {RequiredError}
14113
14727
  */
14114
- async adminAnalyticsStoreXStoreIDQueriesGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesGet200Response>> {
14115
- const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options);
14728
+ async adminAnalyticsStoreXStoreIDQueriesGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesGet200Response>> {
14729
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options);
14116
14730
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14117
14731
  const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesGet']?.[localVarOperationServerIndex]?.url;
14118
14732
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14119
14733
  },
14120
14734
  /**
14121
- * Retrieve queries that received searches but no user clicks, indicating poor result relevance
14735
+ * Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
14122
14736
  * @summary Get No-Clicks Queries
14123
14737
  * @param {string} xStoreID Store ID
14124
14738
  * @param {string} [startTime] Start time in RFC3339 format
14125
14739
  * @param {string} [endTime] End time in RFC3339 format
14740
+ * @param {string} [search] Search term to filter queries (case-insensitive partial match)
14741
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
14742
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
14743
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
14744
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
14745
+ * @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
14746
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
14747
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
14748
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14126
14749
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14127
14750
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14128
14751
  * @param {number} [page] Page number for pagination
@@ -14133,18 +14756,27 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
14133
14756
  * @param {*} [options] Override http request option.
14134
14757
  * @throws {RequiredError}
14135
14758
  */
14136
- async adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>> {
14137
- const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
14759
+ async 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>> {
14760
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
14138
14761
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14139
14762
  const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoClicksGet']?.[localVarOperationServerIndex]?.url;
14140
14763
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14141
14764
  },
14142
14765
  /**
14143
- * Retrieve queries that returned no search results, useful for identifying content gaps
14766
+ * Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
14144
14767
  * @summary Get No-Results Queries
14145
14768
  * @param {string} xStoreID Store ID
14146
14769
  * @param {string} [startTime] Start time in RFC3339 format
14147
14770
  * @param {string} [endTime] End time in RFC3339 format
14771
+ * @param {string} [search] Search term to filter queries (case-insensitive partial match)
14772
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
14773
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
14774
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
14775
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
14776
+ * @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
14777
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
14778
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
14779
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14148
14780
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14149
14781
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14150
14782
  * @param {number} [page] Page number for pagination
@@ -14155,8 +14787,8 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
14155
14787
  * @param {*} [options] Override http request option.
14156
14788
  * @throws {RequiredError}
14157
14789
  */
14158
- async adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>> {
14159
- const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
14790
+ async 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>> {
14791
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
14160
14792
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14161
14793
  const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoResultsGet']?.[localVarOperationServerIndex]?.url;
14162
14794
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -14178,7 +14810,7 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
14178
14810
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14179
14811
  },
14180
14812
  /**
14181
- * Retrieve analytics for top performing search results with actual document data. Returns both performance metrics and the actual documents from the search index.
14813
+ * 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.
14182
14814
  * @summary Get Top Results Analytics
14183
14815
  * @param {string} xStoreID Store ID
14184
14816
  * @param {string} [startTime] Start time in RFC3339 format
@@ -14188,7 +14820,8 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
14188
14820
  * @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
14189
14821
  * @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
14190
14822
  * @param {string} [sort] Combined sort parameter in format \&#39;field:direction\&#39;
14191
- * @param {boolean} [includeDocuments] Whether to include document data from search index
14823
+ * @param {boolean} [includeDocuments] Whether to include full document data from search index
14824
+ * @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
14192
14825
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14193
14826
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14194
14827
  * @param {number} [page] Page number for pagination
@@ -14196,8 +14829,8 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
14196
14829
  * @param {*} [options] Override http request option.
14197
14830
  * @throws {RequiredError}
14198
14831
  */
14199
- async adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response>> {
14200
- const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options);
14832
+ async 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>> {
14833
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options);
14201
14834
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14202
14835
  const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDResultsGet']?.[localVarOperationServerIndex]?.url;
14203
14836
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -14366,7 +14999,7 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
14366
14999
  return localVarFp.adminAnalyticsStoreXStoreIDFiltersTrendsGet(xStoreID, startTime, endTime, granularity, filterKey, topFilters, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
14367
15000
  },
14368
15001
  /**
14369
- * Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
15002
+ * Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
14370
15003
  * @summary Get Geographic Analytics
14371
15004
  * @param {string} xStoreID Store ID
14372
15005
  * @param {string} [startTime] Start time in RFC3339 format
@@ -14377,6 +15010,14 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
14377
15010
  * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
14378
15011
  * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
14379
15012
  * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
15013
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
15014
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
15015
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
15016
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
15017
+ * @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
15018
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
15019
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
15020
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14380
15021
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14381
15022
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14382
15023
  * @param {number} [page] Page number for pagination
@@ -14387,8 +15028,8 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
14387
15028
  * @param {*} [options] Override http request option.
14388
15029
  * @throws {RequiredError}
14389
15030
  */
14390
- adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDGeoGet200Response> {
14391
- return localVarFp.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
15031
+ 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> {
15032
+ return localVarFp.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
14392
15033
  },
14393
15034
  /**
14394
15035
  * Check the health status of analytics service and ClickHouse connection
@@ -14401,7 +15042,7 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
14401
15042
  return localVarFp.adminAnalyticsStoreXStoreIDHealthGet(xStoreID, options).then((request) => request(axios, basePath));
14402
15043
  },
14403
15044
  /**
14404
- * Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
15045
+ * Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators and comparison mode between different timelines and tag sets.
14405
15046
  * @summary Get KPI Analytics
14406
15047
  * @param {string} xStoreID Store ID
14407
15048
  * @param {string} [startTime] Start time in RFC3339 format
@@ -14412,6 +15053,14 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
14412
15053
  * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
14413
15054
  * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
14414
15055
  * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
15056
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
15057
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
15058
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
15059
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
15060
+ * @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
15061
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
15062
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
15063
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14415
15064
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14416
15065
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14417
15066
  * @param {number} [page] Page number for pagination
@@ -14419,8 +15068,8 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
14419
15068
  * @param {*} [options] Override http request option.
14420
15069
  * @throws {RequiredError}
14421
15070
  */
14422
- adminAnalyticsStoreXStoreIDKpiGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDKpiGet200Response> {
14423
- return localVarFp.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
15071
+ 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> {
15072
+ return localVarFp.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
14424
15073
  },
14425
15074
  /**
14426
15075
  * Retrieve real-time KPI metrics for the last hour with minute-level granularity
@@ -14433,7 +15082,7 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
14433
15082
  return localVarFp.adminAnalyticsStoreXStoreIDKpiRealtimeGet(xStoreID, options).then((request) => request(axios, basePath));
14434
15083
  },
14435
15084
  /**
14436
- * Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
15085
+ * Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
14437
15086
  * @summary Get Query Analytics
14438
15087
  * @param {string} xStoreID Store ID
14439
15088
  * @param {string} [startTime] Start time in RFC3339 format
@@ -14445,6 +15094,14 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
14445
15094
  * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
14446
15095
  * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
14447
15096
  * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
15097
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
15098
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
15099
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
15100
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
15101
+ * @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
15102
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
15103
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
15104
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14448
15105
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14449
15106
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14450
15107
  * @param {number} [page] Page number for pagination
@@ -14456,15 +15113,24 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
14456
15113
  * @param {*} [options] Override http request option.
14457
15114
  * @throws {RequiredError}
14458
15115
  */
14459
- adminAnalyticsStoreXStoreIDQueriesGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesGet200Response> {
14460
- return localVarFp.adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
15116
+ 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> {
15117
+ return localVarFp.adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
14461
15118
  },
14462
15119
  /**
14463
- * Retrieve queries that received searches but no user clicks, indicating poor result relevance
15120
+ * Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
14464
15121
  * @summary Get No-Clicks Queries
14465
15122
  * @param {string} xStoreID Store ID
14466
15123
  * @param {string} [startTime] Start time in RFC3339 format
14467
15124
  * @param {string} [endTime] End time in RFC3339 format
15125
+ * @param {string} [search] Search term to filter queries (case-insensitive partial match)
15126
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
15127
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
15128
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
15129
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
15130
+ * @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
15131
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
15132
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
15133
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14468
15134
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14469
15135
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14470
15136
  * @param {number} [page] Page number for pagination
@@ -14475,15 +15141,24 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
14475
15141
  * @param {*} [options] Override http request option.
14476
15142
  * @throws {RequiredError}
14477
15143
  */
14478
- adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response> {
14479
- return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
15144
+ 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> {
15145
+ return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
14480
15146
  },
14481
15147
  /**
14482
- * Retrieve queries that returned no search results, useful for identifying content gaps
15148
+ * Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
14483
15149
  * @summary Get No-Results Queries
14484
15150
  * @param {string} xStoreID Store ID
14485
15151
  * @param {string} [startTime] Start time in RFC3339 format
14486
15152
  * @param {string} [endTime] End time in RFC3339 format
15153
+ * @param {string} [search] Search term to filter queries (case-insensitive partial match)
15154
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
15155
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
15156
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
15157
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
15158
+ * @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
15159
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
15160
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
15161
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14487
15162
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14488
15163
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14489
15164
  * @param {number} [page] Page number for pagination
@@ -14494,8 +15169,8 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
14494
15169
  * @param {*} [options] Override http request option.
14495
15170
  * @throws {RequiredError}
14496
15171
  */
14497
- adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response> {
14498
- return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
15172
+ 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> {
15173
+ return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
14499
15174
  },
14500
15175
  /**
14501
15176
  * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
@@ -14511,7 +15186,7 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
14511
15186
  return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(axios, basePath));
14512
15187
  },
14513
15188
  /**
14514
- * Retrieve analytics for top performing search results with actual document data. Returns both performance metrics and the actual documents from the search index.
15189
+ * 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.
14515
15190
  * @summary Get Top Results Analytics
14516
15191
  * @param {string} xStoreID Store ID
14517
15192
  * @param {string} [startTime] Start time in RFC3339 format
@@ -14521,7 +15196,8 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
14521
15196
  * @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
14522
15197
  * @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
14523
15198
  * @param {string} [sort] Combined sort parameter in format \&#39;field:direction\&#39;
14524
- * @param {boolean} [includeDocuments] Whether to include document data from search index
15199
+ * @param {boolean} [includeDocuments] Whether to include full document data from search index
15200
+ * @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
14525
15201
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14526
15202
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14527
15203
  * @param {number} [page] Page number for pagination
@@ -14529,8 +15205,8 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
14529
15205
  * @param {*} [options] Override http request option.
14530
15206
  * @throws {RequiredError}
14531
15207
  */
14532
- adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response> {
14533
- return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
15208
+ 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> {
15209
+ return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
14534
15210
  },
14535
15211
  /**
14536
15212
  * Retrieve analytics tags usage data and filtering capabilities
@@ -14702,7 +15378,7 @@ export class AnalyticsApi extends BaseAPI {
14702
15378
  }
14703
15379
 
14704
15380
  /**
14705
- * Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
15381
+ * Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
14706
15382
  * @summary Get Geographic Analytics
14707
15383
  * @param {string} xStoreID Store ID
14708
15384
  * @param {string} [startTime] Start time in RFC3339 format
@@ -14713,6 +15389,14 @@ export class AnalyticsApi extends BaseAPI {
14713
15389
  * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
14714
15390
  * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
14715
15391
  * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
15392
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
15393
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
15394
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
15395
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
15396
+ * @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
15397
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
15398
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
15399
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14716
15400
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14717
15401
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14718
15402
  * @param {number} [page] Page number for pagination
@@ -14724,8 +15408,8 @@ export class AnalyticsApi extends BaseAPI {
14724
15408
  * @throws {RequiredError}
14725
15409
  * @memberof AnalyticsApi
14726
15410
  */
14727
- public adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
14728
- return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
15411
+ public adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
15412
+ return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
14729
15413
  }
14730
15414
 
14731
15415
  /**
@@ -14741,7 +15425,7 @@ export class AnalyticsApi extends BaseAPI {
14741
15425
  }
14742
15426
 
14743
15427
  /**
14744
- * Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
15428
+ * Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators and comparison mode between different timelines and tag sets.
14745
15429
  * @summary Get KPI Analytics
14746
15430
  * @param {string} xStoreID Store ID
14747
15431
  * @param {string} [startTime] Start time in RFC3339 format
@@ -14752,6 +15436,14 @@ export class AnalyticsApi extends BaseAPI {
14752
15436
  * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
14753
15437
  * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
14754
15438
  * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
15439
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
15440
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
15441
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
15442
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
15443
+ * @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
15444
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
15445
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
15446
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14755
15447
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14756
15448
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14757
15449
  * @param {number} [page] Page number for pagination
@@ -14760,8 +15452,8 @@ export class AnalyticsApi extends BaseAPI {
14760
15452
  * @throws {RequiredError}
14761
15453
  * @memberof AnalyticsApi
14762
15454
  */
14763
- public adminAnalyticsStoreXStoreIDKpiGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) {
14764
- return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
15455
+ public adminAnalyticsStoreXStoreIDKpiGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) {
15456
+ return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
14765
15457
  }
14766
15458
 
14767
15459
  /**
@@ -14777,7 +15469,7 @@ export class AnalyticsApi extends BaseAPI {
14777
15469
  }
14778
15470
 
14779
15471
  /**
14780
- * Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
15472
+ * Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
14781
15473
  * @summary Get Query Analytics
14782
15474
  * @param {string} xStoreID Store ID
14783
15475
  * @param {string} [startTime] Start time in RFC3339 format
@@ -14789,6 +15481,14 @@ export class AnalyticsApi extends BaseAPI {
14789
15481
  * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
14790
15482
  * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
14791
15483
  * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
15484
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
15485
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
15486
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
15487
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
15488
+ * @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
15489
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
15490
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
15491
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14792
15492
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14793
15493
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14794
15494
  * @param {number} [page] Page number for pagination
@@ -14801,16 +15501,25 @@ export class AnalyticsApi extends BaseAPI {
14801
15501
  * @throws {RequiredError}
14802
15502
  * @memberof AnalyticsApi
14803
15503
  */
14804
- public adminAnalyticsStoreXStoreIDQueriesGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
14805
- return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
15504
+ public adminAnalyticsStoreXStoreIDQueriesGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
15505
+ return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
14806
15506
  }
14807
15507
 
14808
15508
  /**
14809
- * Retrieve queries that received searches but no user clicks, indicating poor result relevance
15509
+ * Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
14810
15510
  * @summary Get No-Clicks Queries
14811
15511
  * @param {string} xStoreID Store ID
14812
15512
  * @param {string} [startTime] Start time in RFC3339 format
14813
15513
  * @param {string} [endTime] End time in RFC3339 format
15514
+ * @param {string} [search] Search term to filter queries (case-insensitive partial match)
15515
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
15516
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
15517
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
15518
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
15519
+ * @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
15520
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
15521
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
15522
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14814
15523
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14815
15524
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14816
15525
  * @param {number} [page] Page number for pagination
@@ -14822,16 +15531,25 @@ export class AnalyticsApi extends BaseAPI {
14822
15531
  * @throws {RequiredError}
14823
15532
  * @memberof AnalyticsApi
14824
15533
  */
14825
- public adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
14826
- return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
15534
+ public 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) {
15535
+ return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
14827
15536
  }
14828
15537
 
14829
15538
  /**
14830
- * Retrieve queries that returned no search results, useful for identifying content gaps
15539
+ * Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
14831
15540
  * @summary Get No-Results Queries
14832
15541
  * @param {string} xStoreID Store ID
14833
15542
  * @param {string} [startTime] Start time in RFC3339 format
14834
15543
  * @param {string} [endTime] End time in RFC3339 format
15544
+ * @param {string} [search] Search term to filter queries (case-insensitive partial match)
15545
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
15546
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
15547
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
15548
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
15549
+ * @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
15550
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
15551
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
15552
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14835
15553
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14836
15554
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14837
15555
  * @param {number} [page] Page number for pagination
@@ -14843,8 +15561,8 @@ export class AnalyticsApi extends BaseAPI {
14843
15561
  * @throws {RequiredError}
14844
15562
  * @memberof AnalyticsApi
14845
15563
  */
14846
- public adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
14847
- return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
15564
+ public 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) {
15565
+ return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
14848
15566
  }
14849
15567
 
14850
15568
  /**
@@ -14863,7 +15581,7 @@ export class AnalyticsApi extends BaseAPI {
14863
15581
  }
14864
15582
 
14865
15583
  /**
14866
- * Retrieve analytics for top performing search results with actual document data. Returns both performance metrics and the actual documents from the search index.
15584
+ * 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.
14867
15585
  * @summary Get Top Results Analytics
14868
15586
  * @param {string} xStoreID Store ID
14869
15587
  * @param {string} [startTime] Start time in RFC3339 format
@@ -14873,7 +15591,8 @@ export class AnalyticsApi extends BaseAPI {
14873
15591
  * @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
14874
15592
  * @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
14875
15593
  * @param {string} [sort] Combined sort parameter in format \&#39;field:direction\&#39;
14876
- * @param {boolean} [includeDocuments] Whether to include document data from search index
15594
+ * @param {boolean} [includeDocuments] Whether to include full document data from search index
15595
+ * @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
14877
15596
  * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
14878
15597
  * @param {number} [offset] Offset for pagination (legacy - use page instead)
14879
15598
  * @param {number} [page] Page number for pagination
@@ -14882,8 +15601,8 @@ export class AnalyticsApi extends BaseAPI {
14882
15601
  * @throws {RequiredError}
14883
15602
  * @memberof AnalyticsApi
14884
15603
  */
14885
- public adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) {
14886
- return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
15604
+ public 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) {
15605
+ return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
14887
15606
  }
14888
15607
 
14889
15608
  /**
@@ -15050,6 +15769,14 @@ export const AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum = {
15050
15769
  All: 'all'
15051
15770
  } as const;
15052
15771
  export type AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum];
15772
+ /**
15773
+ * @export
15774
+ */
15775
+ export const AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum = {
15776
+ Any: 'any',
15777
+ All: 'all'
15778
+ } as const;
15779
+ export type AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum];
15053
15780
  /**
15054
15781
  * @export
15055
15782
  */
@@ -15091,6 +15818,14 @@ export const AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum = {
15091
15818
  All: 'all'
15092
15819
  } as const;
15093
15820
  export type AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum];
15821
+ /**
15822
+ * @export
15823
+ */
15824
+ export const AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum = {
15825
+ Any: 'any',
15826
+ All: 'all'
15827
+ } as const;
15828
+ export type AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum];
15094
15829
  /**
15095
15830
  * @export
15096
15831
  */
@@ -15112,6 +15847,14 @@ export const AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum = {
15112
15847
  All: 'all'
15113
15848
  } as const;
15114
15849
  export type AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum];
15850
+ /**
15851
+ * @export
15852
+ */
15853
+ export const AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum = {
15854
+ Any: 'any',
15855
+ All: 'all'
15856
+ } as const;
15857
+ export type AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum];
15115
15858
  /**
15116
15859
  * @export
15117
15860
  */
@@ -15132,6 +15875,14 @@ export const AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = {
15132
15875
  Desc: 'desc'
15133
15876
  } as const;
15134
15877
  export type AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum];
15878
+ /**
15879
+ * @export
15880
+ */
15881
+ export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum = {
15882
+ Any: 'any',
15883
+ All: 'all'
15884
+ } as const;
15885
+ export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum];
15135
15886
  /**
15136
15887
  * @export
15137
15888
  */
@@ -15149,6 +15900,14 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = {
15149
15900
  Desc: 'desc'
15150
15901
  } as const;
15151
15902
  export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum];
15903
+ /**
15904
+ * @export
15905
+ */
15906
+ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum = {
15907
+ Any: 'any',
15908
+ All: 'all'
15909
+ } as const;
15910
+ export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum];
15152
15911
  /**
15153
15912
  * @export
15154
15913
  */