@seekora-ai/admin-api 1.1.15 → 1.1.16

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
@@ -711,6 +711,49 @@ export interface AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response {
711
711
  */
712
712
  'total'?: number;
713
713
  }
714
+ /**
715
+ *
716
+ * @export
717
+ * @interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
718
+ */
719
+ export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
720
+ /**
721
+ * Comparison metadata when in compare mode
722
+ * @type {AnalyticsComparisonMeta}
723
+ * @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
724
+ */
725
+ 'comparison'?: AnalyticsComparisonMeta;
726
+ /**
727
+ *
728
+ * @type {AnalyticsQueryInsights}
729
+ * @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
730
+ */
731
+ 'data'?: AnalyticsQueryInsights;
732
+ /**
733
+ *
734
+ * @type {string}
735
+ * @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
736
+ */
737
+ 'error'?: string;
738
+ /**
739
+ *
740
+ * @type {string}
741
+ * @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
742
+ */
743
+ 'status'?: string;
744
+ /**
745
+ *
746
+ * @type {string}
747
+ * @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
748
+ */
749
+ 'timestamp'?: string;
750
+ /**
751
+ *
752
+ * @type {number}
753
+ * @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
754
+ */
755
+ 'total'?: number;
756
+ }
714
757
  /**
715
758
  *
716
759
  * @export
@@ -1424,6 +1467,153 @@ export interface AnalyticsAnalyticsAPIResponse {
1424
1467
  */
1425
1468
  'total'?: number;
1426
1469
  }
1470
+ /**
1471
+ *
1472
+ * @export
1473
+ * @interface AnalyticsArrayElementAnalytic
1474
+ */
1475
+ export interface AnalyticsArrayElementAnalytic {
1476
+ /**
1477
+ * Position in array (0-based)
1478
+ * @type {number}
1479
+ * @memberof AnalyticsArrayElementAnalytic
1480
+ */
1481
+ 'array_index'?: number;
1482
+ /**
1483
+ * Total array size
1484
+ * @type {number}
1485
+ * @memberof AnalyticsArrayElementAnalytic
1486
+ */
1487
+ 'array_length'?: number;
1488
+ /**
1489
+ * Average results when this element is used
1490
+ * @type {number}
1491
+ * @memberof AnalyticsArrayElementAnalytic
1492
+ */
1493
+ 'avg_results_count'?: number;
1494
+ /**
1495
+ * e.g., \"tags\"
1496
+ * @type {string}
1497
+ * @memberof AnalyticsArrayElementAnalytic
1498
+ */
1499
+ 'filter_key'?: string;
1500
+ /**
1501
+ * e.g., \"fashion\"
1502
+ * @type {string}
1503
+ * @memberof AnalyticsArrayElementAnalytic
1504
+ */
1505
+ 'filter_value'?: string;
1506
+ /**
1507
+ * \"array\", \"object\", \"string\"
1508
+ * @type {string}
1509
+ * @memberof AnalyticsArrayElementAnalytic
1510
+ */
1511
+ 'original_type'?: string;
1512
+ /**
1513
+ * How often this element appears at this position
1514
+ * @type {number}
1515
+ * @memberof AnalyticsArrayElementAnalytic
1516
+ */
1517
+ 'position_popularity'?: number;
1518
+ /**
1519
+ * Percentage with results > 0
1520
+ * @type {number}
1521
+ * @memberof AnalyticsArrayElementAnalytic
1522
+ */
1523
+ 'success_rate'?: number;
1524
+ /**
1525
+ * Unique searches using this element
1526
+ * @type {number}
1527
+ * @memberof AnalyticsArrayElementAnalytic
1528
+ */
1529
+ 'unique_searches'?: number;
1530
+ /**
1531
+ * How many times this element was used
1532
+ * @type {number}
1533
+ * @memberof AnalyticsArrayElementAnalytic
1534
+ */
1535
+ 'usage_count'?: number;
1536
+ /**
1537
+ * \"array_element\", \"object_key\", etc.
1538
+ * @type {string}
1539
+ * @memberof AnalyticsArrayElementAnalytic
1540
+ */
1541
+ 'value_type'?: string;
1542
+ }
1543
+ /**
1544
+ *
1545
+ * @export
1546
+ * @interface AnalyticsArrayFilterStats
1547
+ */
1548
+ export interface AnalyticsArrayFilterStats {
1549
+ /**
1550
+ * Average array size
1551
+ * @type {number}
1552
+ * @memberof AnalyticsArrayFilterStats
1553
+ */
1554
+ 'avg_array_length'?: number;
1555
+ /**
1556
+ * Largest array seen
1557
+ * @type {number}
1558
+ * @memberof AnalyticsArrayFilterStats
1559
+ */
1560
+ 'max_array_length'?: number;
1561
+ /**
1562
+ * Top values across all arrays
1563
+ * @type {Array<string>}
1564
+ * @memberof AnalyticsArrayFilterStats
1565
+ */
1566
+ 'most_popular_values'?: Array<string>;
1567
+ /**
1568
+ * Usage by array position
1569
+ * @type {Array<AnalyticsArrayPositionAnalytic>}
1570
+ * @memberof AnalyticsArrayFilterStats
1571
+ */
1572
+ 'position_analytics'?: Array<AnalyticsArrayPositionAnalytic>;
1573
+ /**
1574
+ * Total times arrays were used for this filter
1575
+ * @type {number}
1576
+ * @memberof AnalyticsArrayFilterStats
1577
+ */
1578
+ 'total_array_usage'?: number;
1579
+ }
1580
+ /**
1581
+ *
1582
+ * @export
1583
+ * @interface AnalyticsArrayPositionAnalytic
1584
+ */
1585
+ export interface AnalyticsArrayPositionAnalytic {
1586
+ /**
1587
+ * Most popular value at this position
1588
+ * @type {string}
1589
+ * @memberof AnalyticsArrayPositionAnalytic
1590
+ */
1591
+ 'popular_value'?: string;
1592
+ /**
1593
+ * 0-based array position
1594
+ * @type {number}
1595
+ * @memberof AnalyticsArrayPositionAnalytic
1596
+ */
1597
+ 'position'?: number;
1598
+ /**
1599
+ * Success rate for searches with values at this position
1600
+ * @type {number}
1601
+ * @memberof AnalyticsArrayPositionAnalytic
1602
+ */
1603
+ 'success_rate'?: number;
1604
+ /**
1605
+ * Unique values at this position
1606
+ * @type {number}
1607
+ * @memberof AnalyticsArrayPositionAnalytic
1608
+ */
1609
+ 'unique_values'?: number;
1610
+ /**
1611
+ * Times this position was used
1612
+ * @type {number}
1613
+ * @memberof AnalyticsArrayPositionAnalytic
1614
+ */
1615
+ 'usage_count'?: number;
1616
+ }
1427
1617
  /**
1428
1618
  *
1429
1619
  * @export
@@ -1678,6 +1868,43 @@ export interface AnalyticsCategoryWithCount {
1678
1868
  */
