@seekora-ai/admin-api 1.1.14 → 1.1.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +46 -2
- package/api.ts +2479 -0
- package/dist/api.d.ts +1926 -0
- package/dist/api.js +986 -13
- package/dist/esm/api.d.ts +1926 -0
- package/dist/esm/api.js +981 -8
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.16.tgz +0 -0
- package/seekora-ai-admin-api-1.1.14.tgz +0 -0
package/dist/api.d.ts
CHANGED
|
@@ -703,6 +703,49 @@ export interface AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response {
|
|
|
703
703
|
*/
|
|
704
704
|
'total'?: number;
|
|
705
705
|
}
|
|
706
|
+
/**
|
|
707
|
+
*
|
|
708
|
+
* @export
|
|
709
|
+
* @interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
710
|
+
*/
|
|
711
|
+
export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
|
|
712
|
+
/**
|
|
713
|
+
* Comparison metadata when in compare mode
|
|
714
|
+
* @type {AnalyticsComparisonMeta}
|
|
715
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
716
|
+
*/
|
|
717
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
718
|
+
/**
|
|
719
|
+
*
|
|
720
|
+
* @type {AnalyticsQueryInsights}
|
|
721
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
722
|
+
*/
|
|
723
|
+
'data'?: AnalyticsQueryInsights;
|
|
724
|
+
/**
|
|
725
|
+
*
|
|
726
|
+
* @type {string}
|
|
727
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
728
|
+
*/
|
|
729
|
+
'error'?: string;
|
|
730
|
+
/**
|
|
731
|
+
*
|
|
732
|
+
* @type {string}
|
|
733
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
734
|
+
*/
|
|
735
|
+
'status'?: string;
|
|
736
|
+
/**
|
|
737
|
+
*
|
|
738
|
+
* @type {string}
|
|
739
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
740
|
+
*/
|
|
741
|
+
'timestamp'?: string;
|
|
742
|
+
/**
|
|
743
|
+
*
|
|
744
|
+
* @type {number}
|
|
745
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
746
|
+
*/
|
|
747
|
+
'total'?: number;
|
|
748
|
+
}
|
|
706
749
|
/**
|
|
707
750
|
*
|
|
708
751
|
* @export
|
|
@@ -1416,6 +1459,153 @@ export interface AnalyticsAnalyticsAPIResponse {
|
|
|
1416
1459
|
*/
|
|
1417
1460
|
'total'?: number;
|
|
1418
1461
|
}
|
|
1462
|
+
/**
|
|
1463
|
+
*
|
|
1464
|
+
* @export
|
|
1465
|
+
* @interface AnalyticsArrayElementAnalytic
|
|
1466
|
+
*/
|
|
1467
|
+
export interface AnalyticsArrayElementAnalytic {
|
|
1468
|
+
/**
|
|
1469
|
+
* Position in array (0-based)
|
|
1470
|
+
* @type {number}
|
|
1471
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1472
|
+
*/
|
|
1473
|
+
'array_index'?: number;
|
|
1474
|
+
/**
|
|
1475
|
+
* Total array size
|
|
1476
|
+
* @type {number}
|
|
1477
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1478
|
+
*/
|
|
1479
|
+
'array_length'?: number;
|
|
1480
|
+
/**
|
|
1481
|
+
* Average results when this element is used
|
|
1482
|
+
* @type {number}
|
|
1483
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1484
|
+
*/
|
|
1485
|
+
'avg_results_count'?: number;
|
|
1486
|
+
/**
|
|
1487
|
+
* e.g., \"tags\"
|
|
1488
|
+
* @type {string}
|
|
1489
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1490
|
+
*/
|
|
1491
|
+
'filter_key'?: string;
|
|
1492
|
+
/**
|
|
1493
|
+
* e.g., \"fashion\"
|
|
1494
|
+
* @type {string}
|
|
1495
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1496
|
+
*/
|
|
1497
|
+
'filter_value'?: string;
|
|
1498
|
+
/**
|
|
1499
|
+
* \"array\", \"object\", \"string\"
|
|
1500
|
+
* @type {string}
|
|
1501
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1502
|
+
*/
|
|
1503
|
+
'original_type'?: string;
|
|
1504
|
+
/**
|
|
1505
|
+
* How often this element appears at this position
|
|
1506
|
+
* @type {number}
|
|
1507
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1508
|
+
*/
|
|
1509
|
+
'position_popularity'?: number;
|
|
1510
|
+
/**
|
|
1511
|
+
* Percentage with results > 0
|
|
1512
|
+
* @type {number}
|
|
1513
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1514
|
+
*/
|
|
1515
|
+
'success_rate'?: number;
|
|
1516
|
+
/**
|
|
1517
|
+
* Unique searches using this element
|
|
1518
|
+
* @type {number}
|
|
1519
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1520
|
+
*/
|
|
1521
|
+
'unique_searches'?: number;
|
|
1522
|
+
/**
|
|
1523
|
+
* How many times this element was used
|
|
1524
|
+
* @type {number}
|
|
1525
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1526
|
+
*/
|
|
1527
|
+
'usage_count'?: number;
|
|
1528
|
+
/**
|
|
1529
|
+
* \"array_element\", \"object_key\", etc.
|
|
1530
|
+
* @type {string}
|
|
1531
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1532
|
+
*/
|
|
1533
|
+
'value_type'?: string;
|
|
1534
|
+
}
|
|
1535
|
+
/**
|
|
1536
|
+
*
|
|
1537
|
+
* @export
|
|
1538
|
+
* @interface AnalyticsArrayFilterStats
|
|
1539
|
+
*/
|
|
1540
|
+
export interface AnalyticsArrayFilterStats {
|
|
1541
|
+
/**
|
|
1542
|
+
* Average array size
|
|
1543
|
+
* @type {number}
|
|
1544
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1545
|
+
*/
|
|
1546
|
+
'avg_array_length'?: number;
|
|
1547
|
+
/**
|
|
1548
|
+
* Largest array seen
|
|
1549
|
+
* @type {number}
|
|
1550
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1551
|
+
*/
|
|
1552
|
+
'max_array_length'?: number;
|
|
1553
|
+
/**
|
|
1554
|
+
* Top values across all arrays
|
|
1555
|
+
* @type {Array<string>}
|
|
1556
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1557
|
+
*/
|
|
1558
|
+
'most_popular_values'?: Array<string>;
|
|
1559
|
+
/**
|
|
1560
|
+
* Usage by array position
|
|
1561
|
+
* @type {Array<AnalyticsArrayPositionAnalytic>}
|
|
1562
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1563
|
+
*/
|
|
1564
|
+
'position_analytics'?: Array<AnalyticsArrayPositionAnalytic>;
|
|
1565
|
+
/**
|
|
1566
|
+
* Total times arrays were used for this filter
|
|
1567
|
+
* @type {number}
|
|
1568
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1569
|
+
*/
|
|
1570
|
+
'total_array_usage'?: number;
|
|
1571
|
+
}
|
|
1572
|
+
/**
|
|
1573
|
+
*
|
|
1574
|
+
* @export
|
|
1575
|
+
* @interface AnalyticsArrayPositionAnalytic
|
|
1576
|
+
*/
|
|
1577
|
+
export interface AnalyticsArrayPositionAnalytic {
|
|
1578
|
+
/**
|
|
1579
|
+
* Most popular value at this position
|
|
1580
|
+
* @type {string}
|
|
1581
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1582
|
+
*/
|
|
1583
|
+
'popular_value'?: string;
|
|
1584
|
+
/**
|
|
1585
|
+
* 0-based array position
|
|
1586
|
+
* @type {number}
|
|
1587
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1588
|
+
*/
|
|
1589
|
+
'position'?: number;
|
|
1590
|
+
/**
|
|
1591
|
+
* Success rate for searches with values at this position
|
|
1592
|
+
* @type {number}
|
|
1593
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1594
|
+
*/
|
|
1595
|
+
'success_rate'?: number;
|
|
1596
|
+
/**
|
|
1597
|
+
* Unique values at this position
|
|
1598
|
+
* @type {number}
|
|
1599
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1600
|
+
*/
|
|
1601
|
+
'unique_values'?: number;
|
|
1602
|
+
/**
|
|
1603
|
+
* Times this position was used
|
|
1604
|
+
* @type {number}
|
|
1605
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1606
|
+
*/
|
|
1607
|
+
'usage_count'?: number;
|
|
1608
|
+
}
|
|
1419
1609
|
/**
|
|
1420
1610
|
*
|
|
1421
1611
|
* @export
|
|
@@ -1660,6 +1850,43 @@ export interface AnalyticsCategoryWithCount {
|
|
|
1660
1850
|
*/
|
|
1661
1851
|
'value'?: string;
|
|
1662
1852
|
}
|
|
1853
|
+
/**
|
|
1854
|
+
*
|
|
1855
|
+
* @export
|
|
1856
|
+
* @interface AnalyticsClickPositionBucket
|
|
1857
|
+
*/
|
|
1858
|
+
export interface AnalyticsClickPositionBucket {
|
|
1859
|
+
/**
|
|
1860
|
+
*
|
|
1861
|
+
* @type {number}
|
|
1862
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1863
|
+
*/
|
|
1864
|
+
'click_rate'?: number;
|
|
1865
|
+
/**
|
|
1866
|
+
*
|
|
1867
|
+
* @type {number}
|
|
1868
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1869
|
+
*/
|
|
1870
|
+
'clicks'?: number;
|
|
1871
|
+
/**
|
|
1872
|
+
*
|
|
1873
|
+
* @type {number}
|
|
1874
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1875
|
+
*/
|
|
1876
|
+
'impressions'?: number;
|
|
1877
|
+
/**
|
|
1878
|
+
* \"1\", \"2\", \"3\", \"4-5\", \"6-10\", \"11-20\", \"21+\"
|
|
1879
|
+
* @type {string}
|
|
1880
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1881
|
+
*/
|
|
1882
|
+
'position_range'?: string;
|
|
1883
|
+
/**
|
|
1884
|
+
* percentage of total clicks for this query
|
|
1885
|
+
* @type {number}
|
|
1886
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1887
|
+
*/
|
|
1888
|
+
'share'?: number;
|
|
1889
|
+
}
|
|
1663
1890
|
/**
|
|
1664
1891
|
*
|
|
1665
1892
|
* @export
|
|
@@ -2308,6 +2535,43 @@ export interface AnalyticsFilterEffectivenessCategory {
|
|
|
2308
2535
|
*/
|
|
2309
2536
|
'unique_searches'?: number;
|
|
2310
2537
|
}
|
|
2538
|
+
/**
|
|
2539
|
+
*
|
|
2540
|
+
* @export
|
|
2541
|
+
* @interface AnalyticsFilterEffectivenessMetrics
|
|
2542
|
+
*/
|
|
2543
|
+
export interface AnalyticsFilterEffectivenessMetrics {
|
|
2544
|
+
/**
|
|
2545
|
+
*
|
|
2546
|
+
* @type {number}
|
|
2547
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2548
|
+
*/
|
|
2549
|
+
'avg_results_count'?: number;
|
|
2550
|
+
/**
|
|
2551
|
+
*
|
|
2552
|
+
* @type {number}
|
|
2553
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2554
|
+
*/
|
|
2555
|
+
'click_through_rate'?: number;
|
|
2556
|
+
/**
|
|
2557
|
+
*
|
|
2558
|
+
* @type {number}
|
|
2559
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2560
|
+
*/
|
|
2561
|
+
'conversion_rate'?: number;
|
|
2562
|
+
/**
|
|
2563
|
+
*
|
|
2564
|
+
* @type {number}
|
|
2565
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2566
|
+
*/
|
|
2567
|
+
'search_count'?: number;
|
|
2568
|
+
/**
|
|
2569
|
+
* percentage with results > 0
|
|
2570
|
+
* @type {number}
|
|
2571
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2572
|
+
*/
|
|
2573
|
+
'success_rate'?: number;
|
|
2574
|
+
}
|
|
2311
2575
|
/**
|
|
2312
2576
|
*
|
|
2313
2577
|
* @export
|
|
@@ -2351,6 +2615,37 @@ export interface AnalyticsFilterEffectivenessSummary {
|
|
|
2351
2615
|
*/
|
|
2352
2616
|
'total_searches'?: number;
|
|
2353
2617
|
}
|
|
2618
|
+
/**
|
|
2619
|
+
*
|
|
2620
|
+
* @export
|
|
2621
|
+
* @interface AnalyticsFilterImprovementMetrics
|
|
2622
|
+
*/
|
|
2623
|
+
export interface AnalyticsFilterImprovementMetrics {
|
|
2624
|
+
/**
|
|
2625
|
+
* percentage points
|
|
2626
|
+
* @type {number}
|
|
2627
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2628
|
+
*/
|
|
2629
|
+
'conversion_improvement'?: number;
|
|
2630
|
+
/**
|
|
2631
|
+
* percentage points
|
|
2632
|
+
* @type {number}
|
|
2633
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2634
|
+
*/
|
|
2635
|
+
'ctr_improvement'?: number;
|
|
2636
|
+
/**
|
|
2637
|
+
* percentage
|
|
2638
|
+
* @type {number}
|
|
2639
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2640
|
+
*/
|
|
2641
|
+
'results_count_improvement'?: number;
|
|
2642
|
+
/**
|
|
2643
|
+
* percentage points
|
|
2644
|
+
* @type {number}
|
|
2645
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2646
|
+
*/
|
|
2647
|
+
'success_rate_improvement'?: number;
|
|
2648
|
+
}
|
|
2354
2649
|
/**
|
|
2355
2650
|
*
|
|
2356
2651
|
* @export
|
|
@@ -2578,6 +2873,73 @@ export interface AnalyticsFilterValueStatistic {
|
|
|
2578
2873
|
*/
|
|
2579
2874
|
'value_type'?: string;
|
|
2580
2875
|
}
|
|
2876
|
+
/**
|
|
2877
|
+
*
|
|
2878
|
+
* @export
|
|
2879
|
+
* @interface AnalyticsFilterValueUsage
|
|
2880
|
+
*/
|
|
2881
|
+
export interface AnalyticsFilterValueUsage {
|
|
2882
|
+
/**
|
|
2883
|
+
* Position in array (if applicable)
|
|
2884
|
+
* @type {number}
|
|
2885
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2886
|
+
*/
|
|
2887
|
+
'array_index'?: number;
|
|
2888
|
+
/**
|
|
2889
|
+
* Total array size (if applicable)
|
|
2890
|
+
* @type {number}
|
|
2891
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2892
|
+
*/
|
|
2893
|
+
'array_length'?: number;
|
|
2894
|
+
/**
|
|
2895
|
+
*
|
|
2896
|
+
* @type {number}
|
|
2897
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2898
|
+
*/
|
|
2899
|
+
'avg_results_count'?: number;
|
|
2900
|
+
/**
|
|
2901
|
+
* \"array\", \"object\", \"string\"
|
|
2902
|
+
* @type {string}
|
|
2903
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2904
|
+
*/
|
|
2905
|
+
'original_type'?: string;
|
|
2906
|
+
/**
|
|
2907
|
+
* Percentage of total usage for this filter key
|
|
2908
|
+
* @type {number}
|
|
2909
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2910
|
+
*/
|
|
2911
|
+
'share_of_filter_key'?: number;
|
|
2912
|
+
/**
|
|
2913
|
+
*
|
|
2914
|
+
* @type {number}
|
|
2915
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2916
|
+
*/
|
|
2917
|
+
'success_rate'?: number;
|
|
2918
|
+
/**
|
|
2919
|
+
*
|
|
2920
|
+
* @type {number}
|
|
2921
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2922
|
+
*/
|
|
2923
|
+
'unique_searches'?: number;
|
|
2924
|
+
/**
|
|
2925
|
+
*
|
|
2926
|
+
* @type {number}
|
|
2927
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2928
|
+
*/
|
|
2929
|
+
'usage_count'?: number;
|
|
2930
|
+
/**
|
|
2931
|
+
*
|
|
2932
|
+
* @type {string}
|
|
2933
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2934
|
+
*/
|
|
2935
|
+
'value'?: string;
|
|
2936
|
+
/**
|
|
2937
|
+
* \"array_element\", \"object_key\", \"string\", etc.
|
|
2938
|
+
* @type {string}
|
|
2939
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2940
|
+
*/
|
|
2941
|
+
'value_type'?: string;
|
|
2942
|
+
}
|
|
2581
2943
|
/**
|
|
2582
2944
|
*
|
|
2583
2945
|
* @export
|
|
@@ -4750,6 +5112,446 @@ export interface AnalyticsQueryAnalytic {
|
|
|
4750
5112
|
*/
|
|
4751
5113
|
'unique_users'?: number;
|
|
4752
5114
|
}
|
|
5115
|
+
/**
|
|
5116
|
+
*
|
|
5117
|
+
* @export
|
|
5118
|
+
* @interface AnalyticsQueryFilterAnalytics
|
|
5119
|
+
*/
|
|
5120
|
+
export interface AnalyticsQueryFilterAnalytics {
|
|
5121
|
+
/**
|
|
5122
|
+
* NEW: Individual array element insights
|
|
5123
|
+
* @type {Array<AnalyticsArrayElementAnalytic>}
|
|
5124
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5125
|
+
*/
|
|
5126
|
+
'array_element_analytics'?: Array<AnalyticsArrayElementAnalytic>;
|
|
5127
|
+
/**
|
|
5128
|
+
*
|
|
5129
|
+
* @type {number}
|
|
5130
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5131
|
+
*/
|
|
5132
|
+
'avg_filters_per_search'?: number;
|
|
5133
|
+
/**
|
|
5134
|
+
*
|
|
5135
|
+
* @type {Array<AnalyticsQueryFilterCombination>}
|
|
5136
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5137
|
+
*/
|
|
5138
|
+
'filter_combinations'?: Array<AnalyticsQueryFilterCombination>;
|
|
5139
|
+
/**
|
|
5140
|
+
*
|
|
5141
|
+
* @type {AnalyticsQueryFilterEffectiveness}
|
|
5142
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5143
|
+
*/
|
|
5144
|
+
'filter_effectiveness'?: AnalyticsQueryFilterEffectiveness;
|
|
5145
|
+
/**
|
|
5146
|
+
*
|
|
5147
|
+
* @type {Array<AnalyticsQueryFilterTrend>}
|
|
5148
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5149
|
+
*/
|
|
5150
|
+
'filter_trends'?: Array<AnalyticsQueryFilterTrend>;
|
|
5151
|
+
/**
|
|
5152
|
+
*
|
|
5153
|
+
* @type {number}
|
|
5154
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5155
|
+
*/
|
|
5156
|
+
'filter_usage_rate'?: number;
|
|
5157
|
+
/**
|
|
5158
|
+
* NEW: Enhanced filter usage with array data (removed omitempty to always show field)
|
|
5159
|
+
* @type {Array<AnalyticsQueryFilterUsage>}
|
|
5160
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5161
|
+
*/
|
|
5162
|
+
'popular_filters'?: Array<AnalyticsQueryFilterUsage>;
|
|
5163
|
+
/**
|
|
5164
|
+
*
|
|
5165
|
+
* @type {number}
|
|
5166
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5167
|
+
*/
|
|
5168
|
+
'total_searches_with_filters'?: number;
|
|
5169
|
+
}
|
|
5170
|
+
/**
|
|
5171
|
+
*
|
|
5172
|
+
* @export
|
|
5173
|
+
* @interface AnalyticsQueryFilterCombination
|
|
5174
|
+
*/
|
|
5175
|
+
export interface AnalyticsQueryFilterCombination {
|
|
5176
|
+
/**
|
|
5177
|
+
*
|
|
5178
|
+
* @type {number}
|
|
5179
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5180
|
+
*/
|
|
5181
|
+
'avg_results_count'?: number;
|
|
5182
|
+
/**
|
|
5183
|
+
*
|
|
5184
|
+
* @type {Array<string>}
|
|
5185
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5186
|
+
*/
|
|
5187
|
+
'filters'?: Array<string>;
|
|
5188
|
+
/**
|
|
5189
|
+
* percentage of filtered searches
|
|
5190
|
+
* @type {number}
|
|
5191
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5192
|
+
*/
|
|
5193
|
+
'share'?: number;
|
|
5194
|
+
/**
|
|
5195
|
+
*
|
|
5196
|
+
* @type {number}
|
|
5197
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5198
|
+
*/
|
|
5199
|
+
'success_rate'?: number;
|
|
5200
|
+
/**
|
|
5201
|
+
*
|
|
5202
|
+
* @type {number}
|
|
5203
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5204
|
+
*/
|
|
5205
|
+
'usage_count'?: number;
|
|
5206
|
+
}
|
|
5207
|
+
/**
|
|
5208
|
+
*
|
|
5209
|
+
* @export
|
|
5210
|
+
* @interface AnalyticsQueryFilterEffectiveness
|
|
5211
|
+
*/
|
|
5212
|
+
export interface AnalyticsQueryFilterEffectiveness {
|
|
5213
|
+
/**
|
|
5214
|
+
*
|
|
5215
|
+
* @type {AnalyticsFilterImprovementMetrics}
|
|
5216
|
+
* @memberof AnalyticsQueryFilterEffectiveness
|
|
5217
|
+
*/
|
|
5218
|
+
'improvement'?: AnalyticsFilterImprovementMetrics;
|
|
5219
|
+
/**
|
|
5220
|
+
*
|
|
5221
|
+
* @type {AnalyticsFilterEffectivenessMetrics}
|
|
5222
|
+
* @memberof AnalyticsQueryFilterEffectiveness
|
|
5223
|
+
*/
|
|
5224
|
+
'with_filters'?: AnalyticsFilterEffectivenessMetrics;
|
|
5225
|
+
/**
|
|
5226
|
+
*
|
|
5227
|
+
* @type {AnalyticsFilterEffectivenessMetrics}
|
|
5228
|
+
* @memberof AnalyticsQueryFilterEffectiveness
|
|
5229
|
+
*/
|
|
5230
|
+
'without_filters'?: AnalyticsFilterEffectivenessMetrics;
|
|
5231
|
+
}
|
|
5232
|
+
/**
|
|
5233
|
+
*
|
|
5234
|
+
* @export
|
|
5235
|
+
* @interface AnalyticsQueryFilterTrend
|
|
5236
|
+
*/
|
|
5237
|
+
export interface AnalyticsQueryFilterTrend {
|
|
5238
|
+
/**
|
|
5239
|
+
*
|
|
5240
|
+
* @type {string}
|
|
5241
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5242
|
+
*/
|
|
5243
|
+
'filter_key'?: string;
|
|
5244
|
+
/**
|
|
5245
|
+
*
|
|
5246
|
+
* @type {number}
|
|
5247
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5248
|
+
*/
|
|
5249
|
+
'growth_rate'?: number;
|
|
5250
|
+
/**
|
|
5251
|
+
* \"increasing\", \"decreasing\", \"stable\"
|
|
5252
|
+
* @type {string}
|
|
5253
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5254
|
+
*/
|
|
5255
|
+
'trend'?: string;
|
|
5256
|
+
/**
|
|
5257
|
+
*
|
|
5258
|
+
* @type {Array<AnalyticsTimeSeriesPoint>}
|
|
5259
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5260
|
+
*/
|
|
5261
|
+
'trend_data'?: Array<AnalyticsTimeSeriesPoint>;
|
|
5262
|
+
}
|
|
5263
|
+
/**
|
|
5264
|
+
*
|
|
5265
|
+
* @export
|
|
5266
|
+
* @interface AnalyticsQueryFilterUsage
|
|
5267
|
+
*/
|
|
5268
|
+
export interface AnalyticsQueryFilterUsage {
|
|
5269
|
+
/**
|
|
5270
|
+
* Stats specific to array-type filters
|
|
5271
|
+
* @type {AnalyticsArrayFilterStats}
|
|
5272
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5273
|
+
*/
|
|
5274
|
+
'array_stats'?: AnalyticsArrayFilterStats;
|
|
5275
|
+
/**
|
|
5276
|
+
*
|
|
5277
|
+
* @type {number}
|
|
5278
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5279
|
+
*/
|
|
5280
|
+
'effectiveness_score'?: number;
|
|
5281
|
+
/**
|
|
5282
|
+
*
|
|
5283
|
+
* @type {string}
|
|
5284
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5285
|
+
*/
|
|
5286
|
+
'filter_key'?: string;
|
|
5287
|
+
/**
|
|
5288
|
+
* Individual values with array explosion data
|
|
5289
|
+
* @type {Array<AnalyticsFilterValueUsage>}
|
|
5290
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5291
|
+
*/
|
|
5292
|
+
'filter_values'?: Array<AnalyticsFilterValueUsage>;
|
|
5293
|
+
/**
|
|
5294
|
+
* Total times this filter key was used
|
|
5295
|
+
* @type {number}
|
|
5296
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5297
|
+
*/
|
|
5298
|
+
'total_usage'?: number;
|
|
5299
|
+
/**
|
|
5300
|
+
* Unique searches using this filter
|
|
5301
|
+
* @type {number}
|
|
5302
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5303
|
+
*/
|
|
5304
|
+
'unique_searches'?: number;
|
|
5305
|
+
}
|
|
5306
|
+
/**
|
|
5307
|
+
*
|
|
5308
|
+
* @export
|
|
5309
|
+
* @interface AnalyticsQueryGeoAnalytic
|
|
5310
|
+
*/
|
|
5311
|
+
export interface AnalyticsQueryGeoAnalytic {
|
|
5312
|
+
/**
|
|
5313
|
+
*
|
|
5314
|
+
* @type {string}
|
|
5315
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5316
|
+
*/
|
|
5317
|
+
'city'?: string;
|
|
5318
|
+
/**
|
|
5319
|
+
* Clicks / Results Shown
|
|
5320
|
+
* @type {number}
|
|
5321
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5322
|
+
*/
|
|
5323
|
+
'click_through_rate'?: number;
|
|
5324
|
+
/**
|
|
5325
|
+
* Count of result-click events
|
|
5326
|
+
* @type {number}
|
|
5327
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5328
|
+
*/
|
|
5329
|
+
'clicks'?: number;
|
|
5330
|
+
/**
|
|
5331
|
+
* Conversions / Clicks (CVR)
|
|
5332
|
+
* @type {number}
|
|
5333
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5334
|
+
*/
|
|
5335
|
+
'conversion_rate'?: number;
|
|
5336
|
+
/**
|
|
5337
|
+
* Conversions / Searches
|
|
5338
|
+
* @type {number}
|
|
5339
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5340
|
+
*/
|
|
5341
|
+
'conversion_rate_per_search'?: number;
|
|
5342
|
+
/**
|
|
5343
|
+
* Post-click conversions attributed to search
|
|
5344
|
+
* @type {number}
|
|
5345
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5346
|
+
*/
|
|
5347
|
+
'conversions'?: number;
|
|
5348
|
+
/**
|
|
5349
|
+
*
|
|
5350
|
+
* @type {string}
|
|
5351
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5352
|
+
*/
|
|
5353
|
+
'country'?: string;
|
|
5354
|
+
/**
|
|
5355
|
+
*
|
|
5356
|
+
* @type {string}
|
|
5357
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5358
|
+
*/
|
|
5359
|
+
'country_code'?: string;
|
|
5360
|
+
/**
|
|
5361
|
+
* Searches with results but zero clicks / Results Shown
|
|
5362
|
+
* @type {number}
|
|
5363
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5364
|
+
*/
|
|
5365
|
+
'no_click_rate'?: number;
|
|
5366
|
+
/**
|
|
5367
|
+
* No-result searches / Searches
|
|
5368
|
+
* @type {number}
|
|
5369
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5370
|
+
*/
|
|
5371
|
+
'no_result_rate'?: number;
|
|
5372
|
+
/**
|
|
5373
|
+
*
|
|
5374
|
+
* @type {string}
|
|
5375
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5376
|
+
*/
|
|
5377
|
+
'region'?: string;
|
|
5378
|
+
/**
|
|
5379
|
+
* Count of searches that returned ≥1 result
|
|
5380
|
+
* @type {number}
|
|
5381
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5382
|
+
*/
|
|
5383
|
+
'results_shown'?: number;
|
|
5384
|
+
/**
|
|
5385
|
+
* Sum of attributed revenue
|
|
5386
|
+
* @type {number}
|
|
5387
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5388
|
+
*/
|
|
5389
|
+
'revenue'?: number;
|
|
5390
|
+
/**
|
|
5391
|
+
* Count of search events
|
|
5392
|
+
* @type {number}
|
|
5393
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5394
|
+
*/
|
|
5395
|
+
'searches'?: number;
|
|
5396
|
+
/**
|
|
5397
|
+
* percentage of total searches for this query
|
|
5398
|
+
* @type {number}
|
|
5399
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5400
|
+
*/
|
|
5401
|
+
'share'?: number;
|
|
5402
|
+
/**
|
|
5403
|
+
* Unique users
|
|
5404
|
+
* @type {number}
|
|
5405
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5406
|
+
*/
|
|
5407
|
+
'unique_users'?: number;
|
|
5408
|
+
}
|
|
5409
|
+
/**
|
|
5410
|
+
*
|
|
5411
|
+
* @export
|
|
5412
|
+
* @interface AnalyticsQueryGeoAnalyticsSection
|
|
5413
|
+
*/
|
|
5414
|
+
export interface AnalyticsQueryGeoAnalyticsSection {
|
|
5415
|
+
/**
|
|
5416
|
+
*
|
|
5417
|
+
* @type {Array<AnalyticsQueryGeoAnalytic>}
|
|
5418
|
+
* @memberof AnalyticsQueryGeoAnalyticsSection
|
|
5419
|
+
*/
|
|
5420
|
+
'items'?: Array<AnalyticsQueryGeoAnalytic>;
|
|
5421
|
+
/**
|
|
5422
|
+
*
|
|
5423
|
+
* @type {SeekoraGoSrcAnalyticsPaginationMeta}
|
|
5424
|
+
* @memberof AnalyticsQueryGeoAnalyticsSection
|
|
5425
|
+
*/
|
|
5426
|
+
'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
|
|
5427
|
+
}
|
|
5428
|
+
/**
|
|
5429
|
+
*
|
|
5430
|
+
* @export
|
|
5431
|
+
* @interface AnalyticsQueryInsights
|
|
5432
|
+
*/
|
|
5433
|
+
export interface AnalyticsQueryInsights {
|
|
5434
|
+
/**
|
|
5435
|
+
* Average rank position of clicked results (renamed for clarity)
|
|
5436
|
+
* @type {number}
|
|
5437
|
+
* @memberof AnalyticsQueryInsights
|
|
5438
|
+
*/
|
|
5439
|
+
'avg_click_position'?: number;
|
|
5440
|
+
/**
|
|
5441
|
+
* Average rank of the top result shown per search
|
|
5442
|
+
* @type {number}
|
|
5443
|
+
* @memberof AnalyticsQueryInsights
|
|
5444
|
+
*/
|
|
5445
|
+
'avg_result_rank'?: number;
|
|
5446
|
+
/**
|
|
5447
|
+
*
|
|
5448
|
+
* @type {Array<AnalyticsClickPositionBucket>}
|
|
5449
|
+
* @memberof AnalyticsQueryInsights
|
|
5450
|
+
*/
|
|
5451
|
+
'click_position_histogram'?: Array<AnalyticsClickPositionBucket>;
|
|
5452
|
+
/**
|
|
5453
|
+
* Clicks / Results Shown
|
|
5454
|
+
* @type {number}
|
|
5455
|
+
* @memberof AnalyticsQueryInsights
|
|
5456
|
+
*/
|
|
5457
|
+
'click_through_rate'?: number;
|
|
5458
|
+
/**
|
|
5459
|
+
* Conversions / Clicks (CVR)
|
|
5460
|
+
* @type {number}
|
|
5461
|
+
* @memberof AnalyticsQueryInsights
|
|
5462
|
+
*/
|
|
5463
|
+
'conversion_rate'?: number;
|
|
5464
|
+
/**
|
|
5465
|
+
* Conversions / Searches
|
|
5466
|
+
* @type {number}
|
|
5467
|
+
* @memberof AnalyticsQueryInsights
|
|
5468
|
+
*/
|
|
5469
|
+
'conversion_rate_per_search'?: number;
|
|
5470
|
+
/**
|
|
5471
|
+
* Enhanced filter analytics
|
|
5472
|
+
* @type {AnalyticsQueryFilterAnalytics}
|
|
5473
|
+
* @memberof AnalyticsQueryInsights
|
|
5474
|
+
*/
|
|
5475
|
+
'filter_analytics'?: AnalyticsQueryFilterAnalytics;
|
|
5476
|
+
/**
|
|
5477
|
+
*
|
|
5478
|
+
* @type {AnalyticsQueryGeoAnalyticsSection}
|
|
5479
|
+
* @memberof AnalyticsQueryInsights
|
|
5480
|
+
*/
|
|
5481
|
+
'geo_analytics'?: AnalyticsQueryGeoAnalyticsSection;
|
|
5482
|
+
/**
|
|
5483
|
+
*
|
|
5484
|
+
* @type {string}
|
|
5485
|
+
* @memberof AnalyticsQueryInsights
|
|
5486
|
+
*/
|
|
5487
|
+
'last_searched'?: string;
|
|
5488
|
+
/**
|
|
5489
|
+
* Searches with results but zero clicks / Results Shown
|
|
5490
|
+
* @type {number}
|
|
5491
|
+
* @memberof AnalyticsQueryInsights
|
|
5492
|
+
*/
|
|
5493
|
+
'no_click_rate'?: number;
|
|
5494
|
+
/**
|
|
5495
|
+
* No-result searches / Searches
|
|
5496
|
+
* @type {number}
|
|
5497
|
+
* @memberof AnalyticsQueryInsights
|
|
5498
|
+
*/
|
|
5499
|
+
'no_results_rate'?: number;
|
|
5500
|
+
/**
|
|
5501
|
+
*
|
|
5502
|
+
* @type {AnalyticsQueryPopularFiltersSection}
|
|
5503
|
+
* @memberof AnalyticsQueryInsights
|
|
5504
|
+
*/
|
|
5505
|
+
'popular_filters'?: AnalyticsQueryPopularFiltersSection;
|
|
5506
|
+
/**
|
|
5507
|
+
*
|
|
5508
|
+
* @type {AnalyticsQueryPopularResultsSection}
|
|
5509
|
+
* @memberof AnalyticsQueryInsights
|
|
5510
|
+
*/
|
|
5511
|
+
'popular_results'?: AnalyticsQueryPopularResultsSection;
|
|
5512
|
+
/**
|
|
5513
|
+
*
|
|
5514
|
+
* @type {string}
|
|
5515
|
+
* @memberof AnalyticsQueryInsights
|
|
5516
|
+
*/
|
|
5517
|
+
'query'?: string;
|
|
5518
|
+
/**
|
|
5519
|
+
* Searches that returned ≥1 result
|
|
5520
|
+
* @type {number}
|
|
5521
|
+
* @memberof AnalyticsQueryInsights
|
|
5522
|
+
*/
|
|
5523
|
+
'results_shown'?: number;
|
|
5524
|
+
/**
|
|
5525
|
+
* Count of result-click events
|
|
5526
|
+
* @type {number}
|
|
5527
|
+
* @memberof AnalyticsQueryInsights
|
|
5528
|
+
*/
|
|
5529
|
+
'total_clicks'?: number;
|
|
5530
|
+
/**
|
|
5531
|
+
* Count of conversions
|
|
5532
|
+
* @type {number}
|
|
5533
|
+
* @memberof AnalyticsQueryInsights
|
|
5534
|
+
*/
|
|
5535
|
+
'total_conversions'?: number;
|
|
5536
|
+
/**
|
|
5537
|
+
* Sum of attributed revenue
|
|
5538
|
+
* @type {number}
|
|
5539
|
+
* @memberof AnalyticsQueryInsights
|
|
5540
|
+
*/
|
|
5541
|
+
'total_revenue'?: number;
|
|
5542
|
+
/**
|
|
5543
|
+
*
|
|
5544
|
+
* @type {number}
|
|
5545
|
+
* @memberof AnalyticsQueryInsights
|
|
5546
|
+
*/
|
|
5547
|
+
'total_searches'?: number;
|
|
5548
|
+
/**
|
|
5549
|
+
*
|
|
5550
|
+
* @type {number}
|
|
5551
|
+
* @memberof AnalyticsQueryInsights
|
|
5552
|
+
*/
|
|
5553
|
+
'unique_users'?: number;
|
|
5554
|
+
}
|
|
4753
5555
|
/**
|
|
4754
5556
|
*
|
|
4755
5557
|
* @export
|
|
@@ -4847,6 +5649,250 @@ export interface AnalyticsQueryPerformanceAnalytics {
|
|
|
4847
5649
|
*/
|
|
4848
5650
|
'unique_users'?: number;
|
|
4849
5651
|
}
|
|
5652
|
+
/**
|
|
5653
|
+
*
|
|
5654
|
+
* @export
|
|
5655
|
+
* @interface AnalyticsQueryPopularFilter
|
|
5656
|
+
*/
|
|
5657
|
+
export interface AnalyticsQueryPopularFilter {
|
|
5658
|
+
/**
|
|
5659
|
+
* Clicks / Results Shown
|
|
5660
|
+
* @type {number}
|
|
5661
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5662
|
+
*/
|
|
5663
|
+
'click_through_rate'?: number;
|
|
5664
|
+
/**
|
|
5665
|
+
* Count of result-click events
|
|
5666
|
+
* @type {number}
|
|
5667
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5668
|
+
*/
|
|
5669
|
+
'clicks'?: number;
|
|
5670
|
+
/**
|
|
5671
|
+
* Conversions / Clicks (CVR)
|
|
5672
|
+
* @type {number}
|
|
5673
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5674
|
+
*/
|
|
5675
|
+
'conversion_rate'?: number;
|
|
5676
|
+
/**
|
|
5677
|
+
* Conversions / Searches
|
|
5678
|
+
* @type {number}
|
|
5679
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5680
|
+
*/
|
|
5681
|
+
'conversion_rate_per_search'?: number;
|
|
5682
|
+
/**
|
|
5683
|
+
* Post-click conversions attributed to search
|
|
5684
|
+
* @type {number}
|
|
5685
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5686
|
+
*/
|
|
5687
|
+
'conversions'?: number;
|
|
5688
|
+
/**
|
|
5689
|
+
*
|
|
5690
|
+
* @type {string}
|
|
5691
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5692
|
+
*/
|
|
5693
|
+
'filter_key'?: string;
|
|
5694
|
+
/**
|
|
5695
|
+
*
|
|
5696
|
+
* @type {string}
|
|
5697
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5698
|
+
*/
|
|
5699
|
+
'filter_value'?: string;
|
|
5700
|
+
/**
|
|
5701
|
+
* Searches with results but zero clicks / Results Shown
|
|
5702
|
+
* @type {number}
|
|
5703
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5704
|
+
*/
|
|
5705
|
+
'no_click_rate'?: number;
|
|
5706
|
+
/**
|
|
5707
|
+
* No-result searches / Searches
|
|
5708
|
+
* @type {number}
|
|
5709
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5710
|
+
*/
|
|
5711
|
+
'no_result_rate'?: number;
|
|
5712
|
+
/**
|
|
5713
|
+
* Count of searches that returned ≥1 result
|
|
5714
|
+
* @type {number}
|
|
5715
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5716
|
+
*/
|
|
5717
|
+
'results_shown'?: number;
|
|
5718
|
+
/**
|
|
5719
|
+
* Sum of attributed revenue
|
|
5720
|
+
* @type {number}
|
|
5721
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5722
|
+
*/
|
|
5723
|
+
'revenue'?: number;
|
|
5724
|
+
/**
|
|
5725
|
+
* Count of search events with this filter
|
|
5726
|
+
* @type {number}
|
|
5727
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5728
|
+
*/
|
|
5729
|
+
'searches'?: number;
|
|
5730
|
+
/**
|
|
5731
|
+
* percentage of searches with this filter
|
|
5732
|
+
* @type {number}
|
|
5733
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5734
|
+
*/
|
|
5735
|
+
'share'?: number;
|
|
5736
|
+
/**
|
|
5737
|
+
* Number of times this filter was used
|
|
5738
|
+
* @type {number}
|
|
5739
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5740
|
+
*/
|
|
5741
|
+
'usage_count'?: number;
|
|
5742
|
+
}
|
|
5743
|
+
/**
|
|
5744
|
+
*
|
|
5745
|
+
* @export
|
|
5746
|
+
* @interface AnalyticsQueryPopularFiltersSection
|
|
5747
|
+
*/
|
|
5748
|
+
export interface AnalyticsQueryPopularFiltersSection {
|
|
5749
|
+
/**
|
|
5750
|
+
*
|
|
5751
|
+
* @type {Array<AnalyticsQueryPopularFilter>}
|
|
5752
|
+
* @memberof AnalyticsQueryPopularFiltersSection
|
|
5753
|
+
*/
|
|
5754
|
+
'items'?: Array<AnalyticsQueryPopularFilter>;
|
|
5755
|
+
/**
|
|
5756
|
+
*
|
|
5757
|
+
* @type {SeekoraGoSrcAnalyticsPaginationMeta}
|
|
5758
|
+
* @memberof AnalyticsQueryPopularFiltersSection
|
|
5759
|
+
*/
|
|
5760
|
+
'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
|
|
5761
|
+
}
|
|
5762
|
+
/**
|
|
5763
|
+
*
|
|
5764
|
+
* @export
|
|
5765
|
+
* @interface AnalyticsQueryPopularResultWithWidget
|
|
5766
|
+
*/
|
|
5767
|
+
export interface AnalyticsQueryPopularResultWithWidget {
|
|
5768
|
+
/**
|
|
5769
|
+
* Average rank position of clicked results
|
|
5770
|
+
* @type {number}
|
|
5771
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5772
|
+
*/
|
|
5773
|
+
'avg_click_rank'?: number;
|
|
5774
|
+
/**
|
|
5775
|
+
* Same as AvgResultRank (backward compatibility)
|
|
5776
|
+
* @type {number}
|
|
5777
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5778
|
+
*/
|
|
5779
|
+
'avg_position'?: number;
|
|
5780
|
+
/**
|
|
5781
|
+
* Average rank of the top result shown per search
|
|
5782
|
+
* @type {number}
|
|
5783
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5784
|
+
*/
|
|
5785
|
+
'avg_result_rank'?: number;
|
|
5786
|
+
/**
|
|
5787
|
+
* Clicks / Results Shown
|
|
5788
|
+
* @type {number}
|
|
5789
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5790
|
+
*/
|
|
5791
|
+
'click_through_rate'?: number;
|
|
5792
|
+
/**
|
|
5793
|
+
* Count of result-click events
|
|
5794
|
+
* @type {number}
|
|
5795
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5796
|
+
*/
|
|
5797
|
+
'clicks'?: number;
|
|
5798
|
+
/**
|
|
5799
|
+
* Conversions / Clicks (CVR)
|
|
5800
|
+
* @type {number}
|
|
5801
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5802
|
+
*/
|
|
5803
|
+
'conversion_rate'?: number;
|
|
5804
|
+
/**
|
|
5805
|
+
* Conversions / Searches
|
|
5806
|
+
* @type {number}
|
|
5807
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5808
|
+
*/
|
|
5809
|
+
'conversion_rate_per_search'?: number;
|
|
5810
|
+
/**
|
|
5811
|
+
* Post-click conversions attributed to search
|
|
5812
|
+
* @type {number}
|
|
5813
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5814
|
+
*/
|
|
5815
|
+
'conversions'?: number;
|
|
5816
|
+
/**
|
|
5817
|
+
* Count of times item was shown
|
|
5818
|
+
* @type {number}
|
|
5819
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5820
|
+
*/
|
|
5821
|
+
'impressions'?: number;
|
|
5822
|
+
/**
|
|
5823
|
+
*
|
|
5824
|
+
* @type {string}
|
|
5825
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5826
|
+
*/
|
|
5827
|
+
'item_id'?: string;
|
|
5828
|
+
/**
|
|
5829
|
+
*
|
|
5830
|
+
* @type {string}
|
|
5831
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5832
|
+
*/
|
|
5833
|
+
'item_name'?: string;
|
|
5834
|
+
/**
|
|
5835
|
+
* Searches with results but zero clicks / Results Shown
|
|
5836
|
+
* @type {number}
|
|
5837
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5838
|
+
*/
|
|
5839
|
+
'no_click_rate'?: number;
|
|
5840
|
+
/**
|
|
5841
|
+
* No-result searches / Searches
|
|
5842
|
+
* @type {number}
|
|
5843
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5844
|
+
*/
|
|
5845
|
+
'no_result_rate'?: number;
|
|
5846
|
+
/**
|
|
5847
|
+
* Count of searches that returned ≥1 result
|
|
5848
|
+
* @type {number}
|
|
5849
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5850
|
+
*/
|
|
5851
|
+
'results_shown'?: number;
|
|
5852
|
+
/**
|
|
5853
|
+
* Sum of attributed revenue
|
|
5854
|
+
* @type {number}
|
|
5855
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5856
|
+
*/
|
|
5857
|
+
'revenue'?: number;
|
|
5858
|
+
/**
|
|
5859
|
+
* Count of search events
|
|
5860
|
+
* @type {number}
|
|
5861
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5862
|
+
*/
|
|
5863
|
+
'searches'?: number;
|
|
5864
|
+
/**
|
|
5865
|
+
* percentage of total impressions for this query
|
|
5866
|
+
* @type {number}
|
|
5867
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5868
|
+
*/
|
|
5869
|
+
'share'?: number;
|
|
5870
|
+
/**
|
|
5871
|
+
* Widget display fields
|
|
5872
|
+
* @type {AnalyticsWidgetData}
|
|
5873
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5874
|
+
*/
|
|
5875
|
+
'widget'?: AnalyticsWidgetData;
|
|
5876
|
+
}
|
|
5877
|
+
/**
|
|
5878
|
+
*
|
|
5879
|
+
* @export
|
|
5880
|
+
* @interface AnalyticsQueryPopularResultsSection
|
|
5881
|
+
*/
|
|
5882
|
+
export interface AnalyticsQueryPopularResultsSection {
|
|
5883
|
+
/**
|
|
5884
|
+
*
|
|
5885
|
+
* @type {Array<AnalyticsQueryPopularResultWithWidget>}
|
|
5886
|
+
* @memberof AnalyticsQueryPopularResultsSection
|
|
5887
|
+
*/
|
|
5888
|
+
'items'?: Array<AnalyticsQueryPopularResultWithWidget>;
|
|
5889
|
+
/**
|
|
5890
|
+
*
|
|
5891
|
+
* @type {SeekoraGoSrcAnalyticsPaginationMeta}
|
|
5892
|
+
* @memberof AnalyticsQueryPopularResultsSection
|
|
5893
|
+
*/
|
|
5894
|
+
'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
|
|
5895
|
+
}
|
|
4850
5896
|
/**
|
|
4851
5897
|
*
|
|
4852
5898
|
* @export
|
|
@@ -11687,6 +12733,31 @@ export interface DataTypesLimitResponse {
|
|
|
11687
12733
|
*/
|
|
11688
12734
|
'status'?: number;
|
|
11689
12735
|
}
|
|
12736
|
+
/**
|
|
12737
|
+
*
|
|
12738
|
+
* @export
|
|
12739
|
+
* @interface DataTypesLimitsListResponse
|
|
12740
|
+
*/
|
|
12741
|
+
export interface DataTypesLimitsListResponse {
|
|
12742
|
+
/**
|
|
12743
|
+
*
|
|
12744
|
+
* @type {Array<DataTypesLimit>}
|
|
12745
|
+
* @memberof DataTypesLimitsListResponse
|
|
12746
|
+
*/
|
|
12747
|
+
'data'?: Array<DataTypesLimit>;
|
|
12748
|
+
/**
|
|
12749
|
+
*
|
|
12750
|
+
* @type {string}
|
|
12751
|
+
* @memberof DataTypesLimitsListResponse
|
|
12752
|
+
*/
|
|
12753
|
+
'message'?: string;
|
|
12754
|
+
/**
|
|
12755
|
+
*
|
|
12756
|
+
* @type {number}
|
|
12757
|
+
* @memberof DataTypesLimitsListResponse
|
|
12758
|
+
*/
|
|
12759
|
+
'status'?: number;
|
|
12760
|
+
}
|
|
11690
12761
|
/**
|
|
11691
12762
|
*
|
|
11692
12763
|
* @export
|
|
@@ -12516,6 +13587,31 @@ export interface DataTypesNewsLetterRequestResponse {
|
|
|
12516
13587
|
*/
|
|
12517
13588
|
'status'?: number;
|
|
12518
13589
|
}
|
|
13590
|
+
/**
|
|
13591
|
+
*
|
|
13592
|
+
* @export
|
|
13593
|
+
* @interface DataTypesNewsLetterRequestsListResponse
|
|
13594
|
+
*/
|
|
13595
|
+
export interface DataTypesNewsLetterRequestsListResponse {
|
|
13596
|
+
/**
|
|
13597
|
+
*
|
|
13598
|
+
* @type {Array<DataTypesNewsLetterRequest>}
|
|
13599
|
+
* @memberof DataTypesNewsLetterRequestsListResponse
|
|
13600
|
+
*/
|
|
13601
|
+
'data'?: Array<DataTypesNewsLetterRequest>;
|
|
13602
|
+
/**
|
|
13603
|
+
*
|
|
13604
|
+
* @type {string}
|
|
13605
|
+
* @memberof DataTypesNewsLetterRequestsListResponse
|
|
13606
|
+
*/
|
|
13607
|
+
'message'?: string;
|
|
13608
|
+
/**
|
|
13609
|
+
*
|
|
13610
|
+
* @type {number}
|
|
13611
|
+
* @memberof DataTypesNewsLetterRequestsListResponse
|
|
13612
|
+
*/
|
|
13613
|
+
'status'?: number;
|
|
13614
|
+
}
|
|
12519
13615
|
/**
|
|
12520
13616
|
*
|
|
12521
13617
|
* @export
|
|
@@ -12554,6 +13650,109 @@ export interface DataTypesOTPPayload {
|
|
|
12554
13650
|
*/
|
|
12555
13651
|
'otp'?: string;
|
|
12556
13652
|
}
|
|
13653
|
+
/**
|
|
13654
|
+
*
|
|
13655
|
+
* @export
|
|
13656
|
+
* @interface DataTypesOfficialSearchResponse
|
|
13657
|
+
*/
|
|
13658
|
+
export interface DataTypesOfficialSearchResponse {
|
|
13659
|
+
/**
|
|
13660
|
+
*
|
|
13661
|
+
* @type {any}
|
|
13662
|
+
* @memberof DataTypesOfficialSearchResponse
|
|
13663
|
+
*/
|
|
13664
|
+
'facets'?: any;
|
|
13665
|
+
/**
|
|
13666
|
+
*
|
|
13667
|
+
* @type {number}
|
|
13668
|
+
* @memberof DataTypesOfficialSearchResponse
|
|
13669
|
+
*/
|
|
13670
|
+
'page'?: number;
|
|
13671
|
+
/**
|
|
13672
|
+
*
|
|
13673
|
+
* @type {number}
|
|
13674
|
+
* @memberof DataTypesOfficialSearchResponse
|
|
13675
|
+
*/
|
|
13676
|
+
'per_page'?: number;
|
|
13677
|
+
/**
|
|
13678
|
+
*
|
|
13679
|
+
* @type {Array<DataTypesOfficialSearchResult>}
|
|
13680
|
+
* @memberof DataTypesOfficialSearchResponse
|
|
13681
|
+
*/
|
|
13682
|
+
'results'?: Array<DataTypesOfficialSearchResult>;
|
|
13683
|
+
/**
|
|
13684
|
+
*
|
|
13685
|
+
* @type {Array<DataTypesAutocompleteSuggestion>}
|
|
13686
|
+
* @memberof DataTypesOfficialSearchResponse
|
|
13687
|
+
*/
|
|
13688
|
+
'suggestions'?: Array<DataTypesAutocompleteSuggestion>;
|
|
13689
|
+
/**
|
|
13690
|
+
*
|
|
13691
|
+
* @type {number}
|
|
13692
|
+
* @memberof DataTypesOfficialSearchResponse
|
|
13693
|
+
*/
|
|
13694
|
+
'total_results'?: number;
|
|
13695
|
+
}
|
|
13696
|
+
/**
|
|
13697
|
+
*
|
|
13698
|
+
* @export
|
|
13699
|
+
* @interface DataTypesOfficialSearchResponseWrapper
|
|
13700
|
+
*/
|
|
13701
|
+
export interface DataTypesOfficialSearchResponseWrapper {
|
|
13702
|
+
/**
|
|
13703
|
+
*
|
|
13704
|
+
* @type {DataTypesOfficialSearchResponse}
|
|
13705
|
+
* @memberof DataTypesOfficialSearchResponseWrapper
|
|
13706
|
+
*/
|
|
13707
|
+
'data'?: DataTypesOfficialSearchResponse;
|
|
13708
|
+
/**
|
|
13709
|
+
*
|
|
13710
|
+
* @type {string}
|
|
13711
|
+
* @memberof DataTypesOfficialSearchResponseWrapper
|
|
13712
|
+
*/
|
|
13713
|
+
'message'?: string;
|
|
13714
|
+
/**
|
|
13715
|
+
*
|
|
13716
|
+
* @type {number}
|
|
13717
|
+
* @memberof DataTypesOfficialSearchResponseWrapper
|
|
13718
|
+
*/
|
|
13719
|
+
'status'?: number;
|
|
13720
|
+
}
|
|
13721
|
+
/**
|
|
13722
|
+
*
|
|
13723
|
+
* @export
|
|
13724
|
+
* @interface DataTypesOfficialSearchResult
|
|
13725
|
+
*/
|
|
13726
|
+
export interface DataTypesOfficialSearchResult {
|
|
13727
|
+
/**
|
|
13728
|
+
*
|
|
13729
|
+
* @type {{ [key: string]: any; }}
|
|
13730
|
+
* @memberof DataTypesOfficialSearchResult
|
|
13731
|
+
*/
|
|
13732
|
+
'document'?: {
|
|
13733
|
+
[key: string]: any;
|
|
13734
|
+
};
|
|
13735
|
+
/**
|
|
13736
|
+
*
|
|
13737
|
+
* @type {{ [key: string]: any; }}
|
|
13738
|
+
* @memberof DataTypesOfficialSearchResult
|
|
13739
|
+
*/
|
|
13740
|
+
'highlight'?: {
|
|
13741
|
+
[key: string]: any;
|
|
13742
|
+
};
|
|
13743
|
+
/**
|
|
13744
|
+
*
|
|
13745
|
+
* @type {string}
|
|
13746
|
+
* @memberof DataTypesOfficialSearchResult
|
|
13747
|
+
*/
|
|
13748
|
+
'id'?: string;
|
|
13749
|
+
/**
|
|
13750
|
+
*
|
|
13751
|
+
* @type {number}
|
|
13752
|
+
* @memberof DataTypesOfficialSearchResult
|
|
13753
|
+
*/
|
|
13754
|
+
'score'?: number;
|
|
13755
|
+
}
|
|
12557
13756
|
/**
|
|
12558
13757
|
*
|
|
12559
13758
|
* @export
|
|
@@ -13571,6 +14770,31 @@ export interface DataTypesOrganizationTaxDetails {
|
|
|
13571
14770
|
[key: string]: any;
|
|
13572
14771
|
};
|
|
13573
14772
|
}
|
|
14773
|
+
/**
|
|
14774
|
+
*
|
|
14775
|
+
* @export
|
|
14776
|
+
* @interface DataTypesOrganizationsListResponse
|
|
14777
|
+
*/
|
|
14778
|
+
export interface DataTypesOrganizationsListResponse {
|
|
14779
|
+
/**
|
|
14780
|
+
*
|
|
14781
|
+
* @type {Array<DataTypesOrganization>}
|
|
14782
|
+
* @memberof DataTypesOrganizationsListResponse
|
|
14783
|
+
*/
|
|
14784
|
+
'data'?: Array<DataTypesOrganization>;
|
|
14785
|
+
/**
|
|
14786
|
+
*
|
|
14787
|
+
* @type {string}
|
|
14788
|
+
* @memberof DataTypesOrganizationsListResponse
|
|
14789
|
+
*/
|
|
14790
|
+
'message'?: string;
|
|
14791
|
+
/**
|
|
14792
|
+
*
|
|
14793
|
+
* @type {number}
|
|
14794
|
+
* @memberof DataTypesOrganizationsListResponse
|
|
14795
|
+
*/
|
|
14796
|
+
'status'?: number;
|
|
14797
|
+
}
|
|
13574
14798
|
/**
|
|
13575
14799
|
* Defines what happens when a rule is triggered (promote/hide documents, apply filters, etc.)
|
|
13576
14800
|
* @export
|
|
@@ -14083,6 +15307,31 @@ export interface DataTypesPaymentStatusPollResponse {
|
|
|
14083
15307
|
*/
|
|
14084
15308
|
'updated_at'?: string;
|
|
14085
15309
|
}
|
|
15310
|
+
/**
|
|
15311
|
+
*
|
|
15312
|
+
* @export
|
|
15313
|
+
* @interface DataTypesPaymentsListResponse
|
|
15314
|
+
*/
|
|
15315
|
+
export interface DataTypesPaymentsListResponse {
|
|
15316
|
+
/**
|
|
15317
|
+
*
|
|
15318
|
+
* @type {Array<DataTypesPayment>}
|
|
15319
|
+
* @memberof DataTypesPaymentsListResponse
|
|
15320
|
+
*/
|
|
15321
|
+
'data'?: Array<DataTypesPayment>;
|
|
15322
|
+
/**
|
|
15323
|
+
*
|
|
15324
|
+
* @type {string}
|
|
15325
|
+
* @memberof DataTypesPaymentsListResponse
|
|
15326
|
+
*/
|
|
15327
|
+
'message'?: string;
|
|
15328
|
+
/**
|
|
15329
|
+
*
|
|
15330
|
+
* @type {number}
|
|
15331
|
+
* @memberof DataTypesPaymentsListResponse
|
|
15332
|
+
*/
|
|
15333
|
+
'status'?: number;
|
|
15334
|
+
}
|
|
14086
15335
|
/**
|
|
14087
15336
|
*
|
|
14088
15337
|
* @export
|
|
@@ -14204,6 +15453,31 @@ export interface DataTypesPlanResponse {
|
|
|
14204
15453
|
*/
|
|
14205
15454
|
'status'?: number;
|
|
14206
15455
|
}
|
|
15456
|
+
/**
|
|
15457
|
+
*
|
|
15458
|
+
* @export
|
|
15459
|
+
* @interface DataTypesPlansListResponse
|
|
15460
|
+
*/
|
|
15461
|
+
export interface DataTypesPlansListResponse {
|
|
15462
|
+
/**
|
|
15463
|
+
*
|
|
15464
|
+
* @type {Array<DataTypesPlan>}
|
|
15465
|
+
* @memberof DataTypesPlansListResponse
|
|
15466
|
+
*/
|
|
15467
|
+
'data'?: Array<DataTypesPlan>;
|
|
15468
|
+
/**
|
|
15469
|
+
*
|
|
15470
|
+
* @type {string}
|
|
15471
|
+
* @memberof DataTypesPlansListResponse
|
|
15472
|
+
*/
|
|
15473
|
+
'message'?: string;
|
|
15474
|
+
/**
|
|
15475
|
+
*
|
|
15476
|
+
* @type {number}
|
|
15477
|
+
* @memberof DataTypesPlansListResponse
|
|
15478
|
+
*/
|
|
15479
|
+
'status'?: number;
|
|
15480
|
+
}
|
|
14207
15481
|
/**
|
|
14208
15482
|
*
|
|
14209
15483
|
* @export
|
|
@@ -14519,6 +15793,91 @@ export interface DataTypesProfileResponseWrapper {
|
|
|
14519
15793
|
*/
|
|
14520
15794
|
'status'?: number;
|
|
14521
15795
|
}
|
|
15796
|
+
/**
|
|
15797
|
+
*
|
|
15798
|
+
* @export
|
|
15799
|
+
* @interface DataTypesPublicSearchRequest
|
|
15800
|
+
*/
|
|
15801
|
+
export interface DataTypesPublicSearchRequest {
|
|
15802
|
+
/**
|
|
15803
|
+
*
|
|
15804
|
+
* @type {Array<string>}
|
|
15805
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15806
|
+
*/
|
|
15807
|
+
'analytics_tags'?: Array<string>;
|
|
15808
|
+
/**
|
|
15809
|
+
*
|
|
15810
|
+
* @type {string}
|
|
15811
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15812
|
+
*/
|
|
15813
|
+
'facet_by'?: string;
|
|
15814
|
+
/**
|
|
15815
|
+
*
|
|
15816
|
+
* @type {string}
|
|
15817
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15818
|
+
*/
|
|
15819
|
+
'filter'?: string;
|
|
15820
|
+
/**
|
|
15821
|
+
*
|
|
15822
|
+
* @type {boolean}
|
|
15823
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15824
|
+
*/
|
|
15825
|
+
'include_suggestions'?: boolean;
|
|
15826
|
+
/**
|
|
15827
|
+
*
|
|
15828
|
+
* @type {number}
|
|
15829
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15830
|
+
*/
|
|
15831
|
+
'max_facet_values'?: number;
|
|
15832
|
+
/**
|
|
15833
|
+
*
|
|
15834
|
+
* @type {number}
|
|
15835
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15836
|
+
*/
|
|
15837
|
+
'page'?: number;
|
|
15838
|
+
/**
|
|
15839
|
+
*
|
|
15840
|
+
* @type {number}
|
|
15841
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15842
|
+
*/
|
|
15843
|
+
'per_page'?: number;
|
|
15844
|
+
/**
|
|
15845
|
+
*
|
|
15846
|
+
* @type {string}
|
|
15847
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15848
|
+
*/
|
|
15849
|
+
'q': string;
|
|
15850
|
+
/**
|
|
15851
|
+
*
|
|
15852
|
+
* @type {string}
|
|
15853
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15854
|
+
*/
|
|
15855
|
+
'sort'?: string;
|
|
15856
|
+
/**
|
|
15857
|
+
* IDs of stopword sets to use
|
|
15858
|
+
* @type {Array<string>}
|
|
15859
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15860
|
+
*/
|
|
15861
|
+
'stopword_sets'?: Array<string>;
|
|
15862
|
+
/**
|
|
15863
|
+
*
|
|
15864
|
+
* @type {number}
|
|
15865
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15866
|
+
*/
|
|
15867
|
+
'suggestions_limit'?: number;
|
|
15868
|
+
/**
|
|
15869
|
+
* IDs of synonym sets to use
|
|
15870
|
+
* @type {Array<string>}
|
|
15871
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15872
|
+
*/
|
|
15873
|
+
'synonym_sets'?: Array<string>;
|
|
15874
|
+
/**
|
|
15875
|
+
* If true, returns only display fields instead of full document (used in public API only)
|
|
15876
|
+
* @type {boolean}
|
|
15877
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15878
|
+
*/
|
|
15879
|
+
'widget_mode'?: boolean;
|
|
15880
|
+
}
|
|
14522
15881
|
/**
|
|
14523
15882
|
*
|
|
14524
15883
|
* @export
|
|
@@ -15535,6 +16894,31 @@ export interface DataTypesRoleRightsListResponse {
|
|
|
15535
16894
|
*/
|
|
15536
16895
|
'status'?: number;
|
|
15537
16896
|
}
|
|
16897
|
+
/**
|
|
16898
|
+
*
|
|
16899
|
+
* @export
|
|
16900
|
+
* @interface DataTypesRolesListResponse
|
|
16901
|
+
*/
|
|
16902
|
+
export interface DataTypesRolesListResponse {
|
|
16903
|
+
/**
|
|
16904
|
+
*
|
|
16905
|
+
* @type {Array<DataTypesRole>}
|
|
16906
|
+
* @memberof DataTypesRolesListResponse
|
|
16907
|
+
*/
|
|
16908
|
+
'data'?: Array<DataTypesRole>;
|
|
16909
|
+
/**
|
|
16910
|
+
*
|
|
16911
|
+
* @type {string}
|
|
16912
|
+
* @memberof DataTypesRolesListResponse
|
|
16913
|
+
*/
|
|
16914
|
+
'message'?: string;
|
|
16915
|
+
/**
|
|
16916
|
+
*
|
|
16917
|
+
* @type {number}
|
|
16918
|
+
* @memberof DataTypesRolesListResponse
|
|
16919
|
+
*/
|
|
16920
|
+
'status'?: number;
|
|
16921
|
+
}
|
|
15538
16922
|
/**
|
|
15539
16923
|
* Defines the conditions that trigger a rule (query matching, filters, etc.)
|
|
15540
16924
|
* @export
|
|
@@ -16094,6 +17478,31 @@ export interface DataTypesServiceRequestResponse {
|
|
|
16094
17478
|
*/
|
|
16095
17479
|
'status'?: number;
|
|
16096
17480
|
}
|
|
17481
|
+
/**
|
|
17482
|
+
*
|
|
17483
|
+
* @export
|
|
17484
|
+
* @interface DataTypesServiceRequestsListResponse
|
|
17485
|
+
*/
|
|
17486
|
+
export interface DataTypesServiceRequestsListResponse {
|
|
17487
|
+
/**
|
|
17488
|
+
*
|
|
17489
|
+
* @type {Array<DataTypesServiceRequest>}
|
|
17490
|
+
* @memberof DataTypesServiceRequestsListResponse
|
|
17491
|
+
*/
|
|
17492
|
+
'data'?: Array<DataTypesServiceRequest>;
|
|
17493
|
+
/**
|
|
17494
|
+
*
|
|
17495
|
+
* @type {string}
|
|
17496
|
+
* @memberof DataTypesServiceRequestsListResponse
|
|
17497
|
+
*/
|
|
17498
|
+
'message'?: string;
|
|
17499
|
+
/**
|
|
17500
|
+
*
|
|
17501
|
+
* @type {number}
|
|
17502
|
+
* @memberof DataTypesServiceRequestsListResponse
|
|
17503
|
+
*/
|
|
17504
|
+
'status'?: number;
|
|
17505
|
+
}
|
|
16097
17506
|
/**
|
|
16098
17507
|
*
|
|
16099
17508
|
* @export
|
|
@@ -16960,6 +18369,31 @@ export interface DataTypesSubscriptionResponse {
|
|
|
16960
18369
|
*/
|
|
16961
18370
|
'status'?: number;
|
|
16962
18371
|
}
|
|
18372
|
+
/**
|
|
18373
|
+
*
|
|
18374
|
+
* @export
|
|
18375
|
+
* @interface DataTypesSubscriptionsListResponse
|
|
18376
|
+
*/
|
|
18377
|
+
export interface DataTypesSubscriptionsListResponse {
|
|
18378
|
+
/**
|
|
18379
|
+
*
|
|
18380
|
+
* @type {Array<DataTypesSubscription>}
|
|
18381
|
+
* @memberof DataTypesSubscriptionsListResponse
|
|
18382
|
+
*/
|
|
18383
|
+
'data'?: Array<DataTypesSubscription>;
|
|
18384
|
+
/**
|
|
18385
|
+
*
|
|
18386
|
+
* @type {string}
|
|
18387
|
+
* @memberof DataTypesSubscriptionsListResponse
|
|
18388
|
+
*/
|
|
18389
|
+
'message'?: string;
|
|
18390
|
+
/**
|
|
18391
|
+
*
|
|
18392
|
+
* @type {number}
|
|
18393
|
+
* @memberof DataTypesSubscriptionsListResponse
|
|
18394
|
+
*/
|
|
18395
|
+
'status'?: number;
|
|
18396
|
+
}
|
|
16963
18397
|
/**
|
|
16964
18398
|
*
|
|
16965
18399
|
* @export
|
|
@@ -21025,6 +22459,41 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
21025
22459
|
* @throws {RequiredError}
|
|
21026
22460
|
*/
|
|
21027
22461
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: (xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22462
|
+
/**
|
|
22463
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
22464
|
+
* @summary Get Query Insights
|
|
22465
|
+
* @param {string} xStoreID Store ID
|
|
22466
|
+
* @param {string} query Search query to analyze
|
|
22467
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
22468
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
22469
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
22470
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
22471
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
22472
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
22473
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
22474
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
22475
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
22476
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
22477
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
22478
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
22479
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
22480
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
22481
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
22482
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22483
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
22484
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
22485
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
22486
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22487
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
22488
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22489
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22490
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22491
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22492
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
22493
|
+
* @param {*} [options] Override http request option.
|
|
22494
|
+
* @throws {RequiredError}
|
|
22495
|
+
*/
|
|
22496
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21028
22497
|
/**
|
|
21029
22498
|
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
21030
22499
|
* @summary Get Top Results Analytics
|
|
@@ -21430,6 +22899,41 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
21430
22899
|
* @throws {RequiredError}
|
|
21431
22900
|
*/
|
|
21432
22901
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>>;
|
|
22902
|
+
/**
|
|
22903
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
22904
|
+
* @summary Get Query Insights
|
|
22905
|
+
* @param {string} xStoreID Store ID
|
|
22906
|
+
* @param {string} query Search query to analyze
|
|
22907
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
22908
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
22909
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
22910
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
22911
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
22912
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
22913
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
22914
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
22915
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
22916
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
22917
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
22918
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
22919
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
22920
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
22921
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
22922
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22923
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
22924
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
22925
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
22926
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22927
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
22928
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22929
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22930
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22931
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22932
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
22933
|
+
* @param {*} [options] Override http request option.
|
|
22934
|
+
* @throws {RequiredError}
|
|
22935
|
+
*/
|
|
22936
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>>;
|
|
21433
22937
|
/**
|
|
21434
22938
|
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
21435
22939
|
* @summary Get Top Results Analytics
|
|
@@ -21835,6 +23339,41 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
21835
23339
|
* @throws {RequiredError}
|
|
21836
23340
|
*/
|
|
21837
23341
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>;
|
|
23342
|
+
/**
|
|
23343
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
23344
|
+
* @summary Get Query Insights
|
|
23345
|
+
* @param {string} xStoreID Store ID
|
|
23346
|
+
* @param {string} query Search query to analyze
|
|
23347
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
23348
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
23349
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
23350
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
23351
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
23352
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
23353
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
23354
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
23355
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
23356
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
23357
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
23358
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
23359
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
23360
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
23361
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
23362
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
23363
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
23364
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
23365
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
23366
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
23367
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
23368
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
23369
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
23370
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
23371
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
23372
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
23373
|
+
* @param {*} [options] Override http request option.
|
|
23374
|
+
* @throws {RequiredError}
|
|
23375
|
+
*/
|
|
23376
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>;
|
|
21838
23377
|
/**
|
|
21839
23378
|
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
21840
23379
|
* @summary Get Top Results Analytics
|
|
@@ -22256,6 +23795,42 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
22256
23795
|
* @memberof AnalyticsApi
|
|
22257
23796
|
*/
|
|
22258
23797
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response, any, {}>>;
|
|
23798
|
+
/**
|
|
23799
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
23800
|
+
* @summary Get Query Insights
|
|
23801
|
+
* @param {string} xStoreID Store ID
|
|
23802
|
+
* @param {string} query Search query to analyze
|
|
23803
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
23804
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
23805
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
23806
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
23807
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
23808
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
23809
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
23810
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
23811
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
23812
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
23813
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
23814
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
23815
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
23816
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
23817
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
23818
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
23819
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
23820
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
23821
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
23822
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
23823
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
23824
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
23825
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
23826
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
23827
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
23828
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
23829
|
+
* @param {*} [options] Override http request option.
|
|
23830
|
+
* @throws {RequiredError}
|
|
23831
|
+
* @memberof AnalyticsApi
|
|
23832
|
+
*/
|
|
23833
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any, {}>>;
|
|
22259
23834
|
/**
|
|
22260
23835
|
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
22261
23836
|
* @summary Get Top Results Analytics
|
|
@@ -22667,6 +24242,22 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum
|
|
|
22667
24242
|
readonly Desc: "desc";
|
|
22668
24243
|
};
|
|
22669
24244
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
24245
|
+
/**
|
|
24246
|
+
* @export
|
|
24247
|
+
*/
|
|
24248
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum: {
|
|
24249
|
+
readonly Any: "any";
|
|
24250
|
+
readonly All: "all";
|
|
24251
|
+
};
|
|
24252
|
+
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum];
|
|
24253
|
+
/**
|
|
24254
|
+
* @export
|
|
24255
|
+
*/
|
|
24256
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum: {
|
|
24257
|
+
readonly Any: "any";
|
|
24258
|
+
readonly All: "all";
|
|
24259
|
+
};
|
|
24260
|
+
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum];
|
|
22670
24261
|
/**
|
|
22671
24262
|
* @export
|
|
22672
24263
|
*/
|
|
@@ -27980,6 +29571,13 @@ export declare const LimitsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
27980
29571
|
* @throws {RequiredError}
|
|
27981
29572
|
*/
|
|
27982
29573
|
miscLimitsChangeStatusLimitIDIsActivePut: (limitID: number, isActive: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29574
|
+
/**
|
|
29575
|
+
* Fetches list of all limits
|
|
29576
|
+
* @summary Fetches list of all limits
|
|
29577
|
+
* @param {*} [options] Override http request option.
|
|
29578
|
+
* @throws {RequiredError}
|
|
29579
|
+
*/
|
|
29580
|
+
miscLimitsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
27983
29581
|
/**
|
|
27984
29582
|
* Fetches limit by id
|
|
27985
29583
|
* @summary Fetches limit by id
|
|
@@ -28020,6 +29618,13 @@ export declare const LimitsApiFp: (configuration?: Configuration) => {
|
|
|
28020
29618
|
* @throws {RequiredError}
|
|
28021
29619
|
*/
|
|
28022
29620
|
miscLimitsChangeStatusLimitIDIsActivePut(limitID: number, isActive: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
29621
|
+
/**
|
|
29622
|
+
* Fetches list of all limits
|
|
29623
|
+
* @summary Fetches list of all limits
|
|
29624
|
+
* @param {*} [options] Override http request option.
|
|
29625
|
+
* @throws {RequiredError}
|
|
29626
|
+
*/
|
|
29627
|
+
miscLimitsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesLimitsListResponse>>;
|
|
28023
29628
|
/**
|
|
28024
29629
|
* Fetches limit by id
|
|
28025
29630
|
* @summary Fetches limit by id
|
|
@@ -28060,6 +29665,13 @@ export declare const LimitsApiFactory: (configuration?: Configuration, basePath?
|
|
|
28060
29665
|
* @throws {RequiredError}
|
|
28061
29666
|
*/
|
|
28062
29667
|
miscLimitsChangeStatusLimitIDIsActivePut(limitID: number, isActive: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
29668
|
+
/**
|
|
29669
|
+
* Fetches list of all limits
|
|
29670
|
+
* @summary Fetches list of all limits
|
|
29671
|
+
* @param {*} [options] Override http request option.
|
|
29672
|
+
* @throws {RequiredError}
|
|
29673
|
+
*/
|
|
29674
|
+
miscLimitsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesLimitsListResponse>;
|
|
28063
29675
|
/**
|
|
28064
29676
|
* Fetches limit by id
|
|
28065
29677
|
* @summary Fetches limit by id
|
|
@@ -28103,6 +29715,14 @@ export declare class LimitsApi extends BaseAPI {
|
|
|
28103
29715
|
* @memberof LimitsApi
|
|
28104
29716
|
*/
|
|
28105
29717
|
miscLimitsChangeStatusLimitIDIsActivePut(limitID: number, isActive: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
29718
|
+
/**
|
|
29719
|
+
* Fetches list of all limits
|
|
29720
|
+
* @summary Fetches list of all limits
|
|
29721
|
+
* @param {*} [options] Override http request option.
|
|
29722
|
+
* @throws {RequiredError}
|
|
29723
|
+
* @memberof LimitsApi
|
|
29724
|
+
*/
|
|
29725
|
+
miscLimitsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesLimitsListResponse, any, {}>>;
|
|
28106
29726
|
/**
|
|
28107
29727
|
* Fetches limit by id
|
|
28108
29728
|
* @summary Fetches limit by id
|
|
@@ -28137,6 +29757,13 @@ export declare class LimitsApi extends BaseAPI {
|
|
|
28137
29757
|
* @export
|
|
28138
29758
|
*/
|
|
28139
29759
|
export declare const MenusApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
29760
|
+
/**
|
|
29761
|
+
* Fetches list of all menus
|
|
29762
|
+
* @summary Fetches list of all menus
|
|
29763
|
+
* @param {*} [options] Override http request option.
|
|
29764
|
+
* @throws {RequiredError}
|
|
29765
|
+
*/
|
|
29766
|
+
miscMenusGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
28140
29767
|
/**
|
|
28141
29768
|
* Deletes a menu from the system by ID.
|
|
28142
29769
|
* @summary Delete a menu
|
|
@@ -28255,6 +29882,13 @@ export declare const MenusApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
28255
29882
|
* @export
|
|
28256
29883
|
*/
|
|
28257
29884
|
export declare const MenusApiFp: (configuration?: Configuration) => {
|
|
29885
|
+
/**
|
|
29886
|
+
* Fetches list of all menus
|
|
29887
|
+
* @summary Fetches list of all menus
|
|
29888
|
+
* @param {*} [options] Override http request option.
|
|
29889
|
+
* @throws {RequiredError}
|
|
29890
|
+
*/
|
|
29891
|
+
miscMenusGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesMenusListResponse>>;
|
|
28258
29892
|
/**
|
|
28259
29893
|
* Deletes a menu from the system by ID.
|
|
28260
29894
|
* @summary Delete a menu
|
|
@@ -28373,6 +30007,13 @@ export declare const MenusApiFp: (configuration?: Configuration) => {
|
|
|
28373
30007
|
* @export
|
|
28374
30008
|
*/
|
|
28375
30009
|
export declare const MenusApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
30010
|
+
/**
|
|
30011
|
+
* Fetches list of all menus
|
|
30012
|
+
* @summary Fetches list of all menus
|
|
30013
|
+
* @param {*} [options] Override http request option.
|
|
30014
|
+
* @throws {RequiredError}
|
|
30015
|
+
*/
|
|
30016
|
+
miscMenusGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesMenusListResponse>;
|
|
28376
30017
|
/**
|
|
28377
30018
|
* Deletes a menu from the system by ID.
|
|
28378
30019
|
* @summary Delete a menu
|
|
@@ -28493,6 +30134,14 @@ export declare const MenusApiFactory: (configuration?: Configuration, basePath?:
|
|
|
28493
30134
|
* @extends {BaseAPI}
|
|
28494
30135
|
*/
|
|
28495
30136
|
export declare class MenusApi extends BaseAPI {
|
|
30137
|
+
/**
|
|
30138
|
+
* Fetches list of all menus
|
|
30139
|
+
* @summary Fetches list of all menus
|
|
30140
|
+
* @param {*} [options] Override http request option.
|
|
30141
|
+
* @throws {RequiredError}
|
|
30142
|
+
* @memberof MenusApi
|
|
30143
|
+
*/
|
|
30144
|
+
miscMenusGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesMenusListResponse, any, {}>>;
|
|
28496
30145
|
/**
|
|
28497
30146
|
* Deletes a menu from the system by ID.
|
|
28498
30147
|
* @summary Delete a menu
|
|
@@ -29043,6 +30692,13 @@ export declare class MongoDbApi extends BaseAPI {
|
|
|
29043
30692
|
* @export
|
|
29044
30693
|
*/
|
|
29045
30694
|
export declare const NewsLettersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30695
|
+
/**
|
|
30696
|
+
* Fetches list of all NewsLetterSubscription
|
|
30697
|
+
* @summary Fetches list of all NewsLetterSubscription
|
|
30698
|
+
* @param {*} [options] Override http request option.
|
|
30699
|
+
* @throws {RequiredError}
|
|
30700
|
+
*/
|
|
30701
|
+
miscNewsLettersGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29046
30702
|
/**
|
|
29047
30703
|
* Fetches NewsLetterSubscription by id
|
|
29048
30704
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -29083,6 +30739,13 @@ export declare const NewsLettersApiAxiosParamCreator: (configuration?: Configura
|
|
|
29083
30739
|
* @export
|
|
29084
30740
|
*/
|
|
29085
30741
|
export declare const NewsLettersApiFp: (configuration?: Configuration) => {
|
|
30742
|
+
/**
|
|
30743
|
+
* Fetches list of all NewsLetterSubscription
|
|
30744
|
+
* @summary Fetches list of all NewsLetterSubscription
|
|
30745
|
+
* @param {*} [options] Override http request option.
|
|
30746
|
+
* @throws {RequiredError}
|
|
30747
|
+
*/
|
|
30748
|
+
miscNewsLettersGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesNewsLetterRequestsListResponse>>;
|
|
29086
30749
|
/**
|
|
29087
30750
|
* Fetches NewsLetterSubscription by id
|
|
29088
30751
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -29123,6 +30786,13 @@ export declare const NewsLettersApiFp: (configuration?: Configuration) => {
|
|
|
29123
30786
|
* @export
|
|
29124
30787
|
*/
|
|
29125
30788
|
export declare const NewsLettersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
30789
|
+
/**
|
|
30790
|
+
* Fetches list of all NewsLetterSubscription
|
|
30791
|
+
* @summary Fetches list of all NewsLetterSubscription
|
|
30792
|
+
* @param {*} [options] Override http request option.
|
|
30793
|
+
* @throws {RequiredError}
|
|
30794
|
+
*/
|
|
30795
|
+
miscNewsLettersGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesNewsLetterRequestsListResponse>;
|
|
29126
30796
|
/**
|
|
29127
30797
|
* Fetches NewsLetterSubscription by id
|
|
29128
30798
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -29165,6 +30835,14 @@ export declare const NewsLettersApiFactory: (configuration?: Configuration, base
|
|
|
29165
30835
|
* @extends {BaseAPI}
|
|
29166
30836
|
*/
|
|
29167
30837
|
export declare class NewsLettersApi extends BaseAPI {
|
|
30838
|
+
/**
|
|
30839
|
+
* Fetches list of all NewsLetterSubscription
|
|
30840
|
+
* @summary Fetches list of all NewsLetterSubscription
|
|
30841
|
+
* @param {*} [options] Override http request option.
|
|
30842
|
+
* @throws {RequiredError}
|
|
30843
|
+
* @memberof NewsLettersApi
|
|
30844
|
+
*/
|
|
30845
|
+
miscNewsLettersGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesNewsLetterRequestsListResponse, any, {}>>;
|
|
29168
30846
|
/**
|
|
29169
30847
|
* Fetches NewsLetterSubscription by id
|
|
29170
30848
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -29516,6 +31194,13 @@ export declare class OnboardingApi extends BaseAPI {
|
|
|
29516
31194
|
* @export
|
|
29517
31195
|
*/
|
|
29518
31196
|
export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
31197
|
+
/**
|
|
31198
|
+
* Fetches list of all Organizations
|
|
31199
|
+
* @summary Fetches list of all Organizations
|
|
31200
|
+
* @param {*} [options] Override http request option.
|
|
31201
|
+
* @throws {RequiredError}
|
|
31202
|
+
*/
|
|
31203
|
+
adminOrganizationsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29519
31204
|
/**
|
|
29520
31205
|
* Updates Orgnization information by ID.
|
|
29521
31206
|
* @summary Update an existing Orgnization
|
|
@@ -29556,6 +31241,13 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
29556
31241
|
* @export
|
|
29557
31242
|
*/
|
|
29558
31243
|
export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
31244
|
+
/**
|
|
31245
|
+
* Fetches list of all Organizations
|
|
31246
|
+
* @summary Fetches list of all Organizations
|
|
31247
|
+
* @param {*} [options] Override http request option.
|
|
31248
|
+
* @throws {RequiredError}
|
|
31249
|
+
*/
|
|
31250
|
+
adminOrganizationsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOrganizationsListResponse>>;
|
|
29559
31251
|
/**
|
|
29560
31252
|
* Updates Orgnization information by ID.
|
|
29561
31253
|
* @summary Update an existing Orgnization
|
|
@@ -29596,6 +31288,13 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
29596
31288
|
* @export
|
|
29597
31289
|
*/
|
|
29598
31290
|
export declare const OrganizationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
31291
|
+
/**
|
|
31292
|
+
* Fetches list of all Organizations
|
|
31293
|
+
* @summary Fetches list of all Organizations
|
|
31294
|
+
* @param {*} [options] Override http request option.
|
|
31295
|
+
* @throws {RequiredError}
|
|
31296
|
+
*/
|
|
31297
|
+
adminOrganizationsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOrganizationsListResponse>;
|
|
29599
31298
|
/**
|
|
29600
31299
|
* Updates Orgnization information by ID.
|
|
29601
31300
|
* @summary Update an existing Orgnization
|
|
@@ -29638,6 +31337,14 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
|
29638
31337
|
* @extends {BaseAPI}
|
|
29639
31338
|
*/
|
|
29640
31339
|
export declare class OrganizationsApi extends BaseAPI {
|
|
31340
|
+
/**
|
|
31341
|
+
* Fetches list of all Organizations
|
|
31342
|
+
* @summary Fetches list of all Organizations
|
|
31343
|
+
* @param {*} [options] Override http request option.
|
|
31344
|
+
* @throws {RequiredError}
|
|
31345
|
+
* @memberof OrganizationsApi
|
|
31346
|
+
*/
|
|
31347
|
+
adminOrganizationsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOrganizationsListResponse, any, {}>>;
|
|
29641
31348
|
/**
|
|
29642
31349
|
* Updates Orgnization information by ID.
|
|
29643
31350
|
* @summary Update an existing Orgnization
|
|
@@ -30384,6 +32091,13 @@ export declare class PaymentGatewayApi extends BaseAPI {
|
|
|
30384
32091
|
* @export
|
|
30385
32092
|
*/
|
|
30386
32093
|
export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
32094
|
+
/**
|
|
32095
|
+
* Fetches list of all payments
|
|
32096
|
+
* @summary Fetches list of all payments
|
|
32097
|
+
* @param {*} [options] Override http request option.
|
|
32098
|
+
* @throws {RequiredError}
|
|
32099
|
+
*/
|
|
32100
|
+
adminPaymentsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
30387
32101
|
/**
|
|
30388
32102
|
* Deletes a payment from the system by ID.
|
|
30389
32103
|
* @summary Delete a payment
|
|
@@ -30423,6 +32137,13 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
30423
32137
|
* @export
|
|
30424
32138
|
*/
|
|
30425
32139
|
export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
32140
|
+
/**
|
|
32141
|
+
* Fetches list of all payments
|
|
32142
|
+
* @summary Fetches list of all payments
|
|
32143
|
+
* @param {*} [options] Override http request option.
|
|
32144
|
+
* @throws {RequiredError}
|
|
32145
|
+
*/
|
|
32146
|
+
adminPaymentsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPaymentsListResponse>>;
|
|
30426
32147
|
/**
|
|
30427
32148
|
* Deletes a payment from the system by ID.
|
|
30428
32149
|
* @summary Delete a payment
|
|
@@ -30462,6 +32183,13 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
|
30462
32183
|
* @export
|
|
30463
32184
|
*/
|
|
30464
32185
|
export declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
32186
|
+
/**
|
|
32187
|
+
* Fetches list of all payments
|
|
32188
|
+
* @summary Fetches list of all payments
|
|
32189
|
+
* @param {*} [options] Override http request option.
|
|
32190
|
+
* @throws {RequiredError}
|
|
32191
|
+
*/
|
|
32192
|
+
adminPaymentsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPaymentsListResponse>;
|
|
30465
32193
|
/**
|
|
30466
32194
|
* Deletes a payment from the system by ID.
|
|
30467
32195
|
* @summary Delete a payment
|
|
@@ -30503,6 +32231,14 @@ export declare const PaymentsApiFactory: (configuration?: Configuration, basePat
|
|
|
30503
32231
|
* @extends {BaseAPI}
|
|
30504
32232
|
*/
|
|
30505
32233
|
export declare class PaymentsApi extends BaseAPI {
|
|
32234
|
+
/**
|
|
32235
|
+
* Fetches list of all payments
|
|
32236
|
+
* @summary Fetches list of all payments
|
|
32237
|
+
* @param {*} [options] Override http request option.
|
|
32238
|
+
* @throws {RequiredError}
|
|
32239
|
+
* @memberof PaymentsApi
|
|
32240
|
+
*/
|
|
32241
|
+
adminPaymentsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesPaymentsListResponse, any, {}>>;
|
|
30506
32242
|
/**
|
|
30507
32243
|
* Deletes a payment from the system by ID.
|
|
30508
32244
|
* @summary Delete a payment
|
|
@@ -30546,6 +32282,13 @@ export declare class PaymentsApi extends BaseAPI {
|
|
|
30546
32282
|
* @export
|
|
30547
32283
|
*/
|
|
30548
32284
|
export declare const PlansApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
32285
|
+
/**
|
|
32286
|
+
* Fetches list of all Plans
|
|
32287
|
+
* @summary Fetches list of all Plans
|
|
32288
|
+
* @param {*} [options] Override http request option.
|
|
32289
|
+
* @throws {RequiredError}
|
|
32290
|
+
*/
|
|
32291
|
+
miscPlansGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
30549
32292
|
/**
|
|
30550
32293
|
* Fetches plan by id
|
|
30551
32294
|
* @summary Fetches plan by id
|
|
@@ -30586,6 +32329,13 @@ export declare const PlansApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
30586
32329
|
* @export
|
|
30587
32330
|
*/
|
|
30588
32331
|
export declare const PlansApiFp: (configuration?: Configuration) => {
|
|
32332
|
+
/**
|
|
32333
|
+
* Fetches list of all Plans
|
|
32334
|
+
* @summary Fetches list of all Plans
|
|
32335
|
+
* @param {*} [options] Override http request option.
|
|
32336
|
+
* @throws {RequiredError}
|
|
32337
|
+
*/
|
|
32338
|
+
miscPlansGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPlansListResponse>>;
|
|
30589
32339
|
/**
|
|
30590
32340
|
* Fetches plan by id
|
|
30591
32341
|
* @summary Fetches plan by id
|
|
@@ -30626,6 +32376,13 @@ export declare const PlansApiFp: (configuration?: Configuration) => {
|
|
|
30626
32376
|
* @export
|
|
30627
32377
|
*/
|
|
30628
32378
|
export declare const PlansApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
32379
|
+
/**
|
|
32380
|
+
* Fetches list of all Plans
|
|
32381
|
+
* @summary Fetches list of all Plans
|
|
32382
|
+
* @param {*} [options] Override http request option.
|
|
32383
|
+
* @throws {RequiredError}
|
|
32384
|
+
*/
|
|
32385
|
+
miscPlansGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPlansListResponse>;
|
|
30629
32386
|
/**
|
|
30630
32387
|
* Fetches plan by id
|
|
30631
32388
|
* @summary Fetches plan by id
|
|
@@ -30668,6 +32425,14 @@ export declare const PlansApiFactory: (configuration?: Configuration, basePath?:
|
|
|
30668
32425
|
* @extends {BaseAPI}
|
|
30669
32426
|
*/
|
|
30670
32427
|
export declare class PlansApi extends BaseAPI {
|
|
32428
|
+
/**
|
|
32429
|
+
* Fetches list of all Plans
|
|
32430
|
+
* @summary Fetches list of all Plans
|
|
32431
|
+
* @param {*} [options] Override http request option.
|
|
32432
|
+
* @throws {RequiredError}
|
|
32433
|
+
* @memberof PlansApi
|
|
32434
|
+
*/
|
|
32435
|
+
miscPlansGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesPlansListResponse, any, {}>>;
|
|
30671
32436
|
/**
|
|
30672
32437
|
* Fetches plan by id
|
|
30673
32438
|
* @summary Fetches plan by id
|
|
@@ -33002,6 +34767,13 @@ export declare class RegisterApi extends BaseAPI {
|
|
|
33002
34767
|
* @export
|
|
33003
34768
|
*/
|
|
33004
34769
|
export declare const RequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
34770
|
+
/**
|
|
34771
|
+
* Fetches list of all ServiceRequest
|
|
34772
|
+
* @summary Fetches list of all ServiceRequest
|
|
34773
|
+
* @param {*} [options] Override http request option.
|
|
34774
|
+
* @throws {RequiredError}
|
|
34775
|
+
*/
|
|
34776
|
+
miscRequestsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
33005
34777
|
/**
|
|
33006
34778
|
* Updates ServiceRequest information by ID.
|
|
33007
34779
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -33050,6 +34822,13 @@ export declare const RequestsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
33050
34822
|
* @export
|
|
33051
34823
|
*/
|
|
33052
34824
|
export declare const RequestsApiFp: (configuration?: Configuration) => {
|
|
34825
|
+
/**
|
|
34826
|
+
* Fetches list of all ServiceRequest
|
|
34827
|
+
* @summary Fetches list of all ServiceRequest
|
|
34828
|
+
* @param {*} [options] Override http request option.
|
|
34829
|
+
* @throws {RequiredError}
|
|
34830
|
+
*/
|
|
34831
|
+
miscRequestsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesServiceRequestsListResponse>>;
|
|
33053
34832
|
/**
|
|
33054
34833
|
* Updates ServiceRequest information by ID.
|
|
33055
34834
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -33098,6 +34877,13 @@ export declare const RequestsApiFp: (configuration?: Configuration) => {
|
|
|
33098
34877
|
* @export
|
|
33099
34878
|
*/
|
|
33100
34879
|
export declare const RequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
34880
|
+
/**
|
|
34881
|
+
* Fetches list of all ServiceRequest
|
|
34882
|
+
* @summary Fetches list of all ServiceRequest
|
|
34883
|
+
* @param {*} [options] Override http request option.
|
|
34884
|
+
* @throws {RequiredError}
|
|
34885
|
+
*/
|
|
34886
|
+
miscRequestsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesServiceRequestsListResponse>;
|
|
33101
34887
|
/**
|
|
33102
34888
|
* Updates ServiceRequest information by ID.
|
|
33103
34889
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -33148,6 +34934,14 @@ export declare const RequestsApiFactory: (configuration?: Configuration, basePat
|
|
|
33148
34934
|
* @extends {BaseAPI}
|
|
33149
34935
|
*/
|
|
33150
34936
|
export declare class RequestsApi extends BaseAPI {
|
|
34937
|
+
/**
|
|
34938
|
+
* Fetches list of all ServiceRequest
|
|
34939
|
+
* @summary Fetches list of all ServiceRequest
|
|
34940
|
+
* @param {*} [options] Override http request option.
|
|
34941
|
+
* @throws {RequiredError}
|
|
34942
|
+
* @memberof RequestsApi
|
|
34943
|
+
*/
|
|
34944
|
+
miscRequestsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesServiceRequestsListResponse, any, {}>>;
|
|
33151
34945
|
/**
|
|
33152
34946
|
* Updates ServiceRequest information by ID.
|
|
33153
34947
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -33209,6 +35003,13 @@ export declare const RoleRightsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
33209
35003
|
* @throws {RequiredError}
|
|
33210
35004
|
*/
|
|
33211
35005
|
adminRolerightsBulkPost: (dataTypesRoleRightRequestDto: Array<DataTypesRoleRightRequestDto>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35006
|
+
/**
|
|
35007
|
+
* Fetches list of all roleright
|
|
35008
|
+
* @summary Fetches list of all roleright
|
|
35009
|
+
* @param {*} [options] Override http request option.
|
|
35010
|
+
* @throws {RequiredError}
|
|
35011
|
+
*/
|
|
35012
|
+
adminRolerightsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
33212
35013
|
/**
|
|
33213
35014
|
* Fetches roleright by role id
|
|
33214
35015
|
* @summary Fetches roleright by role id
|
|
@@ -33272,6 +35073,13 @@ export declare const RoleRightsApiFp: (configuration?: Configuration) => {
|
|
|
33272
35073
|
* @throws {RequiredError}
|
|
33273
35074
|
*/
|
|
33274
35075
|
adminRolerightsBulkPost(dataTypesRoleRightRequestDto: Array<DataTypesRoleRightRequestDto>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35076
|
+
/**
|
|
35077
|
+
* Fetches list of all roleright
|
|
35078
|
+
* @summary Fetches list of all roleright
|
|
35079
|
+
* @param {*} [options] Override http request option.
|
|
35080
|
+
* @throws {RequiredError}
|
|
35081
|
+
*/
|
|
35082
|
+
adminRolerightsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRoleRightsListResponse>>;
|
|
33275
35083
|
/**
|
|
33276
35084
|
* Fetches roleright by role id
|
|
33277
35085
|
* @summary Fetches roleright by role id
|
|
@@ -33335,6 +35143,13 @@ export declare const RoleRightsApiFactory: (configuration?: Configuration, baseP
|
|
|
33335
35143
|
* @throws {RequiredError}
|
|
33336
35144
|
*/
|
|
33337
35145
|
adminRolerightsBulkPost(dataTypesRoleRightRequestDto: Array<DataTypesRoleRightRequestDto>, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
35146
|
+
/**
|
|
35147
|
+
* Fetches list of all roleright
|
|
35148
|
+
* @summary Fetches list of all roleright
|
|
35149
|
+
* @param {*} [options] Override http request option.
|
|
35150
|
+
* @throws {RequiredError}
|
|
35151
|
+
*/
|
|
35152
|
+
adminRolerightsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRoleRightsListResponse>;
|
|
33338
35153
|
/**
|
|
33339
35154
|
* Fetches roleright by role id
|
|
33340
35155
|
* @summary Fetches roleright by role id
|
|
@@ -33401,6 +35216,14 @@ export declare class RoleRightsApi extends BaseAPI {
|
|
|
33401
35216
|
* @memberof RoleRightsApi
|
|
33402
35217
|
*/
|
|
33403
35218
|
adminRolerightsBulkPost(dataTypesRoleRightRequestDto: Array<DataTypesRoleRightRequestDto>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
35219
|
+
/**
|
|
35220
|
+
* Fetches list of all roleright
|
|
35221
|
+
* @summary Fetches list of all roleright
|
|
35222
|
+
* @param {*} [options] Override http request option.
|
|
35223
|
+
* @throws {RequiredError}
|
|
35224
|
+
* @memberof RoleRightsApi
|
|
35225
|
+
*/
|
|
35226
|
+
adminRolerightsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesRoleRightsListResponse, any, {}>>;
|
|
33404
35227
|
/**
|
|
33405
35228
|
* Fetches roleright by role id
|
|
33406
35229
|
* @summary Fetches roleright by role id
|
|
@@ -33479,6 +35302,14 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
33479
35302
|
* @throws {RequiredError}
|
|
33480
35303
|
*/
|
|
33481
35304
|
adminRolesIdPut: (id: number, dataTypesCreateRoleRequestDto: DataTypesCreateRoleRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35305
|
+
/**
|
|
35306
|
+
* Fetches list of all roles
|
|
35307
|
+
* @summary Fetches list of all roles
|
|
35308
|
+
* @param {number} orgId Org ID
|
|
35309
|
+
* @param {*} [options] Override http request option.
|
|
35310
|
+
* @throws {RequiredError}
|
|
35311
|
+
*/
|
|
35312
|
+
adminRolesOrgIdGet: (orgId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
33482
35313
|
/**
|
|
33483
35314
|
* Fetches role by id
|
|
33484
35315
|
* @summary Fetches role by id
|
|
@@ -33519,6 +35350,14 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
33519
35350
|
* @throws {RequiredError}
|
|
33520
35351
|
*/
|
|
33521
35352
|
adminRolesIdPut(id: number, dataTypesCreateRoleRequestDto: DataTypesCreateRoleRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35353
|
+
/**
|
|
35354
|
+
* Fetches list of all roles
|
|
35355
|
+
* @summary Fetches list of all roles
|
|
35356
|
+
* @param {number} orgId Org ID
|
|
35357
|
+
* @param {*} [options] Override http request option.
|
|
35358
|
+
* @throws {RequiredError}
|
|
35359
|
+
*/
|
|
35360
|
+
adminRolesOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRolesListResponse>>;
|
|
33522
35361
|
/**
|
|
33523
35362
|
* Fetches role by id
|
|
33524
35363
|
* @summary Fetches role by id
|
|
@@ -33559,6 +35398,14 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
33559
35398
|
* @throws {RequiredError}
|
|
33560
35399
|
*/
|
|
33561
35400
|
adminRolesIdPut(id: number, dataTypesCreateRoleRequestDto: DataTypesCreateRoleRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
35401
|
+
/**
|
|
35402
|
+
* Fetches list of all roles
|
|
35403
|
+
* @summary Fetches list of all roles
|
|
35404
|
+
* @param {number} orgId Org ID
|
|
35405
|
+
* @param {*} [options] Override http request option.
|
|
35406
|
+
* @throws {RequiredError}
|
|
35407
|
+
*/
|
|
35408
|
+
adminRolesOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRolesListResponse>;
|
|
33562
35409
|
/**
|
|
33563
35410
|
* Fetches role by id
|
|
33564
35411
|
* @summary Fetches role by id
|
|
@@ -33603,6 +35450,15 @@ export declare class RolesApi extends BaseAPI {
|
|
|
33603
35450
|
* @memberof RolesApi
|
|
33604
35451
|
*/
|
|
33605
35452
|
adminRolesIdPut(id: number, dataTypesCreateRoleRequestDto: DataTypesCreateRoleRequestDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
35453
|
+
/**
|
|
35454
|
+
* Fetches list of all roles
|
|
35455
|
+
* @summary Fetches list of all roles
|
|
35456
|
+
* @param {number} orgId Org ID
|
|
35457
|
+
* @param {*} [options] Override http request option.
|
|
35458
|
+
* @throws {RequiredError}
|
|
35459
|
+
* @memberof RolesApi
|
|
35460
|
+
*/
|
|
35461
|
+
adminRolesOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesRolesListResponse, any, {}>>;
|
|
33606
35462
|
/**
|
|
33607
35463
|
* Fetches role by id
|
|
33608
35464
|
* @summary Fetches role by id
|
|
@@ -33680,6 +35536,16 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
33680
35536
|
* @throws {RequiredError}
|
|
33681
35537
|
*/
|
|
33682
35538
|
v1IndexIndexnameDefaultsGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35539
|
+
/**
|
|
35540
|
+
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
35541
|
+
* @summary Public Search API
|
|
35542
|
+
* @param {string} xStoreid Store ID
|
|
35543
|
+
* @param {string} xStoresecret Store Secret
|
|
35544
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
35545
|
+
* @param {*} [options] Override http request option.
|
|
35546
|
+
* @throws {RequiredError}
|
|
35547
|
+
*/
|
|
35548
|
+
v1SearchPost: (xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
33683
35549
|
};
|
|
33684
35550
|
/**
|
|
33685
35551
|
* SearchApi - functional programming interface
|
|
@@ -33738,6 +35604,16 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
33738
35604
|
* @throws {RequiredError}
|
|
33739
35605
|
*/
|
|
33740
35606
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
|
|
35607
|
+
/**
|
|
35608
|
+
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
35609
|
+
* @summary Public Search API
|
|
35610
|
+
* @param {string} xStoreid Store ID
|
|
35611
|
+
* @param {string} xStoresecret Store Secret
|
|
35612
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
35613
|
+
* @param {*} [options] Override http request option.
|
|
35614
|
+
* @throws {RequiredError}
|
|
35615
|
+
*/
|
|
35616
|
+
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
|
|
33741
35617
|
};
|
|
33742
35618
|
/**
|
|
33743
35619
|
* SearchApi - factory interface
|
|
@@ -33796,6 +35672,16 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
33796
35672
|
* @throws {RequiredError}
|
|
33797
35673
|
*/
|
|
33798
35674
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
|
|
35675
|
+
/**
|
|
35676
|
+
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
35677
|
+
* @summary Public Search API
|
|
35678
|
+
* @param {string} xStoreid Store ID
|
|
35679
|
+
* @param {string} xStoresecret Store Secret
|
|
35680
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
35681
|
+
* @param {*} [options] Override http request option.
|
|
35682
|
+
* @throws {RequiredError}
|
|
35683
|
+
*/
|
|
35684
|
+
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
|
|
33799
35685
|
};
|
|
33800
35686
|
/**
|
|
33801
35687
|
* SearchApi - object-oriented interface
|
|
@@ -33862,6 +35748,17 @@ export declare class SearchApi extends BaseAPI {
|
|
|
33862
35748
|
* @memberof SearchApi
|
|
33863
35749
|
*/
|
|
33864
35750
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any, {}>>;
|
|
35751
|
+
/**
|
|
35752
|
+
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
35753
|
+
* @summary Public Search API
|
|
35754
|
+
* @param {string} xStoreid Store ID
|
|
35755
|
+
* @param {string} xStoresecret Store Secret
|
|
35756
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
35757
|
+
* @param {*} [options] Override http request option.
|
|
35758
|
+
* @throws {RequiredError}
|
|
35759
|
+
* @memberof SearchApi
|
|
35760
|
+
*/
|
|
35761
|
+
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any, {}>>;
|
|
33865
35762
|
}
|
|
33866
35763
|
/**
|
|
33867
35764
|
* StopwordsApi - axios parameter creator
|
|
@@ -35444,6 +37341,13 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
|
|
|
35444
37341
|
* @throws {RequiredError}
|
|
35445
37342
|
*/
|
|
35446
37343
|
adminSubscriptionsUpdatestatusSubscriptionIDStatusPut: (subscriptionID: number, status: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37344
|
+
/**
|
|
37345
|
+
* Fetches list of all Subscription
|
|
37346
|
+
* @summary Fetches list of all Subscription
|
|
37347
|
+
* @param {*} [options] Override http request option.
|
|
37348
|
+
* @throws {RequiredError}
|
|
37349
|
+
*/
|
|
37350
|
+
miscSubscriptionsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35447
37351
|
/**
|
|
35448
37352
|
* Adds a new Subscription to the system
|
|
35449
37353
|
* @summary Creates a new Subscription
|
|
@@ -35500,6 +37404,13 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
|
|
|
35500
37404
|
* @throws {RequiredError}
|
|
35501
37405
|
*/
|
|
35502
37406
|
adminSubscriptionsUpdatestatusSubscriptionIDStatusPut(subscriptionID: number, status: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
37407
|
+
/**
|
|
37408
|
+
* Fetches list of all Subscription
|
|
37409
|
+
* @summary Fetches list of all Subscription
|
|
37410
|
+
* @param {*} [options] Override http request option.
|
|
37411
|
+
* @throws {RequiredError}
|
|
37412
|
+
*/
|
|
37413
|
+
miscSubscriptionsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSubscriptionsListResponse>>;
|
|
35503
37414
|
/**
|
|
35504
37415
|
* Adds a new Subscription to the system
|
|
35505
37416
|
* @summary Creates a new Subscription
|
|
@@ -35556,6 +37467,13 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
|
|
|
35556
37467
|
* @throws {RequiredError}
|
|
35557
37468
|
*/
|
|
35558
37469
|
adminSubscriptionsUpdatestatusSubscriptionIDStatusPut(subscriptionID: number, status: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
37470
|
+
/**
|
|
37471
|
+
* Fetches list of all Subscription
|
|
37472
|
+
* @summary Fetches list of all Subscription
|
|
37473
|
+
* @param {*} [options] Override http request option.
|
|
37474
|
+
* @throws {RequiredError}
|
|
37475
|
+
*/
|
|
37476
|
+
miscSubscriptionsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSubscriptionsListResponse>;
|
|
35559
37477
|
/**
|
|
35560
37478
|
* Adds a new Subscription to the system
|
|
35561
37479
|
* @summary Creates a new Subscription
|
|
@@ -35618,6 +37536,14 @@ export declare class SubscriptionsApi extends BaseAPI {
|
|
|
35618
37536
|
* @memberof SubscriptionsApi
|
|
35619
37537
|
*/
|
|
35620
37538
|
adminSubscriptionsUpdatestatusSubscriptionIDStatusPut(subscriptionID: number, status: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
37539
|
+
/**
|
|
37540
|
+
* Fetches list of all Subscription
|
|
37541
|
+
* @summary Fetches list of all Subscription
|
|
37542
|
+
* @param {*} [options] Override http request option.
|
|
37543
|
+
* @throws {RequiredError}
|
|
37544
|
+
* @memberof SubscriptionsApi
|
|
37545
|
+
*/
|
|
37546
|
+
miscSubscriptionsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSubscriptionsListResponse, any, {}>>;
|
|
35621
37547
|
/**
|
|
35622
37548
|
* Adds a new Subscription to the system
|
|
35623
37549
|
* @summary Creates a new Subscription
|