@seekora-ai/admin-api 1.0.48 → 1.0.50

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
@@ -367,6 +367,49 @@ export interface AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response {
367
367
  */
368
368
  'total'?: number;
369
369
  }
370
+ /**
371
+ *
372
+ * @export
373
+ * @interface AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response
374
+ */
375
+ export interface AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response {
376
+ /**
377
+ * Comparison metadata when in compare mode
378
+ * @type {AnalyticsComparisonMeta}
379
+ * @memberof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response
380
+ */
381
+ 'comparison'?: AnalyticsComparisonMeta;
382
+ /**
383
+ *
384
+ * @type {AnalyticsItemInsights}
385
+ * @memberof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response
386
+ */
387
+ 'data'?: AnalyticsItemInsights;
388
+ /**
389
+ *
390
+ * @type {string}
391
+ * @memberof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response
392
+ */
393
+ 'error'?: string;
394
+ /**
395
+ *
396
+ * @type {string}
397
+ * @memberof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response
398
+ */
399
+ 'status'?: string;
400
+ /**
401
+ *
402
+ * @type {string}
403
+ * @memberof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response
404
+ */
405
+ 'timestamp'?: string;
406
+ /**
407
+ *
408
+ * @type {number}
409
+ * @memberof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response
410
+ */
411
+ 'total'?: number;
412
+ }
370
413
  /**
371
414
  *
372
415
  * @export
@@ -1068,11 +1111,11 @@ export interface AnalyticsExtendedKPIResponse {
1068
1111
  */
1069
1112
  'compare_summary'?: AnalyticsKPIMetrics;
1070
1113
  /**
1071
- *
1072
- * @type {Array<AnalyticsKPIPointExtended>}
1114
+ * Can be []KPIPointExtended or []ComparisonMetrics
1115
+ * @type {object}
1073
1116
  * @memberof AnalyticsExtendedKPIResponse
1074
1117
  */
1075
- 'data'?: Array<AnalyticsKPIPointExtended>;
1118
+ 'data'?: object;
1076
1119
  /**
1077
1120
  *
1078
1121
  * @type {string}
@@ -1140,12 +1183,24 @@ export interface AnalyticsFilterAnalyticsResponse {
1140
1183
  * @memberof AnalyticsFilterAnalyticsResponse
1141
1184
  */
1142
1185
  'filter_key'?: string;
1186
+ /**
1187
+ *
1188
+ * @type {number}
1189
+ * @memberof AnalyticsFilterAnalyticsResponse
1190
+ */
1191
+ 'limit'?: number;
1143
1192
  /**
1144
1193
  *
1145
1194
  * @type {string}
1146
1195
  * @memberof AnalyticsFilterAnalyticsResponse
1147
1196
  */
1148
1197
  'org_id'?: string;
1198
+ /**
1199
+ *
1200
+ * @type {number}
1201
+ * @memberof AnalyticsFilterAnalyticsResponse
1202
+ */
1203
+ 'page'?: number;
1149
1204
  /**
1150
1205
  *
1151
1206
  * @type {string}
@@ -1176,6 +1231,12 @@ export interface AnalyticsFilterAnalyticsResponse {
1176
1231
  * @memberof AnalyticsFilterAnalyticsResponse
1177
1232
  */
1178
1233
  'store_id'?: string;
1234
+ /**
1235
+ *
1236
+ * @type {number}
1237
+ * @memberof AnalyticsFilterAnalyticsResponse
1238
+ */
1239
+ 'total'?: number;
1179
1240
  }
1180
1241
  /**
1181
1242
  *
@@ -1411,12 +1472,24 @@ export interface AnalyticsFilterTrendsResponse {
1411
1472
  * @memberof AnalyticsFilterTrendsResponse
1412
1473
  */
1413
1474
  'granularity'?: string;
1475
+ /**
1476
+ *
1477
+ * @type {number}
1478
+ * @memberof AnalyticsFilterTrendsResponse
1479
+ */
1480
+ 'limit'?: number;
1414
1481
  /**
1415
1482
  *
1416
1483
  * @type {string}
1417
1484
  * @memberof AnalyticsFilterTrendsResponse
1418
1485
  */
1419
1486
  'org_id'?: string;
1487
+ /**
1488
+ *
1489
+ * @type {number}
1490
+ * @memberof AnalyticsFilterTrendsResponse
1491
+ */
1492
+ 'page'?: number;
1420
1493
  /**
1421
1494
  *
1422
1495
  * @type {string}
@@ -1447,6 +1520,12 @@ export interface AnalyticsFilterTrendsResponse {
1447
1520
  * @memberof AnalyticsFilterTrendsResponse
1448
1521
  */
1449
1522
  'top_filters'?: number;
1523
+ /**
1524
+ *
1525
+ * @type {number}
1526
+ * @memberof AnalyticsFilterTrendsResponse
1527
+ */
1528
+ 'total'?: number;
1450
1529
  /**
1451
1530
  *
1452
1531
  * @type {{ [key: string]: Array<AnalyticsTimeSeriesPoint>; }}
@@ -1881,6 +1960,86 @@ export interface AnalyticsItemComparisonAnalyticsComparisonMetrics {
1881
1960
  */
1882
1961
  'worst_performer'?: string;
1883
1962
  }
1963
+ /**
1964
+ *
1965
+ * @export
1966
+ * @interface AnalyticsItemCompetitor
1967
+ */
1968
+ export interface AnalyticsItemCompetitor {
1969
+ /**
1970
+ *
1971
+ * @type {number}
1972
+ * @memberof AnalyticsItemCompetitor
1973
+ */
1974
+ 'avg_position'?: number;
1975
+ /**
1976
+ *
1977
+ * @type {number}
1978
+ * @memberof AnalyticsItemCompetitor
1979
+ */
1980
+ 'competition_score'?: number;
1981
+ /**
1982
+ *
1983
+ * @type {string}
1984
+ * @memberof AnalyticsItemCompetitor
1985
+ */
1986
+ 'item_id'?: string;
1987
+ /**
1988
+ *
1989
+ * @type {string}
1990
+ * @memberof AnalyticsItemCompetitor
1991
+ */
1992
+ 'item_name'?: string;
1993
+ /**
1994
+ * percentage of shared context
1995
+ * @type {number}
1996
+ * @memberof AnalyticsItemCompetitor
1997
+ */
1998
+ 'overlap'?: number;
1999
+ /**
2000
+ *
2001
+ * @type {number}
2002
+ * @memberof AnalyticsItemCompetitor
2003
+ */
2004
+ 'shared_filters'?: number;
2005
+ /**
2006
+ *
2007
+ * @type {number}
2008
+ * @memberof AnalyticsItemCompetitor
2009
+ */
2010
+ 'shared_queries'?: number;
2011
+ }
2012
+ /**
2013
+ *
2014
+ * @export
2015
+ * @interface AnalyticsItemCompetitorAnalysis
2016
+ */
2017
+ export interface AnalyticsItemCompetitorAnalysis {
2018
+ /**
2019
+ *
2020
+ * @type {Array<AnalyticsItemCompetitor>}
2021
+ * @memberof AnalyticsItemCompetitorAnalysis
2022
+ */
2023
+ 'competing_items'?: Array<AnalyticsItemCompetitor>;
2024
+ /**
2025
+ *
2026
+ * @type {number}
2027
+ * @memberof AnalyticsItemCompetitorAnalysis
2028
+ */
2029
+ 'market_share'?: number;
2030
+ /**
2031
+ * average position relative to competitors
2032
+ * @type {number}
2033
+ * @memberof AnalyticsItemCompetitorAnalysis
2034
+ */
2035
+ 'position_advantage'?: number;
2036
+ /**
2037
+ *
2038
+ * @type {Array<AnalyticsSharedQueryAnalysis>}
2039
+ * @memberof AnalyticsItemCompetitorAnalysis
2040
+ */
2041
+ 'shared_queries'?: Array<AnalyticsSharedQueryAnalysis>;
2042
+ }
1884
2043
  /**
1885
2044
  *
1886
2045
  * @export
@@ -1961,6 +2120,207 @@ export interface AnalyticsItemDiscoveryAnalytics {
1961
2120
  */
