@seekora-ai/admin-api 1.1.15 → 1.1.17
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 +26 -2
- package/api.ts +1578 -113
- package/dist/api.d.ts +1332 -52
- package/dist/api.js +344 -5
- package/dist/esm/api.d.ts +1332 -52
- package/dist/esm/api.js +339 -0
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.17.tgz +0 -0
- package/seekora-ai-admin-api-1.1.15.tgz +0 -0
package/api.ts
CHANGED
|
@@ -711,6 +711,49 @@ export interface AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response {
|
|
|
711
711
|
*/
|
|
712
712
|
'total'?: number;
|
|
713
713
|
}
|
|
714
|
+
/**
|
|
715
|
+
*
|
|
716
|
+
* @export
|
|
717
|
+
* @interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
718
|
+
*/
|
|
719
|
+
export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
|
|
720
|
+
/**
|
|
721
|
+
* Comparison metadata when in compare mode
|
|
722
|
+
* @type {AnalyticsComparisonMeta}
|
|
723
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
724
|
+
*/
|
|
725
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
726
|
+
/**
|
|
727
|
+
*
|
|
728
|
+
* @type {AnalyticsQueryInsights}
|
|
729
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
730
|
+
*/
|
|
731
|
+
'data'?: AnalyticsQueryInsights;
|
|
732
|
+
/**
|
|
733
|
+
*
|
|
734
|
+
* @type {string}
|
|
735
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
736
|
+
*/
|
|
737
|
+
'error'?: string;
|
|
738
|
+
/**
|
|
739
|
+
*
|
|
740
|
+
* @type {string}
|
|
741
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
742
|
+
*/
|
|
743
|
+
'status'?: string;
|
|
744
|
+
/**
|
|
745
|
+
*
|
|
746
|
+
* @type {string}
|
|
747
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
748
|
+
*/
|
|
749
|
+
'timestamp'?: string;
|
|
750
|
+
/**
|
|
751
|
+
*
|
|
752
|
+
* @type {number}
|
|
753
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
754
|
+
*/
|
|
755
|
+
'total'?: number;
|
|
756
|
+
}
|
|
714
757
|
/**
|
|
715
758
|
*
|
|
716
759
|
* @export
|
|
@@ -1424,6 +1467,153 @@ export interface AnalyticsAnalyticsAPIResponse {
|
|
|
1424
1467
|
*/
|
|
1425
1468
|
'total'?: number;
|
|
1426
1469
|
}
|
|
1470
|
+
/**
|
|
1471
|
+
*
|
|
1472
|
+
* @export
|
|
1473
|
+
* @interface AnalyticsArrayElementAnalytic
|
|
1474
|
+
*/
|
|
1475
|
+
export interface AnalyticsArrayElementAnalytic {
|
|
1476
|
+
/**
|
|
1477
|
+
* Position in array (0-based)
|
|
1478
|
+
* @type {number}
|
|
1479
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1480
|
+
*/
|
|
1481
|
+
'array_index'?: number;
|
|
1482
|
+
/**
|
|
1483
|
+
* Total array size
|
|
1484
|
+
* @type {number}
|
|
1485
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1486
|
+
*/
|
|
1487
|
+
'array_length'?: number;
|
|
1488
|
+
/**
|
|
1489
|
+
* Average results when this element is used
|
|
1490
|
+
* @type {number}
|
|
1491
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1492
|
+
*/
|
|
1493
|
+
'avg_results_count'?: number;
|
|
1494
|
+
/**
|
|
1495
|
+
* e.g., \"tags\"
|
|
1496
|
+
* @type {string}
|
|
1497
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1498
|
+
*/
|
|
1499
|
+
'filter_key'?: string;
|
|
1500
|
+
/**
|
|
1501
|
+
* e.g., \"fashion\"
|
|
1502
|
+
* @type {string}
|
|
1503
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1504
|
+
*/
|
|
1505
|
+
'filter_value'?: string;
|
|
1506
|
+
/**
|
|
1507
|
+
* \"array\", \"object\", \"string\"
|
|
1508
|
+
* @type {string}
|
|
1509
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1510
|
+
*/
|
|
1511
|
+
'original_type'?: string;
|
|
1512
|
+
/**
|
|
1513
|
+
* How often this element appears at this position
|
|
1514
|
+
* @type {number}
|
|
1515
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1516
|
+
*/
|
|
1517
|
+
'position_popularity'?: number;
|
|
1518
|
+
/**
|
|
1519
|
+
* Percentage with results > 0
|
|
1520
|
+
* @type {number}
|
|
1521
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1522
|
+
*/
|
|
1523
|
+
'success_rate'?: number;
|
|
1524
|
+
/**
|
|
1525
|
+
* Unique searches using this element
|
|
1526
|
+
* @type {number}
|
|
1527
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1528
|
+
*/
|
|
1529
|
+
'unique_searches'?: number;
|
|
1530
|
+
/**
|
|
1531
|
+
* How many times this element was used
|
|
1532
|
+
* @type {number}
|
|
1533
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1534
|
+
*/
|
|
1535
|
+
'usage_count'?: number;
|
|
1536
|
+
/**
|
|
1537
|
+
* \"array_element\", \"object_key\", etc.
|
|
1538
|
+
* @type {string}
|
|
1539
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1540
|
+
*/
|
|
1541
|
+
'value_type'?: string;
|
|
1542
|
+
}
|
|
1543
|
+
/**
|
|
1544
|
+
*
|
|
1545
|
+
* @export
|
|
1546
|
+
* @interface AnalyticsArrayFilterStats
|
|
1547
|
+
*/
|
|
1548
|
+
export interface AnalyticsArrayFilterStats {
|
|
1549
|
+
/**
|
|
1550
|
+
* Average array size
|
|
1551
|
+
* @type {number}
|
|
1552
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1553
|
+
*/
|
|
1554
|
+
'avg_array_length'?: number;
|
|
1555
|
+
/**
|
|
1556
|
+
* Largest array seen
|
|
1557
|
+
* @type {number}
|
|
1558
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1559
|
+
*/
|
|
1560
|
+
'max_array_length'?: number;
|
|
1561
|
+
/**
|
|
1562
|
+
* Top values across all arrays
|
|
1563
|
+
* @type {Array<string>}
|
|
1564
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1565
|
+
*/
|
|
1566
|
+
'most_popular_values'?: Array<string>;
|
|
1567
|
+
/**
|
|
1568
|
+
* Usage by array position
|
|
1569
|
+
* @type {Array<AnalyticsArrayPositionAnalytic>}
|
|
1570
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1571
|
+
*/
|
|
1572
|
+
'position_analytics'?: Array<AnalyticsArrayPositionAnalytic>;
|
|
1573
|
+
/**
|
|
1574
|
+
* Total times arrays were used for this filter
|
|
1575
|
+
* @type {number}
|
|
1576
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1577
|
+
*/
|
|
1578
|
+
'total_array_usage'?: number;
|
|
1579
|
+
}
|
|
1580
|
+
/**
|
|
1581
|
+
*
|
|
1582
|
+
* @export
|
|
1583
|
+
* @interface AnalyticsArrayPositionAnalytic
|
|
1584
|
+
*/
|
|
1585
|
+
export interface AnalyticsArrayPositionAnalytic {
|
|
1586
|
+
/**
|
|
1587
|
+
* Most popular value at this position
|
|
1588
|
+
* @type {string}
|
|
1589
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1590
|
+
*/
|
|
1591
|
+
'popular_value'?: string;
|
|
1592
|
+
/**
|
|
1593
|
+
* 0-based array position
|
|
1594
|
+
* @type {number}
|
|
1595
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1596
|
+
*/
|
|
1597
|
+
'position'?: number;
|
|
1598
|
+
/**
|
|
1599
|
+
* Success rate for searches with values at this position
|
|
1600
|
+
* @type {number}
|
|
1601
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1602
|
+
*/
|
|
1603
|
+
'success_rate'?: number;
|
|
1604
|
+
/**
|
|
1605
|
+
* Unique values at this position
|
|
1606
|
+
* @type {number}
|
|
1607
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1608
|
+
*/
|
|
1609
|
+
'unique_values'?: number;
|
|
1610
|
+
/**
|
|
1611
|
+
* Times this position was used
|
|
1612
|
+
* @type {number}
|
|
1613
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1614
|
+
*/
|
|
1615
|
+
'usage_count'?: number;
|
|
1616
|
+
}
|
|
1427
1617
|
/**
|
|
1428
1618
|
*
|
|
1429
1619
|
* @export
|
|
@@ -1678,6 +1868,43 @@ export interface AnalyticsCategoryWithCount {
|
|
|
1678
1868
|
*/
|
|
1679
1869
|
'value'?: string;
|
|
1680
1870
|
}
|
|
1871
|
+
/**
|
|
1872
|
+
*
|
|
1873
|
+
* @export
|
|
1874
|
+
* @interface AnalyticsClickPositionBucket
|
|
1875
|
+
*/
|
|
1876
|
+
export interface AnalyticsClickPositionBucket {
|
|
1877
|
+
/**
|
|
1878
|
+
*
|
|
1879
|
+
* @type {number}
|
|
1880
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1881
|
+
*/
|
|
1882
|
+
'click_rate'?: number;
|
|
1883
|
+
/**
|
|
1884
|
+
*
|
|
1885
|
+
* @type {number}
|
|
1886
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1887
|
+
*/
|
|
1888
|
+
'clicks'?: number;
|
|
1889
|
+
/**
|
|
1890
|
+
*
|
|
1891
|
+
* @type {number}
|
|
1892
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1893
|
+
*/
|
|
1894
|
+
'impressions'?: number;
|
|
1895
|
+
/**
|
|
1896
|
+
* \"1\", \"2\", \"3\", \"4-5\", \"6-10\", \"11-20\", \"21+\"
|
|
1897
|
+
* @type {string}
|
|
1898
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1899
|
+
*/
|
|
1900
|
+
'position_range'?: string;
|
|
1901
|
+
/**
|
|
1902
|
+
* percentage of total clicks for this query
|
|
1903
|
+
* @type {number}
|
|
1904
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1905
|
+
*/
|
|
1906
|
+
'share'?: number;
|
|
1907
|
+
}
|
|
1681
1908
|
/**
|
|
1682
1909
|
*
|
|
1683
1910
|
* @export
|
|
@@ -2316,6 +2543,43 @@ export interface AnalyticsFilterEffectivenessCategory {
|
|
|
2316
2543
|
*/
|
|
2317
2544
|
'unique_searches'?: number;
|
|
2318
2545
|
}
|
|
2546
|
+
/**
|
|
2547
|
+
*
|
|
2548
|
+
* @export
|
|
2549
|
+
* @interface AnalyticsFilterEffectivenessMetrics
|
|
2550
|
+
*/
|
|
2551
|
+
export interface AnalyticsFilterEffectivenessMetrics {
|
|
2552
|
+
/**
|
|
2553
|
+
*
|
|
2554
|
+
* @type {number}
|
|
2555
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2556
|
+
*/
|
|
2557
|
+
'avg_results_count'?: number;
|
|
2558
|
+
/**
|
|
2559
|
+
*
|
|
2560
|
+
* @type {number}
|
|
2561
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2562
|
+
*/
|
|
2563
|
+
'click_through_rate'?: number;
|
|
2564
|
+
/**
|
|
2565
|
+
*
|
|
2566
|
+
* @type {number}
|
|
2567
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2568
|
+
*/
|
|
2569
|
+
'conversion_rate'?: number;
|
|
2570
|
+
/**
|
|
2571
|
+
*
|
|
2572
|
+
* @type {number}
|
|
2573
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2574
|
+
*/
|
|
2575
|
+
'search_count'?: number;
|
|
2576
|
+
/**
|
|
2577
|
+
* percentage with results > 0
|
|
2578
|
+
* @type {number}
|
|
2579
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2580
|
+
*/
|
|
2581
|
+
'success_rate'?: number;
|
|
2582
|
+
}
|
|
2319
2583
|
/**
|
|
2320
2584
|
*
|
|
2321
2585
|
* @export
|
|
@@ -2359,6 +2623,37 @@ export interface AnalyticsFilterEffectivenessSummary {
|
|
|
2359
2623
|
*/
|
|
2360
2624
|
'total_searches'?: number;
|
|
2361
2625
|
}
|
|
2626
|
+
/**
|
|
2627
|
+
*
|
|
2628
|
+
* @export
|
|
2629
|
+
* @interface AnalyticsFilterImprovementMetrics
|
|
2630
|
+
*/
|
|
2631
|
+
export interface AnalyticsFilterImprovementMetrics {
|
|
2632
|
+
/**
|
|
2633
|
+
* percentage points
|
|
2634
|
+
* @type {number}
|
|
2635
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2636
|
+
*/
|
|
2637
|
+
'conversion_improvement'?: number;
|
|
2638
|
+
/**
|
|
2639
|
+
* percentage points
|
|
2640
|
+
* @type {number}
|
|
2641
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2642
|
+
*/
|
|
2643
|
+
'ctr_improvement'?: number;
|
|
2644
|
+
/**
|
|
2645
|
+
* percentage
|
|
2646
|
+
* @type {number}
|
|
2647
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2648
|
+
*/
|
|
2649
|
+
'results_count_improvement'?: number;
|
|
2650
|
+
/**
|
|
2651
|
+
* percentage points
|
|
2652
|
+
* @type {number}
|
|
2653
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2654
|
+
*/
|
|
2655
|
+
'success_rate_improvement'?: number;
|
|
2656
|
+
}
|
|
2362
2657
|
/**
|
|
2363
2658
|
*
|
|
2364
2659
|
* @export
|
|
@@ -2584,6 +2879,73 @@ export interface AnalyticsFilterValueStatistic {
|
|
|
2584
2879
|
*/
|
|
2585
2880
|
'value_type'?: string;
|
|
2586
2881
|
}
|
|
2882
|
+
/**
|
|
2883
|
+
*
|
|
2884
|
+
* @export
|
|
2885
|
+
* @interface AnalyticsFilterValueUsage
|
|
2886
|
+
*/
|
|
2887
|
+
export interface AnalyticsFilterValueUsage {
|
|
2888
|
+
/**
|
|
2889
|
+
* Position in array (if applicable)
|
|
2890
|
+
* @type {number}
|
|
2891
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2892
|
+
*/
|
|
2893
|
+
'array_index'?: number;
|
|
2894
|
+
/**
|
|
2895
|
+
* Total array size (if applicable)
|
|
2896
|
+
* @type {number}
|
|
2897
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2898
|
+
*/
|
|
2899
|
+
'array_length'?: number;
|
|
2900
|
+
/**
|
|
2901
|
+
*
|
|
2902
|
+
* @type {number}
|
|
2903
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2904
|
+
*/
|
|
2905
|
+
'avg_results_count'?: number;
|
|
2906
|
+
/**
|
|
2907
|
+
* \"array\", \"object\", \"string\"
|
|
2908
|
+
* @type {string}
|
|
2909
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2910
|
+
*/
|
|
2911
|
+
'original_type'?: string;
|
|
2912
|
+
/**
|
|
2913
|
+
* Percentage of total usage for this filter key
|
|
2914
|
+
* @type {number}
|
|
2915
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2916
|
+
*/
|
|
2917
|
+
'share_of_filter_key'?: number;
|
|
2918
|
+
/**
|
|
2919
|
+
*
|
|
2920
|
+
* @type {number}
|
|
2921
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2922
|
+
*/
|
|
2923
|
+
'success_rate'?: number;
|
|
2924
|
+
/**
|
|
2925
|
+
*
|
|
2926
|
+
* @type {number}
|
|
2927
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2928
|
+
*/
|
|
2929
|
+
'unique_searches'?: number;
|
|
2930
|
+
/**
|
|
2931
|
+
*
|
|
2932
|
+
* @type {number}
|
|
2933
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2934
|
+
*/
|
|
2935
|
+
'usage_count'?: number;
|
|
2936
|
+
/**
|
|
2937
|
+
*
|
|
2938
|
+
* @type {string}
|
|
2939
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2940
|
+
*/
|
|
2941
|
+
'value'?: string;
|
|
2942
|
+
/**
|
|
2943
|
+
* \"array_element\", \"object_key\", \"string\", etc.
|
|
2944
|
+
* @type {string}
|
|
2945
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2946
|
+
*/
|
|
2947
|
+
'value_type'?: string;
|
|
2948
|
+
}
|
|
2587
2949
|
/**
|
|
2588
2950
|
*
|
|
2589
2951
|
* @export
|
|
@@ -4747,99 +5109,783 @@ export interface AnalyticsQueryAnalytic {
|
|
|
4747
5109
|
/**
|
|
4748
5110
|
*
|
|
4749
5111
|
* @export
|
|
4750
|
-
* @interface
|
|
5112
|
+
* @interface AnalyticsQueryFilterAnalytics
|
|
4751
5113
|
*/
|
|
4752
|
-
export interface
|
|
5114
|
+
export interface AnalyticsQueryFilterAnalytics {
|
|
4753
5115
|
/**
|
|
4754
|
-
*
|
|
4755
|
-
* @type {
|
|
4756
|
-
* @memberof
|
|
5116
|
+
* NEW: Individual array element insights
|
|
5117
|
+
* @type {Array<AnalyticsArrayElementAnalytic>}
|
|
5118
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
4757
5119
|
*/
|
|
4758
|
-
'
|
|
5120
|
+
'array_element_analytics'?: Array<AnalyticsArrayElementAnalytic>;
|
|
4759
5121
|
/**
|
|
4760
5122
|
*
|
|
4761
5123
|
* @type {number}
|
|
4762
|
-
* @memberof
|
|
5124
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
4763
5125
|
*/
|
|
4764
|
-
'
|
|
5126
|
+
'avg_filters_per_search'?: number;
|
|
5127
|
+
/**
|
|
5128
|
+
*
|
|
5129
|
+
* @type {Array<AnalyticsQueryFilterCombination>}
|
|
5130
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5131
|
+
*/
|
|
5132
|
+
'filter_combinations'?: Array<AnalyticsQueryFilterCombination>;
|
|
5133
|
+
/**
|
|
5134
|
+
*
|
|
5135
|
+
* @type {AnalyticsQueryFilterEffectiveness}
|
|
5136
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5137
|
+
*/
|
|
5138
|
+
'filter_effectiveness'?: AnalyticsQueryFilterEffectiveness;
|
|
5139
|
+
/**
|
|
5140
|
+
*
|
|
5141
|
+
* @type {Array<AnalyticsQueryFilterTrend>}
|
|
5142
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5143
|
+
*/
|
|
5144
|
+
'filter_trends'?: Array<AnalyticsQueryFilterTrend>;
|
|
5145
|
+
/**
|
|
5146
|
+
*
|
|
5147
|
+
* @type {number}
|
|
5148
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5149
|
+
*/
|
|
5150
|
+
'filter_usage_rate'?: number;
|
|
5151
|
+
/**
|
|
5152
|
+
* NEW: Enhanced filter usage with array data (removed omitempty to always show field)
|
|
5153
|
+
* @type {Array<AnalyticsQueryFilterUsage>}
|
|
5154
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5155
|
+
*/
|
|
5156
|
+
'popular_filters'?: Array<AnalyticsQueryFilterUsage>;
|
|
5157
|
+
/**
|
|
5158
|
+
*
|
|
5159
|
+
* @type {number}
|
|
5160
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5161
|
+
*/
|
|
5162
|
+
'total_searches_with_filters'?: number;
|
|
5163
|
+
}
|
|
5164
|
+
/**
|
|
5165
|
+
*
|
|
5166
|
+
* @export
|
|
5167
|
+
* @interface AnalyticsQueryFilterCombination
|
|
5168
|
+
*/
|
|
5169
|
+
export interface AnalyticsQueryFilterCombination {
|
|
5170
|
+
/**
|
|
5171
|
+
*
|
|
5172
|
+
* @type {number}
|
|
5173
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5174
|
+
*/
|
|
5175
|
+
'avg_results_count'?: number;
|
|
5176
|
+
/**
|
|
5177
|
+
*
|
|
5178
|
+
* @type {Array<string>}
|
|
5179
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5180
|
+
*/
|
|
5181
|
+
'filters'?: Array<string>;
|
|
5182
|
+
/**
|
|
5183
|
+
* percentage of filtered searches
|
|
5184
|
+
* @type {number}
|
|
5185
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5186
|
+
*/
|
|
5187
|
+
'share'?: number;
|
|
5188
|
+
/**
|
|
5189
|
+
*
|
|
5190
|
+
* @type {number}
|
|
5191
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5192
|
+
*/
|
|
5193
|
+
'success_rate'?: number;
|
|
5194
|
+
/**
|
|
5195
|
+
*
|
|
5196
|
+
* @type {number}
|
|
5197
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5198
|
+
*/
|
|
5199
|
+
'usage_count'?: number;
|
|
5200
|
+
}
|
|
5201
|
+
/**
|
|
5202
|
+
*
|
|
5203
|
+
* @export
|
|
5204
|
+
* @interface AnalyticsQueryFilterEffectiveness
|
|
5205
|
+
*/
|
|
5206
|
+
export interface AnalyticsQueryFilterEffectiveness {
|
|
5207
|
+
/**
|
|
5208
|
+
*
|
|
5209
|
+
* @type {AnalyticsFilterImprovementMetrics}
|
|
5210
|
+
* @memberof AnalyticsQueryFilterEffectiveness
|
|
5211
|
+
*/
|
|
5212
|
+
'improvement'?: AnalyticsFilterImprovementMetrics;
|
|
5213
|
+
/**
|
|
5214
|
+
*
|
|
5215
|
+
* @type {AnalyticsFilterEffectivenessMetrics}
|
|
5216
|
+
* @memberof AnalyticsQueryFilterEffectiveness
|
|
5217
|
+
*/
|
|
5218
|
+
'with_filters'?: AnalyticsFilterEffectivenessMetrics;
|
|
5219
|
+
/**
|
|
5220
|
+
*
|
|
5221
|
+
* @type {AnalyticsFilterEffectivenessMetrics}
|
|
5222
|
+
* @memberof AnalyticsQueryFilterEffectiveness
|
|
5223
|
+
*/
|
|
5224
|
+
'without_filters'?: AnalyticsFilterEffectivenessMetrics;
|
|
5225
|
+
}
|
|
5226
|
+
/**
|
|
5227
|
+
*
|
|
5228
|
+
* @export
|
|
5229
|
+
* @interface AnalyticsQueryFilterTrend
|
|
5230
|
+
*/
|
|
5231
|
+
export interface AnalyticsQueryFilterTrend {
|
|
5232
|
+
/**
|
|
5233
|
+
*
|
|
5234
|
+
* @type {string}
|
|
5235
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5236
|
+
*/
|
|
5237
|
+
'filter_key'?: string;
|
|
5238
|
+
/**
|
|
5239
|
+
*
|
|
5240
|
+
* @type {number}
|
|
5241
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5242
|
+
*/
|
|
5243
|
+
'growth_rate'?: number;
|
|
5244
|
+
/**
|
|
5245
|
+
* \"increasing\", \"decreasing\", \"stable\"
|
|
5246
|
+
* @type {string}
|
|
5247
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5248
|
+
*/
|
|
5249
|
+
'trend'?: string;
|
|
5250
|
+
/**
|
|
5251
|
+
*
|
|
5252
|
+
* @type {Array<AnalyticsTimeSeriesPoint>}
|
|
5253
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5254
|
+
*/
|
|
5255
|
+
'trend_data'?: Array<AnalyticsTimeSeriesPoint>;
|
|
5256
|
+
}
|
|
5257
|
+
/**
|
|
5258
|
+
*
|
|
5259
|
+
* @export
|
|
5260
|
+
* @interface AnalyticsQueryFilterUsage
|
|
5261
|
+
*/
|
|
5262
|
+
export interface AnalyticsQueryFilterUsage {
|
|
5263
|
+
/**
|
|
5264
|
+
* Stats specific to array-type filters
|
|
5265
|
+
* @type {AnalyticsArrayFilterStats}
|
|
5266
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5267
|
+
*/
|
|
5268
|
+
'array_stats'?: AnalyticsArrayFilterStats;
|
|
5269
|
+
/**
|
|
5270
|
+
*
|
|
5271
|
+
* @type {number}
|
|
5272
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5273
|
+
*/
|
|
5274
|
+
'effectiveness_score'?: number;
|
|
5275
|
+
/**
|
|
5276
|
+
*
|
|
5277
|
+
* @type {string}
|
|
5278
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5279
|
+
*/
|
|
5280
|
+
'filter_key'?: string;
|
|
5281
|
+
/**
|
|
5282
|
+
* Individual values with array explosion data
|
|
5283
|
+
* @type {Array<AnalyticsFilterValueUsage>}
|
|
5284
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5285
|
+
*/
|
|
5286
|
+
'filter_values'?: Array<AnalyticsFilterValueUsage>;
|
|
5287
|
+
/**
|
|
5288
|
+
* Total times this filter key was used
|
|
5289
|
+
* @type {number}
|
|
5290
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5291
|
+
*/
|
|
5292
|
+
'total_usage'?: number;
|
|
5293
|
+
/**
|
|
5294
|
+
* Unique searches using this filter
|
|
5295
|
+
* @type {number}
|
|
5296
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5297
|
+
*/
|
|
5298
|
+
'unique_searches'?: number;
|
|
5299
|
+
}
|
|
5300
|
+
/**
|
|
5301
|
+
*
|
|
5302
|
+
* @export
|
|
5303
|
+
* @interface AnalyticsQueryGeoAnalytic
|
|
5304
|
+
*/
|
|
5305
|
+
export interface AnalyticsQueryGeoAnalytic {
|
|
5306
|
+
/**
|
|
5307
|
+
*
|
|
5308
|
+
* @type {string}
|
|
5309
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5310
|
+
*/
|
|
5311
|
+
'city'?: string;
|
|
5312
|
+
/**
|
|
5313
|
+
* Clicks / Results Shown
|
|
5314
|
+
* @type {number}
|
|
5315
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5316
|
+
*/
|
|
5317
|
+
'click_through_rate'?: number;
|
|
5318
|
+
/**
|
|
5319
|
+
* Count of result-click events
|
|
5320
|
+
* @type {number}
|
|
5321
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5322
|
+
*/
|
|
5323
|
+
'clicks'?: number;
|
|
5324
|
+
/**
|
|
5325
|
+
* Conversions / Clicks (CVR)
|
|
5326
|
+
* @type {number}
|
|
5327
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5328
|
+
*/
|
|
5329
|
+
'conversion_rate'?: number;
|
|
5330
|
+
/**
|
|
5331
|
+
* Conversions / Searches
|
|
5332
|
+
* @type {number}
|
|
5333
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5334
|
+
*/
|
|
5335
|
+
'conversion_rate_per_search'?: number;
|
|
5336
|
+
/**
|
|
5337
|
+
* Post-click conversions attributed to search
|
|
5338
|
+
* @type {number}
|
|
5339
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5340
|
+
*/
|
|
5341
|
+
'conversions'?: number;
|
|
5342
|
+
/**
|
|
5343
|
+
*
|
|
5344
|
+
* @type {string}
|
|
5345
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5346
|
+
*/
|
|
5347
|
+
'country'?: string;
|
|
5348
|
+
/**
|
|
5349
|
+
*
|
|
5350
|
+
* @type {string}
|
|
5351
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5352
|
+
*/
|
|
5353
|
+
'country_code'?: string;
|
|
5354
|
+
/**
|
|
5355
|
+
* Searches with results but zero clicks / Results Shown
|
|
5356
|
+
* @type {number}
|
|
5357
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5358
|
+
*/
|
|
5359
|
+
'no_click_rate'?: number;
|
|
5360
|
+
/**
|
|
5361
|
+
* No-result searches / Searches
|
|
5362
|
+
* @type {number}
|
|
5363
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5364
|
+
*/
|
|
5365
|
+
'no_result_rate'?: number;
|
|
5366
|
+
/**
|
|
5367
|
+
*
|
|
5368
|
+
* @type {string}
|
|
5369
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5370
|
+
*/
|
|
5371
|
+
'region'?: string;
|
|
5372
|
+
/**
|
|
5373
|
+
* Count of searches that returned ≥1 result
|
|
5374
|
+
* @type {number}
|
|
5375
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5376
|
+
*/
|
|
5377
|
+
'results_shown'?: number;
|
|
5378
|
+
/**
|
|
5379
|
+
* Sum of attributed revenue
|
|
5380
|
+
* @type {number}
|
|
5381
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5382
|
+
*/
|
|
5383
|
+
'revenue'?: number;
|
|
5384
|
+
/**
|
|
5385
|
+
* Count of search events
|
|
5386
|
+
* @type {number}
|
|
5387
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5388
|
+
*/
|
|
5389
|
+
'searches'?: number;
|
|
5390
|
+
/**
|
|
5391
|
+
* percentage of total searches for this query
|
|
5392
|
+
* @type {number}
|
|
5393
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5394
|
+
*/
|
|
5395
|
+
'share'?: number;
|
|
5396
|
+
/**
|
|
5397
|
+
* Unique users
|
|
5398
|
+
* @type {number}
|
|
5399
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5400
|
+
*/
|
|
5401
|
+
'unique_users'?: number;
|
|
5402
|
+
}
|
|
5403
|
+
/**
|
|
5404
|
+
*
|
|
5405
|
+
* @export
|
|
5406
|
+
* @interface AnalyticsQueryGeoAnalyticsSection
|
|
5407
|
+
*/
|
|
5408
|
+
export interface AnalyticsQueryGeoAnalyticsSection {
|
|
5409
|
+
/**
|
|
5410
|
+
*
|
|
5411
|
+
* @type {Array<AnalyticsQueryGeoAnalytic>}
|
|
5412
|
+
* @memberof AnalyticsQueryGeoAnalyticsSection
|
|
5413
|
+
*/
|
|
5414
|
+
'items'?: Array<AnalyticsQueryGeoAnalytic>;
|
|
5415
|
+
/**
|
|
5416
|
+
*
|
|
5417
|
+
* @type {SeekoraGoSrcAnalyticsPaginationMeta}
|
|
5418
|
+
* @memberof AnalyticsQueryGeoAnalyticsSection
|
|
5419
|
+
*/
|
|
5420
|
+
'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
|
|
5421
|
+
}
|
|
5422
|
+
/**
|
|
5423
|
+
*
|
|
5424
|
+
* @export
|
|
5425
|
+
* @interface AnalyticsQueryInsights
|
|
5426
|
+
*/
|
|
5427
|
+
export interface AnalyticsQueryInsights {
|
|
5428
|
+
/**
|
|
5429
|
+
* Average rank position of clicked results (renamed for clarity)
|
|
5430
|
+
* @type {number}
|
|
5431
|
+
* @memberof AnalyticsQueryInsights
|
|
5432
|
+
*/
|
|
5433
|
+
'avg_click_position'?: number;
|
|
5434
|
+
/**
|
|
5435
|
+
* Average rank of the top result shown per search
|
|
5436
|
+
* @type {number}
|
|
5437
|
+
* @memberof AnalyticsQueryInsights
|
|
5438
|
+
*/
|
|
5439
|
+
'avg_result_rank'?: number;
|
|
5440
|
+
/**
|
|
5441
|
+
*
|
|
5442
|
+
* @type {Array<AnalyticsClickPositionBucket>}
|
|
5443
|
+
* @memberof AnalyticsQueryInsights
|
|
5444
|
+
*/
|
|
5445
|
+
'click_position_histogram'?: Array<AnalyticsClickPositionBucket>;
|
|
5446
|
+
/**
|
|
5447
|
+
* Clicks / Results Shown
|
|
5448
|
+
* @type {number}
|
|
5449
|
+
* @memberof AnalyticsQueryInsights
|
|
5450
|
+
*/
|
|
5451
|
+
'click_through_rate'?: number;
|
|
5452
|
+
/**
|
|
5453
|
+
* Conversions / Clicks (CVR)
|
|
5454
|
+
* @type {number}
|
|
5455
|
+
* @memberof AnalyticsQueryInsights
|
|
5456
|
+
*/
|
|
5457
|
+
'conversion_rate'?: number;
|
|
5458
|
+
/**
|
|
5459
|
+
* Conversions / Searches
|
|
5460
|
+
* @type {number}
|
|
5461
|
+
* @memberof AnalyticsQueryInsights
|
|
5462
|
+
*/
|
|
5463
|
+
'conversion_rate_per_search'?: number;
|
|
5464
|
+
/**
|
|
5465
|
+
* Enhanced filter analytics
|
|
5466
|
+
* @type {AnalyticsQueryFilterAnalytics}
|
|
5467
|
+
* @memberof AnalyticsQueryInsights
|
|
5468
|
+
*/
|
|
5469
|
+
'filter_analytics'?: AnalyticsQueryFilterAnalytics;
|
|
5470
|
+
/**
|
|
5471
|
+
*
|
|
5472
|
+
* @type {AnalyticsQueryGeoAnalyticsSection}
|
|
5473
|
+
* @memberof AnalyticsQueryInsights
|
|
5474
|
+
*/
|
|
5475
|
+
'geo_analytics'?: AnalyticsQueryGeoAnalyticsSection;
|
|
5476
|
+
/**
|
|
5477
|
+
*
|
|
5478
|
+
* @type {string}
|
|
5479
|
+
* @memberof AnalyticsQueryInsights
|
|
5480
|
+
*/
|
|
5481
|
+
'last_searched'?: string;
|
|
5482
|
+
/**
|
|
5483
|
+
* Searches with results but zero clicks / Results Shown
|
|
5484
|
+
* @type {number}
|
|
5485
|
+
* @memberof AnalyticsQueryInsights
|
|
5486
|
+
*/
|
|
5487
|
+
'no_click_rate'?: number;
|
|
5488
|
+
/**
|
|
5489
|
+
* No-result searches / Searches
|
|
5490
|
+
* @type {number}
|
|
5491
|
+
* @memberof AnalyticsQueryInsights
|
|
5492
|
+
*/
|
|
5493
|
+
'no_results_rate'?: number;
|
|
5494
|
+
/**
|
|
5495
|
+
*
|
|
5496
|
+
* @type {AnalyticsQueryPopularFiltersSection}
|
|
5497
|
+
* @memberof AnalyticsQueryInsights
|
|
5498
|
+
*/
|
|
5499
|
+
'popular_filters'?: AnalyticsQueryPopularFiltersSection;
|
|
5500
|
+
/**
|
|
5501
|
+
*
|
|
5502
|
+
* @type {AnalyticsQueryPopularResultsSection}
|
|
5503
|
+
* @memberof AnalyticsQueryInsights
|
|
5504
|
+
*/
|
|
5505
|
+
'popular_results'?: AnalyticsQueryPopularResultsSection;
|
|
5506
|
+
/**
|
|
5507
|
+
*
|
|
5508
|
+
* @type {string}
|
|
5509
|
+
* @memberof AnalyticsQueryInsights
|
|
5510
|
+
*/
|
|
5511
|
+
'query'?: string;
|
|
5512
|
+
/**
|
|
5513
|
+
* Searches that returned ≥1 result
|
|
5514
|
+
* @type {number}
|
|
5515
|
+
* @memberof AnalyticsQueryInsights
|
|
5516
|
+
*/
|
|
5517
|
+
'results_shown'?: number;
|
|
5518
|
+
/**
|
|
5519
|
+
* Count of result-click events
|
|
5520
|
+
* @type {number}
|
|
5521
|
+
* @memberof AnalyticsQueryInsights
|
|
5522
|
+
*/
|
|
5523
|
+
'total_clicks'?: number;
|
|
5524
|
+
/**
|
|
5525
|
+
* Count of conversions
|
|
5526
|
+
* @type {number}
|
|
5527
|
+
* @memberof AnalyticsQueryInsights
|
|
5528
|
+
*/
|
|
5529
|
+
'total_conversions'?: number;
|
|
5530
|
+
/**
|
|
5531
|
+
* Sum of attributed revenue
|
|
5532
|
+
* @type {number}
|
|
5533
|
+
* @memberof AnalyticsQueryInsights
|
|
5534
|
+
*/
|
|
5535
|
+
'total_revenue'?: number;
|
|
5536
|
+
/**
|
|
5537
|
+
*
|
|
5538
|
+
* @type {number}
|
|
5539
|
+
* @memberof AnalyticsQueryInsights
|
|
5540
|
+
*/
|
|
5541
|
+
'total_searches'?: number;
|
|
5542
|
+
/**
|
|
5543
|
+
*
|
|
5544
|
+
* @type {number}
|
|
5545
|
+
* @memberof AnalyticsQueryInsights
|
|
5546
|
+
*/
|
|
5547
|
+
'unique_users'?: number;
|
|
5548
|
+
}
|
|
5549
|
+
/**
|
|
5550
|
+
*
|
|
5551
|
+
* @export
|
|
5552
|
+
* @interface AnalyticsQueryPerformanceAnalytics
|
|
5553
|
+
*/
|
|
5554
|
+
export interface AnalyticsQueryPerformanceAnalytics {
|
|
5555
|
+
/**
|
|
5556
|
+
*
|
|
5557
|
+
* @type {number}
|
|
5558
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5559
|
+
*/
|
|
5560
|
+
'avg_results'?: number;
|
|
5561
|
+
/**
|
|
5562
|
+
*
|
|
5563
|
+
* @type {number}
|
|
5564
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5565
|
+
*/
|
|
5566
|
+
'avg_search_duration_ms'?: number;
|
|
4765
5567
|
/**
|
|
4766
5568
|
* Item-level metrics
|
|
4767
5569
|
* @type {number}
|
|
4768
|
-
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5570
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5571
|
+
*/
|
|
5572
|
+
'impressions'?: number;
|
|
5573
|
+
/**
|
|
5574
|
+
*
|
|
5575
|
+
* @type {number}
|
|
5576
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5577
|
+
*/
|
|
5578
|
+
'no_results_rate'?: number;
|
|
5579
|
+
/**
|
|
5580
|
+
*
|
|
5581
|
+
* @type {number}
|
|
5582
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5583
|
+
*/
|
|
5584
|
+
'no_results_searches'?: number;
|
|
5585
|
+
/**
|
|
5586
|
+
*
|
|
5587
|
+
* @type {string}
|
|
5588
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5589
|
+
*/
|
|
5590
|
+
'query'?: string;
|
|
5591
|
+
/**
|
|
5592
|
+
*
|
|
5593
|
+
* @type {number}
|
|
5594
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5595
|
+
*/
|
|
5596
|
+
'searches'?: number;
|
|
5597
|
+
/**
|
|
5598
|
+
*
|
|
5599
|
+
* @type {number}
|
|
5600
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5601
|
+
*/
|
|
5602
|
+
'top_10_impressions'?: number;
|
|
5603
|
+
/**
|
|
5604
|
+
*
|
|
5605
|
+
* @type {number}
|
|
5606
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5607
|
+
*/
|
|
5608
|
+
'top_3_impression_rate'?: number;
|
|
5609
|
+
/**
|
|
5610
|
+
*
|
|
5611
|
+
* @type {number}
|
|
5612
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5613
|
+
*/
|
|
5614
|
+
'top_3_impressions'?: number;
|
|
5615
|
+
/**
|
|
5616
|
+
*
|
|
5617
|
+
* @type {number}
|
|
5618
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5619
|
+
*/
|
|
5620
|
+
'total_results'?: number;
|
|
5621
|
+
/**
|
|
5622
|
+
* Context metrics
|
|
5623
|
+
* @type {number}
|
|
5624
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5625
|
+
*/
|
|
5626
|
+
'unique_filters'?: number;
|
|
5627
|
+
/**
|
|
5628
|
+
*
|
|
5629
|
+
* @type {number}
|
|
5630
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5631
|
+
*/
|
|
5632
|
+
'unique_items'?: number;
|
|
5633
|
+
/**
|
|
5634
|
+
*
|
|
5635
|
+
* @type {number}
|
|
5636
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5637
|
+
*/
|
|
5638
|
+
'unique_sorts'?: number;
|
|
5639
|
+
/**
|
|
5640
|
+
*
|
|
5641
|
+
* @type {number}
|
|
5642
|
+
* @memberof AnalyticsQueryPerformanceAnalytics
|
|
5643
|
+
*/
|
|
5644
|
+
'unique_users'?: number;
|
|
5645
|
+
}
|
|
5646
|
+
/**
|
|
5647
|
+
*
|
|
5648
|
+
* @export
|
|
5649
|
+
* @interface AnalyticsQueryPopularFilter
|
|
5650
|
+
*/
|
|
5651
|
+
export interface AnalyticsQueryPopularFilter {
|
|
5652
|
+
/**
|
|
5653
|
+
* Clicks / Results Shown
|
|
5654
|
+
* @type {number}
|
|
5655
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5656
|
+
*/
|
|
5657
|
+
'click_through_rate'?: number;
|
|
5658
|
+
/**
|
|
5659
|
+
* Count of result-click events
|
|
5660
|
+
* @type {number}
|
|
5661
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5662
|
+
*/
|
|
5663
|
+
'clicks'?: number;
|
|
5664
|
+
/**
|
|
5665
|
+
* Conversions / Clicks (CVR)
|
|
5666
|
+
* @type {number}
|
|
5667
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5668
|
+
*/
|
|
5669
|
+
'conversion_rate'?: number;
|
|
5670
|
+
/**
|
|
5671
|
+
* Conversions / Searches
|
|
5672
|
+
* @type {number}
|
|
5673
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5674
|
+
*/
|
|
5675
|
+
'conversion_rate_per_search'?: number;
|
|
5676
|
+
/**
|
|
5677
|
+
* Post-click conversions attributed to search
|
|
5678
|
+
* @type {number}
|
|
5679
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5680
|
+
*/
|
|
5681
|
+
'conversions'?: number;
|
|
5682
|
+
/**
|
|
5683
|
+
*
|
|
5684
|
+
* @type {string}
|
|
5685
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5686
|
+
*/
|
|
5687
|
+
'filter_key'?: string;
|
|
5688
|
+
/**
|
|
5689
|
+
*
|
|
5690
|
+
* @type {string}
|
|
5691
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5692
|
+
*/
|
|
5693
|
+
'filter_value'?: string;
|
|
5694
|
+
/**
|
|
5695
|
+
* Searches with results but zero clicks / Results Shown
|
|
5696
|
+
* @type {number}
|
|
5697
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5698
|
+
*/
|
|
5699
|
+
'no_click_rate'?: number;
|
|
5700
|
+
/**
|
|
5701
|
+
* No-result searches / Searches
|
|
5702
|
+
* @type {number}
|
|
5703
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5704
|
+
*/
|
|
5705
|
+
'no_result_rate'?: number;
|
|
5706
|
+
/**
|
|
5707
|
+
* Count of searches that returned ≥1 result
|
|
5708
|
+
* @type {number}
|
|
5709
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5710
|
+
*/
|
|
5711
|
+
'results_shown'?: number;
|
|
5712
|
+
/**
|
|
5713
|
+
* Sum of attributed revenue
|
|
5714
|
+
* @type {number}
|
|
5715
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5716
|
+
*/
|
|
5717
|
+
'revenue'?: number;
|
|
5718
|
+
/**
|
|
5719
|
+
* Count of search events with this filter
|
|
5720
|
+
* @type {number}
|
|
5721
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5722
|
+
*/
|
|
5723
|
+
'searches'?: number;
|
|
5724
|
+
/**
|
|
5725
|
+
* percentage of searches with this filter
|
|
5726
|
+
* @type {number}
|
|
5727
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5728
|
+
*/
|
|
5729
|
+
'share'?: number;
|
|
5730
|
+
/**
|
|
5731
|
+
* Number of times this filter was used
|
|
5732
|
+
* @type {number}
|
|
5733
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5734
|
+
*/
|
|
5735
|
+
'usage_count'?: number;
|
|
5736
|
+
}
|
|
5737
|
+
/**
|
|
5738
|
+
*
|
|
5739
|
+
* @export
|
|
5740
|
+
* @interface AnalyticsQueryPopularFiltersSection
|
|
5741
|
+
*/
|
|
5742
|
+
export interface AnalyticsQueryPopularFiltersSection {
|
|
5743
|
+
/**
|
|
5744
|
+
*
|
|
5745
|
+
* @type {Array<AnalyticsQueryPopularFilter>}
|
|
5746
|
+
* @memberof AnalyticsQueryPopularFiltersSection
|
|
5747
|
+
*/
|
|
5748
|
+
'items'?: Array<AnalyticsQueryPopularFilter>;
|
|
5749
|
+
/**
|
|
5750
|
+
*
|
|
5751
|
+
* @type {SeekoraGoSrcAnalyticsPaginationMeta}
|
|
5752
|
+
* @memberof AnalyticsQueryPopularFiltersSection
|
|
5753
|
+
*/
|
|
5754
|
+
'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
|
|
5755
|
+
}
|
|
5756
|
+
/**
|
|
5757
|
+
*
|
|
5758
|
+
* @export
|
|
5759
|
+
* @interface AnalyticsQueryPopularResultWithWidget
|
|
5760
|
+
*/
|
|
5761
|
+
export interface AnalyticsQueryPopularResultWithWidget {
|
|
5762
|
+
/**
|
|
5763
|
+
* Average rank position of clicked results
|
|
5764
|
+
* @type {number}
|
|
5765
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5766
|
+
*/
|
|
5767
|
+
'avg_click_rank'?: number;
|
|
5768
|
+
/**
|
|
5769
|
+
* Same as AvgResultRank (backward compatibility)
|
|
5770
|
+
* @type {number}
|
|
5771
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5772
|
+
*/
|
|
5773
|
+
'avg_position'?: number;
|
|
5774
|
+
/**
|
|
5775
|
+
* Average rank of the top result shown per search
|
|
5776
|
+
* @type {number}
|
|
5777
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5778
|
+
*/
|
|
5779
|
+
'avg_result_rank'?: number;
|
|
5780
|
+
/**
|
|
5781
|
+
* Clicks / Results Shown
|
|
5782
|
+
* @type {number}
|
|
5783
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5784
|
+
*/
|
|
5785
|
+
'click_through_rate'?: number;
|
|
5786
|
+
/**
|
|
5787
|
+
* Count of result-click events
|
|
5788
|
+
* @type {number}
|
|
5789
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5790
|
+
*/
|
|
5791
|
+
'clicks'?: number;
|
|
5792
|
+
/**
|
|
5793
|
+
* Conversions / Clicks (CVR)
|
|
5794
|
+
* @type {number}
|
|
5795
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5796
|
+
*/
|
|
5797
|
+
'conversion_rate'?: number;
|
|
5798
|
+
/**
|
|
5799
|
+
* Conversions / Searches
|
|
5800
|
+
* @type {number}
|
|
5801
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5802
|
+
*/
|
|
5803
|
+
'conversion_rate_per_search'?: number;
|
|
5804
|
+
/**
|
|
5805
|
+
* Post-click conversions attributed to search
|
|
5806
|
+
* @type {number}
|
|
5807
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4769
5808
|
*/
|
|
4770
|
-
'
|
|
5809
|
+
'conversions'?: number;
|
|
4771
5810
|
/**
|
|
4772
|
-
*
|
|
5811
|
+
* Count of times item was shown
|
|
4773
5812
|
* @type {number}
|
|
4774
|
-
* @memberof
|
|
5813
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4775
5814
|
*/
|
|
4776
|
-
'
|
|
5815
|
+
'impressions'?: number;
|
|
4777
5816
|
/**
|
|
4778
5817
|
*
|
|
4779
|
-
* @type {
|
|
4780
|
-
* @memberof
|
|
5818
|
+
* @type {string}
|
|
5819
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4781
5820
|
*/
|
|
4782
|
-
'
|
|
5821
|
+
'item_id'?: string;
|
|
4783
5822
|
/**
|
|
4784
5823
|
*
|
|
4785
5824
|
* @type {string}
|
|
4786
|
-
* @memberof
|
|
5825
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4787
5826
|
*/
|
|
4788
|
-
'
|
|
5827
|
+
'item_name'?: string;
|
|
4789
5828
|
/**
|
|
4790
|
-
*
|
|
5829
|
+
* Searches with results but zero clicks / Results Shown
|
|
4791
5830
|
* @type {number}
|
|
4792
|
-
* @memberof
|
|
5831
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4793
5832
|
*/
|
|
4794
|
-
'
|
|
5833
|
+
'no_click_rate'?: number;
|
|
4795
5834
|
/**
|
|
4796
|
-
*
|
|
5835
|
+
* No-result searches / Searches
|
|
4797
5836
|
* @type {number}
|
|
4798
|
-
* @memberof
|
|
5837
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4799
5838
|
*/
|
|
4800
|
-
'
|
|
5839
|
+
'no_result_rate'?: number;
|
|
4801
5840
|
/**
|
|
4802
|
-
*
|
|
5841
|
+
* Count of searches that returned ≥1 result
|
|
4803
5842
|
* @type {number}
|
|
4804
|
-
* @memberof
|
|
5843
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4805
5844
|
*/
|
|
4806
|
-
'
|
|
5845
|
+
'results_shown'?: number;
|
|
4807
5846
|
/**
|
|
4808
|
-
*
|
|
5847
|
+
* Sum of attributed revenue
|
|
4809
5848
|
* @type {number}
|
|
4810
|
-
* @memberof
|
|
5849
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4811
5850
|
*/
|
|
4812
|
-
'
|
|
5851
|
+
'revenue'?: number;
|
|
4813
5852
|
/**
|
|
4814
|
-
*
|
|
5853
|
+
* Count of search events
|
|
4815
5854
|
* @type {number}
|
|
4816
|
-
* @memberof
|
|
5855
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4817
5856
|
*/
|
|
4818
|
-
'
|
|
5857
|
+
'searches'?: number;
|
|
4819
5858
|
/**
|
|
4820
|
-
*
|
|
5859
|
+
* percentage of total impressions for this query
|
|
4821
5860
|
* @type {number}
|
|
4822
|
-
* @memberof
|
|
5861
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4823
5862
|
*/
|
|
4824
|
-
'
|
|
5863
|
+
'share'?: number;
|
|
4825
5864
|
/**
|
|
4826
|
-
*
|
|
4827
|
-
* @type {
|
|
4828
|
-
* @memberof
|
|
5865
|
+
* Widget display fields
|
|
5866
|
+
* @type {AnalyticsWidgetData}
|
|
5867
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
4829
5868
|
*/
|
|
4830
|
-
'
|
|
5869
|
+
'widget'?: AnalyticsWidgetData;
|
|
5870
|
+
}
|
|
5871
|
+
/**
|
|
5872
|
+
*
|
|
5873
|
+
* @export
|
|
5874
|
+
* @interface AnalyticsQueryPopularResultsSection
|
|
5875
|
+
*/
|
|
5876
|
+
export interface AnalyticsQueryPopularResultsSection {
|
|
4831
5877
|
/**
|
|
4832
5878
|
*
|
|
4833
|
-
* @type {
|
|
4834
|
-
* @memberof
|
|
5879
|
+
* @type {Array<AnalyticsQueryPopularResultWithWidget>}
|
|
5880
|
+
* @memberof AnalyticsQueryPopularResultsSection
|
|
4835
5881
|
*/
|
|
4836
|
-
'
|
|
5882
|
+
'items'?: Array<AnalyticsQueryPopularResultWithWidget>;
|
|
4837
5883
|
/**
|
|
4838
5884
|
*
|
|
4839
|
-
* @type {
|
|
4840
|
-
* @memberof
|
|
5885
|
+
* @type {SeekoraGoSrcAnalyticsPaginationMeta}
|
|
5886
|
+
* @memberof AnalyticsQueryPopularResultsSection
|
|
4841
5887
|
*/
|
|
4842
|
-
'
|
|
5888
|
+
'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
|
|
4843
5889
|
}
|
|
4844
5890
|
/**
|
|
4845
5891
|
*
|
|
@@ -5752,6 +6798,50 @@ export const AnalyticsRuleType = {
|
|
|
5752
6798
|
export type AnalyticsRuleType = typeof AnalyticsRuleType[keyof typeof AnalyticsRuleType];
|
|
5753
6799
|
|
|
5754
6800
|
|
|
6801
|
+
/**
|
|
6802
|
+
*
|
|
6803
|
+
* @export
|
|
6804
|
+
* @interface AnalyticsSearchCount
|
|
6805
|
+
*/
|
|
6806
|
+
export interface AnalyticsSearchCount {
|
|
6807
|
+
/**
|
|
6808
|
+
*
|
|
6809
|
+
* @type {number}
|
|
6810
|
+
* @memberof AnalyticsSearchCount
|
|
6811
|
+
*/
|
|
6812
|
+
'count'?: number;
|
|
6813
|
+
/**
|
|
6814
|
+
*
|
|
6815
|
+
* @type {string}
|
|
6816
|
+
* @memberof AnalyticsSearchCount
|
|
6817
|
+
*/
|
|
6818
|
+
'date'?: string;
|
|
6819
|
+
}
|
|
6820
|
+
/**
|
|
6821
|
+
*
|
|
6822
|
+
* @export
|
|
6823
|
+
* @interface AnalyticsSearchCountResponse
|
|
6824
|
+
*/
|
|
6825
|
+
export interface AnalyticsSearchCountResponse {
|
|
6826
|
+
/**
|
|
6827
|
+
*
|
|
6828
|
+
* @type {Array<AnalyticsSearchCount>}
|
|
6829
|
+
* @memberof AnalyticsSearchCountResponse
|
|
6830
|
+
*/
|
|
6831
|
+
'data'?: Array<AnalyticsSearchCount>;
|
|
6832
|
+
/**
|
|
6833
|
+
*
|
|
6834
|
+
* @type {string}
|
|
6835
|
+
* @memberof AnalyticsSearchCountResponse
|
|
6836
|
+
*/
|
|
6837
|
+
'message'?: string;
|
|
6838
|
+
/**
|
|
6839
|
+
*
|
|
6840
|
+
* @type {number}
|
|
6841
|
+
* @memberof AnalyticsSearchCountResponse
|
|
6842
|
+
*/
|
|
6843
|
+
'status'?: number;
|
|
6844
|
+
}
|
|
5755
6845
|
/**
|
|
5756
6846
|
*
|
|
5757
6847
|
* @export
|
|
@@ -22587,12 +23677,174 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
22587
23677
|
baseOptions = configuration.baseOptions;
|
|
22588
23678
|
}
|
|
22589
23679
|
|
|
22590
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
22591
|
-
const localVarHeaderParameter = {} as any;
|
|
22592
|
-
const localVarQueryParameter = {} as any;
|
|
23680
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
23681
|
+
const localVarHeaderParameter = {} as any;
|
|
23682
|
+
const localVarQueryParameter = {} as any;
|
|
23683
|
+
|
|
23684
|
+
// authentication BearerAuth required
|
|
23685
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
23686
|
+
|
|
23687
|
+
|
|
23688
|
+
|
|
23689
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23690
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23691
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
23692
|
+
|
|
23693
|
+
return {
|
|
23694
|
+
url: toPathString(localVarUrlObj),
|
|
23695
|
+
options: localVarRequestOptions,
|
|
23696
|
+
};
|
|
23697
|
+
},
|
|
23698
|
+
/**
|
|
23699
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
23700
|
+
* @summary Get Query Analytics
|
|
23701
|
+
* @param {string} xStoreID Store ID
|
|
23702
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
23703
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
23704
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum} [granularity] Time granularity
|
|
23705
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
23706
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
23707
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
23708
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
23709
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
23710
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
23711
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
23712
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
23713
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
23714
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
23715
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
23716
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
23717
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
23718
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
23719
|
+
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
23720
|
+
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
23721
|
+
* @param {number} [page] Page number for pagination
|
|
23722
|
+
* @param {number} [pageSize] Number of results per page
|
|
23723
|
+
* @param {string} [orderBy] Order by field (legacy - use sort_by instead)
|
|
23724
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum} [sortBy] Field to sort by
|
|
23725
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum} [sortOrder] Sort direction
|
|
23726
|
+
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
23727
|
+
* @param {*} [options] Override http request option.
|
|
23728
|
+
* @throws {RequiredError}
|
|
23729
|
+
*/
|
|
23730
|
+
adminAnalyticsStoreXStoreIDQueriesGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
23731
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
23732
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQueriesGet', 'xStoreID', xStoreID)
|
|
23733
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/queries`
|
|
23734
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
23735
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23736
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23737
|
+
let baseOptions;
|
|
23738
|
+
if (configuration) {
|
|
23739
|
+
baseOptions = configuration.baseOptions;
|
|
23740
|
+
}
|
|
23741
|
+
|
|
23742
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
23743
|
+
const localVarHeaderParameter = {} as any;
|
|
23744
|
+
const localVarQueryParameter = {} as any;
|
|
23745
|
+
|
|
23746
|
+
// authentication BearerAuth required
|
|
23747
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
23748
|
+
|
|
23749
|
+
if (startTime !== undefined) {
|
|
23750
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
23751
|
+
}
|
|
23752
|
+
|
|
23753
|
+
if (endTime !== undefined) {
|
|
23754
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
23755
|
+
}
|
|
23756
|
+
|
|
23757
|
+
if (granularity !== undefined) {
|
|
23758
|
+
localVarQueryParameter['granularity'] = granularity;
|
|
23759
|
+
}
|
|
23760
|
+
|
|
23761
|
+
if (search !== undefined) {
|
|
23762
|
+
localVarQueryParameter['search'] = search;
|
|
23763
|
+
}
|
|
23764
|
+
|
|
23765
|
+
if (analyticsTags !== undefined) {
|
|
23766
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
23767
|
+
}
|
|
23768
|
+
|
|
23769
|
+
if (tagsMatchMode !== undefined) {
|
|
23770
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
23771
|
+
}
|
|
23772
|
+
|
|
23773
|
+
if (tagsExclude !== undefined) {
|
|
23774
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
23775
|
+
}
|
|
23776
|
+
|
|
23777
|
+
if (tagKeyFilter !== undefined) {
|
|
23778
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
23779
|
+
}
|
|
23780
|
+
|
|
23781
|
+
if (tagValueFilter !== undefined) {
|
|
23782
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
23783
|
+
}
|
|
23784
|
+
|
|
23785
|
+
if (compareMode !== undefined) {
|
|
23786
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
23787
|
+
}
|
|
23788
|
+
|
|
23789
|
+
if (compareStartTime !== undefined) {
|
|
23790
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
23791
|
+
}
|
|
23792
|
+
|
|
23793
|
+
if (compareEndTime !== undefined) {
|
|
23794
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
23795
|
+
}
|
|
23796
|
+
|
|
23797
|
+
if (compareAnalyticsTags !== undefined) {
|
|
23798
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
23799
|
+
}
|
|
23800
|
+
|
|
23801
|
+
if (compareTagsMatchMode !== undefined) {
|
|
23802
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
23803
|
+
}
|
|
23804
|
+
|
|
23805
|
+
if (compareTagsExclude !== undefined) {
|
|
23806
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
23807
|
+
}
|
|
23808
|
+
|
|
23809
|
+
if (compareTagKeyFilter !== undefined) {
|
|
23810
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
23811
|
+
}
|
|
23812
|
+
|
|
23813
|
+
if (compareTagValueFilter !== undefined) {
|
|
23814
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
23815
|
+
}
|
|
23816
|
+
|
|
23817
|
+
if (limit !== undefined) {
|
|
23818
|
+
localVarQueryParameter['limit'] = limit;
|
|
23819
|
+
}
|
|
23820
|
+
|
|
23821
|
+
if (offset !== undefined) {
|
|
23822
|
+
localVarQueryParameter['offset'] = offset;
|
|
23823
|
+
}
|
|
23824
|
+
|
|
23825
|
+
if (page !== undefined) {
|
|
23826
|
+
localVarQueryParameter['page'] = page;
|
|
23827
|
+
}
|
|
23828
|
+
|
|
23829
|
+
if (pageSize !== undefined) {
|
|
23830
|
+
localVarQueryParameter['page_size'] = pageSize;
|
|
23831
|
+
}
|
|
23832
|
+
|
|
23833
|
+
if (orderBy !== undefined) {
|
|
23834
|
+
localVarQueryParameter['order_by'] = orderBy;
|
|
23835
|
+
}
|
|
23836
|
+
|
|
23837
|
+
if (sortBy !== undefined) {
|
|
23838
|
+
localVarQueryParameter['sort_by'] = sortBy;
|
|
23839
|
+
}
|
|
23840
|
+
|
|
23841
|
+
if (sortOrder !== undefined) {
|
|
23842
|
+
localVarQueryParameter['sort_order'] = sortOrder;
|
|
23843
|
+
}
|
|
22593
23844
|
|
|
22594
|
-
|
|
22595
|
-
|
|
23845
|
+
if (sort !== undefined) {
|
|
23846
|
+
localVarQueryParameter['sort'] = sort;
|
|
23847
|
+
}
|
|
22596
23848
|
|
|
22597
23849
|
|
|
22598
23850
|
|
|
@@ -22606,15 +23858,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
22606
23858
|
};
|
|
22607
23859
|
},
|
|
22608
23860
|
/**
|
|
22609
|
-
* Retrieve
|
|
22610
|
-
* @summary Get
|
|
23861
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
23862
|
+
* @summary Get No-Clicks Queries
|
|
22611
23863
|
* @param {string} xStoreID Store ID
|
|
22612
23864
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
22613
23865
|
* @param {string} [endTime] End time in RFC3339 format
|
|
22614
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum} [granularity] Time granularity
|
|
22615
23866
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
22616
23867
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
22617
|
-
* @param {
|
|
23868
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
22618
23869
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
22619
23870
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
22620
23871
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
@@ -22622,7 +23873,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
22622
23873
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
22623
23874
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
22624
23875
|
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
22625
|
-
* @param {
|
|
23876
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
22626
23877
|
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
22627
23878
|
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
22628
23879
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
@@ -22630,17 +23881,16 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
22630
23881
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
22631
23882
|
* @param {number} [page] Page number for pagination
|
|
22632
23883
|
* @param {number} [pageSize] Number of results per page
|
|
22633
|
-
* @param {
|
|
22634
|
-
* @param {
|
|
22635
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum} [sortOrder] Sort direction
|
|
23884
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum} [sortBy] Field to sort by
|
|
23885
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum} [sortOrder] Sort direction
|
|
22636
23886
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
22637
23887
|
* @param {*} [options] Override http request option.
|
|
22638
23888
|
* @throws {RequiredError}
|
|
22639
23889
|
*/
|
|
22640
|
-
|
|
23890
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet: async (xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22641
23891
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
22642
|
-
assertParamExists('
|
|
22643
|
-
const localVarPath = `/admin/analytics/store/{xStoreID}/queries`
|
|
23892
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoClicksGet', 'xStoreID', xStoreID)
|
|
23893
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-clicks`
|
|
22644
23894
|
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
22645
23895
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22646
23896
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -22664,10 +23914,6 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
22664
23914
|
localVarQueryParameter['end_time'] = endTime;
|
|
22665
23915
|
}
|
|
22666
23916
|
|
|
22667
|
-
if (granularity !== undefined) {
|
|
22668
|
-
localVarQueryParameter['granularity'] = granularity;
|
|
22669
|
-
}
|
|
22670
|
-
|
|
22671
23917
|
if (search !== undefined) {
|
|
22672
23918
|
localVarQueryParameter['search'] = search;
|
|
22673
23919
|
}
|
|
@@ -22740,10 +23986,6 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
22740
23986
|
localVarQueryParameter['page_size'] = pageSize;
|
|
22741
23987
|
}
|
|
22742
23988
|
|
|
22743
|
-
if (orderBy !== undefined) {
|
|
22744
|
-
localVarQueryParameter['order_by'] = orderBy;
|
|
22745
|
-
}
|
|
22746
|
-
|
|
22747
23989
|
if (sortBy !== undefined) {
|
|
22748
23990
|
localVarQueryParameter['sort_by'] = sortBy;
|
|
22749
23991
|
}
|
|
@@ -22768,14 +24010,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
22768
24010
|
};
|
|
22769
24011
|
},
|
|
22770
24012
|
/**
|
|
22771
|
-
* Retrieve queries that
|
|
22772
|
-
* @summary Get No-
|
|
24013
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
24014
|
+
* @summary Get No-Results Queries
|
|
22773
24015
|
* @param {string} xStoreID Store ID
|
|
22774
24016
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
22775
24017
|
* @param {string} [endTime] End time in RFC3339 format
|
|
22776
24018
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
22777
24019
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
22778
|
-
* @param {
|
|
24020
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
22779
24021
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
22780
24022
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
22781
24023
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
@@ -22783,7 +24025,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
22783
24025
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
22784
24026
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
22785
24027
|
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
22786
|
-
* @param {
|
|
24028
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
22787
24029
|
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
22788
24030
|
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
22789
24031
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
@@ -22791,16 +24033,16 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
22791
24033
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
22792
24034
|
* @param {number} [page] Page number for pagination
|
|
22793
24035
|
* @param {number} [pageSize] Number of results per page
|
|
22794
|
-
* @param {
|
|
22795
|
-
* @param {
|
|
24036
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum} [sortBy] Field to sort by
|
|
24037
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
22796
24038
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
22797
24039
|
* @param {*} [options] Override http request option.
|
|
22798
24040
|
* @throws {RequiredError}
|
|
22799
24041
|
*/
|
|
22800
|
-
|
|
24042
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: async (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> => {
|
|
22801
24043
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
22802
|
-
assertParamExists('
|
|
22803
|
-
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-
|
|
24044
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoResultsGet', 'xStoreID', xStoreID)
|
|
24045
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-results`
|
|
22804
24046
|
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
22805
24047
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22806
24048
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -22920,40 +24162,47 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
22920
24162
|
};
|
|
22921
24163
|
},
|
|
22922
24164
|
/**
|
|
22923
|
-
* Retrieve
|
|
22924
|
-
* @summary Get
|
|
24165
|
+
* 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
|
|
24166
|
+
* @summary Get Query Insights
|
|
22925
24167
|
* @param {string} xStoreID Store ID
|
|
24168
|
+
* @param {string} query Search query to analyze
|
|
22926
24169
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
22927
24170
|
* @param {string} [endTime] End time in RFC3339 format
|
|
22928
|
-
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
22929
24171
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
22930
|
-
* @param {
|
|
24172
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
22931
24173
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
22932
24174
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
22933
24175
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
24176
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
22934
24177
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
22935
24178
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
22936
24179
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
22937
24180
|
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
22938
|
-
* @param {
|
|
24181
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
22939
24182
|
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
22940
24183
|
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
22941
24184
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22942
|
-
* @param {number} [
|
|
22943
|
-
* @param {number} [
|
|
22944
|
-
* @param {
|
|
22945
|
-
* @param {number} [
|
|
22946
|
-
* @param {
|
|
22947
|
-
* @param {
|
|
22948
|
-
* @param {
|
|
24185
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
24186
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
24187
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
24188
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
24189
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
24190
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
24191
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
24192
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
24193
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
24194
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
22949
24195
|
* @param {*} [options] Override http request option.
|
|
22950
24196
|
* @throws {RequiredError}
|
|
22951
24197
|
*/
|
|
22952
|
-
|
|
24198
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22953
24199
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
22954
|
-
assertParamExists('
|
|
22955
|
-
|
|
22956
|
-
|
|
24200
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID)
|
|
24201
|
+
// verify required parameter 'query' is not null or undefined
|
|
24202
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'query', query)
|
|
24203
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/{query}/insights`
|
|
24204
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
24205
|
+
.replace(`{${"query"}}`, encodeURIComponent(String(query)));
|
|
22957
24206
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22958
24207
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22959
24208
|
let baseOptions;
|
|
@@ -22976,10 +24225,6 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
22976
24225
|
localVarQueryParameter['end_time'] = endTime;
|
|
22977
24226
|
}
|
|
22978
24227
|
|
|
22979
|
-
if (search !== undefined) {
|
|
22980
|
-
localVarQueryParameter['search'] = search;
|
|
22981
|
-
}
|
|
22982
|
-
|
|
22983
24228
|
if (analyticsTags !== undefined) {
|
|
22984
24229
|
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
22985
24230
|
}
|
|
@@ -23000,6 +24245,10 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
23000
24245
|
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
23001
24246
|
}
|
|
23002
24247
|
|
|
24248
|
+
if (search !== undefined) {
|
|
24249
|
+
localVarQueryParameter['search'] = search;
|
|
24250
|
+
}
|
|
24251
|
+
|
|
23003
24252
|
if (compareMode !== undefined) {
|
|
23004
24253
|
localVarQueryParameter['compare_mode'] = compareMode;
|
|
23005
24254
|
}
|
|
@@ -23032,32 +24281,44 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
23032
24281
|
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
23033
24282
|
}
|
|
23034
24283
|
|
|
23035
|
-
if (
|
|
23036
|
-
localVarQueryParameter['
|
|
24284
|
+
if (resultsPage !== undefined) {
|
|
24285
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
23037
24286
|
}
|
|
23038
24287
|
|
|
23039
|
-
if (
|
|
23040
|
-
localVarQueryParameter['
|
|
24288
|
+
if (resultsPageSize !== undefined) {
|
|
24289
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
23041
24290
|
}
|
|
23042
24291
|
|
|
23043
|
-
if (
|
|
23044
|
-
localVarQueryParameter['
|
|
24292
|
+
if (resultsSearch !== undefined) {
|
|
24293
|
+
localVarQueryParameter['results_search'] = resultsSearch;
|
|
23045
24294
|
}
|
|
23046
24295
|
|
|
23047
|
-
if (
|
|
23048
|
-
localVarQueryParameter['
|
|
24296
|
+
if (filtersPage !== undefined) {
|
|
24297
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
23049
24298
|
}
|
|
23050
24299
|
|
|
23051
|
-
if (
|
|
23052
|
-
localVarQueryParameter['
|
|
24300
|
+
if (filtersPageSize !== undefined) {
|
|
24301
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
23053
24302
|
}
|
|
23054
24303
|
|
|
23055
|
-
if (
|
|
23056
|
-
localVarQueryParameter['
|
|
24304
|
+
if (filtersSearch !== undefined) {
|
|
24305
|
+
localVarQueryParameter['filters_search'] = filtersSearch;
|
|
23057
24306
|
}
|
|
23058
24307
|
|
|
23059
|
-
if (
|
|
23060
|
-
localVarQueryParameter['
|
|
24308
|
+
if (geoPage !== undefined) {
|
|
24309
|
+
localVarQueryParameter['geo_page'] = geoPage;
|
|
24310
|
+
}
|
|
24311
|
+
|
|
24312
|
+
if (geoPageSize !== undefined) {
|
|
24313
|
+
localVarQueryParameter['geo_page_size'] = geoPageSize;
|
|
24314
|
+
}
|
|
24315
|
+
|
|
24316
|
+
if (geoSearch !== undefined) {
|
|
24317
|
+
localVarQueryParameter['geo_search'] = geoSearch;
|
|
24318
|
+
}
|
|
24319
|
+
|
|
24320
|
+
if (includeWidget !== undefined) {
|
|
24321
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
23061
24322
|
}
|
|
23062
24323
|
|
|
23063
24324
|
|
|
@@ -23542,6 +24803,43 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
23542
24803
|
|
|
23543
24804
|
|
|
23544
24805
|
|
|
24806
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24807
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24808
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
24809
|
+
|
|
24810
|
+
return {
|
|
24811
|
+
url: toPathString(localVarUrlObj),
|
|
24812
|
+
options: localVarRequestOptions,
|
|
24813
|
+
};
|
|
24814
|
+
},
|
|
24815
|
+
/**
|
|
24816
|
+
* Retrieves and returns the number of search events per day for the past 7 days from ClickHouse.
|
|
24817
|
+
* @summary Get daily search counts for the last 7 days
|
|
24818
|
+
* @param {string} xStoreID Unique store identifier
|
|
24819
|
+
* @param {*} [options] Override http request option.
|
|
24820
|
+
* @throws {RequiredError}
|
|
24821
|
+
*/
|
|
24822
|
+
apiAdminAnalyticsStoreXStoreIDSearchcountGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
24823
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
24824
|
+
assertParamExists('apiAdminAnalyticsStoreXStoreIDSearchcountGet', 'xStoreID', xStoreID)
|
|
24825
|
+
const localVarPath = `/api/admin/analytics/store/{xStoreID}/searchcount`
|
|
24826
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
24827
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24828
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24829
|
+
let baseOptions;
|
|
24830
|
+
if (configuration) {
|
|
24831
|
+
baseOptions = configuration.baseOptions;
|
|
24832
|
+
}
|
|
24833
|
+
|
|
24834
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
24835
|
+
const localVarHeaderParameter = {} as any;
|
|
24836
|
+
const localVarQueryParameter = {} as any;
|
|
24837
|
+
|
|
24838
|
+
// authentication BearerAuth required
|
|
24839
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
24840
|
+
|
|
24841
|
+
|
|
24842
|
+
|
|
23545
24843
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23546
24844
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23547
24845
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -23930,6 +25228,46 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
23930
25228
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoResultsGet']?.[localVarOperationServerIndex]?.url;
|
|
23931
25229
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23932
25230
|
},
|
|
25231
|
+
/**
|
|
25232
|
+
* 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
|
|
25233
|
+
* @summary Get Query Insights
|
|
25234
|
+
* @param {string} xStoreID Store ID
|
|
25235
|
+
* @param {string} query Search query to analyze
|
|
25236
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
25237
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
25238
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
25239
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
25240
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
25241
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
25242
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
25243
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
25244
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
25245
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
25246
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
25247
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
25248
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
25249
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
25250
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
25251
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
25252
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
25253
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
25254
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
25255
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
25256
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
25257
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
25258
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
25259
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
25260
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
25261
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
25262
|
+
* @param {*} [options] Override http request option.
|
|
25263
|
+
* @throws {RequiredError}
|
|
25264
|
+
*/
|
|
25265
|
+
async adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>> {
|
|
25266
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options);
|
|
25267
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25268
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']?.[localVarOperationServerIndex]?.url;
|
|
25269
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25270
|
+
},
|
|
23933
25271
|
/**
|
|
23934
25272
|
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
23935
25273
|
* @summary Get Top Results Analytics
|
|
@@ -24055,6 +25393,19 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
24055
25393
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.analyticsApiUsageStoreStoreIdGet']?.[localVarOperationServerIndex]?.url;
|
|
24056
25394
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24057
25395
|
},
|
|
25396
|
+
/**
|
|
25397
|
+
* Retrieves and returns the number of search events per day for the past 7 days from ClickHouse.
|
|
25398
|
+
* @summary Get daily search counts for the last 7 days
|
|
25399
|
+
* @param {string} xStoreID Unique store identifier
|
|
25400
|
+
* @param {*} [options] Override http request option.
|
|
25401
|
+
* @throws {RequiredError}
|
|
25402
|
+
*/
|
|
25403
|
+
async apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsSearchCountResponse>> {
|
|
25404
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID, options);
|
|
25405
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25406
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.apiAdminAnalyticsStoreXStoreIDSearchcountGet']?.[localVarOperationServerIndex]?.url;
|
|
25407
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25408
|
+
},
|
|
24058
25409
|
}
|
|
24059
25410
|
};
|
|
24060
25411
|
|
|
@@ -24392,6 +25743,43 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
24392
25743
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response> {
|
|
24393
25744
|
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
24394
25745
|
},
|
|
25746
|
+
/**
|
|
25747
|
+
* 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
|
|
25748
|
+
* @summary Get Query Insights
|
|
25749
|
+
* @param {string} xStoreID Store ID
|
|
25750
|
+
* @param {string} query Search query to analyze
|
|
25751
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
25752
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
25753
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
25754
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
25755
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
25756
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
25757
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
25758
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
25759
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
25760
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
25761
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
25762
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
25763
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
25764
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
25765
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
25766
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
25767
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
25768
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
25769
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
25770
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
25771
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
25772
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
25773
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
25774
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
25775
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
25776
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
25777
|
+
* @param {*} [options] Override http request option.
|
|
25778
|
+
* @throws {RequiredError}
|
|
25779
|
+
*/
|
|
25780
|
+
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> {
|
|
25781
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options).then((request) => request(axios, basePath));
|
|
25782
|
+
},
|
|
24395
25783
|
/**
|
|
24396
25784
|
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
24397
25785
|
* @summary Get Top Results Analytics
|
|
@@ -24502,6 +25890,16 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
24502
25890
|
analyticsApiUsageStoreStoreIdGet(storeId: string, startDate?: string, endDate?: string, method?: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAPIUsageResponse> {
|
|
24503
25891
|
return localVarFp.analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options).then((request) => request(axios, basePath));
|
|
24504
25892
|
},
|
|
25893
|
+
/**
|
|
25894
|
+
* Retrieves and returns the number of search events per day for the past 7 days from ClickHouse.
|
|
25895
|
+
* @summary Get daily search counts for the last 7 days
|
|
25896
|
+
* @param {string} xStoreID Unique store identifier
|
|
25897
|
+
* @param {*} [options] Override http request option.
|
|
25898
|
+
* @throws {RequiredError}
|
|
25899
|
+
*/
|
|
25900
|
+
apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsSearchCountResponse> {
|
|
25901
|
+
return localVarFp.apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
25902
|
+
},
|
|
24505
25903
|
};
|
|
24506
25904
|
};
|
|
24507
25905
|
|
|
@@ -24867,6 +26265,45 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
24867
26265
|
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
24868
26266
|
}
|
|
24869
26267
|
|
|
26268
|
+
/**
|
|
26269
|
+
* 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
|
|
26270
|
+
* @summary Get Query Insights
|
|
26271
|
+
* @param {string} xStoreID Store ID
|
|
26272
|
+
* @param {string} query Search query to analyze
|
|
26273
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
26274
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
26275
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
26276
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
26277
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
26278
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
26279
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
26280
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
26281
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
26282
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
26283
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
26284
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
26285
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
26286
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
26287
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
26288
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
26289
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
26290
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
26291
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
26292
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
26293
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
26294
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
26295
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
26296
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
26297
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
26298
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
26299
|
+
* @param {*} [options] Override http request option.
|
|
26300
|
+
* @throws {RequiredError}
|
|
26301
|
+
* @memberof AnalyticsApi
|
|
26302
|
+
*/
|
|
26303
|
+
public adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig) {
|
|
26304
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
26305
|
+
}
|
|
26306
|
+
|
|
24870
26307
|
/**
|
|
24871
26308
|
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
24872
26309
|
* @summary Get Top Results Analytics
|
|
@@ -24986,6 +26423,18 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
24986
26423
|
public analyticsApiUsageStoreStoreIdGet(storeId: string, startDate?: string, endDate?: string, method?: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig) {
|
|
24987
26424
|
return AnalyticsApiFp(this.configuration).analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options).then((request) => request(this.axios, this.basePath));
|
|
24988
26425
|
}
|
|
26426
|
+
|
|
26427
|
+
/**
|
|
26428
|
+
* Retrieves and returns the number of search events per day for the past 7 days from ClickHouse.
|
|
26429
|
+
* @summary Get daily search counts for the last 7 days
|
|
26430
|
+
* @param {string} xStoreID Unique store identifier
|
|
26431
|
+
* @param {*} [options] Override http request option.
|
|
26432
|
+
* @throws {RequiredError}
|
|
26433
|
+
* @memberof AnalyticsApi
|
|
26434
|
+
*/
|
|
26435
|
+
public apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID: string, options?: RawAxiosRequestConfig) {
|
|
26436
|
+
return AnalyticsApiFp(this.configuration).apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
26437
|
+
}
|
|
24989
26438
|
}
|
|
24990
26439
|
|
|
24991
26440
|
/**
|
|
@@ -25293,6 +26742,22 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
25293
26742
|
Desc: 'desc'
|
|
25294
26743
|
} as const;
|
|
25295
26744
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
26745
|
+
/**
|
|
26746
|
+
* @export
|
|
26747
|
+
*/
|
|
26748
|
+
export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = {
|
|
26749
|
+
Any: 'any',
|
|
26750
|
+
All: 'all'
|
|
26751
|
+
} as const;
|
|
26752
|
+
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum];
|
|
26753
|
+
/**
|
|
26754
|
+
* @export
|
|
26755
|
+
*/
|
|
26756
|
+
export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = {
|
|
26757
|
+
Any: 'any',
|
|
26758
|
+
All: 'all'
|
|
26759
|
+
} as const;
|
|
26760
|
+
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum];
|
|
25296
26761
|
/**
|
|
25297
26762
|
* @export
|
|
25298
26763
|
*/
|