@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/README.md +23 -2
- package/api.ts +1368 -19
- package/dist/api.d.ts +1297 -94
- package/dist/api.js +276 -5
- package/dist/esm/api.d.ts +1297 -94
- package/dist/esm/api.js +271 -0
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.16.tgz +0 -0
- package/seekora-ai-admin-api-1.1.15.tgz +0 -0
package/dist/esm/api.d.ts
CHANGED
|
@@ -703,6 +703,49 @@ export interface AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response {
|
|
|
703
703
|
*/
|
|
704
704
|
'total'?: number;
|
|
705
705
|
}
|
|
706
|
+
/**
|
|
707
|
+
*
|
|
708
|
+
* @export
|
|
709
|
+
* @interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
710
|
+
*/
|
|
711
|
+
export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
|
|
712
|
+
/**
|
|
713
|
+
* Comparison metadata when in compare mode
|
|
714
|
+
* @type {AnalyticsComparisonMeta}
|
|
715
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
716
|
+
*/
|
|
717
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
718
|
+
/**
|
|
719
|
+
*
|
|
720
|
+
* @type {AnalyticsQueryInsights}
|
|
721
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
722
|
+
*/
|
|
723
|
+
'data'?: AnalyticsQueryInsights;
|
|
724
|
+
/**
|
|
725
|
+
*
|
|
726
|
+
* @type {string}
|
|
727
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
728
|
+
*/
|
|
729
|
+
'error'?: string;
|
|
730
|
+
/**
|
|
731
|
+
*
|
|
732
|
+
* @type {string}
|
|
733
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
734
|
+
*/
|
|
735
|
+
'status'?: string;
|
|
736
|
+
/**
|
|
737
|
+
*
|
|
738
|
+
* @type {string}
|
|
739
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
740
|
+
*/
|
|
741
|
+
'timestamp'?: string;
|
|
742
|
+
/**
|
|
743
|
+
*
|
|
744
|
+
* @type {number}
|
|
745
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
746
|
+
*/
|
|
747
|
+
'total'?: number;
|
|
748
|
+
}
|
|
706
749
|
/**
|
|
707
750
|
*
|
|
708
751
|
* @export
|
|
@@ -1416,6 +1459,153 @@ export interface AnalyticsAnalyticsAPIResponse {
|
|
|
1416
1459
|
*/
|
|
1417
1460
|
'total'?: number;
|
|
1418
1461
|
}
|
|
1462
|
+
/**
|
|
1463
|
+
*
|
|
1464
|
+
* @export
|
|
1465
|
+
* @interface AnalyticsArrayElementAnalytic
|
|
1466
|
+
*/
|
|
1467
|
+
export interface AnalyticsArrayElementAnalytic {
|
|
1468
|
+
/**
|
|
1469
|
+
* Position in array (0-based)
|
|
1470
|
+
* @type {number}
|
|
1471
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1472
|
+
*/
|
|
1473
|
+
'array_index'?: number;
|
|
1474
|
+
/**
|
|
1475
|
+
* Total array size
|
|
1476
|
+
* @type {number}
|
|
1477
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1478
|
+
*/
|
|
1479
|
+
'array_length'?: number;
|
|
1480
|
+
/**
|
|
1481
|
+
* Average results when this element is used
|
|
1482
|
+
* @type {number}
|
|
1483
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1484
|
+
*/
|
|
1485
|
+
'avg_results_count'?: number;
|
|
1486
|
+
/**
|
|
1487
|
+
* e.g., \"tags\"
|
|
1488
|
+
* @type {string}
|
|
1489
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1490
|
+
*/
|
|
1491
|
+
'filter_key'?: string;
|
|
1492
|
+
/**
|
|
1493
|
+
* e.g., \"fashion\"
|
|
1494
|
+
* @type {string}
|
|
1495
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1496
|
+
*/
|
|
1497
|
+
'filter_value'?: string;
|
|
1498
|
+
/**
|
|
1499
|
+
* \"array\", \"object\", \"string\"
|
|
1500
|
+
* @type {string}
|
|
1501
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1502
|
+
*/
|
|
1503
|
+
'original_type'?: string;
|
|
1504
|
+
/**
|
|
1505
|
+
* How often this element appears at this position
|
|
1506
|
+
* @type {number}
|
|
1507
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1508
|
+
*/
|
|
1509
|
+
'position_popularity'?: number;
|
|
1510
|
+
/**
|
|
1511
|
+
* Percentage with results > 0
|
|
1512
|
+
* @type {number}
|
|
1513
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1514
|
+
*/
|
|
1515
|
+
'success_rate'?: number;
|
|
1516
|
+
/**
|
|
1517
|
+
* Unique searches using this element
|
|
1518
|
+
* @type {number}
|
|
1519
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1520
|
+
*/
|
|
1521
|
+
'unique_searches'?: number;
|
|
1522
|
+
/**
|
|
1523
|
+
* How many times this element was used
|
|
1524
|
+
* @type {number}
|
|
1525
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1526
|
+
*/
|
|
1527
|
+
'usage_count'?: number;
|
|
1528
|
+
/**
|
|
1529
|
+
* \"array_element\", \"object_key\", etc.
|
|
1530
|
+
* @type {string}
|
|
1531
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1532
|
+
*/
|
|
1533
|
+
'value_type'?: string;
|
|
1534
|
+
}
|
|
1535
|
+
/**
|
|
1536
|
+
*
|
|
1537
|
+
* @export
|
|
1538
|
+
* @interface AnalyticsArrayFilterStats
|
|
1539
|
+
*/
|
|
1540
|
+
export interface AnalyticsArrayFilterStats {
|
|
1541
|
+
/**
|
|
1542
|
+
* Average array size
|
|
1543
|
+
* @type {number}
|
|
1544
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1545
|
+
*/
|
|
1546
|
+
'avg_array_length'?: number;
|
|
1547
|
+
/**
|
|
1548
|
+
* Largest array seen
|
|
1549
|
+
* @type {number}
|
|
1550
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1551
|
+
*/
|
|
1552
|
+
'max_array_length'?: number;
|
|
1553
|
+
/**
|
|
1554
|
+
* Top values across all arrays
|
|
1555
|
+
* @type {Array<string>}
|
|
1556
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1557
|
+
*/
|
|
1558
|
+
'most_popular_values'?: Array<string>;
|
|
1559
|
+
/**
|
|
1560
|
+
* Usage by array position
|
|
1561
|
+
* @type {Array<AnalyticsArrayPositionAnalytic>}
|
|
1562
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1563
|
+
*/
|
|
1564
|
+
'position_analytics'?: Array<AnalyticsArrayPositionAnalytic>;
|
|
1565
|
+
/**
|
|
1566
|
+
* Total times arrays were used for this filter
|
|
1567
|
+
* @type {number}
|
|
1568
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1569
|
+
*/
|
|
1570
|
+
'total_array_usage'?: number;
|
|
1571
|
+
}
|
|
1572
|
+
/**
|
|
1573
|
+
*
|
|
1574
|
+
* @export
|
|
1575
|
+
* @interface AnalyticsArrayPositionAnalytic
|
|
1576
|
+
*/
|
|
1577
|
+
export interface AnalyticsArrayPositionAnalytic {
|
|
1578
|
+
/**
|
|
1579
|
+
* Most popular value at this position
|
|
1580
|
+
* @type {string}
|
|
1581
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1582
|
+
*/
|
|
1583
|
+
'popular_value'?: string;
|
|
1584
|
+
/**
|
|
1585
|
+
* 0-based array position
|
|
1586
|
+
* @type {number}
|
|
1587
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1588
|
+
*/
|
|
1589
|
+
'position'?: number;
|
|
1590
|
+
/**
|
|
1591
|
+
* Success rate for searches with values at this position
|
|
1592
|
+
* @type {number}
|
|
1593
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1594
|
+
*/
|
|
1595
|
+
'success_rate'?: number;
|
|
1596
|
+
/**
|
|
1597
|
+
* Unique values at this position
|
|
1598
|
+
* @type {number}
|
|
1599
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1600
|
+
*/
|
|
1601
|
+
'unique_values'?: number;
|
|
1602
|
+
/**
|
|
1603
|
+
* Times this position was used
|
|
1604
|
+
* @type {number}
|
|
1605
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1606
|
+
*/
|
|
1607
|
+
'usage_count'?: number;
|
|
1608
|
+
}
|
|
1419
1609
|
/**
|
|
1420
1610
|
*
|
|
1421
1611
|
* @export
|
|
@@ -1660,6 +1850,43 @@ export interface AnalyticsCategoryWithCount {
|
|
|
1660
1850
|
*/
|
|
1661
1851
|
'value'?: string;
|
|
1662
1852
|
}
|
|
1853
|
+
/**
|
|
1854
|
+
*
|
|
1855
|
+
* @export
|
|
1856
|
+
* @interface AnalyticsClickPositionBucket
|
|
1857
|
+
*/
|
|
1858
|
+
export interface AnalyticsClickPositionBucket {
|
|
1859
|
+
/**
|
|
1860
|
+
*
|
|
1861
|
+
* @type {number}
|
|
1862
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1863
|
+
*/
|
|
1864
|
+
'click_rate'?: number;
|
|
1865
|
+
/**
|
|
1866
|
+
*
|
|
1867
|
+
* @type {number}
|
|
1868
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1869
|
+
*/
|
|
1870
|
+
'clicks'?: number;
|
|
1871
|
+
/**
|
|
1872
|
+
*
|
|
1873
|
+
* @type {number}
|
|
1874
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1875
|
+
*/
|
|
1876
|
+
'impressions'?: number;
|
|
1877
|
+
/**
|
|
1878
|
+
* \"1\", \"2\", \"3\", \"4-5\", \"6-10\", \"11-20\", \"21+\"
|
|
1879
|
+
* @type {string}
|
|
1880
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1881
|
+
*/
|
|
1882
|
+
'position_range'?: string;
|
|
1883
|
+
/**
|
|
1884
|
+
* percentage of total clicks for this query
|
|
1885
|
+
* @type {number}
|
|
1886
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1887
|
+
*/
|
|
1888
|
+
'share'?: number;
|
|
1889
|
+
}
|
|
1663
1890
|
/**
|
|
1664
1891
|
*
|
|
1665
1892
|
* @export
|
|
@@ -2308,6 +2535,43 @@ export interface AnalyticsFilterEffectivenessCategory {
|
|
|
2308
2535
|
*/
|
|
2309
2536
|
'unique_searches'?: number;
|
|
2310
2537
|
}
|
|
2538
|
+
/**
|
|
2539
|
+
*
|
|
2540
|
+
* @export
|
|
2541
|
+
* @interface AnalyticsFilterEffectivenessMetrics
|
|
2542
|
+
*/
|
|
2543
|
+
export interface AnalyticsFilterEffectivenessMetrics {
|
|
2544
|
+
/**
|
|
2545
|
+
*
|
|
2546
|
+
* @type {number}
|
|
2547
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2548
|
+
*/
|
|
2549
|
+
'avg_results_count'?: number;
|
|
2550
|
+
/**
|
|
2551
|
+
*
|
|
2552
|
+
* @type {number}
|
|
2553
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2554
|
+
*/
|
|
2555
|
+
'click_through_rate'?: number;
|
|
2556
|
+
/**
|
|
2557
|
+
*
|
|
2558
|
+
* @type {number}
|
|
2559
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2560
|
+
*/
|
|
2561
|
+
'conversion_rate'?: number;
|
|
2562
|
+
/**
|
|
2563
|
+
*
|
|
2564
|
+
* @type {number}
|
|
2565
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2566
|
+
*/
|
|
2567
|
+
'search_count'?: number;
|
|
2568
|
+
/**
|
|
2569
|
+
* percentage with results > 0
|
|
2570
|
+
* @type {number}
|
|
2571
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2572
|
+
*/
|
|
2573
|
+
'success_rate'?: number;
|
|
2574
|
+
}
|
|
2311
2575
|
/**
|
|
2312
2576
|
*
|
|
2313
2577
|
* @export
|
|
@@ -2351,6 +2615,37 @@ export interface AnalyticsFilterEffectivenessSummary {
|
|
|
2351
2615
|
*/
|
|
2352
2616
|
'total_searches'?: number;
|
|
2353
2617
|
}
|
|
2618
|
+
/**
|
|
2619
|
+
*
|
|
2620
|
+
* @export
|
|
2621
|
+
* @interface AnalyticsFilterImprovementMetrics
|
|
2622
|
+
*/
|
|
2623
|
+
export interface AnalyticsFilterImprovementMetrics {
|
|
2624
|
+
/**
|
|
2625
|
+
* percentage points
|
|
2626
|
+
* @type {number}
|
|
2627
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2628
|
+
*/
|
|
2629
|
+
'conversion_improvement'?: number;
|
|
2630
|
+
/**
|
|
2631
|
+
* percentage points
|
|
2632
|
+
* @type {number}
|
|
2633
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2634
|
+
*/
|
|
2635
|
+
'ctr_improvement'?: number;
|
|
2636
|
+
/**
|
|
2637
|
+
* percentage
|
|
2638
|
+
* @type {number}
|
|
2639
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2640
|
+
*/
|
|
2641
|
+
'results_count_improvement'?: number;
|
|
2642
|
+
/**
|
|
2643
|
+
* percentage points
|
|
2644
|
+
* @type {number}
|
|
2645
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2646
|
+
*/
|
|
2647
|
+
'success_rate_improvement'?: number;
|
|
2648
|
+
}
|
|
2354
2649
|
/**
|
|
2355
2650
|
*
|
|
2356
2651
|
* @export
|
|
@@ -2578,6 +2873,73 @@ export interface AnalyticsFilterValueStatistic {
|
|
|
2578
2873
|
*/
|
|
2579
2874
|
'value_type'?: string;
|
|
2580
2875
|
}
|
|
2876
|
+
/**
|
|
2877
|
+
*
|
|
2878
|
+
* @export
|
|
2879
|
+
* @interface AnalyticsFilterValueUsage
|
|
2880
|
+
*/
|
|
2881
|
+
export interface AnalyticsFilterValueUsage {
|
|
2882
|
+
/**
|
|
2883
|
+
* Position in array (if applicable)
|
|
2884
|
+
* @type {number}
|
|
2885
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2886
|
+
*/
|
|
2887
|
+
'array_index'?: number;
|
|
2888
|
+
/**
|
|
2889
|
+
* Total array size (if applicable)
|
|
2890
|
+
* @type {number}
|
|
2891
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2892
|
+
*/
|
|
2893
|
+
'array_length'?: number;
|
|
2894
|
+
/**
|
|
2895
|
+
*
|
|
2896
|
+
* @type {number}
|
|
2897
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2898
|
+
*/
|
|
2899
|
+
'avg_results_count'?: number;
|
|
2900
|
+
/**
|
|
2901
|
+
* \"array\", \"object\", \"string\"
|
|
2902
|
+
* @type {string}
|
|
2903
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2904
|
+
*/
|
|
2905
|
+
'original_type'?: string;
|
|
2906
|
+
/**
|
|
2907
|
+
* Percentage of total usage for this filter key
|
|
2908
|
+
* @type {number}
|
|
2909
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2910
|
+
*/
|
|
2911
|
+
'share_of_filter_key'?: number;
|
|
2912
|
+
/**
|
|
2913
|
+
*
|
|
2914
|
+
* @type {number}
|
|
2915
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2916
|
+
*/
|
|
2917
|
+
'success_rate'?: number;
|
|
2918
|
+
/**
|
|
2919
|
+
*
|
|
2920
|
+
* @type {number}
|
|
2921
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2922
|
+
*/
|
|
2923
|
+
'unique_searches'?: number;
|
|
2924
|
+
/**
|
|
2925
|
+
*
|
|
2926
|
+
* @type {number}
|
|
2927
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2928
|
+
*/
|
|
2929
|
+
'usage_count'?: number;
|
|
2930
|
+
/**
|
|
2931
|
+
*
|
|
2932
|
+
* @type {string}
|
|
2933
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2934
|
+
*/
|
|
2935
|
+
'value'?: string;
|
|
2936
|
+
/**
|
|
2937
|
+
* \"array_element\", \"object_key\", \"string\", etc.
|
|
2938
|
+
* @type {string}
|
|
2939
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2940
|
+
*/
|
|
2941
|
+
'value_type'?: string;
|
|
2942
|
+
}
|
|
2581
2943
|
/**
|
|
2582
2944
|
*
|
|
2583
2945
|
* @export
|
|
@@ -4674,178 +5036,862 @@ export interface AnalyticsQueryAnalytic {
|
|
|
4674
5036
|
* @type {number}
|
|
4675
5037
|
* @memberof AnalyticsQueryAnalytic
|
|
4676
5038
|
*/
|
|
4677
|
-
'avg_click_position'?: number;
|
|
5039
|
+
'avg_click_position'?: number;
|
|
5040
|
+
/**
|
|
5041
|
+
*
|
|
5042
|
+
* @type {number}
|
|
5043
|
+
* @memberof AnalyticsQueryAnalytic
|
|
5044
|
+
*/
|
|
5045
|
+
'click_through_rate'?: number;
|
|
5046
|
+
/**
|
|
5047
|
+
*
|
|
5048
|
+
* @type {number}
|
|
5049
|
+
* @memberof AnalyticsQueryAnalytic
|
|
5050
|
+
*/
|
|
5051
|
+
'clicks'?: number;
|
|
5052
|
+
/**
|
|
5053
|
+
*
|
|
5054
|
+
* @type {number}
|
|
5055
|
+
* @memberof AnalyticsQueryAnalytic
|
|
5056
|
+
*/
|
|
5057
|
+
'conversion_rate'?: number;
|
|
5058
|
+
/**
|
|
5059
|
+
*
|
|
5060
|
+
* @type {string}
|
|
5061
|
+
* @memberof AnalyticsQueryAnalytic
|
|
5062
|
+
*/
|
|
5063
|
+
'last_seen'?: string;
|
|
5064
|
+
/**
|
|
5065
|
+
*
|
|
5066
|
+
* @type {number}
|
|
5067
|
+
* @memberof AnalyticsQueryAnalytic
|
|
5068
|
+
*/
|
|
5069
|
+
'no_results'?: number;
|
|
5070
|
+
/**
|
|
5071
|
+
*
|
|
5072
|
+
* @type {number}
|
|
5073
|
+
* @memberof AnalyticsQueryAnalytic
|
|
5074
|
+
*/
|
|
5075
|
+
'purchases'?: number;
|
|
5076
|
+
/**
|
|
5077
|
+
*
|
|
5078
|
+
* @type {string}
|
|
5079
|
+
* @memberof AnalyticsQueryAnalytic
|
|
5080
|
+
*/
|
|
5081
|
+
'query'?: string;
|
|
5082
|
+
/**
|
|
5083
|
+
*
|
|
5084
|
+
* @type {number}
|
|
5085
|
+
* @memberof AnalyticsQueryAnalytic
|
|
5086
|
+
*/
|
|
5087
|
+
'revenue'?: number;
|
|
5088
|
+
/**
|
|
5089
|
+
*
|
|
5090
|
+
* @type {{ [key: string]: number; }}
|
|
5091
|
+
* @memberof AnalyticsQueryAnalytic
|
|
5092
|
+
*/
|
|
5093
|
+
'revenue_breakdown'?: {
|
|
5094
|
+
[key: string]: number;
|
|
5095
|
+
};
|
|
5096
|
+
/**
|
|
5097
|
+
*
|
|
5098
|
+
* @type {string}
|
|
5099
|
+
* @memberof AnalyticsQueryAnalytic
|
|
5100
|
+
*/
|
|
5101
|
+
'revenue_currency'?: string;
|
|
5102
|
+
/**
|
|
5103
|
+
*
|
|
5104
|
+
* @type {number}
|
|
5105
|
+
* @memberof AnalyticsQueryAnalytic
|
|
5106
|
+
*/
|
|
5107
|
+
'searches'?: number;
|
|
5108
|
+
/**
|
|
5109
|
+
*
|
|
5110
|
+
* @type {number}
|
|
5111
|
+
* @memberof AnalyticsQueryAnalytic
|
|
5112
|
+
*/
|
|
5113
|
+
'unique_users'?: number;
|
|
5114
|
+
}
|
|
5115
|
+
/**
|
|
5116
|
+
*
|
|
5117
|
+
* @export
|
|
5118
|
+
* @interface AnalyticsQueryFilterAnalytics
|
|
5119
|
+
*/
|
|
5120
|
+
export interface AnalyticsQueryFilterAnalytics {
|
|
5121
|
+
/**
|
|
5122
|
+
* NEW: Individual array element insights
|
|
5123
|
+
* @type {Array<AnalyticsArrayElementAnalytic>}
|
|
5124
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5125
|
+
*/
|
|
5126
|
+
'array_element_analytics'?: Array<AnalyticsArrayElementAnalytic>;
|
|
5127
|
+
/**
|
|
5128
|
+
*
|
|
5129
|
+
* @type {number}
|
|
5130
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5131
|
+
*/
|
|
5132
|
+
'avg_filters_per_search'?: number;
|
|
5133
|
+
/**
|
|
5134
|
+
*
|
|
5135
|
+
* @type {Array<AnalyticsQueryFilterCombination>}
|
|
5136
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5137
|
+
*/
|
|
5138
|
+
'filter_combinations'?: Array<AnalyticsQueryFilterCombination>;
|
|
5139
|
+
/**
|
|
5140
|
+
*
|
|
5141
|
+
* @type {AnalyticsQueryFilterEffectiveness}
|
|
5142
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5143
|
+
*/
|
|
5144
|
+
'filter_effectiveness'?: AnalyticsQueryFilterEffectiveness;
|
|
5145
|
+
/**
|
|
5146
|
+
*
|
|
5147
|
+
* @type {Array<AnalyticsQueryFilterTrend>}
|
|
5148
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5149
|
+
*/
|
|
5150
|
+
'filter_trends'?: Array<AnalyticsQueryFilterTrend>;
|
|
5151
|
+
/**
|
|
5152
|
+
*
|
|
5153
|
+
* @type {number}
|
|
5154
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5155
|
+
*/
|
|
5156
|
+
'filter_usage_rate'?: number;
|
|
5157
|
+
/**
|
|
5158
|
+
* NEW: Enhanced filter usage with array data (removed omitempty to always show field)
|
|
5159
|
+
* @type {Array<AnalyticsQueryFilterUsage>}
|
|
5160
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5161
|
+
*/
|
|
5162
|
+
'popular_filters'?: Array<AnalyticsQueryFilterUsage>;
|
|
5163
|
+
/**
|
|
5164
|
+
*
|
|
5165
|
+
* @type {number}
|
|
5166
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5167
|
+
*/
|
|
5168
|
+
'total_searches_with_filters'?: number;
|
|
5169
|
+
}
|
|
5170
|
+
/**
|
|
5171
|
+
*
|
|
5172
|
+
* @export
|
|
5173
|
+
* @interface AnalyticsQueryFilterCombination
|
|
5174
|
+
*/
|
|
5175
|
+
export interface AnalyticsQueryFilterCombination {
|
|
5176
|
+
/**
|
|
5177
|
+
*
|
|
5178
|
+
* @type {number}
|
|
5179
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5180
|
+
*/
|
|
5181
|
+
'avg_results_count'?: number;
|
|
5182
|
+
/**
|
|
5183
|
+
*
|
|
5184
|
+
* @type {Array<string>}
|
|
5185
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5186
|
+
*/
|
|
5187
|
+
'filters'?: Array<string>;
|
|
5188
|
+
/**
|
|
5189
|
+
* percentage of filtered searches
|
|
5190
|
+
* @type {number}
|
|
5191
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5192
|
+
*/
|
|
5193
|
+
'share'?: number;
|
|
5194
|
+
/**
|
|
5195
|
+
*
|
|
5196
|
+
* @type {number}
|
|
5197
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5198
|
+
*/
|
|
5199
|
+
'success_rate'?: number;
|
|
5200
|
+
/**
|
|
5201
|
+
*
|
|
5202
|
+
* @type {number}
|
|
5203
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5204
|
+
*/
|
|
5205
|
+
'usage_count'?: number;
|
|
5206
|
+
}
|
|
5207
|
+
/**
|
|
5208
|
+
*
|
|
5209
|
+
* @export
|
|
5210
|
+
* @interface AnalyticsQueryFilterEffectiveness
|
|
5211
|
+
*/
|
|
5212
|
+
export interface AnalyticsQueryFilterEffectiveness {
|
|
5213
|
+
/**
|
|
5214
|
+
*
|
|
5215
|
+
* @type {AnalyticsFilterImprovementMetrics}
|
|
5216
|
+
* @memberof AnalyticsQueryFilterEffectiveness
|
|
5217
|
+
*/
|
|
5218
|
+
'improvement'?: AnalyticsFilterImprovementMetrics;
|
|
5219
|
+
/**
|
|
5220
|
+
*
|
|
5221
|
+
* @type {AnalyticsFilterEffectivenessMetrics}
|
|
5222
|
+
* @memberof AnalyticsQueryFilterEffectiveness
|
|
5223
|
+
*/
|
|
5224
|
+
'with_filters'?: AnalyticsFilterEffectivenessMetrics;
|
|
5225
|
+
/**
|
|
5226
|
+
*
|
|
5227
|
+
* @type {AnalyticsFilterEffectivenessMetrics}
|
|
5228
|
+
* @memberof AnalyticsQueryFilterEffectiveness
|
|
5229
|
+
*/
|
|
5230
|
+
'without_filters'?: AnalyticsFilterEffectivenessMetrics;
|
|
5231
|
+
}
|
|
5232
|
+
/**
|
|
5233
|
+
*
|
|
5234
|
+
* @export
|
|
5235
|
+
* @interface AnalyticsQueryFilterTrend
|
|
5236
|
+
*/
|
|
5237
|
+
export interface AnalyticsQueryFilterTrend {
|
|
5238
|
+
/**
|
|
5239
|
+
*
|
|
5240
|
+
* @type {string}
|
|
5241
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5242
|
+
*/
|
|
5243
|
+
'filter_key'?: string;
|
|
5244
|
+
/**
|
|
5245
|
+
*
|
|
5246
|
+
* @type {number}
|
|
5247
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5248
|
+
*/
|
|
5249
|
+
'growth_rate'?: number;
|
|
5250
|
+
/**
|
|
5251
|
+
* \"increasing\", \"decreasing\", \"stable\"
|
|
5252
|
+
* @type {string}
|
|
5253
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5254
|
+
*/
|
|
5255
|
+
'trend'?: string;
|
|
5256
|
+
/**
|
|
5257
|
+
*
|
|
5258
|
+
* @type {Array<AnalyticsTimeSeriesPoint>}
|
|
5259
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5260
|
+
*/
|
|
5261
|
+
'trend_data'?: Array<AnalyticsTimeSeriesPoint>;
|
|
5262
|
+
}
|
|
5263
|
+
/**
|
|
5264
|
+
*
|
|
5265
|
+
* @export
|
|
5266
|
+
* @interface AnalyticsQueryFilterUsage
|
|
5267
|
+
*/
|
|
5268
|
+
export interface AnalyticsQueryFilterUsage {
|
|
5269
|
+
/**
|
|
5270
|
+
* Stats specific to array-type filters
|
|
5271
|
+
* @type {AnalyticsArrayFilterStats}
|
|
5272
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5273
|
+
*/
|
|
5274
|
+
'array_stats'?: AnalyticsArrayFilterStats;
|
|
5275
|
+
/**
|
|
5276
|
+
*
|
|
5277
|
+
* @type {number}
|
|
5278
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5279
|
+
*/
|
|
5280
|
+
'effectiveness_score'?: number;
|
|
5281
|
+
/**
|
|
5282
|
+
*
|
|
5283
|
+
* @type {string}
|
|
5284
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5285
|
+
*/
|
|
5286
|
+
'filter_key'?: string;
|
|
5287
|
+
/**
|
|
5288
|
+
* Individual values with array explosion data
|
|
5289
|
+
* @type {Array<AnalyticsFilterValueUsage>}
|
|
5290
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5291
|
+
*/
|
|
5292
|
+
'filter_values'?: Array<AnalyticsFilterValueUsage>;
|
|
5293
|
+
/**
|
|
5294
|
+
* Total times this filter key was used
|
|
5295
|
+
* @type {number}
|
|
5296
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5297
|
+
*/
|
|
5298
|
+
'total_usage'?: number;
|
|
5299
|
+
/**
|
|
5300
|
+
* Unique searches using this filter
|
|
5301
|
+
* @type {number}
|
|
5302
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5303
|
+
*/
|
|
5304
|
+
'unique_searches'?: number;
|
|
5305
|
+
}
|
|
5306
|
+
/**
|
|
5307
|
+
*
|
|
5308
|
+
* @export
|
|
5309
|
+
* @interface AnalyticsQueryGeoAnalytic
|
|
5310
|
+
*/
|
|
5311
|
+
export interface AnalyticsQueryGeoAnalytic {
|
|
5312
|
+
/**
|
|
5313
|
+
*
|
|
5314
|
+
* @type {string}
|
|
5315
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5316
|
+
*/
|
|
5317
|
+
'city'?: string;
|
|
5318
|
+
/**
|
|
5319
|
+
* Clicks / Results Shown
|
|
5320
|
+
* @type {number}
|
|
5321
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5322
|
+
*/
|
|
5323
|
+
'click_through_rate'?: number;
|
|
5324
|
+
/**
|
|
5325
|
+
* Count of result-click events
|
|
5326
|
+
* @type {number}
|
|
5327
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5328
|
+
*/
|
|
5329
|
+
'clicks'?: number;
|
|
5330
|
+
/**
|
|
5331
|
+
* Conversions / Clicks (CVR)
|
|
5332
|
+
* @type {number}
|
|
5333
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5334
|
+
*/
|
|
5335
|
+
'conversion_rate'?: number;
|
|
5336
|
+
/**
|
|
5337
|
+
* Conversions / Searches
|
|
5338
|
+
* @type {number}
|
|
5339
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5340
|
+
*/
|
|
5341
|
+
'conversion_rate_per_search'?: number;
|
|
5342
|
+
/**
|
|
5343
|
+
* Post-click conversions attributed to search
|
|
5344
|
+
* @type {number}
|
|
5345
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5346
|
+
*/
|
|
5347
|
+
'conversions'?: number;
|
|
5348
|
+
/**
|
|
5349
|
+
*
|
|
5350
|
+
* @type {string}
|
|
5351
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5352
|
+
*/
|
|
5353
|
+
'country'?: string;
|
|
5354
|
+
/**
|
|
5355
|
+
*
|
|
5356
|
+
* @type {string}
|
|
5357
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5358
|
+
*/
|
|
5359
|
+
'country_code'?: string;
|
|
5360
|
+
/**
|
|
5361
|
+
* Searches with results but zero clicks / Results Shown
|
|
5362
|
+
* @type {number}
|
|
5363
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5364
|
+
*/
|
|
5365
|
+
'no_click_rate'?: number;
|
|
5366
|
+
/**
|
|
5367
|
+
* No-result searches / Searches
|
|
5368
|
+
* @type {number}
|
|
5369
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5370
|
+
*/
|
|
5371
|
+
'no_result_rate'?: number;
|
|
5372
|
+
/**
|
|
5373
|
+
*
|
|
5374
|
+
* @type {string}
|
|
5375
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5376
|
+
*/
|
|
5377
|
+
'region'?: string;
|
|
5378
|
+
/**
|
|
5379
|
+
* Count of searches that returned ≥1 result
|
|
5380
|
+
* @type {number}
|
|
5381
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5382
|
+
*/
|
|
5383
|
+
'results_shown'?: number;
|
|
5384
|
+
/**
|
|
5385
|
+
* Sum of attributed revenue
|
|
5386
|
+
* @type {number}
|
|
5387
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5388
|
+
*/
|
|
5389
|
+
'revenue'?: number;
|
|
5390
|
+
/**
|
|
5391
|
+
* Count of search events
|
|
5392
|
+
* @type {number}
|
|
5393
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5394
|
+
*/
|
|
5395
|
+
'searches'?: number;
|
|
5396
|
+
/**
|
|
5397
|
+
* percentage of total searches for this query
|
|
5398
|
+
* @type {number}
|
|
5399
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5400
|
+
*/
|
|
5401
|
+
'share'?: number;
|
|
5402
|
+
/**
|
|
5403
|
+
* Unique users
|
|
5404
|
+
* @type {number}
|
|
5405
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5406
|
+
*/
|
|
5407
|
+
'unique_users'?: number;
|
|
5408
|
+
}
|
|
5409
|
+
/**
|
|
5410
|
+
*
|
|
5411
|
+
* @export
|
|
5412
|
+
* @interface AnalyticsQueryGeoAnalyticsSection
|
|
5413
|
+
*/
|
|
5414
|
+
export interface AnalyticsQueryGeoAnalyticsSection {
|
|
5415
|
+
/**
|
|
5416
|
+
*
|
|
5417
|
+
* @type {Array<AnalyticsQueryGeoAnalytic>}
|
|
5418
|
+
* @memberof AnalyticsQueryGeoAnalyticsSection
|
|
5419
|
+
*/
|
|
5420
|
+
'items'?: Array<AnalyticsQueryGeoAnalytic>;
|
|
5421
|
+
/**
|
|
5422
|
+
*
|
|
5423
|
+
* @type {SeekoraGoSrcAnalyticsPaginationMeta}
|
|
5424
|
+
* @memberof AnalyticsQueryGeoAnalyticsSection
|
|
5425
|
+
*/
|
|
5426
|
+
'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
|
|
5427
|
+
}
|
|
5428
|
+
/**
|
|
5429
|
+
*
|
|
5430
|
+
* @export
|
|
5431
|
+
* @interface AnalyticsQueryInsights
|
|
5432
|
+
*/
|
|
5433
|
+
export interface AnalyticsQueryInsights {
|
|
5434
|
+
/**
|
|
5435
|
+
* Average rank position of clicked results (renamed for clarity)
|
|
5436
|
+
* @type {number}
|
|
5437
|
+
* @memberof AnalyticsQueryInsights
|
|
5438
|
+
*/
|
|
5439
|
+
'avg_click_position'?: number;
|
|
5440
|
+
/**
|
|
5441
|
+
* Average rank of the top result shown per search
|
|
5442
|
+
* @type {number}
|
|
5443
|
+
* @memberof AnalyticsQueryInsights
|
|
5444
|
+
*/
|
|
5445
|
+
'avg_result_rank'?: number;
|
|
5446
|
+
/**
|
|
5447
|
+
*
|
|
5448
|
+
* @type {Array<AnalyticsClickPositionBucket>}
|
|
5449
|
+
* @memberof AnalyticsQueryInsights
|
|
5450
|
+
*/
|
|
5451
|
+
'click_position_histogram'?: Array<AnalyticsClickPositionBucket>;
|
|
5452
|
+
/**
|
|
5453
|
+
* Clicks / Results Shown
|
|
5454
|
+
* @type {number}
|
|
5455
|
+
* @memberof AnalyticsQueryInsights
|
|
5456
|
+
*/
|
|
5457
|
+
'click_through_rate'?: number;
|
|
5458
|
+
/**
|
|
5459
|
+
* Conversions / Clicks (CVR)
|
|
5460
|
+
* @type {number}
|
|
5461
|
+
* @memberof AnalyticsQueryInsights
|
|
5462
|
+
*/
|
|
5463
|
+
'conversion_rate'?: number;
|
|
5464
|
+
/**
|
|
5465
|
+
* Conversions / Searches
|
|
5466
|
+
* @type {number}
|
|
5467
|
+
* @memberof AnalyticsQueryInsights
|
|
5468
|
+
*/
|
|
5469
|
+
'conversion_rate_per_search'?: number;
|
|
5470
|
+
/**
|
|
5471
|
+
* Enhanced filter analytics
|
|
5472
|
+
* @type {AnalyticsQueryFilterAnalytics}
|
|
5473
|
+
* @memberof AnalyticsQueryInsights
|
|
5474
|
+
*/
|
|
5475
|
+
'filter_analytics'?: AnalyticsQueryFilterAnalytics;
|
|
5476
|
+
/**
|
|
5477
|
+
*
|
|
5478
|
+
* @type {AnalyticsQueryGeoAnalyticsSection}
|
|
5479
|
+
* @memberof AnalyticsQueryInsights
|
|
5480
|
+
*/
|
|
5481
|
+
'geo_analytics'?: AnalyticsQueryGeoAnalyticsSection;
|
|
5482
|
+
/**
|
|
5483
|
+
*
|
|
5484
|
+
* @type {string}
|
|
5485
|
+
* @memberof AnalyticsQueryInsights
|
|
5486
|
+
*/
|
|
5487
|
+
'last_searched'?: string;
|
|
5488
|
+
/**
|
|
5489
|
+
* Searches with results but zero clicks / Results Shown
|
|
5490
|
+
* @type {number}
|
|
5491
|
+
* @memberof AnalyticsQueryInsights
|
|
5492
|
+
*/
|
|
5493
|
+
'no_click_rate'?: number;
|
|
5494
|
+
/**
|
|
5495
|
+
* No-result searches / Searches
|
|
5496
|
+
* @type {number}
|
|
5497
|
+
* @memberof AnalyticsQueryInsights
|
|
5498
|
+
*/
|
|
5499
|
+
'no_results_rate'?: number;
|
|
5500
|
+
/**
|
|
5501
|
+
*
|
|
5502
|
+
* @type {AnalyticsQueryPopularFiltersSection}
|
|
5503
|
+
* @memberof AnalyticsQueryInsights
|
|
5504
|
+
*/
|
|
5505
|
+
'popular_filters'?: AnalyticsQueryPopularFiltersSection;
|
|
5506
|
+
/**
|
|
5507
|
+
*
|
|
5508
|
+
* @type {AnalyticsQueryPopularResultsSection}
|
|
5509
|
+
* @memberof AnalyticsQueryInsights
|
|
5510
|
+
*/
|
|
5511
|
+
'popular_results'?: AnalyticsQueryPopularResultsSection;
|
|
5512
|
+
/**
|
|
5513
|
+
*
|
|
5514
|
+
* @type {string}
|
|
5515
|
+
* @memberof AnalyticsQueryInsights
|
|
5516
|
+
*/
|
|
5517
|
+
'query'?: string;
|
|
5518
|
+
/**
|
|
5519
|
+
* Searches that returned ≥1 result
|
|
5520
|
+
* @type {number}
|
|
5521
|
+
* @memberof AnalyticsQueryInsights
|
|
5522
|
+
*/
|
|
5523
|
+
'results_shown'?: number;
|
|
5524
|
+
/**
|
|
5525
|
+
* Count of result-click events
|
|
5526
|
+
* @type {number}
|
|
5527
|
+
* @memberof AnalyticsQueryInsights
|
|
5528
|
+
*/
|
|
5529
|
+
'total_clicks'?: number;
|
|
5530
|
+
/**
|
|
5531
|
+
* Count of conversions
|
|
5532
|
+
* @type {number}
|
|
5533
|
+
* @memberof AnalyticsQueryInsights
|
|
5534
|
+
*/
|
|
5535
|
+
'total_conversions'?: number;
|
|
5536
|
+
/**
|
|
5537
|
+
* Sum of attributed revenue
|
|
5538
|
+
* @type {number}
|
|
5539
|
+
* @memberof AnalyticsQueryInsights
|
|
5540
|
+
*/
|
|
5541
|
+
'total_revenue'?: number;
|
|
5542
|
+
/**
|
|
5543
|
+
*
|
|
5544
|
+
* @type {number}
|
|
5545
|
+
* @memberof AnalyticsQueryInsights
|
|
5546
|
+
*/
|
|
5547
|
+
'total_searches'?: number;
|
|
5548
|
+
/**
|
|
5549
|
+
*
|
|
5550
|
+
* @type {number}
|
|
5551
|
+
* @memberof AnalyticsQueryInsights
|
|
5552
|
+
*/
|
|
5553
|
+
'unique_users'?: number;
|
|
5554
|
+
}
|
|
5555
|
+
/**
|
|
5556
|
+
*
|
|
5557
|
+
* @export
|
|
5558
|
+
* @interface AnalyticsQueryPerformanceAnalytics
|
|
5559
|
+
*/
|
|
5560
|
+
export interface AnalyticsQueryPerformanceAnalytics {
|
|
5561
|
+
/**
|
|
5562
|
+
*
|
|
5563
|
+
* @type {number}
|
|
5564
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5565
|
+
*/
|
|
5566
|
+
'avg_results'?: number;
|
|
5567
|
+
/**
|
|
5568
|
+
*
|
|
5569
|
+
* @type {number}
|
|
5570
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5571
|
+
*/
|
|
5572
|
+
'avg_search_duration_ms'?: number;
|
|
5573
|
+
/**
|
|
5574
|
+
* Item-level metrics
|
|
5575
|
+
* @type {number}
|
|
5576
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5577
|
+
*/
|
|
5578
|
+
'impressions'?: number;
|
|
5579
|
+
/**
|
|
5580
|
+
*
|
|
5581
|
+
* @type {number}
|
|
5582
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5583
|
+
*/
|
|
5584
|
+
'no_results_rate'?: number;
|
|
5585
|
+
/**
|
|
5586
|
+
*
|
|
5587
|
+
* @type {number}
|
|
5588
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5589
|
+
*/
|
|
5590
|
+
'no_results_searches'?: number;
|
|
5591
|
+
/**
|
|
5592
|
+
*
|
|
5593
|
+
* @type {string}
|
|
5594
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5595
|
+
*/
|
|
5596
|
+
'query'?: string;
|
|
5597
|
+
/**
|
|
5598
|
+
*
|
|
5599
|
+
* @type {number}
|
|
5600
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5601
|
+
*/
|
|
5602
|
+
'searches'?: number;
|
|
5603
|
+
/**
|
|
5604
|
+
*
|
|
5605
|
+
* @type {number}
|
|
5606
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5607
|
+
*/
|
|
5608
|
+
'top_10_impressions'?: number;
|
|
5609
|
+
/**
|
|
5610
|
+
*
|
|
5611
|
+
* @type {number}
|
|
5612
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5613
|
+
*/
|
|
5614
|
+
'top_3_impression_rate'?: number;
|
|
5615
|
+
/**
|
|
5616
|
+
*
|
|
5617
|
+
* @type {number}
|
|
5618
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5619
|
+
*/
|
|
5620
|
+
'top_3_impressions'?: number;
|
|
5621
|
+
/**
|
|
5622
|
+
*
|
|
5623
|
+
* @type {number}
|
|
5624
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5625
|
+
*/
|
|
5626
|
+
'total_results'?: number;
|
|
5627
|
+
/**
|
|
5628
|
+
* Context metrics
|
|
5629
|
+
* @type {number}
|
|
5630
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5631
|
+
*/
|
|
5632
|
+
'unique_filters'?: number;
|
|
5633
|
+
/**
|
|
5634
|
+
*
|
|
5635
|
+
* @type {number}
|
|
5636
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5637
|
+
*/
|
|
5638
|
+
'unique_items'?: number;
|
|
5639
|
+
/**
|
|
5640
|
+
*
|
|
5641
|
+
* @type {number}
|
|
5642
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5643
|
+
*/
|
|
5644
|
+
'unique_sorts'?: number;
|
|
5645
|
+
/**
|
|
5646
|
+
*
|
|
5647
|
+
* @type {number}
|
|
5648
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5649
|
+
*/
|
|
5650
|
+
'unique_users'?: number;
|
|
5651
|
+
}
|
|
5652
|
+
/**
|
|
5653
|
+
*
|
|
5654
|
+
* @export
|
|
5655
|
+
* @interface AnalyticsQueryPopularFilter
|
|
5656
|
+
*/
|
|
5657
|
+
export interface AnalyticsQueryPopularFilter {
|
|
5658
|
+
/**
|
|
5659
|
+
* Clicks / Results Shown
|
|
5660
|
+
* @type {number}
|
|
5661
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5662
|
+
*/
|
|
5663
|
+
'click_through_rate'?: number;
|
|
5664
|
+
/**
|
|
5665
|
+
* Count of result-click events
|
|
5666
|
+
* @type {number}
|
|
5667
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5668
|
+
*/
|
|
5669
|
+
'clicks'?: number;
|
|
5670
|
+
/**
|
|
5671
|
+
* Conversions / Clicks (CVR)
|
|
5672
|
+
* @type {number}
|
|
5673
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5674
|
+
*/
|
|
5675
|
+
'conversion_rate'?: number;
|
|
5676
|
+
/**
|
|
5677
|
+
* Conversions / Searches
|
|
5678
|
+
* @type {number}
|
|
5679
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5680
|
+
*/
|
|
5681
|
+
'conversion_rate_per_search'?: number;
|
|
5682
|
+
/**
|
|
5683
|
+
* Post-click conversions attributed to search
|
|
5684
|
+
* @type {number}
|
|
5685
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5686
|
+
*/
|
|
5687
|
+
'conversions'?: number;
|
|
5688
|
+
/**
|
|
5689
|
+
*
|
|
5690
|
+
* @type {string}
|
|
5691
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5692
|
+
*/
|
|
5693
|
+
'filter_key'?: string;
|
|
5694
|
+
/**
|
|
5695
|
+
*
|
|
5696
|
+
* @type {string}
|
|
5697
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5698
|
+
*/
|
|
5699
|
+
'filter_value'?: string;
|
|
5700
|
+
/**
|
|
5701
|
+
* Searches with results but zero clicks / Results Shown
|
|
5702
|
+
* @type {number}
|
|
5703
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5704
|
+
*/
|
|
5705
|
+
'no_click_rate'?: number;
|
|
5706
|
+
/**
|
|
5707
|
+
* No-result searches / Searches
|
|
5708
|
+
* @type {number}
|
|
5709
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5710
|
+
*/
|
|
5711
|
+
'no_result_rate'?: number;
|
|
4678
5712
|
/**
|
|
4679
|
-
*
|
|
5713
|
+
* Count of searches that returned ≥1 result
|
|
4680
5714
|
* @type {number}
|
|
4681
|
-
* @memberof
|
|
5715
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
4682
5716
|
*/
|
|
4683
|
-
'
|
|
5717
|
+
'results_shown'?: number;
|
|
4684
5718
|
/**
|
|
4685
|
-
*
|
|
5719
|
+
* Sum of attributed revenue
|
|
4686
5720
|
* @type {number}
|
|
4687
|
-
* @memberof
|
|
5721
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
4688
5722
|
*/
|
|
4689
|
-
'
|
|
5723
|
+
'revenue'?: number;
|
|
4690
5724
|
/**
|
|
4691
|
-
*
|
|
5725
|
+
* Count of search events with this filter
|
|
4692
5726
|
* @type {number}
|
|
4693
|
-
* @memberof
|
|
5727
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
4694
5728
|
*/
|
|
4695
|
-
'
|
|
5729
|
+
'searches'?: number;
|
|
4696
5730
|
/**
|
|
4697
|
-
*
|
|
4698
|
-
* @type {
|
|
4699
|
-
* @memberof
|
|
5731
|
+
* percentage of searches with this filter
|
|
5732
|
+
* @type {number}
|
|
5733
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
4700
5734
|
*/
|
|
4701
|
-
'
|
|
5735
|
+
'share'?: number;
|
|
4702
5736
|
/**
|
|
4703
|
-
*
|
|
5737
|
+
* Number of times this filter was used
|
|
4704
5738
|
* @type {number}
|
|
4705
|
-
* @memberof
|
|
5739
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
4706
5740
|
*/
|
|
4707
|
-
'
|
|
5741
|
+
'usage_count'?: number;
|
|
5742
|
+
}
|
|
5743
|
+
/**
|
|
5744
|
+
*
|
|
5745
|
+
* @export
|
|
5746
|
+
* @interface AnalyticsQueryPopularFiltersSection
|
|
5747
|
+
*/
|
|
5748
|
+
export interface AnalyticsQueryPopularFiltersSection {
|
|
4708
5749
|
/**
|
|
4709
5750
|
*
|
|
4710
|
-
* @type {
|
|
4711
|
-
* @memberof
|
|
5751
|
+
* @type {Array<AnalyticsQueryPopularFilter>}
|
|
5752
|
+
* @memberof AnalyticsQueryPopularFiltersSection
|
|
4712
5753
|
*/
|
|
4713
|
-
'
|
|
5754
|
+
'items'?: Array<AnalyticsQueryPopularFilter>;
|
|
4714
5755
|
/**
|
|
4715
5756
|
*
|
|
4716
|
-
* @type {
|
|
4717
|
-
* @memberof
|
|
5757
|
+
* @type {SeekoraGoSrcAnalyticsPaginationMeta}
|
|
5758
|
+
* @memberof AnalyticsQueryPopularFiltersSection
|
|
4718
5759
|
*/
|
|
4719
|
-
'
|
|
5760
|
+
'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
|
|
5761
|
+
}
|
|
5762
|
+
/**
|
|
5763
|
+
*
|
|
5764
|
+
* @export
|
|
5765
|
+
* @interface AnalyticsQueryPopularResultWithWidget
|
|
5766
|
+
*/
|
|
5767
|
+
export interface AnalyticsQueryPopularResultWithWidget {
|
|
4720
5768
|
/**
|
|
4721
|
-
*
|
|
5769
|
+
* Average rank position of clicked results
|
|
4722
5770
|
* @type {number}
|
|
4723
|
-
* @memberof
|
|
5771
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4724
5772
|
*/
|
|
4725
|
-
'
|
|
5773
|
+
'avg_click_rank'?: number;
|
|
4726
5774
|
/**
|
|
4727
|
-
*
|
|
4728
|
-
* @type {
|
|
4729
|
-
* @memberof
|
|
5775
|
+
* Same as AvgResultRank (backward compatibility)
|
|
5776
|
+
* @type {number}
|
|
5777
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4730
5778
|
*/
|
|
4731
|
-
'
|
|
4732
|
-
[key: string]: number;
|
|
4733
|
-
};
|
|
5779
|
+
'avg_position'?: number;
|
|
4734
5780
|
/**
|
|
4735
|
-
*
|
|
4736
|
-
* @type {
|
|
4737
|
-
* @memberof
|
|
5781
|
+
* Average rank of the top result shown per search
|
|
5782
|
+
* @type {number}
|
|
5783
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4738
5784
|
*/
|
|
4739
|
-
'
|
|
5785
|
+
'avg_result_rank'?: number;
|
|
4740
5786
|
/**
|
|
4741
|
-
*
|
|
5787
|
+
* Clicks / Results Shown
|
|
4742
5788
|
* @type {number}
|
|
4743
|
-
* @memberof
|
|
5789
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4744
5790
|
*/
|
|
4745
|
-
'
|
|
5791
|
+
'click_through_rate'?: number;
|
|
4746
5792
|
/**
|
|
4747
|
-
*
|
|
5793
|
+
* Count of result-click events
|
|
4748
5794
|
* @type {number}
|
|
4749
|
-
* @memberof
|
|
5795
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4750
5796
|
*/
|
|
4751
|
-
'
|
|
4752
|
-
}
|
|
4753
|
-
/**
|
|
4754
|
-
*
|
|
4755
|
-
* @export
|
|
4756
|
-
* @interface AnalyticsQueryPerformanceAnalytics
|
|
4757
|
-
*/
|
|
4758
|
-
export interface AnalyticsQueryPerformanceAnalytics {
|
|
5797
|
+
'clicks'?: number;
|
|
4759
5798
|
/**
|
|
4760
|
-
*
|
|
5799
|
+
* Conversions / Clicks (CVR)
|
|
4761
5800
|
* @type {number}
|
|
4762
|
-
* @memberof
|
|
5801
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4763
5802
|
*/
|
|
4764
|
-
'
|
|
5803
|
+
'conversion_rate'?: number;
|
|
4765
5804
|
/**
|
|
4766
|
-
*
|
|
5805
|
+
* Conversions / Searches
|
|
4767
5806
|
* @type {number}
|
|
4768
|
-
* @memberof
|
|
5807
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4769
5808
|
*/
|
|
4770
|
-
'
|
|
5809
|
+
'conversion_rate_per_search'?: number;
|
|
4771
5810
|
/**
|
|
4772
|
-
*
|
|
5811
|
+
* Post-click conversions attributed to search
|
|
4773
5812
|
* @type {number}
|
|
4774
|
-
* @memberof
|
|
5813
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4775
5814
|
*/
|
|
4776
|
-
'
|
|
5815
|
+
'conversions'?: number;
|
|
4777
5816
|
/**
|
|
4778
|
-
*
|
|
5817
|
+
* Count of times item was shown
|
|
4779
5818
|
* @type {number}
|
|
4780
|
-
* @memberof
|
|
5819
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4781
5820
|
*/
|
|
4782
|
-
'
|
|
5821
|
+
'impressions'?: number;
|
|
4783
5822
|
/**
|
|
4784
5823
|
*
|
|
4785
|
-
* @type {
|
|
4786
|
-
* @memberof
|
|
5824
|
+
* @type {string}
|
|
5825
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4787
5826
|
*/
|
|
4788
|
-
'
|
|
5827
|
+
'item_id'?: string;
|
|
4789
5828
|
/**
|
|
4790
5829
|
*
|
|
4791
5830
|
* @type {string}
|
|
4792
|
-
* @memberof
|
|
5831
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4793
5832
|
*/
|
|
4794
|
-
'
|
|
5833
|
+
'item_name'?: string;
|
|
4795
5834
|
/**
|
|
4796
|
-
*
|
|
5835
|
+
* Searches with results but zero clicks / Results Shown
|
|
4797
5836
|
* @type {number}
|
|
4798
|
-
* @memberof
|
|
5837
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4799
5838
|
*/
|
|
4800
|
-
'
|
|
5839
|
+
'no_click_rate'?: number;
|
|
4801
5840
|
/**
|
|
4802
|
-
*
|
|
5841
|
+
* No-result searches / Searches
|
|
4803
5842
|
* @type {number}
|
|
4804
|
-
* @memberof
|
|
5843
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4805
5844
|
*/
|
|
4806
|
-
'
|
|
5845
|
+
'no_result_rate'?: number;
|
|
4807
5846
|
/**
|
|
4808
|
-
*
|
|
5847
|
+
* Count of searches that returned ≥1 result
|
|
4809
5848
|
* @type {number}
|
|
4810
|
-
* @memberof
|
|
5849
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4811
5850
|
*/
|
|
4812
|
-
'
|
|
5851
|
+
'results_shown'?: number;
|
|
4813
5852
|
/**
|
|
4814
|
-
*
|
|
5853
|
+
* Sum of attributed revenue
|
|
4815
5854
|
* @type {number}
|
|
4816
|
-
* @memberof
|
|
5855
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4817
5856
|
*/
|
|
4818
|
-
'
|
|
5857
|
+
'revenue'?: number;
|
|
4819
5858
|
/**
|
|
4820
|
-
*
|
|
5859
|
+
* Count of search events
|
|
4821
5860
|
* @type {number}
|
|
4822
|
-
* @memberof
|
|
5861
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4823
5862
|
*/
|
|
4824
|
-
'
|
|
5863
|
+
'searches'?: number;
|
|
4825
5864
|
/**
|
|
4826
|
-
*
|
|
5865
|
+
* percentage of total impressions for this query
|
|
4827
5866
|
* @type {number}
|
|
4828
|
-
* @memberof
|
|
5867
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4829
5868
|
*/
|
|
4830
|
-
'
|
|
5869
|
+
'share'?: number;
|
|
4831
5870
|
/**
|
|
4832
|
-
*
|
|
4833
|
-
* @type {
|
|
4834
|
-
* @memberof
|
|
5871
|
+
* Widget display fields
|
|
5872
|
+
* @type {AnalyticsWidgetData}
|
|
5873
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4835
5874
|
*/
|
|
4836
|
-
'
|
|
5875
|
+
'widget'?: AnalyticsWidgetData;
|
|
5876
|
+
}
|
|
5877
|
+
/**
|
|
5878
|
+
*
|
|
5879
|
+
* @export
|
|
5880
|
+
* @interface AnalyticsQueryPopularResultsSection
|
|
5881
|
+
*/
|
|
5882
|
+
export interface AnalyticsQueryPopularResultsSection {
|
|
4837
5883
|
/**
|
|
4838
5884
|
*
|
|
4839
|
-
* @type {
|
|
4840
|
-
* @memberof
|
|
5885
|
+
* @type {Array<AnalyticsQueryPopularResultWithWidget>}
|
|
5886
|
+
* @memberof AnalyticsQueryPopularResultsSection
|
|
4841
5887
|
*/
|
|
4842
|
-
'
|
|
5888
|
+
'items'?: Array<AnalyticsQueryPopularResultWithWidget>;
|
|
4843
5889
|
/**
|
|
4844
5890
|
*
|
|
4845
|
-
* @type {
|
|
4846
|
-
* @memberof
|
|
5891
|
+
* @type {SeekoraGoSrcAnalyticsPaginationMeta}
|
|
5892
|
+
* @memberof AnalyticsQueryPopularResultsSection
|
|
4847
5893
|
*/
|
|
4848
|
-
'
|
|
5894
|
+
'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
|
|
4849
5895
|
}
|
|
4850
5896
|
/**
|
|
4851
5897
|
*
|
|
@@ -21413,6 +22459,41 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
21413
22459
|
* @throws {RequiredError}
|
|
21414
22460
|
*/
|
|
21415
22461
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: (xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22462
|
+
/**
|
|
22463
|
+
* 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
|
|
22464
|
+
* @summary Get Query Insights
|
|
22465
|
+
* @param {string} xStoreID Store ID
|
|
22466
|
+
* @param {string} query Search query to analyze
|
|
22467
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
22468
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
22469
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
22470
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
22471
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
22472
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
22473
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
22474
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
22475
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
22476
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
22477
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
22478
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
22479
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
22480
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
22481
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
22482
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22483
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
22484
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
22485
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
22486
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22487
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
22488
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22489
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22490
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22491
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22492
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
22493
|
+
* @param {*} [options] Override http request option.
|
|
22494
|
+
* @throws {RequiredError}
|
|
22495
|
+
*/
|
|
22496
|
+
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<RequestArgs>;
|
|
21416
22497
|
/**
|
|
21417
22498
|
* 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.
|
|
21418
22499
|
* @summary Get Top Results Analytics
|
|
@@ -21818,6 +22899,41 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
21818
22899
|
* @throws {RequiredError}
|
|
21819
22900
|
*/
|
|
21820
22901
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>>;
|
|
22902
|
+
/**
|
|
22903
|
+
* 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
|
|
22904
|
+
* @summary Get Query Insights
|
|
22905
|
+
* @param {string} xStoreID Store ID
|
|
22906
|
+
* @param {string} query Search query to analyze
|
|
22907
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
22908
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
22909
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
22910
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
22911
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
22912
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
22913
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
22914
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
22915
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
22916
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
22917
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
22918
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
22919
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
22920
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
22921
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
22922
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22923
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
22924
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
22925
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
22926
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22927
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
22928
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22929
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22930
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22931
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22932
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
22933
|
+
* @param {*} [options] Override http request option.
|
|
22934
|
+
* @throws {RequiredError}
|
|
22935
|
+
*/
|
|
22936
|
+
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>>;
|
|
21821
22937
|
/**
|
|
21822
22938
|
* 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.
|
|
21823
22939
|
* @summary Get Top Results Analytics
|
|
@@ -22223,6 +23339,41 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
22223
23339
|
* @throws {RequiredError}
|
|
22224
23340
|
*/
|
|
22225
23341
|
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>;
|
|
23342
|
+
/**
|
|
23343
|
+
* 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
|
|
23344
|
+
* @summary Get Query Insights
|
|
23345
|
+
* @param {string} xStoreID Store ID
|
|
23346
|
+
* @param {string} query Search query to analyze
|
|
23347
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
23348
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
23349
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
23350
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
23351
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
23352
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
23353
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
23354
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
23355
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
23356
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
23357
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
23358
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
23359
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
23360
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
23361
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
23362
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
23363
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
23364
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
23365
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
23366
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
23367
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
23368
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
23369
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
23370
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
23371
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
23372
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
23373
|
+
* @param {*} [options] Override http request option.
|
|
23374
|
+
* @throws {RequiredError}
|
|
23375
|
+
*/
|
|
23376
|
+
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>;
|
|
22226
23377
|
/**
|
|
22227
23378
|
* 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.
|
|
22228
23379
|
* @summary Get Top Results Analytics
|
|
@@ -22644,6 +23795,42 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
22644
23795
|
* @memberof AnalyticsApi
|
|
22645
23796
|
*/
|
|
22646
23797
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response, any, {}>>;
|
|
23798
|
+
/**
|
|
23799
|
+
* 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
|
|
23800
|
+
* @summary Get Query Insights
|
|
23801
|
+
* @param {string} xStoreID Store ID
|
|
23802
|
+
* @param {string} query Search query to analyze
|
|
23803
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
23804
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
23805
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
23806
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
23807
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
23808
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
23809
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
23810
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
23811
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
23812
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
23813
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
23814
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
23815
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
23816
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
23817
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
23818
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
23819
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
23820
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
23821
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
23822
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
23823
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
23824
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
23825
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
23826
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
23827
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
23828
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
23829
|
+
* @param {*} [options] Override http request option.
|
|
23830
|
+
* @throws {RequiredError}
|
|
23831
|
+
* @memberof AnalyticsApi
|
|
23832
|
+
*/
|
|
23833
|
+
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any, {}>>;
|
|
22647
23834
|
/**
|
|
22648
23835
|
* 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.
|
|
22649
23836
|
* @summary Get Top Results Analytics
|
|
@@ -23055,6 +24242,22 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum
|
|
|
23055
24242
|
readonly Desc: "desc";
|
|
23056
24243
|
};
|
|
23057
24244
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
24245
|
+
/**
|
|
24246
|
+
* @export
|
|
24247
|
+
*/
|
|
24248
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum: {
|
|
24249
|
+
readonly Any: "any";
|
|
24250
|
+
readonly All: "all";
|
|
24251
|
+
};
|
|
24252
|
+
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum];
|
|
24253
|
+
/**
|
|
24254
|
+
* @export
|
|
24255
|
+
*/
|
|
24256
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum: {
|
|
24257
|
+
readonly Any: "any";
|
|
24258
|
+
readonly All: "all";
|
|
24259
|
+
};
|
|
24260
|
+
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum];
|
|
23058
24261
|
/**
|
|
23059
24262
|
* @export
|
|
23060
24263
|
*/
|