1962
2121
  'total_impressions'?: number;
1963
2122
  }
2123
+ /**
2124
+ *
2125
+ * @export
2126
+ * @interface AnalyticsItemGeoAnalytic
2127
+ */
2128
+ export interface AnalyticsItemGeoAnalytic {
2129
+ /**
2130
+ *
2131
+ * @type {number}
2132
+ * @memberof AnalyticsItemGeoAnalytic
2133
+ */
2134
+ 'avg_position'?: number;
2135
+ /**
2136
+ *
2137
+ * @type {string}
2138
+ * @memberof AnalyticsItemGeoAnalytic
2139
+ */
2140
+ 'city'?: string;
2141
+ /**
2142
+ *
2143
+ * @type {number}
2144
+ * @memberof AnalyticsItemGeoAnalytic
2145
+ */
2146
+ 'click_through_rate'?: number;
2147
+ /**
2148
+ *
2149
+ * @type {number}
2150
+ * @memberof AnalyticsItemGeoAnalytic
2151
+ */
2152
+ 'clicks'?: number;
2153
+ /**
2154
+ *
2155
+ * @type {string}
2156
+ * @memberof AnalyticsItemGeoAnalytic
2157
+ */
2158
+ 'country'?: string;
2159
+ /**
2160
+ *
2161
+ * @type {string}
2162
+ * @memberof AnalyticsItemGeoAnalytic
2163
+ */
2164
+ 'country_code'?: string;
2165
+ /**
2166
+ *
2167
+ * @type {number}
2168
+ * @memberof AnalyticsItemGeoAnalytic
2169
+ */
2170
+ 'impressions'?: number;
2171
+ /**
2172
+ *
2173
+ * @type {string}
2174
+ * @memberof AnalyticsItemGeoAnalytic
2175
+ */
2176
+ 'region'?: string;
2177
+ /**
2178
+ * percentage of total impressions for this item
2179
+ * @type {number}
2180
+ * @memberof AnalyticsItemGeoAnalytic
2181
+ */
2182
+ 'share'?: number;
2183
+ /**
2184
+ *
2185
+ * @type {number}
2186
+ * @memberof AnalyticsItemGeoAnalytic
2187
+ */
2188
+ 'unique_users'?: number;
2189
+ }
2190
+ /**
2191
+ *
2192
+ * @export
2193
+ * @interface AnalyticsItemGeoAnalyticsSection
2194
+ */
2195
+ export interface AnalyticsItemGeoAnalyticsSection {
2196
+ /**
2197
+ *
2198
+ * @type {Array<AnalyticsItemGeoAnalytic>}
2199
+ * @memberof AnalyticsItemGeoAnalyticsSection
2200
+ */
2201
+ 'items'?: Array<AnalyticsItemGeoAnalytic>;
2202
+ /**
2203
+ *
2204
+ * @type {AnalyticsPaginationMeta}
2205
+ * @memberof AnalyticsItemGeoAnalyticsSection
2206
+ */
2207
+ 'meta'?: AnalyticsPaginationMeta;
2208
+ }
2209
+ /**
2210
+ *
2211
+ * @export
2212
+ * @interface AnalyticsItemInsights
2213
+ */
2214
+ export interface AnalyticsItemInsights {
2215
+ /**
2216
+ *
2217
+ * @type {number}
2218
+ * @memberof AnalyticsItemInsights
2219
+ */
2220
+ 'avg_position'?: number;
2221
+ /**
2222
+ *
2223
+ * @type {number}
2224
+ * @memberof AnalyticsItemInsights
2225
+ */
2226
+ 'click_through_rate'?: number;
2227
+ /**
2228
+ *
2229
+ * @type {AnalyticsItemCompetitorAnalysis}
2230
+ * @memberof AnalyticsItemInsights
2231
+ */
2232
+ 'competitor_analysis'?: AnalyticsItemCompetitorAnalysis;
2233
+ /**
2234
+ *
2235
+ * @type {number}
2236
+ * @memberof AnalyticsItemInsights
2237
+ */
2238
+ 'conversion_rate'?: number;
2239
+ /**
2240
+ *
2241
+ * @type {number}
2242
+ * @memberof AnalyticsItemInsights
2243
+ */
2244
+ 'discovery_score'?: number;
2245
+ /**
2246
+ *
2247
+ * @type {AnalyticsItemGeoAnalyticsSection}
2248
+ * @memberof AnalyticsItemInsights
2249
+ */
2250
+ 'geo_analytics'?: AnalyticsItemGeoAnalyticsSection;
2251
+ /**
2252
+ *
2253
+ * @type {string}
2254
+ * @memberof AnalyticsItemInsights
2255
+ */
2256
+ 'item_id'?: string;
2257
+ /**
2258
+ *
2259
+ * @type {string}
2260
+ * @memberof AnalyticsItemInsights
2261
+ */
2262
+ 'item_name'?: string;
2263
+ /**
2264
+ *
2265
+ * @type {string}
2266
+ * @memberof AnalyticsItemInsights
2267
+ */
2268
+ 'last_seen'?: string;
2269
+ /**
2270
+ *
2271
+ * @type {Array<AnalyticsItemTrendData>}
2272
+ * @memberof AnalyticsItemInsights
2273
+ */
2274
+ 'performance_trends'?: Array<AnalyticsItemTrendData>;
2275
+ /**
2276
+ *
2277
+ * @type {AnalyticsItemPopularFiltersSection}
2278
+ * @memberof AnalyticsItemInsights
2279
+ */
2280
+ 'popular_filters'?: AnalyticsItemPopularFiltersSection;
2281
+ /**
2282
+ *
2283
+ * @type {AnalyticsItemPopularQueriesSection}
2284
+ * @memberof AnalyticsItemInsights
2285
+ */
2286
+ 'popular_queries'?: AnalyticsItemPopularQueriesSection;
2287
+ /**
2288
+ *
2289
+ * @type {Array<AnalyticsItemPositionBucket>}
2290
+ * @memberof AnalyticsItemInsights
2291
+ */
2292
+ 'position_distribution'?: Array<AnalyticsItemPositionBucket>;
2293
+ /**
2294
+ *
2295
+ * @type {number}
2296
+ * @memberof AnalyticsItemInsights
2297
+ */
2298
+ 'top_10_impression_rate'?: number;
2299
+ /**
2300
+ *
2301
+ * @type {number}
2302
+ * @memberof AnalyticsItemInsights
2303
+ */
2304
+ 'top_3_impression_rate'?: number;
2305
+ /**
2306
+ *
2307
+ * @type {number}
2308
+ * @memberof AnalyticsItemInsights
2309
+ */
2310
+ 'total_impressions'?: number;
2311
+ /**
2312
+ *
2313
+ * @type {number}
2314
+ * @memberof AnalyticsItemInsights
2315
+ */
2316
+ 'unique_searches'?: number;
2317
+ /**
2318
+ *
2319
+ * @type {number}
2320
+ * @memberof AnalyticsItemInsights
2321
+ */
2322
+ 'unique_users'?: number;
2323
+ }
1964
2324
  /**
1965
2325
  *
1966
2326
  * @export
@@ -2139,100 +2499,255 @@ export interface AnalyticsItemPerformanceWithWidget {
2139
2499
  'clicks'?: number;
2140
2500
  /**
2141
2501
  *
2142
- * @type {number}
2143
- * @memberof AnalyticsItemPerformanceWithWidget
2502
+ * @type {number}
2503
+ * @memberof AnalyticsItemPerformanceWithWidget
2504
+ */
2505
+ 'conversion_rate'?: number;
2506
+ /**
2507
+ *
2508
+ * @type {number}
2509
+ * @memberof AnalyticsItemPerformanceWithWidget
2510
+ */
2511
+ 'conversions'?: number;
2512
+ /**
2513
+ *
2514
+ * @type {number}
2515
+ * @memberof AnalyticsItemPerformanceWithWidget
2516
+ */
2517
+ 'impressions'?: number;
2518
+ /**
2519
+ *
2520
+ * @type {string}
2521
+ * @memberof AnalyticsItemPerformanceWithWidget
2522
+ */
2523
+ 'item_id'?: string;
2524
+ /**
2525
+ *
2526
+ * @type {string}
2527
+ * @memberof AnalyticsItemPerformanceWithWidget
2528
+ */
2529
+ 'item_name'?: string;
2530
+ /**
2531
+ *
2532
+ * @type {number}
2533
+ * @memberof AnalyticsItemPerformanceWithWidget
2534
+ */
2535
+ 'revenue'?: number;
2536
+ /**
2537
+ *
2538
+ * @type {number}
2539
+ * @memberof AnalyticsItemPerformanceWithWidget
2540
+ */
2541
+ 'revenue_per_item'?: number;
2542
+ /**
2543
+ *
2544
+ * @type {number}
2545
+ * @memberof AnalyticsItemPerformanceWithWidget
2546
+ */
2547
+ 'top_10_impressions'?: number;
2548
+ /**
2549
+ *
2550
+ * @type {number}
2551
+ * @memberof AnalyticsItemPerformanceWithWidget
2552
+ */
2553
+ 'top_3_impression_rate'?: number;
2554
+ /**
2555
+ *
2556
+ * @type {number}
2557
+ * @memberof AnalyticsItemPerformanceWithWidget
2558
+ */
2559
+ 'top_3_impressions'?: number;
2560
+ /**
2561
+ *
2562
+ * @type {number}
2563
+ * @memberof AnalyticsItemPerformanceWithWidget
2564
+ */
2565
+ 'unique_filters'?: number;
2566
+ /**
2567
+ *
2568
+ * @type {number}
2569
+ * @memberof AnalyticsItemPerformanceWithWidget
2570
+ */
2571
+ 'unique_queries'?: number;
2572
+ /**
2573
+ *
2574
+ * @type {number}
2575
+ * @memberof AnalyticsItemPerformanceWithWidget
2576
+ */
2577
+ 'unique_searches'?: number;
2578
+ /**
2579
+ *
2580
+ * @type {number}
2581
+ * @memberof AnalyticsItemPerformanceWithWidget
2582
+ */
2583
+ 'unique_sorts'?: number;
2584
+ /**
2585
+ *
2586
+ * @type {number}
2587
+ * @memberof AnalyticsItemPerformanceWithWidget
2588
+ */
2589
+ 'unique_users'?: number;
2590
+ /**
2591
+ * Widget display data for UI presentation
2592
+ * @type {AnalyticsWidgetData}
2593
+ * @memberof AnalyticsItemPerformanceWithWidget
2594
+ */
2595
+ 'widget'?: AnalyticsWidgetData;
2596
+ }
2597
+ /**
2598
+ *
2599
+ * @export
2600
+ * @interface AnalyticsItemPopularFilter
2601
+ */
2602
+ export interface AnalyticsItemPopularFilter {
2603
+ /**
2604
+ *
2605
+ * @type {number}
2606
+ * @memberof AnalyticsItemPopularFilter
2607
+ */
2608
+ 'avg_position'?: number;
2609
+ /**
2610
+ *
2611
+ * @type {string}
2612
+ * @memberof AnalyticsItemPopularFilter
2144
2613
  */
2145
- 'conversion_rate'?: number;
2614
+ 'filter_key'?: string;
2146
2615
  /**
2147
2616
  *
2148
- * @type {number}
2149
- * @memberof AnalyticsItemPerformanceWithWidget
2617
+ * @type {string}
2618
+ * @memberof AnalyticsItemPopularFilter
2150
2619
  */
2151
- 'conversions'?: number;
2620
+ 'filter_value'?: string;
2152
2621
  /**
2153
2622
  *
2154
2623
  * @type {number}
2155
- * @memberof AnalyticsItemPerformanceWithWidget
2624
+ * @memberof AnalyticsItemPopularFilter
2156
2625
  */
2157
2626
  'impressions'?: number;
2627
+ /**
2628
+ * percentage of impressions for this item
2629
+ * @type {number}
2630
+ * @memberof AnalyticsItemPopularFilter
2631
+ */
2632
+ 'share'?: number;
2633
+ }
2634
+ /**
2635
+ *
2636
+ * @export
2637
+ * @interface AnalyticsItemPopularFiltersSection
2638
+ */
2639
+ export interface AnalyticsItemPopularFiltersSection {
2158
2640
  /**
2159
2641
  *
2160
- * @type {string}
2161
- * @memberof AnalyticsItemPerformanceWithWidget
2642
+ * @type {Array<AnalyticsItemPopularFilter>}
2643
+ * @memberof AnalyticsItemPopularFiltersSection
2162
2644
  */
2163
- 'item_id'?: string;
2645
+ 'items'?: Array<AnalyticsItemPopularFilter>;
2164
2646
  /**
2165
2647
  *
2166
- * @type {string}
2167
- * @memberof AnalyticsItemPerformanceWithWidget
2648
+ * @type {AnalyticsPaginationMeta}
2649
+ * @memberof AnalyticsItemPopularFiltersSection
2168
2650
  */
2169
- 'item_name'?: string;
2651
+ 'meta'?: AnalyticsPaginationMeta;
2652
+ }
2653
+ /**
2654
+ *
2655
+ * @export
2656
+ * @interface AnalyticsItemPopularQueriesSection
2657
+ */
2658
+ export interface AnalyticsItemPopularQueriesSection {
2170
2659
  /**
2171
2660
  *
2172
- * @type {number}
2173
- * @memberof AnalyticsItemPerformanceWithWidget
2661
+ * @type {Array<AnalyticsItemPopularQuery>}
2662
+ * @memberof AnalyticsItemPopularQueriesSection
2174
2663
  */
2175
- 'revenue'?: number;
2664
+ 'items'?: Array<AnalyticsItemPopularQuery>;
2176
2665
  /**
2177
2666
  *
2178
- * @type {number}
2179
- * @memberof AnalyticsItemPerformanceWithWidget
2667
+ * @type {AnalyticsPaginationMeta}
2668
+ * @memberof AnalyticsItemPopularQueriesSection
2180
2669
  */
2181
- 'revenue_per_item'?: number;
2670
+ 'meta'?: AnalyticsPaginationMeta;
2671
+ }
2672
+ /**
2673
+ *
2674
+ * @export
2675
+ * @interface AnalyticsItemPopularQuery
2676
+ */
2677
+ export interface AnalyticsItemPopularQuery {
2182
2678
  /**
2183
2679
  *
2184
2680
  * @type {number}
2185
- * @memberof AnalyticsItemPerformanceWithWidget
2681
+ * @memberof AnalyticsItemPopularQuery
2186
2682
  */
2187
- 'top_10_impressions'?: number;
2683
+ 'avg_position'?: number;
2188
2684
  /**
2189
2685
  *
2190
2686
  * @type {number}
2191
- * @memberof AnalyticsItemPerformanceWithWidget
2687
+ * @memberof AnalyticsItemPopularQuery
2192
2688
  */
2193
- 'top_3_impression_rate'?: number;
2689
+ 'click_through_rate'?: number;
2194
2690
  /**
2195
2691
  *
2196
2692
  * @type {number}
2197
- * @memberof AnalyticsItemPerformanceWithWidget
2693
+ * @memberof AnalyticsItemPopularQuery
2198
2694
  */
2199
- 'top_3_impressions'?: number;
2695
+ 'clicks'?: number;
2200
2696
  /**
2201
2697
  *
2202
2698
  * @type {number}
2203
- * @memberof AnalyticsItemPerformanceWithWidget
2699
+ * @memberof AnalyticsItemPopularQuery
2204
2700
  */
2205
- 'unique_filters'?: number;
2701
+ 'impressions'?: number;
2206
2702
  /**
2207
2703
  *
2704
+ * @type {string}
2705
+ * @memberof AnalyticsItemPopularQuery
2706
+ */
2707
+ 'query'?: string;
2708
+ /**
2709
+ * percentage of total impressions for this item
2208
2710
  * @type {number}
2209
- * @memberof AnalyticsItemPerformanceWithWidget
2711
+ * @memberof AnalyticsItemPopularQuery
2210
2712
  */
2211
- 'unique_queries'?: number;
2713
+ 'share'?: number;
2714
+ }
2715
+ /**
2716
+ *
2717
+ * @export
2718
+ * @interface AnalyticsItemPositionBucket
2719
+ */
2720
+ export interface AnalyticsItemPositionBucket {
2212
2721
  /**
2213
2722
  *
2214
2723
  * @type {number}
2215
- * @memberof AnalyticsItemPerformanceWithWidget
2724
+ * @memberof AnalyticsItemPositionBucket
2216
2725
  */
2217
- 'unique_searches'?: number;
2726
+ 'click_rate'?: number;
2218
2727
  /**
2219
2728
  *
2220
2729
  * @type {number}
2221
- * @memberof AnalyticsItemPerformanceWithWidget
2730
+ * @memberof AnalyticsItemPositionBucket
2222
2731
  */
2223
- 'unique_sorts'?: number;
2732
+ 'clicks'?: number;
2224
2733
  /**
2225
2734
  *
2226
2735
  * @type {number}
2227
- * @memberof AnalyticsItemPerformanceWithWidget
2736
+ * @memberof AnalyticsItemPositionBucket
2228
2737
  */
2229
- 'unique_users'?: number;
2738
+ 'impressions'?: number;
2230
2739
  /**
2231
- * Widget display data for UI presentation
2232
- * @type {AnalyticsWidgetData}
2233
- * @memberof AnalyticsItemPerformanceWithWidget
2740
+ * \"1\", \"2\", \"3\", \"4-5\", \"6-10\", \"11-20\", \"21+\"
2741
+ * @type {string}
2742
+ * @memberof AnalyticsItemPositionBucket
2234
2743
  */
2235
- 'widget'?: AnalyticsWidgetData;
2744
+ 'position_range'?: string;
2745
+ /**
2746
+ * percentage of total impressions for this item
2747
+ * @type {number}
2748
+ * @memberof AnalyticsItemPositionBucket
2749
+ */
2750
+ 'share'?: number;
2236
2751
  }