1679
1869
  'value'?: string;
1680
1870
  }
1871
+ /**
1872
+ *
1873
+ * @export
1874
+ * @interface AnalyticsClickPositionBucket
1875
+ */
1876
+ export interface AnalyticsClickPositionBucket {
1877
+ /**
1878
+ *
1879
+ * @type {number}
1880
+ * @memberof AnalyticsClickPositionBucket
1881
+ */
1882
+ 'click_rate'?: number;
1883
+ /**
1884
+ *
1885
+ * @type {number}
1886
+ * @memberof AnalyticsClickPositionBucket
1887
+ */
1888
+ 'clicks'?: number;
1889
+ /**
1890
+ *
1891
+ * @type {number}
1892
+ * @memberof AnalyticsClickPositionBucket
1893
+ */
1894
+ 'impressions'?: number;
1895
+ /**
1896
+ * \"1\", \"2\", \"3\", \"4-5\", \"6-10\", \"11-20\", \"21+\"
1897
+ * @type {string}
1898
+ * @memberof AnalyticsClickPositionBucket
1899
+ */
1900
+ 'position_range'?: string;
1901
+ /**
1902
+ * percentage of total clicks for this query
1903
+ * @type {number}
1904
+ * @memberof AnalyticsClickPositionBucket
1905
+ */
1906
+ 'share'?: number;
1907
+ }
1681
1908
  /**
1682
1909
  *
1683
1910
  * @export
@@ -2316,6 +2543,43 @@ export interface AnalyticsFilterEffectivenessCategory {
2316
2543
  */
2317
2544
  'unique_searches'?: number;
2318
2545
  }
2546
+ /**
2547
+ *
2548
+ * @export
2549
+ * @interface AnalyticsFilterEffectivenessMetrics
2550
+ */
2551
+ export interface AnalyticsFilterEffectivenessMetrics {
2552
+ /**
2553
+ *
2554
+ * @type {number}
2555
+ * @memberof AnalyticsFilterEffectivenessMetrics
2556
+ */
2557
+ 'avg_results_count'?: number;
2558
+ /**
2559
+ *
2560
+ * @type {number}
2561
+ * @memberof AnalyticsFilterEffectivenessMetrics
2562
+ */
2563
+ 'click_through_rate'?: number;
2564
+ /**
2565
+ *
2566
+ * @type {number}
2567
+ * @memberof AnalyticsFilterEffectivenessMetrics
2568
+ */
2569
+ 'conversion_rate'?: number;
2570
+ /**
2571
+ *
2572
+ * @type {number}
2573
+ * @memberof AnalyticsFilterEffectivenessMetrics
2574
+ */
2575
+ 'search_count'?: number;
2576
+ /**
2577
+ * percentage with results > 0
2578
+ * @type {number}
2579
+ * @memberof AnalyticsFilterEffectivenessMetrics
2580
+ */
2581
+ 'success_rate'?: number;
2582
+ }
2319
2583
  /**
2320
2584
  *
2321
2585
  * @export
@@ -2359,6 +2623,37 @@ export interface AnalyticsFilterEffectivenessSummary {
2359
2623
  */
2360
2624
  'total_searches'?: number;
2361
2625
  }
2626
+ /**
2627
+ *
2628
+ * @export
2629
+ * @interface AnalyticsFilterImprovementMetrics
2630
+ */
2631
+ export interface AnalyticsFilterImprovementMetrics {
2632
+ /**
2633
+ * percentage points
2634
+ * @type {number}
2635
+ * @memberof AnalyticsFilterImprovementMetrics
2636
+ */
2637
+ 'conversion_improvement'?: number;
2638
+ /**
2639
+ * percentage points
2640
+ * @type {number}
2641
+ * @memberof AnalyticsFilterImprovementMetrics
2642
+ */
2643
+ 'ctr_improvement'?: number;
2644
+ /**
2645
+ * percentage
2646
+ * @type {number}
2647
+ * @memberof AnalyticsFilterImprovementMetrics
2648
+ */
2649
+ 'results_count_improvement'?: number;
2650
+ /**
2651
+ * percentage points
2652
+ * @type {number}
2653
+ * @memberof AnalyticsFilterImprovementMetrics
2654
+ */
2655
+ 'success_rate_improvement'?: number;
2656
+ }
2362
2657
  /**
2363
2658
  *
2364
2659
  * @export
@@ -2584,6 +2879,73 @@ export interface AnalyticsFilterValueStatistic {
2584
2879
  */
2585
2880
  'value_type'?: string;
2586
2881
  }
2882
+ /**
2883
+ *
2884
+ * @export
2885
+ * @interface AnalyticsFilterValueUsage
2886
+ */
2887
+ export interface AnalyticsFilterValueUsage {
2888
+ /**
2889
+ * Position in array (if applicable)
2890
+ * @type {number}
2891
+ * @memberof AnalyticsFilterValueUsage
2892
+ */
2893
+ 'array_index'?: number;
2894
+ /**
2895
+ * Total array size (if applicable)
2896
+ * @type {number}
2897
+ * @memberof AnalyticsFilterValueUsage
2898
+ */
2899
+ 'array_length'?: number;
2900
+ /**
2901
+ *
2902
+ * @type {number}
2903
+ * @memberof AnalyticsFilterValueUsage
2904
+ */
2905
+ 'avg_results_count'?: number;
2906
+ /**
2907
+ * \"array\", \"object\", \"string\"
2908
+ * @type {string}
2909
+ * @memberof AnalyticsFilterValueUsage
2910
+ */
2911
+ 'original_type'?: string;
2912
+ /**
2913
+ * Percentage of total usage for this filter key
2914
+ * @type {number}
2915
+ * @memberof AnalyticsFilterValueUsage
2916
+ */
2917
+ 'share_of_filter_key'?: number;
2918
+ /**
2919
+ *
2920
+ * @type {number}
2921
+ * @memberof AnalyticsFilterValueUsage
2922
+ */
2923
+ 'success_rate'?: number;
2924
+ /**
2925
+ *
2926
+ * @type {number}
2927
+ * @memberof AnalyticsFilterValueUsage
2928
+ */
2929
+ 'unique_searches'?: number;
2930
+ /**
2931
+ *
2932
+ * @type {number}
2933
+ * @memberof AnalyticsFilterValueUsage
2934
+ */
2935
+ 'usage_count'?: number;
2936
+ /**
2937
+ *
2938
+ * @type {string}
2939
+ * @memberof AnalyticsFilterValueUsage
2940
+ */
2941
+ 'value'?: string;
2942
+ /**
2943
+ * \"array_element\", \"object_key\", \"string\", etc.
2944
+ * @type {string}
2945
+ * @memberof AnalyticsFilterValueUsage
2946
+ */
2947
+ 'value_type'?: string;
2948
+ }
2587
2949
  /**
2588
2950
  *
2589
2951
  * @export
@@ -4747,21 +5109,461 @@ export interface AnalyticsQueryAnalytic {
4747
5109
  /**
4748
5110
  *
4749
5111
  * @export
4750
- * @interface AnalyticsQueryPerformanceAnalytics
5112
+ * @interface AnalyticsQueryFilterAnalytics
4751
5113
  */
4752
- export interface AnalyticsQueryPerformanceAnalytics {
5114
+ export interface AnalyticsQueryFilterAnalytics {
4753
5115
  /**
4754
- *
4755
- * @type {number}
4756
- * @memberof AnalyticsQueryPerformanceAnalytics
5116
+ * NEW: Individual array element insights
5117
+ * @type {Array<AnalyticsArrayElementAnalytic>}
5118
+ * @memberof AnalyticsQueryFilterAnalytics
4757
5119
  */
4758
- 'avg_results'?: number;
5120
+ 'array_element_analytics'?: Array<AnalyticsArrayElementAnalytic>;
4759
5121
  /**
4760
5122
  *
4761
5123
  * @type {number}
4762
- * @memberof AnalyticsQueryPerformanceAnalytics
5124
+ * @memberof AnalyticsQueryFilterAnalytics
4763
5125
  */
4764
- 'avg_search_duration_ms'?: number;
5126
+ 'avg_filters_per_search'?: number;
5127
+ /**
5128
+ *
5129
+ * @type {Array<AnalyticsQueryFilterCombination>}
5130
+ * @memberof AnalyticsQueryFilterAnalytics
5131
+ */
5132
+ 'filter_combinations'?: Array<AnalyticsQueryFilterCombination>;
5133
+ /**
5134
+ *
5135
+ * @type {AnalyticsQueryFilterEffectiveness}
5136
+ * @memberof AnalyticsQueryFilterAnalytics
5137
+ */
5138
+ 'filter_effectiveness'?: AnalyticsQueryFilterEffectiveness;
5139
+ /**
5140
+ *
5141
+ * @type {Array<AnalyticsQueryFilterTrend>}
5142
+ * @memberof AnalyticsQueryFilterAnalytics
5143
+ */
5144
+ 'filter_trends'?: Array<AnalyticsQueryFilterTrend>;
5145
+ /**
5146
+ *
5147
+ * @type {number}
5148
+ * @memberof AnalyticsQueryFilterAnalytics
5149
+ */
5150
+ 'filter_usage_rate'?: number;
5151
+ /**
5152
+ * NEW: Enhanced filter usage with array data (removed omitempty to always show field)
5153
+ * @type {Array<AnalyticsQueryFilterUsage>}
5154
+ * @memberof AnalyticsQueryFilterAnalytics
5155
+ */
5156
+ 'popular_filters'?: Array<AnalyticsQueryFilterUsage>;
5157
+ /**
5158
+ *
5159
+ * @type {number}
5160
+ * @memberof AnalyticsQueryFilterAnalytics
5161
+ */
5162
+ 'total_searches_with_filters'?: number;
5163
+ }
5164
+ /**
5165
+ *
5166
+ * @export
5167
+ * @interface AnalyticsQueryFilterCombination
5168
+ */
5169
+ export interface AnalyticsQueryFilterCombination {
5170
+ /**
5171
+ *
5172
+ * @type {number}
5173
+ * @memberof AnalyticsQueryFilterCombination
5174
+ */
5175
+ 'avg_results_count'?: number;
5176
+ /**
5177
+ *
5178
+ * @type {Array<string>}
5179
+ * @memberof AnalyticsQueryFilterCombination
5180
+ */
5181
+ 'filters'?: Array<string>;
5182
+ /**
5183
+ * percentage of filtered searches
5184
+ * @type {number}
5185
+ * @memberof AnalyticsQueryFilterCombination
5186
+ */
5187
+ 'share'?: number;
5188
+ /**
5189
+ *
5190
+ * @type {number}
5191
+ * @memberof AnalyticsQueryFilterCombination
5192
+ */
5193
+ 'success_rate'?: number;
5194
+ /**
5195
+ *
5196
+ * @type {number}
5197
+ * @memberof AnalyticsQueryFilterCombination
5198
+ */
5199
+ 'usage_count'?: number;
5200
+ }
5201
+ /**
5202
+ *
5203
+ * @export
5204
+ * @interface AnalyticsQueryFilterEffectiveness
5205
+ */
5206
+ export interface AnalyticsQueryFilterEffectiveness {
5207
+ /**
5208
+ *
5209
+ * @type {AnalyticsFilterImprovementMetrics}
5210
+ * @memberof AnalyticsQueryFilterEffectiveness
5211
+ */
5212
+ 'improvement'?: AnalyticsFilterImprovementMetrics;
5213
+ /**
5214
+ *
5215
+ * @type {AnalyticsFilterEffectivenessMetrics}
5216
+ * @memberof AnalyticsQueryFilterEffectiveness
5217
+ */
5218
+ 'with_filters'?: AnalyticsFilterEffectivenessMetrics;
5219
+ /**
5220
+ *
5221
+ * @type {AnalyticsFilterEffectivenessMetrics}
5222
+ * @memberof AnalyticsQueryFilterEffectiveness
5223
+ */
5224
+ 'without_filters'?: AnalyticsFilterEffectivenessMetrics;
5225
+ }
5226
+ /**
5227
+ *
5228
+ * @export
5229
+ * @interface AnalyticsQueryFilterTrend
5230
+ */
5231
+ export interface AnalyticsQueryFilterTrend {
5232
+ /**
5233
+ *
5234
+ * @type {string}
5235
+ * @memberof AnalyticsQueryFilterTrend
5236
+ */
5237
+ 'filter_key'?: string;
5238
+ /**
5239
+ *
5240
+ * @type {number}
5241
+ * @memberof AnalyticsQueryFilterTrend
5242
+ */
5243
+ 'growth_rate'?: number;
5244
+ /**
5245
+ * \"increasing\", \"decreasing\", \"stable\"
5246
+ * @type {string}
5247
+ * @memberof AnalyticsQueryFilterTrend
5248
+ */
5249
+ 'trend'?: string;
5250
+ /**
5251
+ *
5252
+ * @type {Array<AnalyticsTimeSeriesPoint>}
5253
+ * @memberof AnalyticsQueryFilterTrend
5254
+ */
5255
+ 'trend_data'?: Array<AnalyticsTimeSeriesPoint>;
5256
+ }
5257
+ /**
5258
+ *
5259
+ * @export
5260
+ * @interface AnalyticsQueryFilterUsage
5261
+ */
5262
+ export interface AnalyticsQueryFilterUsage {
5263
+ /**
5264
+ * Stats specific to array-type filters
5265
+ * @type {AnalyticsArrayFilterStats}
5266
+ * @memberof AnalyticsQueryFilterUsage
5267
+ */
5268
+ 'array_stats'?: AnalyticsArrayFilterStats;
5269
+ /**
5270
+ *
5271
+ * @type {number}
5272
+ * @memberof AnalyticsQueryFilterUsage
5273
+ */
5274
+ 'effectiveness_score'?: number;
5275
+ /**
5276
+ *
5277
+ * @type {string}
5278
+ * @memberof AnalyticsQueryFilterUsage
5279
+ */
5280
+ 'filter_key'?: string;
5281
+ /**
5282
+ * Individual values with array explosion data
5283
+ * @type {Array<AnalyticsFilterValueUsage>}
5284
+ * @memberof AnalyticsQueryFilterUsage
5285
+ */
5286
+ 'filter_values'?: Array<AnalyticsFilterValueUsage>;
5287
+ /**
5288
+ * Total times this filter key was used
5289
+ * @type {number}
5290
+ * @memberof AnalyticsQueryFilterUsage
5291
+ */
5292
+ 'total_usage'?: number;
5293
+ /**
5294
+ * Unique searches using this filter
5295
+ * @type {number}
5296
+ * @memberof AnalyticsQueryFilterUsage
5297
+ */
5298
+ 'unique_searches'?: number;
5299
+ }
5300
+ /**
5301
+ *
5302
+ * @export
5303
+ * @interface AnalyticsQueryGeoAnalytic
5304
+ */
5305
+ export interface AnalyticsQueryGeoAnalytic {
5306
+ /**
5307
+ *
5308
+ * @type {string}
5309
+ * @memberof AnalyticsQueryGeoAnalytic
5310
+ */
5311
+ 'city'?: string;
5312
+ /**
5313
+ * Clicks / Results Shown
5314
+ * @type {number}
5315
+ * @memberof AnalyticsQueryGeoAnalytic
5316
+ */
5317
+ 'click_through_rate'?: number;
5318
+ /**
5319
+ * Count of result-click events
5320
+ * @type {number}
5321
+ * @memberof AnalyticsQueryGeoAnalytic
5322
+ */
5323
+ 'clicks'?: number;
5324
+ /**
5325
+ * Conversions / Clicks (CVR)
5326
+ * @type {number}
5327
+ * @memberof AnalyticsQueryGeoAnalytic
5328
+ */
5329
+ 'conversion_rate'?: number;
5330
+ /**
5331
+ * Conversions / Searches
5332
+ * @type {number}
5333
+ * @memberof AnalyticsQueryGeoAnalytic
5334
+ */
5335
+ 'conversion_rate_per_search'?: number;
5336
+ /**
5337
+ * Post-click conversions attributed to search
5338
+ * @type {number}
5339
+ * @memberof AnalyticsQueryGeoAnalytic
5340
+ */
5341
+ 'conversions'?: number;
5342
+ /**
5343
+ *
5344
+ * @type {string}
5345
+ * @memberof AnalyticsQueryGeoAnalytic
5346
+ */
5347
+ 'country'?: string;
5348
+ /**
5349
+ *
5350
+ * @type {string}
5351
+ * @memberof AnalyticsQueryGeoAnalytic
5352
+ */
5353
+ 'country_code'?: string;
5354
+ /**
5355
+ * Searches with results but zero clicks / Results Shown
5356
+ * @type {number}
5357
+ * @memberof AnalyticsQueryGeoAnalytic
5358
+ */
5359
+ 'no_click_rate'?: number;
5360
+ /**
5361
+ * No-result searches / Searches
5362
+ * @type {number}
5363
+ * @memberof AnalyticsQueryGeoAnalytic
5364
+ */
5365
+ 'no_result_rate'?: number;
5366
+ /**
5367
+ *
5368
+ * @type {string}
5369
+ * @memberof AnalyticsQueryGeoAnalytic
5370
+ */
5371
+ 'region'?: string;
5372
+ /**
5373
+ * Count of searches that returned ≥1 result
5374
+ * @type {number}
5375
+ * @memberof AnalyticsQueryGeoAnalytic
5376
+ */
5377
+ 'results_shown'?: number;
5378
+ /**
5379
+ * Sum of attributed revenue
5380
+ * @type {number}
5381
+ * @memberof AnalyticsQueryGeoAnalytic
5382
+ */
5383
+ 'revenue'?: number;
5384
+ /**
5385
+ * Count of search events
5386
+ * @type {number}
5387
+ * @memberof AnalyticsQueryGeoAnalytic
5388
+ */
5389
+ 'searches'?: number;
5390
+ /**
5391
+ * percentage of total searches for this query
5392
+ * @type {number}
5393
+ * @memberof AnalyticsQueryGeoAnalytic
5394
+ */
5395
+ 'share'?: number;
5396
+ /**
5397
+ * Unique users
5398
+ * @type {number}
5399
+ * @memberof AnalyticsQueryGeoAnalytic
5400
+ */
5401
+ 'unique_users'?: number;
5402
+ }
5403
+ /**
5404
+ *
5405
+ * @export
5406
+ * @interface AnalyticsQueryGeoAnalyticsSection
5407
+ */
5408
+ export interface AnalyticsQueryGeoAnalyticsSection {
5409
+ /**
5410
+ *
5411
+ * @type {Array<AnalyticsQueryGeoAnalytic>}
5412
+ * @memberof AnalyticsQueryGeoAnalyticsSection
5413
+ */
5414
+ 'items'?: Array<AnalyticsQueryGeoAnalytic>;
5415
+ /**
5416
+ *
5417
+ * @type {SeekoraGoSrcAnalyticsPaginationMeta}
5418
+ * @memberof AnalyticsQueryGeoAnalyticsSection
5419
+ */
5420
+ 'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
5421
+ }
5422
+ /**
5423
+ *
5424
+ * @export
5425
+ * @interface AnalyticsQueryInsights
5426
+ */
5427
+ export interface AnalyticsQueryInsights {
5428
+ /**
5429
+ * Average rank position of clicked results (renamed for clarity)
5430
+ * @type {number}
5431
+ * @memberof AnalyticsQueryInsights
5432
+ */
5433
+ 'avg_click_position'?: number;
5434
+ /**
5435
+ * Average rank of the top result shown per search
5436
+ * @type {number}
5437
+ * @memberof AnalyticsQueryInsights
5438
+ */
5439
+ 'avg_result_rank'?: number;
5440
+ /**
5441
+ *
5442
+ * @type {Array<AnalyticsClickPositionBucket>}
5443
+ * @memberof AnalyticsQueryInsights
5444
+ */
5445
+ 'click_position_histogram'?: Array<AnalyticsClickPositionBucket>;
5446
+ /**
5447
+ * Clicks / Results Shown
5448
+ * @type {number}
5449
+ * @memberof AnalyticsQueryInsights
5450
+ */
5451
+ 'click_through_rate'?: number;
5452
+ /**
5453
+ * Conversions / Clicks (CVR)
5454
+ * @type {number}
5455
+ * @memberof AnalyticsQueryInsights
5456
+ */
5457
+ 'conversion_rate'?: number;
5458
+ /**
5459
+ * Conversions / Searches
5460
+ * @type {number}
5461
+ * @memberof AnalyticsQueryInsights
5462
+ */
5463
+ 'conversion_rate_per_search'?: number;
5464
+ /**
5465
+ * Enhanced filter analytics
5466
+ * @type {AnalyticsQueryFilterAnalytics}
5467
+ * @memberof AnalyticsQueryInsights
5468
+ */
5469
+ 'filter_analytics'?: AnalyticsQueryFilterAnalytics;
5470
+ /**
5471
+ *
5472
+ * @type {AnalyticsQueryGeoAnalyticsSection}
5473
+ * @memberof AnalyticsQueryInsights
5474
+ */
5475
+ 'geo_analytics'?: AnalyticsQueryGeoAnalyticsSection;
5476
+ /**
5477
+ *
5478
+ * @type {string}
5479
+ * @memberof AnalyticsQueryInsights
5480
+ */
5481
+ 'last_searched'?: string;
5482
+ /**
5483
+ * Searches with results but zero clicks / Results Shown
5484
+ * @type {number}
5485
+ * @memberof AnalyticsQueryInsights
5486
+ */
5487
+ 'no_click_rate'?: number;
5488
+ /**
5489
+ * No-result searches / Searches
5490
+ * @type {number}
5491
+ * @memberof AnalyticsQueryInsights
5492
+ */
5493
+ 'no_results_rate'?: number;
5494
+ /**
5495
+ *
5496
+ * @type {AnalyticsQueryPopularFiltersSection}
5497
+ * @memberof AnalyticsQueryInsights
5498
+ */
5499
+ 'popular_filters'?: AnalyticsQueryPopularFiltersSection;
5500
+ /**
5501
+ *
5502
+ * @type {AnalyticsQueryPopularResultsSection}
5503
+ * @memberof AnalyticsQueryInsights
5504
+ */
5505
+ 'popular_results'?: AnalyticsQueryPopularResultsSection;
5506
+ /**
5507
+ *
5508
+ * @type {string}
5509
+ * @memberof AnalyticsQueryInsights
5510
+ */
5511
+ 'query'?: string;
5512
+ /**
5513
+ * Searches that returned ≥1 result
5514
+ * @type {number}
5515
+ * @memberof AnalyticsQueryInsights
5516
+ */
5517
+ 'results_shown'?: number;
5518
+ /**
5519
+ * Count of result-click events
5520
+ * @type {number}
5521
+ * @memberof AnalyticsQueryInsights
5522
+ */
5523
+ 'total_clicks'?: number;
5524
+ /**
5525
+ * Count of conversions
5526
+ * @type {number}
5527
+ * @memberof AnalyticsQueryInsights
5528
+ */
5529
+ 'total_conversions'?: number;
5530
+ /**
5531
+ * Sum of attributed revenue
5532
+ * @type {number}
5533
+ * @memberof AnalyticsQueryInsights
5534
+ */
5535
+ 'total_revenue'?: number;
5536
+ /**
5537
+ *
5538
+ * @type {number}
5539
+ * @memberof AnalyticsQueryInsights
5540
+ */
5541
+ 'total_searches'?: number;
5542
+ /**
5543
+ *
5544
+ * @type {number}
5545
+ * @memberof AnalyticsQueryInsights
5546
+ */
5547
+ 'unique_users'?: number;
5548
+ }
5549
+ /**
5550
+ *
5551
+ * @export
5552
+ * @interface AnalyticsQueryPerformanceAnalytics
5553
+ */
5554
+ export interface AnalyticsQueryPerformanceAnalytics {
5555
+ /**
5556
+ *
5557
+ * @type {number}
5558
+ * @memberof AnalyticsQueryPerformanceAnalytics
5559
+ */
5560
+ 'avg_results'?: number;
5561
+ /**
5562
+ *
5563
+ * @type {number}
5564
+ * @memberof AnalyticsQueryPerformanceAnalytics
5565
+ */
5566
+ 'avg_search_duration_ms'?: number;
4765
5567
  /**
4766
5568
  * Item-level metrics
4767
5569
  * @type {number}
@@ -4819,27 +5621,271 @@ export interface AnalyticsQueryPerformanceAnalytics {
4819
5621
  /**
4820
5622
  * Context metrics
4821
5623
  * @type {number}
4822
- * @memberof AnalyticsQueryPerformanceAnalytics
5624
+ * @memberof AnalyticsQueryPerformanceAnalytics
5625
+ */
5626
+ 'unique_filters'?: number;
5627
+ /**
5628
+ *
5629
+ * @type {number}
5630
+ * @memberof AnalyticsQueryPerformanceAnalytics
5631
+ */
5632
+ 'unique_items'?: number;
5633
+ /**
5634
+ *
5635
+ * @type {number}
5636
+ * @memberof AnalyticsQueryPerformanceAnalytics
5637
+ */
5638
+ 'unique_sorts'?: number;
5639
+ /**
5640
+ *
5641
+ * @type {number}
5642
+ * @memberof AnalyticsQueryPerformanceAnalytics
5643
+ */
5644
+ 'unique_users'?: number;
5645
+ }
5646
+ /**
5647
+ *
5648
+ * @export
5649
+ * @interface AnalyticsQueryPopularFilter
5650
+ */
5651
+ export interface AnalyticsQueryPopularFilter {
5652
+ /**
5653
+ * Clicks / Results Shown
5654
+ * @type {number}
5655
+ * @memberof AnalyticsQueryPopularFilter
5656
+ */
5657
+ 'click_through_rate'?: number;
5658
+ /**
5659
+ * Count of result-click events
5660
+ * @type {number}
5661
+ * @memberof AnalyticsQueryPopularFilter
5662
+ */
5663
+ 'clicks'?: number;
5664
+ /**
5665
+ * Conversions / Clicks (CVR)
5666
+ * @type {number}
5667
+ * @memberof AnalyticsQueryPopularFilter
5668
+ */
5669
+ 'conversion_rate'?: number;
5670
+ /**
5671
+ * Conversions / Searches
5672
+ * @type {number}
5673
+ * @memberof AnalyticsQueryPopularFilter
5674
+ */
5675
+ 'conversion_rate_per_search'?: number;
5676
+ /**
5677
+ * Post-click conversions attributed to search
5678
+ * @type {number}
5679
+ * @memberof AnalyticsQueryPopularFilter
5680
+ */
5681
+ 'conversions'?: number;
5682
+ /**
5683
+ *
5684
+ * @type {string}
5685
+ * @memberof AnalyticsQueryPopularFilter
5686
+ */
5687
+ 'filter_key'?: string;
5688
+ /**
5689
+ *
5690
+ * @type {string}
5691
+ * @memberof AnalyticsQueryPopularFilter
5692
+ */
5693
+ 'filter_value'?: string;
5694
+ /**
5695
+ * Searches with results but zero clicks / Results Shown
5696
+ * @type {number}
5697
+ * @memberof AnalyticsQueryPopularFilter
5698
+ */
5699
+ 'no_click_rate'?: number;
5700
+ /**
5701
+ * No-result searches / Searches
5702
+ * @type {number}
5703
+ * @memberof AnalyticsQueryPopularFilter
5704
+ */
5705
+ 'no_result_rate'?: number;
5706
+ /**
5707
+ * Count of searches that returned ≥1 result
5708
+ * @type {number}
5709
+ * @memberof AnalyticsQueryPopularFilter
5710
+ */
5711
+ 'results_shown'?: number;
5712
+ /**
5713
+ * Sum of attributed revenue
5714
+ * @type {number}
5715
+ * @memberof AnalyticsQueryPopularFilter
5716
+ */
5717
+ 'revenue'?: number;
5718
+ /**
5719
+ * Count of search events with this filter
5720
+ * @type {number}
5721
+ * @memberof AnalyticsQueryPopularFilter
5722
+ */
5723
+ 'searches'?: number;
5724
+ /**
5725
+ * percentage of searches with this filter
5726
+ * @type {number}
5727
+ * @memberof AnalyticsQueryPopularFilter
5728
+ */
5729
+ 'share'?: number;
5730
+ /**
5731
+ * Number of times this filter was used
5732
+ * @type {number}
5733
+ * @memberof AnalyticsQueryPopularFilter
5734
+ */
5735
+ 'usage_count'?: number;
5736
+ }
5737
+ /**
5738
+ *
5739
+ * @export
5740
+ * @interface AnalyticsQueryPopularFiltersSection
5741
+ */
5742
+ export interface AnalyticsQueryPopularFiltersSection {
5743
+ /**
5744
+ *
5745
+ * @type {Array<AnalyticsQueryPopularFilter>}
5746
+ * @memberof AnalyticsQueryPopularFiltersSection
5747
+ */
5748
+ 'items'?: Array<AnalyticsQueryPopularFilter>;
5749
+ /**
5750
+ *
5751
+ * @type {SeekoraGoSrcAnalyticsPaginationMeta}
5752
+ * @memberof AnalyticsQueryPopularFiltersSection
5753
+ */
5754
+ 'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
5755
+ }
5756
+ /**
5757
+ *
5758
+ * @export
5759
+ * @interface AnalyticsQueryPopularResultWithWidget
5760
+ */
5761
+ export interface AnalyticsQueryPopularResultWithWidget {
5762
+ /**
5763
+ * Average rank position of clicked results
5764
+ * @type {number}
5765
+ * @memberof AnalyticsQueryPopularResultWithWidget
5766
+ */
5767
+ 'avg_click_rank'?: number;
5768
+ /**
5769
+ * Same as AvgResultRank (backward compatibility)
5770
+ * @type {number}
5771
+ * @memberof AnalyticsQueryPopularResultWithWidget
5772
+ */
5773
+ 'avg_position'?: number;
5774
+ /**
5775
+ * Average rank of the top result shown per search
5776
+ * @type {number}
5777
+ * @memberof AnalyticsQueryPopularResultWithWidget
5778
+ */
5779
+ 'avg_result_rank'?: number;
5780
+ /**
5781
+ * Clicks / Results Shown
5782
+ * @type {number}
5783
+ * @memberof AnalyticsQueryPopularResultWithWidget
5784
+ */
5785
+ 'click_through_rate'?: number;
5786
+ /**
5787
+ * Count of result-click events
5788
+ * @type {number}
5789
+ * @memberof AnalyticsQueryPopularResultWithWidget
5790
+ */
5791
+ 'clicks'?: number;
5792
+ /**
5793
+ * Conversions / Clicks (CVR)
5794
+ * @type {number}
5795
+ * @memberof AnalyticsQueryPopularResultWithWidget
5796
+ */
5797
+ 'conversion_rate'?: number;
5798
+ /**
5799
+ * Conversions / Searches
5800
+ * @type {number}
5801
+ * @memberof AnalyticsQueryPopularResultWithWidget
5802
+ */
5803
+ 'conversion_rate_per_search'?: number;
5804
+ /**
5805
+ * Post-click conversions attributed to search
5806
+ * @type {number}
5807
+ * @memberof AnalyticsQueryPopularResultWithWidget
5808
+ */
5809
+ 'conversions'?: number;
5810
+ /**
5811
+ * Count of times item was shown
5812
+ * @type {number}
5813
+ * @memberof AnalyticsQueryPopularResultWithWidget
5814
+ */
5815
+ 'impressions'?: number;
5816
+ /**
5817
+ *
5818
+ * @type {string}
5819
+ * @memberof AnalyticsQueryPopularResultWithWidget
5820
+ */
5821
+ 'item_id'?: string;
5822
+ /**
5823
+ *
5824
+ * @type {string}
5825
+ * @memberof AnalyticsQueryPopularResultWithWidget
5826
+ */
5827
+ 'item_name'?: string;
5828
+ /**
5829
+ * Searches with results but zero clicks / Results Shown
5830
+ * @type {number}
5831
+ * @memberof AnalyticsQueryPopularResultWithWidget
5832
+ */
5833
+ 'no_click_rate'?: number;
5834
+ /**
5835
+ * No-result searches / Searches
5836
+ * @type {number}
5837
+ * @memberof AnalyticsQueryPopularResultWithWidget
5838
+ */
5839
+ 'no_result_rate'?: number;
5840
+ /**
5841
+ * Count of searches that returned ≥1 result
5842
+ * @type {number}
5843
+ * @memberof AnalyticsQueryPopularResultWithWidget
5844
+ */
5845
+ 'results_shown'?: number;
5846
+ /**
5847
+ * Sum of attributed revenue
5848
+ * @type {number}
5849
+ * @memberof AnalyticsQueryPopularResultWithWidget
5850
+ */
5851
+ 'revenue'?: number;
5852
+ /**
5853
+ * Count of search events
5854
+ * @type {number}
5855
+ * @memberof AnalyticsQueryPopularResultWithWidget
4823
5856
  */
4824
- 'unique_filters'?: number;
5857
+ 'searches'?: number;
4825
5858
  /**
4826
- *
5859
+ * percentage of total impressions for this query
4827
5860
  * @type {number}
4828
- * @memberof AnalyticsQueryPerformanceAnalytics
5861
+ * @memberof AnalyticsQueryPopularResultWithWidget
4829
5862
  */
4830
- 'unique_items'?: number;
5863
+ 'share'?: number;
5864
+ /**
5865
+ * Widget display fields
5866
+ * @type {AnalyticsWidgetData}
5867
+ * @memberof AnalyticsQueryPopularResultWithWidget
5868
+ */
5869
+ 'widget'?: AnalyticsWidgetData;
5870
+ }
5871
+ /**
5872
+ *
5873
+ * @export
5874
+ * @interface AnalyticsQueryPopularResultsSection
5875
+ */
5876
+ export interface AnalyticsQueryPopularResultsSection {
4831
5877
  /**
4832
5878
  *
4833
- * @type {number}
4834
- * @memberof AnalyticsQueryPerformanceAnalytics
5879
+ * @type {Array<AnalyticsQueryPopularResultWithWidget>}
5880
+ * @memberof AnalyticsQueryPopularResultsSection
4835
5881
  */
4836
- 'unique_sorts'?: number;
5882
+ 'items'?: Array<AnalyticsQueryPopularResultWithWidget>;
4837
5883
  /**
4838
5884
  *
4839
- * @type {number}
4840
- * @memberof AnalyticsQueryPerformanceAnalytics
5885
+ * @type {SeekoraGoSrcAnalyticsPaginationMeta}
5886
+ * @memberof AnalyticsQueryPopularResultsSection
4841
5887
  */
4842
- 'unique_users'?: number;
5888
+ 'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
4843
5889
  }
4844
5890
  /**
4845
5891
  *
@@ -23062,6 +24108,177 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
23062
24108
 
23063
24109
 
23064
24110
 
24111
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
24112
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24113
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
24114
+
24115
+ return {
24116
+ url: toPathString(localVarUrlObj),
24117
+ options: localVarRequestOptions,
24118
+ };
24119
+ },
24120
+ /**
24121
+ * Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
24122
+ * @summary Get Query Insights
24123
+ * @param {string} xStoreID Store ID
24124
+ * @param {string} query Search query to analyze
24125
+ * @param {string} [startTime] Start time in RFC3339 format
24126
+ * @param {string} [endTime] End time in RFC3339 format
24127
+ * @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \&#39;campaign:summer,source:email\&#39;)
24128
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
24129
+ * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
24130
+ * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
24131
+ * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
24132
+ * @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
24133
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
24134
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
24135
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
24136
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
24137
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
24138
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
24139
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
24140
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
24141
+ * @param {number} [resultsPage] Page number for popular results pagination
24142
+ * @param {number} [resultsPageSize] Number of results per page for popular results
24143
+ * @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
24144
+ * @param {number} [filtersPage] Page number for popular filters pagination
24145
+ * @param {number} [filtersPageSize] Number of filters per page
24146
+ * @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
24147
+ * @param {number} [geoPage] Page number for geo analytics pagination
24148
+ * @param {number} [geoPageSize] Number of geo locations per page
24149
+ * @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
24150
+ * @param {boolean} [includeWidget] Whether to include widget display fields for popular results
24151
+ * @param {*} [options] Override http request option.
24152
+ * @throws {RequiredError}
24153
+ */
24154
+ adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24155
+ // verify required parameter 'xStoreID' is not null or undefined
24156
+ assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID)
24157
+ // verify required parameter 'query' is not null or undefined
24158
+ assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'query', query)
24159
+ const localVarPath = `/admin/analytics/store/{xStoreID}/queries/{query}/insights`
24160
+ .replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
24161
+ .replace(`{${"query"}}`, encodeURIComponent(String(query)));
24162
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
24163
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
24164
+ let baseOptions;
24165
+ if (configuration) {
24166
+ baseOptions = configuration.baseOptions;
24167
+ }
24168
+
24169
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
24170
+ const localVarHeaderParameter = {} as any;
24171
+ const localVarQueryParameter = {} as any;
24172
+
24173
+ // authentication BearerAuth required
24174
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
24175
+
24176
+ if (startTime !== undefined) {
24177
+ localVarQueryParameter['start_time'] = startTime;
24178
+ }
24179
+
24180
+ if (endTime !== undefined) {
24181
+ localVarQueryParameter['end_time'] = endTime;
24182
+ }
24183
+
24184
+ if (analyticsTags !== undefined) {
24185
+ localVarQueryParameter['analytics_tags'] = analyticsTags;
24186
+ }
24187
+
24188
+ if (tagsMatchMode !== undefined) {
24189
+ localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
24190
+ }
24191
+
24192
+ if (tagsExclude !== undefined) {
24193
+ localVarQueryParameter['tags_exclude'] = tagsExclude;
24194
+ }
24195
+
24196
+ if (tagKeyFilter !== undefined) {
24197
+ localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
24198
+ }
24199
+
24200
+ if (tagValueFilter !== undefined) {
24201
+ localVarQueryParameter['tag_value_filter'] = tagValueFilter;
24202
+ }
24203
+
24204
+ if (search !== undefined) {
24205
+ localVarQueryParameter['search'] = search;
24206
+ }
24207
+
24208
+ if (compareMode !== undefined) {
24209
+ localVarQueryParameter['compare_mode'] = compareMode;
24210
+ }
24211
+
24212
+ if (compareStartTime !== undefined) {
24213
+ localVarQueryParameter['compare_start_time'] = compareStartTime;
24214
+ }
24215
+
24216
+ if (compareEndTime !== undefined) {
24217
+ localVarQueryParameter['compare_end_time'] = compareEndTime;
24218
+ }
24219
+
24220
+ if (compareAnalyticsTags !== undefined) {
24221
+ localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
24222
+ }
24223
+
24224
+ if (compareTagsMatchMode !== undefined) {
24225
+ localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
24226
+ }
24227
+
24228
+ if (compareTagsExclude !== undefined) {
24229
+ localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
24230
+ }
24231
+
24232
+ if (compareTagKeyFilter !== undefined) {
24233
+ localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
24234
+ }
24235
+
24236
+ if (compareTagValueFilter !== undefined) {
24237
+ localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
24238
+ }
24239
+
24240
+ if (resultsPage !== undefined) {
24241
+ localVarQueryParameter['results_page'] = resultsPage;
24242
+ }
24243
+
24244
+ if (resultsPageSize !== undefined) {
24245
+ localVarQueryParameter['results_page_size'] = resultsPageSize;
24246
+ }
24247
+
24248
+ if (resultsSearch !== undefined) {
24249
+ localVarQueryParameter['results_search'] = resultsSearch;
24250
+ }
24251
+
24252
+ if (filtersPage !== undefined) {
24253
+ localVarQueryParameter['filters_page'] = filtersPage;
24254
+ }
24255
+
24256
+ if (filtersPageSize !== undefined) {
24257
+ localVarQueryParameter['filters_page_size'] = filtersPageSize;
24258
+ }
24259
+
24260
+ if (filtersSearch !== undefined) {
24261
+ localVarQueryParameter['filters_search'] = filtersSearch;
24262
+ }
24263
+
24264
+ if (geoPage !== undefined) {
24265
+ localVarQueryParameter['geo_page'] = geoPage;
24266
+ }
24267
+
24268
+ if (geoPageSize !== undefined) {
24269
+ localVarQueryParameter['geo_page_size'] = geoPageSize;
24270
+ }
24271
+
24272
+ if (geoSearch !== undefined) {
24273
+ localVarQueryParameter['geo_search'] = geoSearch;
24274
+ }
24275
+
24276
+ if (includeWidget !== undefined) {
24277
+ localVarQueryParameter['include_widget'] = includeWidget;
24278
+ }
24279
+
24280
+
24281
+
23065
24282
  setSearchParams(localVarUrlObj, localVarQueryParameter);