2237
2752
  /**
2238
2753
  *
@@ -2798,6 +3313,86 @@ export interface AnalyticsQueryFilterUsage {
2798
3313
  */
2799
3314
  'unique_searches'?: number;
2800
3315
  }
3316
+ /**
3317
+ *
3318
+ * @export
3319
+ * @interface AnalyticsQueryGeoAnalytic
3320
+ */
3321
+ export interface AnalyticsQueryGeoAnalytic {
3322
+ /**
3323
+ *
3324
+ * @type {string}
3325
+ * @memberof AnalyticsQueryGeoAnalytic
3326
+ */
3327
+ 'city'?: string;
3328
+ /**
3329
+ *
3330
+ * @type {number}
3331
+ * @memberof AnalyticsQueryGeoAnalytic
3332
+ */
3333
+ 'click_through_rate'?: number;
3334
+ /**
3335
+ *
3336
+ * @type {number}
3337
+ * @memberof AnalyticsQueryGeoAnalytic
3338
+ */
3339
+ 'clicks'?: number;
3340
+ /**
3341
+ *
3342
+ * @type {string}
3343
+ * @memberof AnalyticsQueryGeoAnalytic
3344
+ */
3345
+ 'country'?: string;
3346
+ /**
3347
+ *
3348
+ * @type {string}
3349
+ * @memberof AnalyticsQueryGeoAnalytic
3350
+ */
3351
+ 'country_code'?: string;
3352
+ /**
3353
+ *
3354
+ * @type {string}
3355
+ * @memberof AnalyticsQueryGeoAnalytic
3356
+ */
3357
+ 'region'?: string;
3358
+ /**
3359
+ *
3360
+ * @type {number}
3361
+ * @memberof AnalyticsQueryGeoAnalytic
3362
+ */
3363
+ 'searches'?: number;
3364
+ /**
3365
+ * percentage of total searches for this query
3366
+ * @type {number}
3367
+ * @memberof AnalyticsQueryGeoAnalytic
3368
+ */
3369
+ 'share'?: number;
3370
+ /**
3371
+ *
3372
+ * @type {number}
3373
+ * @memberof AnalyticsQueryGeoAnalytic
3374
+ */
3375
+ 'unique_users'?: number;
3376
+ }
3377
+ /**
3378
+ *
3379
+ * @export
3380
+ * @interface AnalyticsQueryGeoAnalyticsSection
3381
+ */
3382
+ export interface AnalyticsQueryGeoAnalyticsSection {
3383
+ /**
3384
+ *
3385
+ * @type {Array<AnalyticsQueryGeoAnalytic>}
3386
+ * @memberof AnalyticsQueryGeoAnalyticsSection
3387
+ */
3388
+ 'items'?: Array<AnalyticsQueryGeoAnalytic>;
3389
+ /**
3390
+ *
3391
+ * @type {AnalyticsPaginationMeta}
3392
+ * @memberof AnalyticsQueryGeoAnalyticsSection
3393
+ */
3394
+ 'meta'?: AnalyticsPaginationMeta;
3395
+ }
2801
3396
  /**
2802
3397
  *
2803
3398
  * @export
@@ -2834,6 +3429,12 @@ export interface AnalyticsQueryInsights {
2834
3429
  * @memberof AnalyticsQueryInsights
2835
3430
  */