23066
24283
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
23067
24284
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -23930,6 +25147,46 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
23930
25147
  const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoResultsGet']?.[localVarOperationServerIndex]?.url;
23931
25148
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
23932
25149
  },
25150
+ /**
25151
+ * Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
25152
+ * @summary Get Query Insights
25153
+ * @param {string} xStoreID Store ID
25154
+ * @param {string} query Search query to analyze
25155
+ * @param {string} [startTime] Start time in RFC3339 format
25156
+ * @param {string} [endTime] End time in RFC3339 format
25157
+ * @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \&#39;campaign:summer,source:email\&#39;)
25158
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
25159
+ * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
25160
+ * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
25161
+ * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
25162
+ * @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
25163
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
25164
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
25165
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
25166
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
25167
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
25168
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
25169
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
25170
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
25171
+ * @param {number} [resultsPage] Page number for popular results pagination
25172
+ * @param {number} [resultsPageSize] Number of results per page for popular results
25173
+ * @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
25174
+ * @param {number} [filtersPage] Page number for popular filters pagination
25175
+ * @param {number} [filtersPageSize] Number of filters per page
25176
+ * @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
25177
+ * @param {number} [geoPage] Page number for geo analytics pagination
25178
+ * @param {number} [geoPageSize] Number of geo locations per page
25179
+ * @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
25180
+ * @param {boolean} [includeWidget] Whether to include widget display fields for popular results
25181
+ * @param {*} [options] Override http request option.
25182
+ * @throws {RequiredError}
25183
+ */
25184
+ async adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>> {
25185
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options);
25186
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
25187
+ const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']?.[localVarOperationServerIndex]?.url;
25188
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
25189
+ },
23933
25190
  /**
23934
25191
  * Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
23935
25192
  * @summary Get Top Results Analytics
@@ -24392,6 +25649,43 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
24392
25649
  adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response> {
24393
25650
  return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
24394
25651
  },
25652
+ /**
25653
+ * Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
25654
+ * @summary Get Query Insights
25655
+ * @param {string} xStoreID Store ID
25656
+ * @param {string} query Search query to analyze
25657
+ * @param {string} [startTime] Start time in RFC3339 format
25658
+ * @param {string} [endTime] End time in RFC3339 format
25659
+ * @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \&#39;campaign:summer,source:email\&#39;)
25660
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
25661
+ * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
25662
+ * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
25663
+ * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
25664
+ * @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
25665
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
25666
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
25667
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
25668
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
25669
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
25670
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
25671
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
25672
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
25673
+ * @param {number} [resultsPage] Page number for popular results pagination
25674
+ * @param {number} [resultsPageSize] Number of results per page for popular results
25675
+ * @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
25676
+ * @param {number} [filtersPage] Page number for popular filters pagination
25677
+ * @param {number} [filtersPageSize] Number of filters per page
25678
+ * @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
25679
+ * @param {number} [geoPage] Page number for geo analytics pagination
25680
+ * @param {number} [geoPageSize] Number of geo locations per page
25681
+ * @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
25682
+ * @param {boolean} [includeWidget] Whether to include widget display fields for popular results
25683
+ * @param {*} [options] Override http request option.
25684
+ * @throws {RequiredError}
25685
+ */
25686
+ adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response> {
25687
+ return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options).then((request) => request(axios, basePath));
25688
+ },
24395
25689
  /**
24396
25690
  * Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
24397
25691
  * @summary Get Top Results Analytics
@@ -24867,6 +26161,45 @@ export class AnalyticsApi extends BaseAPI {
24867
26161
  return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
24868
26162
  }
24869
26163
 
26164
+ /**
26165
+ * Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
26166
+ * @summary Get Query Insights
26167
+ * @param {string} xStoreID Store ID
26168
+ * @param {string} query Search query to analyze
26169
+ * @param {string} [startTime] Start time in RFC3339 format
26170
+ * @param {string} [endTime] End time in RFC3339 format
26171
+ * @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \&#39;campaign:summer,source:email\&#39;)
26172
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
26173
+ * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
26174
+ * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
26175
+ * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
26176
+ * @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
26177
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
26178
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
26179
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
26180
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
26181
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
26182
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
26183
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
26184
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
26185
+ * @param {number} [resultsPage] Page number for popular results pagination
26186
+ * @param {number} [resultsPageSize] Number of results per page for popular results
26187
+ * @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
26188
+ * @param {number} [filtersPage] Page number for popular filters pagination
26189
+ * @param {number} [filtersPageSize] Number of filters per page
26190
+ * @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
26191
+ * @param {number} [geoPage] Page number for geo analytics pagination
26192
+ * @param {number} [geoPageSize] Number of geo locations per page
26193
+ * @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
26194
+ * @param {boolean} [includeWidget] Whether to include widget display fields for popular results
26195
+ * @param {*} [options] Override http request option.
26196
+ * @throws {RequiredError}
26197
+ * @memberof AnalyticsApi
26198
+ */
26199
+ public adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig) {
26200
+ return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options).then((request) => request(this.axios, this.basePath));
26201
+ }
26202
+
24870
26203
  /**
24871
26204
  * Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
24872
26205
  * @summary Get Top Results Analytics
@@ -25293,6 +26626,22 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
25293
26626
  Desc: 'desc'
25294
26627
  } as const;
25295
26628
  export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
26629
+ /**
26630
+ * @export
26631
+ */
26632
+ export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = {
26633
+ Any: 'any',
26634
+ All: 'all'
26635
+ } as const;
26636
+ export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum];
26637
+ /**
26638
+ * @export
26639
+ */
26640
+ export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = {
26641
+ Any: 'any',
26642
+ All: 'all'
26643
+ } as const;
26644
+ export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum];
25296
26645
  /**
25297
26646
  * @export
25298
26647
  */