2836
3431
  'filter_analytics'?: AnalyticsQueryFilterAnalytics;
3432
+ /**
3433
+ *
3434
+ * @type {AnalyticsQueryGeoAnalyticsSection}
3435
+ * @memberof AnalyticsQueryInsights
3436
+ */
3437
+ 'geo_analytics'?: AnalyticsQueryGeoAnalyticsSection;
2837
3438
  /**
2838
3439
  *
2839
3440
  * @type {string}
@@ -3183,6 +3784,49 @@ export interface AnalyticsQueryResponse {
3183
3784
  */
3184
3785
  'total'?: number;
3185
3786
  }
3787
+ /**
3788
+ *
3789
+ * @export
3790
+ * @interface AnalyticsSharedQueryAnalysis
3791
+ */
3792
+ export interface AnalyticsSharedQueryAnalysis {
3793
+ /**
3794
+ *
3795
+ * @type {string}
3796
+ * @memberof AnalyticsSharedQueryAnalysis
3797
+ */
3798
+ 'competitor_id'?: string;
3799
+ /**
3800
+ *
3801
+ * @type {number}
3802
+ * @memberof AnalyticsSharedQueryAnalysis
3803
+ */
3804
+ 'competitor_position'?: number;
3805
+ /**
3806
+ *
3807
+ * @type {number}
3808
+ * @memberof AnalyticsSharedQueryAnalysis
3809
+ */
3810
+ 'impressions'?: number;
3811
+ /**
3812
+ *
3813
+ * @type {number}
3814
+ * @memberof AnalyticsSharedQueryAnalysis
3815
+ */
3816
+ 'position_advantage'?: number;
3817
+ /**
3818
+ *
3819
+ * @type {string}
3820
+ * @memberof AnalyticsSharedQueryAnalysis
3821
+ */
3822
+ 'query'?: string;
3823
+ /**
3824
+ *
3825
+ * @type {number}
3826
+ * @memberof AnalyticsSharedQueryAnalysis
3827
+ */
3828
+ 'this_item_position'?: number;
3829
+ }
3186
3830
  /**
3187
3831
  *
3188
3832
  * @export
@@ -6002,11 +6646,17 @@ export interface DataTypesErrorMetaResponse {
6002
6646
  */
6003
6647
  export interface DataTypesEventPayload {
6004
6648
  /**
6005
- *
6649
+ * Journey Tracking & Analytics
6006
6650
  * @type {Array<string>}
6007
6651
  * @memberof DataTypesEventPayload
6008
6652
  */
6009
6653
  'analytics_tags'?: Array<string>;
6654
+ /**
6655
+ * Anonymous user identifier
6656
+ * @type {string}
6657
+ * @memberof DataTypesEventPayload
6658
+ */
6659
+ 'anon_id'?: string;
6010
6660
  /**
6011
6661
  *
6012
6662
  * @type {string}
@@ -6014,13 +6664,13 @@ export interface DataTypesEventPayload {
6014
6664
  */
6015
6665
  'city'?: string;
6016
6666
  /**
6017
- *
6667
+ * Click/Interaction Event Fields
6018
6668
  * @type {string}
6019
6669
  * @memberof DataTypesEventPayload
6020
6670
  */
6021
6671
  'clicked_product_id'?: string;
6022
6672
  /**
6023
- * Geo data fields for direct submission
6673
+ * Enhanced Geo data fields for direct submission
6024
6674
  * @type {string}
6025
6675
  * @memberof DataTypesEventPayload
6026
6676
  */
@@ -6031,6 +6681,12 @@ export interface DataTypesEventPayload {
6031
6681
  * @memberof DataTypesEventPayload
6032
6682
  */
6033
6683
  'country_code'?: string;
6684
+ /**
6685
+ * Currency for value
6686
+ * @type {string}
6687
+ * @memberof DataTypesEventPayload
6688
+ */
6689
+ 'currency'?: string;
6034
6690
  /**
6035
6691
  *
6036
6692
  * @type {string}
@@ -6038,7 +6694,7 @@ export interface DataTypesEventPayload {
6038
6694
  */
6039
6695
  'device_type'?: string;
6040
6696
  /**
6041
- *
6697
+ * Core Event Information
6042
6698
  * @type {string}
6043
6699
  * @memberof DataTypesEventPayload
6044
6700
  */
@@ -6050,25 +6706,25 @@ export interface DataTypesEventPayload {
6050
6706
  */
6051
6707
  'event_name'?: string;
6052
6708
  /**
6053
- *
6709
+ * Device & Location Context
6054
6710
  * @type {string}
6055
6711
  * @memberof DataTypesEventPayload
6056
6712
  */
6057
6713
  'ip'?: string;
6058
6714
  /**
6059
- *
6715
+ * Performance
6060
6716
  * @type {number}
6061
6717
  * @memberof DataTypesEventPayload
6062
6718
  */
6063
6719
  'latency_ms'?: number;
6064
6720
  /**
6065
- *
6721
+ * Legacy field
6066
6722
  * @type {string}
6067
6723
  * @memberof DataTypesEventPayload
6068
6724
  */
6069
6725
  'location'?: string;
6070
6726
  /**
6071
- *
6727
+ * Flexible metadata including search_id, position, etc.
6072
6728
  * @type {{ [key: string]: any; }}
6073
6729
  * @memberof DataTypesEventPayload
6074
6730
  */
@@ -6080,7 +6736,13 @@ export interface DataTypesEventPayload {
6080
6736
  */
6081
6737
  'org_id'?: string;
6082
6738
  /**
6083
- *
6739
+ * web, ios, android
6740
+ * @type {string}
6741
+ * @memberof DataTypesEventPayload
6742
+ */
6743
+ 'platform'?: string;
6744
+ /**
6745
+ * Search Event Fields
6084
6746
  * @type {string}
6085
6747
  * @memberof DataTypesEventPayload
6086
6748
  */
@@ -6098,7 +6760,13 @@ export interface DataTypesEventPayload {
6098
6760
  */
6099
6761
  'results_count'?: number;
6100
6762
  /**
6101
- *
6763
+ * Session identifier for journey tracking
6764
+ * @type {string}
6765
+ * @memberof DataTypesEventPayload
6766
+ */
6767
+ 'session_id'?: string;
6768
+ /**
6769
+ * Organization Context
6102
6770
  * @type {string}
6103
6771
  * @memberof DataTypesEventPayload
6104
6772
  */
@@ -6110,11 +6778,17 @@ export interface DataTypesEventPayload {
6110
6778
  */
6111
6779
  'timestamp'?: string;
6112
6780
  /**
6113
- *
6781
+ * User Context
6114
6782
  * @type {string}
6115
6783
  * @memberof DataTypesEventPayload
6116
6784
  */
6117
6785
  'user_id'?: string;
6786
+ /**
6787
+ * Business Context
6788
+ * @type {number}
6789
+ * @memberof DataTypesEventPayload
6790
+ */
6791
+ 'value'?: number;
6118
6792
  }
6119
6793
  /**
6120
6794
  *
@@ -14680,21 +15354,31 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
14680
15354
  };
14681
15355
  },
14682
15356
  /**
14683
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
15357
+ * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
14684
15358
  * @summary Get Query Insights
14685
15359
  * @param {string} xStoreID Store ID
14686
15360
  * @param {string} query Search query to analyze
14687
15361
  * @param {string} [startTime] Start time in RFC3339 format
14688
15362
  * @param {string} [endTime] End time in RFC3339 format
15363
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
15364
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
15365
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
15366
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
15367
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
15368
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
15369
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
15370
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14689
15371
  * @param {number} [resultsPage] Page number for popular results pagination
14690
15372
  * @param {number} [resultsPageSize] Number of results per page for popular results
14691
15373
  * @param {number} [filtersPage] Page number for popular filters pagination
14692
- * @param {number} [filtersPageSize] Number of filters per page for popular filters
15374
+ * @param {number} [filtersPageSize] Number of filters per page
15375
+ * @param {number} [geoPage] Page number for geo analytics pagination
15376
+ * @param {number} [geoPageSize] Number of geo locations per page
14693
15377
  * @param {boolean} [includeWidget] Whether to include widget display fields for popular results
14694
15378
  * @param {*} [options] Override http request option.
14695
15379
  * @throws {RequiredError}
14696
15380
  */
14697
- adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
15381
+ adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, includeWidget?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14698
15382
  // verify required parameter 'xStoreID' is not null or undefined
14699
15383
  assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID)
14700
15384
  // verify required parameter 'query' is not null or undefined
@@ -14713,15 +15397,47 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
14713
15397
  const localVarHeaderParameter = {} as any;
14714
15398
  const localVarQueryParameter = {} as any;
14715
15399
 
14716
- // authentication BearerAuth required
14717
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
15400
+ // authentication BearerAuth required
15401
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
15402
+
15403
+ if (startTime !== undefined) {
15404
+ localVarQueryParameter['start_time'] = startTime;
15405
+ }
15406
+
15407
+ if (endTime !== undefined) {
15408
+ localVarQueryParameter['end_time'] = endTime;
15409
+ }
15410
+
15411
+ if (compareMode !== undefined) {
15412
+ localVarQueryParameter['compare_mode'] = compareMode;
15413
+ }
15414
+
15415
+ if (compareStartTime !== undefined) {
15416
+ localVarQueryParameter['compare_start_time'] = compareStartTime;
15417
+ }
15418
+
15419
+ if (compareEndTime !== undefined) {
15420
+ localVarQueryParameter['compare_end_time'] = compareEndTime;
15421
+ }
15422
+
15423
+ if (compareAnalyticsTags !== undefined) {
15424
+ localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
15425
+ }
15426
+
15427
+ if (compareTagsMatchMode !== undefined) {
15428
+ localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
15429
+ }
15430
+
15431
+ if (compareTagsExclude !== undefined) {
15432
+ localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
15433
+ }
14718
15434
 
14719
- if (startTime !== undefined) {
14720
- localVarQueryParameter['start_time'] = startTime;
15435
+ if (compareTagKeyFilter !== undefined) {
15436
+ localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
14721
15437
  }
14722
15438
 
14723
- if (endTime !== undefined) {
14724
- localVarQueryParameter['end_time'] = endTime;
15439
+ if (compareTagValueFilter !== undefined) {
15440
+ localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
14725
15441
  }
14726
15442
 
14727
15443
  if (resultsPage !== undefined) {
@@ -14740,6 +15456,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
14740
15456
  localVarQueryParameter['filters_page_size'] = filtersPageSize;
14741
15457
  }
14742
15458
 
15459
+ if (geoPage !== undefined) {
15460
+ localVarQueryParameter['geo_page'] = geoPage;
15461
+ }
15462
+
15463
+ if (geoPageSize !== undefined) {
15464
+ localVarQueryParameter['geo_page_size'] = geoPageSize;
15465
+ }
15466
+
14743
15467
  if (includeWidget !== undefined) {
14744
15468
  localVarQueryParameter['include_widget'] = includeWidget;
14745
15469
  }
@@ -15439,22 +16163,32 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
15439
16163
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15440
16164
  },
15441
16165
  /**
15442
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
16166
+ * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
15443
16167
  * @summary Get Query Insights
15444
16168
  * @param {string} xStoreID Store ID
15445
16169
  * @param {string} query Search query to analyze
15446
16170
  * @param {string} [startTime] Start time in RFC3339 format
15447
16171
  * @param {string} [endTime] End time in RFC3339 format
16172
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
16173
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
16174
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
16175
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
16176
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
16177
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
16178
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
16179
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
15448
16180
  * @param {number} [resultsPage] Page number for popular results pagination
15449
16181
  * @param {number} [resultsPageSize] Number of results per page for popular results
15450
16182
  * @param {number} [filtersPage] Page number for popular filters pagination
15451
- * @param {number} [filtersPageSize] Number of filters per page for popular filters
16183
+ * @param {number} [filtersPageSize] Number of filters per page
16184
+ * @param {number} [geoPage] Page number for geo analytics pagination
16185
+ * @param {number} [geoPageSize] Number of geo locations per page
15452
16186
  * @param {boolean} [includeWidget] Whether to include widget display fields for popular results
15453
16187
  * @param {*} [options] Override http request option.
15454
16188
  * @throws {RequiredError}
15455
16189
  */
15456
- async adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>> {
15457
- const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
16190
+ async adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>> {
16191
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options);
15458
16192
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
15459
16193
  const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']?.[localVarOperationServerIndex]?.url;
15460
16194
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -15846,22 +16580,32 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
15846
16580
  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));
15847
16581
  },
15848
16582
  /**
15849
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
16583
+ * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
15850
16584
  * @summary Get Query Insights
15851
16585
  * @param {string} xStoreID Store ID
15852
16586
  * @param {string} query Search query to analyze
15853
16587
  * @param {string} [startTime] Start time in RFC3339 format
15854
16588
  * @param {string} [endTime] End time in RFC3339 format
16589
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
16590
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
16591
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
16592
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
16593
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
16594
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
16595
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
16596
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
15855
16597
  * @param {number} [resultsPage] Page number for popular results pagination
15856
16598
  * @param {number} [resultsPageSize] Number of results per page for popular results
15857
16599
  * @param {number} [filtersPage] Page number for popular filters pagination
15858
- * @param {number} [filtersPageSize] Number of filters per page for popular filters
16600
+ * @param {number} [filtersPageSize] Number of filters per page
16601
+ * @param {number} [geoPage] Page number for geo analytics pagination
16602
+ * @param {number} [geoPageSize] Number of geo locations per page
15859
16603
  * @param {boolean} [includeWidget] Whether to include widget display fields for popular results
15860
16604
  * @param {*} [options] Override http request option.
15861
16605
  * @throws {RequiredError}
15862
16606
  */
15863
- adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response> {
15864
- return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(axios, basePath));
16607
+ adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response> {
16608
+ return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options).then((request) => request(axios, basePath));
15865
16609
  },
15866
16610
  /**
15867
16611
  * 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.
@@ -16267,23 +17011,33 @@ export class AnalyticsApi extends BaseAPI {
16267
17011
  }
16268
17012
 
16269
17013
  /**
16270
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
17014
+ * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
16271
17015
  * @summary Get Query Insights
16272
17016
  * @param {string} xStoreID Store ID
16273
17017
  * @param {string} query Search query to analyze
16274
17018
  * @param {string} [startTime] Start time in RFC3339 format
16275
17019
  * @param {string} [endTime] End time in RFC3339 format
17020
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
17021
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
17022
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
17023
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
17024
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
17025
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
17026
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
17027
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
16276
17028
  * @param {number} [resultsPage] Page number for popular results pagination
16277
17029
  * @param {number} [resultsPageSize] Number of results per page for popular results
16278
17030
  * @param {number} [filtersPage] Page number for popular filters pagination
16279
- * @param {number} [filtersPageSize] Number of filters per page for popular filters
17031
+ * @param {number} [filtersPageSize] Number of filters per page
17032
+ * @param {number} [geoPage] Page number for geo analytics pagination
17033
+ * @param {number} [geoPageSize] Number of geo locations per page
16280
17034
  * @param {boolean} [includeWidget] Whether to include widget display fields for popular results
16281
17035
  * @param {*} [options] Override http request option.
16282
17036
  * @throws {RequiredError}
16283
17037
  * @memberof AnalyticsApi
16284
17038
  */
16285
- public adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig) {
16286
- return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
17039
+ public adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig) {
17040
+ return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
16287
17041
  }
16288
17042
 
16289
17043
  /**
@@ -16660,6 +17414,14 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
16660
17414
  Desc: 'desc'
16661
17415
  } as const;
16662
17416
  export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
17417
+ /**
17418
+ * @export
17419
+ */
17420
+ export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = {
17421
+ Any: 'any',
17422
+ All: 'all'
17423
+ } as const;
17424
+ export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum];
16663
17425
  /**
16664
17426
  * @export
16665
17427
  */
@@ -20368,6 +21130,157 @@ export const ItemAnalyticsApiAxiosParamCreator = function (configuration?: Confi
20368
21130
 
20369
21131
 
20370
21132
 
21133
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
21134
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
21135
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
21136
+
21137
+ return {
21138
+ url: toPathString(localVarUrlObj),
21139
+ options: localVarRequestOptions,
21140
+ };
21141
+ },
21142
+ /**
21143
+ * Retrieve comprehensive analytics insights for a specific item including popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
21144
+ * @summary Get Item Insights
21145
+ * @param {string} xStoreID Store ID
21146
+ * @param {string} itemId Item ID to analyze
21147
+ * @param {string} [startTime] Start time in RFC3339 format
21148
+ * @param {string} [endTime] End time in RFC3339 format
21149
+ * @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \&#39;campaign:summer,source:email\&#39;)
21150
+ * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
21151
+ * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
21152
+ * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
21153
+ * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
21154
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
21155
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
21156
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
21157
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
21158
+ * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
21159
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
21160
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
21161
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
21162
+ * @param {number} [resultsPage] Page number for popular queries pagination
21163
+ * @param {number} [resultsPageSize] Number of queries per page for popular queries
21164
+ * @param {number} [filtersPage] Page number for popular filters pagination
21165
+ * @param {number} [filtersPageSize] Number of filters per page
21166
+ * @param {number} [geoPage] Page number for geo analytics pagination
21167
+ * @param {number} [geoPageSize] Number of geo locations per page
21168
+ * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
21169
+ * @param {*} [options] Override http request option.
21170
+ * @throws {RequiredError}
21171
+ */
21172
+ adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet: async (xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
21173
+ // verify required parameter 'xStoreID' is not null or undefined
21174
+ assertParamExists('adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet', 'xStoreID', xStoreID)
21175
+ // verify required parameter 'itemId' is not null or undefined
21176
+ assertParamExists('adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet', 'itemId', itemId)
21177
+ const localVarPath = `/admin/analytics/store/{xStoreID}/items/{itemId}/insights`
21178
+ .replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
21179
+ .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
21180
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
21181
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
21182
+ let baseOptions;
21183
+ if (configuration) {
21184
+ baseOptions = configuration.baseOptions;
21185
+ }
21186
+
21187
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
21188
+ const localVarHeaderParameter = {} as any;
21189
+ const localVarQueryParameter = {} as any;
21190
+
21191
+ // authentication BearerAuth required
21192
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
21193
+
21194
+ if (startTime !== undefined) {
21195
+ localVarQueryParameter['start_time'] = startTime;
21196
+ }
21197
+
21198
+ if (endTime !== undefined) {
21199
+ localVarQueryParameter['end_time'] = endTime;
21200
+ }
21201
+
21202
+ if (analyticsTags !== undefined) {
21203
+ localVarQueryParameter['analytics_tags'] = analyticsTags;
21204
+ }
21205
+
21206
+ if (tagsMatchMode !== undefined) {
21207
+ localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
21208
+ }
21209
+
21210
+ if (tagsExclude !== undefined) {
21211
+ localVarQueryParameter['tags_exclude'] = tagsExclude;
21212
+ }
21213
+
21214
+ if (tagKeyFilter !== undefined) {
21215
+ localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
21216
+ }
21217
+
21218
+ if (tagValueFilter !== undefined) {
21219
+ localVarQueryParameter['tag_value_filter'] = tagValueFilter;
21220
+ }
21221
+
21222
+ if (compareMode !== undefined) {
21223
+ localVarQueryParameter['compare_mode'] = compareMode;
21224
+ }
21225
+
21226
+ if (compareStartTime !== undefined) {
21227
+ localVarQueryParameter['compare_start_time'] = compareStartTime;
21228
+ }
21229
+
21230
+ if (compareEndTime !== undefined) {
21231
+ localVarQueryParameter['compare_end_time'] = compareEndTime;
21232
+ }
21233
+
21234
+ if (compareAnalyticsTags !== undefined) {
21235
+ localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
21236
+ }
21237
+
21238
+ if (compareTagsMatchMode !== undefined) {
21239
+ localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
21240
+ }
21241
+
21242
+ if (compareTagsExclude !== undefined) {
21243
+ localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
21244
+ }
21245
+
21246
+ if (compareTagKeyFilter !== undefined) {
21247
+ localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
21248
+ }
21249
+
21250
+ if (compareTagValueFilter !== undefined) {
21251
+ localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
21252
+ }
21253
+
21254
+ if (resultsPage !== undefined) {
21255
+ localVarQueryParameter['results_page'] = resultsPage;
21256
+ }
21257
+
21258
+ if (resultsPageSize !== undefined) {
21259
+ localVarQueryParameter['results_page_size'] = resultsPageSize;
21260
+ }
21261
+
21262
+ if (filtersPage !== undefined) {
21263
+ localVarQueryParameter['filters_page'] = filtersPage;
21264
+ }
21265
+
21266
+ if (filtersPageSize !== undefined) {
21267
+ localVarQueryParameter['filters_page_size'] = filtersPageSize;
21268
+ }
21269
+
21270
+ if (geoPage !== undefined) {
21271
+ localVarQueryParameter['geo_page'] = geoPage;
21272
+ }
21273
+
21274
+ if (geoPageSize !== undefined) {
21275
+ localVarQueryParameter['geo_page_size'] = geoPageSize;
21276
+ }
21277
+
21278
+ if (groupBy !== undefined) {
21279
+ localVarQueryParameter['group_by'] = groupBy;
21280
+ }
21281
+
21282
+
21283
+
20371
21284
  setSearchParams(localVarUrlObj, localVarQueryParameter);
20372
21285
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20373
21286
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -20772,6 +21685,42 @@ export const ItemAnalyticsApiFp = function(configuration?: Configuration) {
20772
21685
  const localVarOperationServerBasePath = operationServerMap['ItemAnalyticsApi.adminAnalyticsStoreXStoreIDItemsItemIdGet']?.[localVarOperationServerIndex]?.url;
20773
21686
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
20774
21687
  },
21688
+ /**
21689
+ * Retrieve comprehensive analytics insights for a specific item including popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
21690
+ * @summary Get Item Insights
21691
+ * @param {string} xStoreID Store ID
21692
+ * @param {string} itemId Item ID to analyze
21693
+ * @param {string} [startTime] Start time in RFC3339 format
21694
+ * @param {string} [endTime] End time in RFC3339 format
21695
+ * @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \&#39;campaign:summer,source:email\&#39;)
21696
+ * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
21697
+ * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
21698
+ * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
21699
+ * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
21700
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
21701
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
21702
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
21703
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
21704
+ * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
21705
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
21706
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
21707
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
21708
+ * @param {number} [resultsPage] Page number for popular queries pagination
21709
+ * @param {number} [resultsPageSize] Number of queries per page for popular queries
21710
+ * @param {number} [filtersPage] Page number for popular filters pagination
21711
+ * @param {number} [filtersPageSize] Number of filters per page
21712
+ * @param {number} [geoPage] Page number for geo analytics pagination
21713
+ * @param {number} [geoPageSize] Number of geo locations per page
21714
+ * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
21715
+ * @param {*} [options] Override http request option.
21716
+ * @throws {RequiredError}
21717
+ */
21718
+ async adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response>> {
21719
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options);
21720
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21721
+ const localVarOperationServerBasePath = operationServerMap['ItemAnalyticsApi.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet']?.[localVarOperationServerIndex]?.url;
21722
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21723
+ },
20775
21724
  /**
20776
21725
  * Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
20777
21726
  * @summary Get Item Performance Analytics
@@ -20931,6 +21880,39 @@ export const ItemAnalyticsApiFactory = function (configuration?: Configuration,
20931
21880
  adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse> {
20932
21881
  return localVarFp.adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options).then((request) => request(axios, basePath));
20933
21882
  },
21883
+ /**
21884
+ * Retrieve comprehensive analytics insights for a specific item including popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
21885
+ * @summary Get Item Insights
21886
+ * @param {string} xStoreID Store ID
21887
+ * @param {string} itemId Item ID to analyze
21888
+ * @param {string} [startTime] Start time in RFC3339 format
21889
+ * @param {string} [endTime] End time in RFC3339 format
21890
+ * @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \&#39;campaign:summer,source:email\&#39;)
21891
+ * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
21892
+ * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
21893
+ * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
21894
+ * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
21895
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
21896
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
21897
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
21898
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
21899
+ * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
21900
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
21901
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
21902
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
21903
+ * @param {number} [resultsPage] Page number for popular queries pagination
21904
+ * @param {number} [resultsPageSize] Number of queries per page for popular queries
21905
+ * @param {number} [filtersPage] Page number for popular filters pagination
21906
+ * @param {number} [filtersPageSize] Number of filters per page
21907
+ * @param {number} [geoPage] Page number for geo analytics pagination
21908
+ * @param {number} [geoPageSize] Number of geo locations per page
21909
+ * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
21910
+ * @param {*} [options] Override http request option.
21911
+ * @throws {RequiredError}
21912
+ */
21913
+ adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response> {
21914
+ return localVarFp.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options).then((request) => request(axios, basePath));
21915
+ },
20934
21916
  /**
20935
21917
  * Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
20936
21918
  * @summary Get Item Performance Analytics
@@ -21089,6 +22071,41 @@ export class ItemAnalyticsApi extends BaseAPI {
21089
22071
  return ItemAnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
21090
22072
  }
21091
22073
 
22074
+ /**
22075
+ * Retrieve comprehensive analytics insights for a specific item including popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
22076
+ * @summary Get Item Insights
22077
+ * @param {string} xStoreID Store ID
22078
+ * @param {string} itemId Item ID to analyze
22079
+ * @param {string} [startTime] Start time in RFC3339 format
22080
+ * @param {string} [endTime] End time in RFC3339 format
22081
+ * @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \&#39;campaign:summer,source:email\&#39;)
22082
+ * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
22083
+ * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
22084
+ * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
22085
+ * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
22086
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
22087
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
22088
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
22089
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
22090
+ * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
22091
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
22092
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
22093
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
22094
+ * @param {number} [resultsPage] Page number for popular queries pagination
22095
+ * @param {number} [resultsPageSize] Number of queries per page for popular queries
22096
+ * @param {number} [filtersPage] Page number for popular filters pagination
22097
+ * @param {number} [filtersPageSize] Number of filters per page
22098
+ * @param {number} [geoPage] Page number for geo analytics pagination
22099
+ * @param {number} [geoPageSize] Number of geo locations per page
22100
+ * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
22101
+ * @param {*} [options] Override http request option.
22102
+ * @throws {RequiredError}
22103
+ * @memberof ItemAnalyticsApi
22104
+ */
22105
+ public adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig) {
22106
+ return ItemAnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options).then((request) => request(this.axios, this.basePath));
22107
+ }
22108
+
21092
22109
  /**
21093
22110
  * Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
21094
22111
  * @summary Get Item Performance Analytics
@@ -21200,6 +22217,29 @@ export const AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum = {
21200
22217
  Desc: 'desc'
21201
22218
  } as const;
21202
22219
  export type AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum];
22220
+ /**
22221
+ * @export
22222
+ */
22223
+ export const AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum = {
22224
+ Any: 'any',
22225
+ All: 'all'
22226
+ } as const;
22227
+ export type AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum];
22228
+ /**
22229
+ * @export
22230
+ */
22231
+ export const AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum = {
22232
+ Any: 'any',
22233
+ All: 'all'
22234
+ } as const;
22235
+ export type AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum];
22236
+ /**
22237
+ * @export
22238
+ */
22239
+ export const AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum = {
22240
+ Date: 'date'
22241
+ } as const;
22242
+ export type AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum = typeof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum[keyof typeof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum];
21203
22243
  /**
21204
22244
  * @export
21205
22245
  */