@seekora-ai/admin-api 1.1.66 → 1.1.67
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 +10 -13
- package/api.ts +737 -1090
- package/dist/api.d.ts +376 -703
- package/dist/api.js +227 -314
- package/dist/esm/api.d.ts +376 -703
- package/dist/esm/api.js +222 -305
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.67.tgz +0 -0
- package/seekora-ai-admin-api-1.1.66.tgz +0 -0
package/dist/api.d.ts
CHANGED
|
@@ -2321,6 +2321,12 @@ export interface AnalyticsExtendedKPIResponse {
|
|
|
2321
2321
|
* @memberof AnalyticsExtendedKPIResponse
|
|
2322
2322
|
*/
|
|
2323
2323
|
'start_time'?: string;
|
|
2324
|
+
/**
|
|
2325
|
+
* Store-level breakdown
|
|
2326
|
+
* @type {Array<AnalyticsStoreBreakdown>}
|
|
2327
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
2328
|
+
*/
|
|
2329
|
+
'store_breakdown'?: Array<AnalyticsStoreBreakdown>;
|
|
2324
2330
|
/**
|
|
2325
2331
|
* Can be KPIMetrics or ComparisonMetrics
|
|
2326
2332
|
* @type {any}
|
|
@@ -3345,6 +3351,12 @@ export interface AnalyticsGeoResponse {
|
|
|
3345
3351
|
* @memberof AnalyticsGeoResponse
|
|
3346
3352
|
*/
|
|
3347
3353
|
'start_time'?: string;
|
|
3354
|
+
/**
|
|
3355
|
+
* Store-level breakdown
|
|
3356
|
+
* @type {Array<AnalyticsStoreGeoBreakdown>}
|
|
3357
|
+
* @memberof AnalyticsGeoResponse
|
|
3358
|
+
*/
|
|
3359
|
+
'store_breakdown'?: Array<AnalyticsStoreGeoBreakdown>;
|
|
3348
3360
|
/**
|
|
3349
3361
|
*
|
|
3350
3362
|
* @type {string}
|
|
@@ -5832,6 +5844,12 @@ export interface AnalyticsQueryResponse {
|
|
|
5832
5844
|
* @memberof AnalyticsQueryResponse
|
|
5833
5845
|
*/
|
|
5834
5846
|
'start_time'?: string;
|
|
5847
|
+
/**
|
|
5848
|
+
* Store-level breakdown
|
|
5849
|
+
* @type {Array<AnalyticsStoreQueryBreakdown>}
|
|
5850
|
+
* @memberof AnalyticsQueryResponse
|
|
5851
|
+
*/
|
|
5852
|
+
'store_breakdown'?: Array<AnalyticsStoreQueryBreakdown>;
|
|
5835
5853
|
/**
|
|
5836
5854
|
*
|
|
5837
5855
|
* @type {string}
|
|
@@ -5938,6 +5956,123 @@ export interface AnalyticsSharedQueryAnalysis {
|
|
|
5938
5956
|
*/
|
|
5939
5957
|
'this_item_position'?: number;
|
|
5940
5958
|
}
|
|
5959
|
+
/**
|
|
5960
|
+
*
|
|
5961
|
+
* @export
|
|
5962
|
+
* @interface AnalyticsStoreBreakdown
|
|
5963
|
+
*/
|
|
5964
|
+
export interface AnalyticsStoreBreakdown {
|
|
5965
|
+
/**
|
|
5966
|
+
*
|
|
5967
|
+
* @type {AnalyticsKPIMetrics}
|
|
5968
|
+
* @memberof AnalyticsStoreBreakdown
|
|
5969
|
+
*/
|
|
5970
|
+
'compare_summary'?: AnalyticsKPIMetrics;
|
|
5971
|
+
/**
|
|
5972
|
+
*
|
|
5973
|
+
* @type {number}
|
|
5974
|
+
* @memberof AnalyticsStoreBreakdown
|
|
5975
|
+
*/
|
|
5976
|
+
'store_id'?: number;
|
|
5977
|
+
/**
|
|
5978
|
+
*
|
|
5979
|
+
* @type {string}
|
|
5980
|
+
* @memberof AnalyticsStoreBreakdown
|
|
5981
|
+
*/
|
|
5982
|
+
'store_name'?: string;
|
|
5983
|
+
/**
|
|
5984
|
+
*
|
|
5985
|
+
* @type {AnalyticsKPIMetrics}
|
|
5986
|
+
* @memberof AnalyticsStoreBreakdown
|
|
5987
|
+
*/
|
|
5988
|
+
'summary'?: AnalyticsKPIMetrics;
|
|
5989
|
+
/**
|
|
5990
|
+
* Can be []KPIPointExtended or []ComparisonMetrics
|
|
5991
|
+
* @type {any}
|
|
5992
|
+
* @memberof AnalyticsStoreBreakdown
|
|
5993
|
+
*/
|
|
5994
|
+
'time_series'?: any;
|
|
5995
|
+
/**
|
|
5996
|
+
*
|
|
5997
|
+
* @type {string}
|
|
5998
|
+
* @memberof AnalyticsStoreBreakdown
|
|
5999
|
+
*/
|
|
6000
|
+
'xstoreid'?: string;
|
|
6001
|
+
}
|
|
6002
|
+
/**
|
|
6003
|
+
*
|
|
6004
|
+
* @export
|
|
6005
|
+
* @interface AnalyticsStoreGeoBreakdown
|
|
6006
|
+
*/
|
|
6007
|
+
export interface AnalyticsStoreGeoBreakdown {
|
|
6008
|
+
/**
|
|
6009
|
+
* Can be []GeoAnalytic or []ComparisonMetrics
|
|
6010
|
+
* @type {any}
|
|
6011
|
+
* @memberof AnalyticsStoreGeoBreakdown
|
|
6012
|
+
*/
|
|
6013
|
+
'data'?: any;
|
|
6014
|
+
/**
|
|
6015
|
+
*
|
|
6016
|
+
* @type {number}
|
|
6017
|
+
* @memberof AnalyticsStoreGeoBreakdown
|
|
6018
|
+
*/
|
|
6019
|
+
'store_id'?: number;
|
|
6020
|
+
/**
|
|
6021
|
+
*
|
|
6022
|
+
* @type {string}
|
|
6023
|
+
* @memberof AnalyticsStoreGeoBreakdown
|
|
6024
|
+
*/
|
|
6025
|
+
'store_name'?: string;
|
|
6026
|
+
/**
|
|
6027
|
+
*
|
|
6028
|
+
* @type {number}
|
|
6029
|
+
* @memberof AnalyticsStoreGeoBreakdown
|
|
6030
|
+
*/
|
|
6031
|
+
'total'?: number;
|
|
6032
|
+
/**
|
|
6033
|
+
*
|
|
6034
|
+
* @type {string}
|
|
6035
|
+
* @memberof AnalyticsStoreGeoBreakdown
|
|
6036
|
+
*/
|
|
6037
|
+
'xstoreid'?: string;
|
|
6038
|
+
}
|
|
6039
|
+
/**
|
|
6040
|
+
*
|
|
6041
|
+
* @export
|
|
6042
|
+
* @interface AnalyticsStoreQueryBreakdown
|
|
6043
|
+
*/
|
|
6044
|
+
export interface AnalyticsStoreQueryBreakdown {
|
|
6045
|
+
/**
|
|
6046
|
+
* Can be []QueryAnalytic or []ComparisonMetrics
|
|
6047
|
+
* @type {any}
|
|
6048
|
+
* @memberof AnalyticsStoreQueryBreakdown
|
|
6049
|
+
*/
|
|
6050
|
+
'data'?: any;
|
|
6051
|
+
/**
|
|
6052
|
+
*
|
|
6053
|
+
* @type {number}
|
|
6054
|
+
* @memberof AnalyticsStoreQueryBreakdown
|
|
6055
|
+
*/
|
|
6056
|
+
'store_id'?: number;
|
|
6057
|
+
/**
|
|
6058
|
+
*
|
|
6059
|
+
* @type {string}
|
|
6060
|
+
* @memberof AnalyticsStoreQueryBreakdown
|
|
6061
|
+
*/
|
|
6062
|
+
'store_name'?: string;
|
|
6063
|
+
/**
|
|
6064
|
+
*
|
|
6065
|
+
* @type {number}
|
|
6066
|
+
* @memberof AnalyticsStoreQueryBreakdown
|
|
6067
|
+
*/
|
|
6068
|
+
'total'?: number;
|
|
6069
|
+
/**
|
|
6070
|
+
*
|
|
6071
|
+
* @type {string}
|
|
6072
|
+
* @memberof AnalyticsStoreQueryBreakdown
|
|
6073
|
+
*/
|
|
6074
|
+
'xstoreid'?: string;
|
|
6075
|
+
}
|
|
5941
6076
|
/**
|
|
5942
6077
|
*
|
|
5943
6078
|
* @export
|
|
@@ -9880,6 +10015,12 @@ export interface DataTypesDropdownRecommendationsConfig {
|
|
|
9880
10015
|
'category_field_mappings'?: {
|
|
9881
10016
|
[key: string]: string;
|
|
9882
10017
|
};
|
|
10018
|
+
/**
|
|
10019
|
+
* Filtered tabs configuration (for tabbed product recommendations)
|
|
10020
|
+
* @type {boolean}
|
|
10021
|
+
* @memberof DataTypesDropdownRecommendationsConfig
|
|
10022
|
+
*/
|
|
10023
|
+
'enable_filtered_tabs'?: boolean;
|
|
9883
10024
|
/**
|
|
9884
10025
|
* Enable popular brands section
|
|
9885
10026
|
* @type {boolean}
|
|
@@ -9910,6 +10051,12 @@ export interface DataTypesDropdownRecommendationsConfig {
|
|
|
9910
10051
|
* @memberof DataTypesDropdownRecommendationsConfig
|
|
9911
10052
|
*/
|
|
9912
10053
|
'exclude_out_of_stock'?: boolean;
|
|
10054
|
+
/**
|
|
10055
|
+
* Configuration for each filtered tab
|
|
10056
|
+
* @type {Array<DataTypesFilteredTabConfig>}
|
|
10057
|
+
* @memberof DataTypesDropdownRecommendationsConfig
|
|
10058
|
+
*/
|
|
10059
|
+
'filtered_tabs'?: Array<DataTypesFilteredTabConfig>;
|
|
9913
10060
|
/**
|
|
9914
10061
|
* Include only in stock products
|
|
9915
10062
|
* @type {boolean}
|
|
@@ -10638,6 +10785,63 @@ export interface DataTypesFieldMetadata {
|
|
|
10638
10785
|
*/
|
|
10639
10786
|
'type'?: string;
|
|
10640
10787
|
}
|
|
10788
|
+
/**
|
|
10789
|
+
*
|
|
10790
|
+
* @export
|
|
10791
|
+
* @interface DataTypesFilteredTabConfig
|
|
10792
|
+
*/
|
|
10793
|
+
export interface DataTypesFilteredTabConfig {
|
|
10794
|
+
/**
|
|
10795
|
+
* Optional description for the tab
|
|
10796
|
+
* @type {string}
|
|
10797
|
+
* @memberof DataTypesFilteredTabConfig
|
|
10798
|
+
*/
|
|
10799
|
+
'description'?: string;
|
|
10800
|
+
/**
|
|
10801
|
+
* Whether this tab is enabled
|
|
10802
|
+
* @type {boolean}
|
|
10803
|
+
* @memberof DataTypesFilteredTabConfig
|
|
10804
|
+
*/
|
|
10805
|
+
'enabled'?: boolean;
|
|
10806
|
+
/**
|
|
10807
|
+
* Facet filters to apply (e.g., {\"brand\": \"Nike\"}, {\"category\": \"Electronics\"})
|
|
10808
|
+
* @type {{ [key: string]: string; }}
|
|
10809
|
+
* @memberof DataTypesFilteredTabConfig
|
|
10810
|
+
*/
|
|
10811
|
+
'filters'?: {
|
|
10812
|
+
[key: string]: string;
|
|
10813
|
+
};
|
|
10814
|
+
/**
|
|
10815
|
+
* Unique tab ID (e.g., \"all\", \"brands\", \"categories\")
|
|
10816
|
+
* @type {string}
|
|
10817
|
+
* @memberof DataTypesFilteredTabConfig
|
|
10818
|
+
*/
|
|
10819
|
+
'id'?: string;
|
|
10820
|
+
/**
|
|
10821
|
+
* Display label for the tab (e.g., \"All Results\", \"Brands\", \"Categories\")
|
|
10822
|
+
* @type {string}
|
|
10823
|
+
* @memberof DataTypesFilteredTabConfig
|
|
10824
|
+
*/
|
|
10825
|
+
'label'?: string;
|
|
10826
|
+
/**
|
|
10827
|
+
* Max number of products to show in this tab (default: 8, max: 50)
|
|
10828
|
+
* @type {number}
|
|
10829
|
+
* @memberof DataTypesFilteredTabConfig
|
|
10830
|
+
*/
|
|
10831
|
+
'limit'?: number;
|
|
10832
|
+
/**
|
|
10833
|
+
* Display order priority (lower = higher priority, default: 0)
|
|
10834
|
+
* @type {number}
|
|
10835
|
+
* @memberof DataTypesFilteredTabConfig
|
|
10836
|
+
*/
|
|
10837
|
+
'priority'?: number;
|
|
10838
|
+
/**
|
|
10839
|
+
* Sort method: \"relevance\", \"popularity\", \"price_asc\", \"price_desc\" (default: \"relevance\")
|
|
10840
|
+
* @type {string}
|
|
10841
|
+
* @memberof DataTypesFilteredTabConfig
|
|
10842
|
+
*/
|
|
10843
|
+
'sort_by'?: string;
|
|
10844
|
+
}
|
|
10641
10845
|
/**
|
|
10642
10846
|
*
|
|
10643
10847
|
* @export
|
|
@@ -24458,548 +24662,6 @@ export interface DefaultMenuRoutesUpdateMenuVisibilityResponse {
|
|
|
24458
24662
|
*/
|
|
24459
24663
|
'menuName'?: string;
|
|
24460
24664
|
}
|
|
24461
|
-
/**
|
|
24462
|
-
*
|
|
24463
|
-
* @export
|
|
24464
|
-
* @interface DropdownRecommendationsServiceDropdownConfigResponse
|
|
24465
|
-
*/
|
|
24466
|
-
export interface DropdownRecommendationsServiceDropdownConfigResponse {
|
|
24467
|
-
/**
|
|
24468
|
-
*
|
|
24469
|
-
* @type {DropdownRecommendationsServiceDropdownRecommendationsConfig}
|
|
24470
|
-
* @memberof DropdownRecommendationsServiceDropdownConfigResponse
|
|
24471
|
-
*/
|
|
24472
|
-
'data'?: DropdownRecommendationsServiceDropdownRecommendationsConfig;
|
|
24473
|
-
/**
|
|
24474
|
-
*
|
|
24475
|
-
* @type {string}
|
|
24476
|
-
* @memberof DropdownRecommendationsServiceDropdownConfigResponse
|
|
24477
|
-
*/
|
|
24478
|
-
'message'?: string;
|
|
24479
|
-
/**
|
|
24480
|
-
*
|
|
24481
|
-
* @type {string}
|
|
24482
|
-
* @memberof DropdownRecommendationsServiceDropdownConfigResponse
|
|
24483
|
-
*/
|
|
24484
|
-
'status'?: string;
|
|
24485
|
-
/**
|
|
24486
|
-
*
|
|
24487
|
-
* @type {string}
|
|
24488
|
-
* @memberof DropdownRecommendationsServiceDropdownConfigResponse
|
|
24489
|
-
*/
|
|
24490
|
-
'timestamp'?: string;
|
|
24491
|
-
/**
|
|
24492
|
-
*
|
|
24493
|
-
* @type {string}
|
|
24494
|
-
* @memberof DropdownRecommendationsServiceDropdownConfigResponse
|
|
24495
|
-
*/
|
|
24496
|
-
'version'?: string;
|
|
24497
|
-
}
|
|
24498
|
-
/**
|
|
24499
|
-
*
|
|
24500
|
-
* @export
|
|
24501
|
-
* @interface DropdownRecommendationsServiceDropdownRecommendationsAPIResponse
|
|
24502
|
-
*/
|
|
24503
|
-
export interface DropdownRecommendationsServiceDropdownRecommendationsAPIResponse {
|
|
24504
|
-
/**
|
|
24505
|
-
*
|
|
24506
|
-
* @type {DropdownRecommendationsServiceDropdownRecommendationsResponse}
|
|
24507
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsAPIResponse
|
|
24508
|
-
*/
|
|
24509
|
-
'data'?: DropdownRecommendationsServiceDropdownRecommendationsResponse;
|
|
24510
|
-
/**
|
|
24511
|
-
*
|
|
24512
|
-
* @type {string}
|
|
24513
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsAPIResponse
|
|
24514
|
-
*/
|
|
24515
|
-
'error'?: string;
|
|
24516
|
-
/**
|
|
24517
|
-
*
|
|
24518
|
-
* @type {string}
|
|
24519
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsAPIResponse
|
|
24520
|
-
*/
|
|
24521
|
-
'status'?: string;
|
|
24522
|
-
/**
|
|
24523
|
-
*
|
|
24524
|
-
* @type {string}
|
|
24525
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsAPIResponse
|
|
24526
|
-
*/
|
|
24527
|
-
'timestamp'?: string;
|
|
24528
|
-
/**
|
|
24529
|
-
*
|
|
24530
|
-
* @type {string}
|
|
24531
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsAPIResponse
|
|
24532
|
-
*/
|
|
24533
|
-
'version'?: string;
|
|
24534
|
-
}
|
|
24535
|
-
/**
|
|
24536
|
-
*
|
|
24537
|
-
* @export
|
|
24538
|
-
* @interface DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24539
|
-
*/
|
|
24540
|
-
export interface DropdownRecommendationsServiceDropdownRecommendationsConfig {
|
|
24541
|
-
/**
|
|
24542
|
-
*
|
|
24543
|
-
* @type {{ [key: string]: string; }}
|
|
24544
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24545
|
-
*/
|
|
24546
|
-
'brand_field_mappings'?: {
|
|
24547
|
-
[key: string]: string;
|
|
24548
|
-
};
|
|
24549
|
-
/**
|
|
24550
|
-
* \'searches\', \'clicks\', \'conversions\'
|
|
24551
|
-
* @type {string}
|
|
24552
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24553
|
-
*/
|
|
24554
|
-
'brand_sort_by'?: string;
|
|
24555
|
-
/**
|
|
24556
|
-
* Caching configuration
|
|
24557
|
-
* @type {number}
|
|
24558
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24559
|
-
*/
|
|
24560
|
-
'cache_ttl_seconds'?: number;
|
|
24561
|
-
/**
|
|
24562
|
-
*
|
|
24563
|
-
* @type {{ [key: string]: string; }}
|
|
24564
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24565
|
-
*/
|
|
24566
|
-
'category_field_mappings'?: {
|
|
24567
|
-
[key: string]: string;
|
|
24568
|
-
};
|
|
24569
|
-
/**
|
|
24570
|
-
*
|
|
24571
|
-
* @type {string}
|
|
24572
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24573
|
-
*/
|
|
24574
|
-
'created_at'?: string;
|
|
24575
|
-
/**
|
|
24576
|
-
*
|
|
24577
|
-
* @type {boolean}
|
|
24578
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24579
|
-
*/
|
|
24580
|
-
'enable_popular_brands'?: boolean;
|
|
24581
|
-
/**
|
|
24582
|
-
*
|
|
24583
|
-
* @type {boolean}
|
|
24584
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24585
|
-
*/
|
|
24586
|
-
'enable_trending_products'?: boolean;
|
|
24587
|
-
/**
|
|
24588
|
-
*
|
|
24589
|
-
* @type {boolean}
|
|
24590
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24591
|
-
*/
|
|
24592
|
-
'enable_trending_search'?: boolean;
|
|
24593
|
-
/**
|
|
24594
|
-
* Feature enable/disable flags
|
|
24595
|
-
* @type {boolean}
|
|
24596
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24597
|
-
*/
|
|
24598
|
-
'enabled'?: boolean;
|
|
24599
|
-
/**
|
|
24600
|
-
* Additional filters
|
|
24601
|
-
* @type {boolean}
|
|
24602
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24603
|
-
*/
|
|
24604
|
-
'exclude_out_of_stock'?: boolean;
|
|
24605
|
-
/**
|
|
24606
|
-
*
|
|
24607
|
-
* @type {boolean}
|
|
24608
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24609
|
-
*/
|
|
24610
|
-
'include_only_in_stock'?: boolean;
|
|
24611
|
-
/**
|
|
24612
|
-
* Brand selection criteria
|
|
24613
|
-
* @type {number}
|
|
24614
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24615
|
-
*/
|
|
24616
|
-
'min_brand_searches'?: number;
|
|
24617
|
-
/**
|
|
24618
|
-
* Product selection criteria
|
|
24619
|
-
* @type {number}
|
|
24620
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24621
|
-
*/
|
|
24622
|
-
'min_product_clicks'?: number;
|
|
24623
|
-
/**
|
|
24624
|
-
*
|
|
24625
|
-
* @type {number}
|
|
24626
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24627
|
-
*/
|
|
24628
|
-
'min_product_conversions'?: number;
|
|
24629
|
-
/**
|
|
24630
|
-
*
|
|
24631
|
-
* @type {number}
|
|
24632
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24633
|
-
*/
|
|
24634
|
-
'popular_brands_limit'?: number;
|
|
24635
|
-
/**
|
|
24636
|
-
* Dataset-agnostic field mappings
|
|
24637
|
-
* @type {{ [key: string]: string; }}
|
|
24638
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24639
|
-
*/
|
|
24640
|
-
'product_field_mappings'?: {
|
|
24641
|
-
[key: string]: string;
|
|
24642
|
-
};
|
|
24643
|
-
/**
|
|
24644
|
-
* \'clicks\', \'conversions\', \'revenue\', \'trend_score\'
|
|
24645
|
-
* @type {string}
|
|
24646
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24647
|
-
*/
|
|
24648
|
-
'product_sort_by'?: string;
|
|
24649
|
-
/**
|
|
24650
|
-
*
|
|
24651
|
-
* @type {number}
|
|
24652
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24653
|
-
*/
|
|
24654
|
-
'trending_products_limit'?: number;
|
|
24655
|
-
/**
|
|
24656
|
-
* Limits for each section
|
|
24657
|
-
* @type {number}
|
|
24658
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24659
|
-
*/
|
|
24660
|
-
'trending_search_limit'?: number;
|
|
24661
|
-
/**
|
|
24662
|
-
* Time range configuration
|
|
24663
|
-
* @type {number}
|
|
24664
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24665
|
-
*/
|
|
24666
|
-
'trending_time_range_days'?: number;
|
|
24667
|
-
/**
|
|
24668
|
-
*
|
|
24669
|
-
* @type {string}
|
|
24670
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24671
|
-
*/
|
|
24672
|
-
'updated_at'?: string;
|
|
24673
|
-
/**
|
|
24674
|
-
* Trending search configuration
|
|
24675
|
-
* @type {boolean}
|
|
24676
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24677
|
-
*/
|
|
24678
|
-
'use_query_suggestions_config'?: boolean;
|
|
24679
|
-
}
|
|
24680
|
-
/**
|
|
24681
|
-
*
|
|
24682
|
-
* @export
|
|
24683
|
-
* @interface DropdownRecommendationsServiceDropdownRecommendationsResponse
|
|
24684
|
-
*/
|
|
24685
|
-
export interface DropdownRecommendationsServiceDropdownRecommendationsResponse {
|
|
24686
|
-
/**
|
|
24687
|
-
*
|
|
24688
|
-
* @type {Array<DropdownRecommendationsServicePopularBrand>}
|
|
24689
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsResponse
|
|
24690
|
-
*/
|
|
24691
|
-
'popular_brands'?: Array<DropdownRecommendationsServicePopularBrand>;
|
|
24692
|
-
/**
|
|
24693
|
-
*
|
|
24694
|
-
* @type {number}
|
|
24695
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsResponse
|
|
24696
|
-
*/
|
|
24697
|
-
'processing_time_ms'?: number;
|
|
24698
|
-
/**
|
|
24699
|
-
*
|
|
24700
|
-
* @type {string}
|
|
24701
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsResponse
|
|
24702
|
-
*/
|
|
24703
|
-
'timestamp'?: string;
|
|
24704
|
-
/**
|
|
24705
|
-
*
|
|
24706
|
-
* @type {Array<DropdownRecommendationsServiceTrendingProduct>}
|
|
24707
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsResponse
|
|
24708
|
-
*/
|
|
24709
|
-
'trending_products'?: Array<DropdownRecommendationsServiceTrendingProduct>;
|
|
24710
|
-
/**
|
|
24711
|
-
*
|
|
24712
|
-
* @type {Array<DropdownRecommendationsServiceTrendingSearchItem>}
|
|
24713
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsResponse
|
|
24714
|
-
*/
|
|
24715
|
-
'trending_search'?: Array<DropdownRecommendationsServiceTrendingSearchItem>;
|
|
24716
|
-
}
|
|
24717
|
-
/**
|
|
24718
|
-
*
|
|
24719
|
-
* @export
|
|
24720
|
-
* @interface DropdownRecommendationsServicePopularBrand
|
|
24721
|
-
*/
|
|
24722
|
-
export interface DropdownRecommendationsServicePopularBrand {
|
|
24723
|
-
/**
|
|
24724
|
-
*
|
|
24725
|
-
* @type {number}
|
|
24726
|
-
* @memberof DropdownRecommendationsServicePopularBrand
|
|
24727
|
-
*/
|
|
24728
|
-
'clicks'?: number;
|
|
24729
|
-
/**
|
|
24730
|
-
*
|
|
24731
|
-
* @type {number}
|
|
24732
|
-
* @memberof DropdownRecommendationsServicePopularBrand
|
|
24733
|
-
*/
|
|
24734
|
-
'conversions'?: number;
|
|
24735
|
-
/**
|
|
24736
|
-
*
|
|
24737
|
-
* @type {string}
|
|
24738
|
-
* @memberof DropdownRecommendationsServicePopularBrand
|
|
24739
|
-
*/
|
|
24740
|
-
'name'?: string;
|
|
24741
|
-
/**
|
|
24742
|
-
*
|
|
24743
|
-
* @type {number}
|
|
24744
|
-
* @memberof DropdownRecommendationsServicePopularBrand
|
|
24745
|
-
*/
|
|
24746
|
-
'searches'?: number;
|
|
24747
|
-
}
|
|
24748
|
-
/**
|
|
24749
|
-
*
|
|
24750
|
-
* @export
|
|
24751
|
-
* @interface DropdownRecommendationsServiceTrendingProduct
|
|
24752
|
-
*/
|
|
24753
|
-
export interface DropdownRecommendationsServiceTrendingProduct {
|
|
24754
|
-
/**
|
|
24755
|
-
*
|
|
24756
|
-
* @type {string}
|
|
24757
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24758
|
-
*/
|
|
24759
|
-
'brand'?: string;
|
|
24760
|
-
/**
|
|
24761
|
-
*
|
|
24762
|
-
* @type {string}
|
|
24763
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24764
|
-
*/
|
|
24765
|
-
'category'?: string;
|
|
24766
|
-
/**
|
|
24767
|
-
* Analytics metrics
|
|
24768
|
-
* @type {number}
|
|
24769
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24770
|
-
*/
|
|
24771
|
-
'clicks'?: number;
|
|
24772
|
-
/**
|
|
24773
|
-
*
|
|
24774
|
-
* @type {number}
|
|
24775
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24776
|
-
*/
|
|
24777
|
-
'conversions'?: number;
|
|
24778
|
-
/**
|
|
24779
|
-
*
|
|
24780
|
-
* @type {string}
|
|
24781
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24782
|
-
*/
|
|
24783
|
-
'description'?: string;
|
|
24784
|
-
/**
|
|
24785
|
-
*
|
|
24786
|
-
* @type {number}
|
|
24787
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24788
|
-
*/
|
|
24789
|
-
'discount'?: number;
|
|
24790
|
-
/**
|
|
24791
|
-
*
|
|
24792
|
-
* @type {number}
|
|
24793
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24794
|
-
*/
|
|
24795
|
-
'discount_percentage'?: number;
|
|
24796
|
-
/**
|
|
24797
|
-
*
|
|
24798
|
-
* @type {string}
|
|
24799
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24800
|
-
*/
|
|
24801
|
-
'id'?: string;
|
|
24802
|
-
/**
|
|
24803
|
-
*
|
|
24804
|
-
* @type {string}
|
|
24805
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24806
|
-
*/
|
|
24807
|
-
'image'?: string;
|
|
24808
|
-
/**
|
|
24809
|
-
*
|
|
24810
|
-
* @type {boolean}
|
|
24811
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24812
|
-
*/
|
|
24813
|
-
'in_stock'?: boolean;
|
|
24814
|
-
/**
|
|
24815
|
-
*
|
|
24816
|
-
* @type {string}
|
|
24817
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24818
|
-
*/
|
|
24819
|
-
'name'?: string;
|
|
24820
|
-
/**
|
|
24821
|
-
*
|
|
24822
|
-
* @type {number}
|
|
24823
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24824
|
-
*/
|
|
24825
|
-
'price'?: number;
|
|
24826
|
-
/**
|
|
24827
|
-
*
|
|
24828
|
-
* @type {number}
|
|
24829
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24830
|
-
*/
|
|
24831
|
-
'revenue'?: number;
|
|
24832
|
-
/**
|
|
24833
|
-
*
|
|
24834
|
-
* @type {number}
|
|
24835
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24836
|
-
*/
|
|
24837
|
-
'selling_price'?: number;
|
|
24838
|
-
/**
|
|
24839
|
-
*
|
|
24840
|
-
* @type {string}
|
|
24841
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24842
|
-
*/
|
|
24843
|
-
'url'?: string;
|
|
24844
|
-
}
|
|
24845
|
-
/**
|
|
24846
|
-
*
|
|
24847
|
-
* @export
|
|
24848
|
-
* @interface DropdownRecommendationsServiceTrendingSearchItem
|
|
24849
|
-
*/
|
|
24850
|
-
export interface DropdownRecommendationsServiceTrendingSearchItem {
|
|
24851
|
-
/**
|
|
24852
|
-
*
|
|
24853
|
-
* @type {string}
|
|
24854
|
-
* @memberof DropdownRecommendationsServiceTrendingSearchItem
|
|
24855
|
-
*/
|
|
24856
|
-
'category'?: string;
|
|
24857
|
-
/**
|
|
24858
|
-
*
|
|
24859
|
-
* @type {number}
|
|
24860
|
-
* @memberof DropdownRecommendationsServiceTrendingSearchItem
|
|
24861
|
-
*/
|
|
24862
|
-
'popularity'?: number;
|
|
24863
|
-
/**
|
|
24864
|
-
*
|
|
24865
|
-
* @type {string}
|
|
24866
|
-
* @memberof DropdownRecommendationsServiceTrendingSearchItem
|
|
24867
|
-
*/
|
|
24868
|
-
'query'?: string;
|
|
24869
|
-
}
|
|
24870
|
-
/**
|
|
24871
|
-
*
|
|
24872
|
-
* @export
|
|
24873
|
-
* @interface DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24874
|
-
*/
|
|
24875
|
-
export interface DropdownRecommendationsServiceUpdateDropdownConfigRequest {
|
|
24876
|
-
/**
|
|
24877
|
-
*
|
|
24878
|
-
* @type {{ [key: string]: string; }}
|
|
24879
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24880
|
-
*/
|
|
24881
|
-
'brand_field_mappings'?: {
|
|
24882
|
-
[key: string]: string;
|
|
24883
|
-
};
|
|
24884
|
-
/**
|
|
24885
|
-
*
|
|
24886
|
-
* @type {string}
|
|
24887
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24888
|
-
*/
|
|
24889
|
-
'brand_sort_by'?: string;
|
|
24890
|
-
/**
|
|
24891
|
-
*
|
|
24892
|
-
* @type {number}
|
|
24893
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24894
|
-
*/
|
|
24895
|
-
'cache_ttl_seconds'?: number;
|
|
24896
|
-
/**
|
|
24897
|
-
*
|
|
24898
|
-
* @type {{ [key: string]: string; }}
|
|
24899
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24900
|
-
*/
|
|
24901
|
-
'category_field_mappings'?: {
|
|
24902
|
-
[key: string]: string;
|
|
24903
|
-
};
|
|
24904
|
-
/**
|
|
24905
|
-
*
|
|
24906
|
-
* @type {boolean}
|
|
24907
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24908
|
-
*/
|
|
24909
|
-
'enable_popular_brands'?: boolean;
|
|
24910
|
-
/**
|
|
24911
|
-
*
|
|
24912
|
-
* @type {boolean}
|
|
24913
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24914
|
-
*/
|
|
24915
|
-
'enable_trending_products'?: boolean;
|
|
24916
|
-
/**
|
|
24917
|
-
*
|
|
24918
|
-
* @type {boolean}
|
|
24919
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24920
|
-
*/
|
|
24921
|
-
'enable_trending_search'?: boolean;
|
|
24922
|
-
/**
|
|
24923
|
-
*
|
|
24924
|
-
* @type {boolean}
|
|
24925
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24926
|
-
*/
|
|
24927
|
-
'enabled'?: boolean;
|
|
24928
|
-
/**
|
|
24929
|
-
*
|
|
24930
|
-
* @type {boolean}
|
|
24931
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24932
|
-
*/
|
|
24933
|
-
'exclude_out_of_stock'?: boolean;
|
|
24934
|
-
/**
|
|
24935
|
-
*
|
|
24936
|
-
* @type {boolean}
|
|
24937
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24938
|
-
*/
|
|
24939
|
-
'include_only_in_stock'?: boolean;
|
|
24940
|
-
/**
|
|
24941
|
-
*
|
|
24942
|
-
* @type {number}
|
|
24943
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24944
|
-
*/
|
|
24945
|
-
'min_brand_searches'?: number;
|
|
24946
|
-
/**
|
|
24947
|
-
*
|
|
24948
|
-
* @type {number}
|
|
24949
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24950
|
-
*/
|
|
24951
|
-
'min_product_clicks'?: number;
|
|
24952
|
-
/**
|
|
24953
|
-
*
|
|
24954
|
-
* @type {number}
|
|
24955
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24956
|
-
*/
|
|
24957
|
-
'min_product_conversions'?: number;
|
|
24958
|
-
/**
|
|
24959
|
-
*
|
|
24960
|
-
* @type {number}
|
|
24961
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24962
|
-
*/
|
|
24963
|
-
'popular_brands_limit'?: number;
|
|
24964
|
-
/**
|
|
24965
|
-
*
|
|
24966
|
-
* @type {{ [key: string]: string; }}
|
|
24967
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24968
|
-
*/
|
|
24969
|
-
'product_field_mappings'?: {
|
|
24970
|
-
[key: string]: string;
|
|
24971
|
-
};
|
|
24972
|
-
/**
|
|
24973
|
-
*
|
|
24974
|
-
* @type {string}
|
|
24975
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24976
|
-
*/
|
|
24977
|
-
'product_sort_by'?: string;
|
|
24978
|
-
/**
|
|
24979
|
-
*
|
|
24980
|
-
* @type {number}
|
|
24981
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24982
|
-
*/
|
|
24983
|
-
'trending_products_limit'?: number;
|
|
24984
|
-
/**
|
|
24985
|
-
*
|
|
24986
|
-
* @type {number}
|
|
24987
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24988
|
-
*/
|
|
24989
|
-
'trending_search_limit'?: number;
|
|
24990
|
-
/**
|
|
24991
|
-
*
|
|
24992
|
-
* @type {number}
|
|
24993
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24994
|
-
*/
|
|
24995
|
-
'trending_time_range_days'?: number;
|
|
24996
|
-
/**
|
|
24997
|
-
*
|
|
24998
|
-
* @type {boolean}
|
|
24999
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
25000
|
-
*/
|
|
25001
|
-
'use_query_suggestions_config'?: boolean;
|
|
25002
|
-
}
|
|
25003
24665
|
/**
|
|
25004
24666
|
*
|
|
25005
24667
|
* @export
|
|
@@ -25710,6 +25372,18 @@ export interface QuerySuggestionsServiceDropdownRecommendations {
|
|
|
25710
25372
|
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25711
25373
|
*/
|
|
25712
25374
|
'cached_at'?: string;
|
|
25375
|
+
/**
|
|
25376
|
+
* Filtered product tabs (e.g., \"All\", \"Brands\", \"Categories\")
|
|
25377
|
+
* @type {Array<QuerySuggestionsServiceFilteredTabResult>}
|
|
25378
|
+
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25379
|
+
*/
|
|
25380
|
+
'filtered_tabs'?: Array<QuerySuggestionsServiceFilteredTabResult>;
|
|
25381
|
+
/**
|
|
25382
|
+
* Item recommendations for query
|
|
25383
|
+
* @type {Array<QuerySuggestionsServiceTrendingProduct>}
|
|
25384
|
+
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25385
|
+
*/
|
|
25386
|
+
'item_recommendations'?: Array<QuerySuggestionsServiceTrendingProduct>;
|
|
25713
25387
|
/**
|
|
25714
25388
|
* Popular brands
|
|
25715
25389
|
* @type {Array<QuerySuggestionsServicePopularBrand>}
|
|
@@ -25722,6 +25396,18 @@ export interface QuerySuggestionsServiceDropdownRecommendations {
|
|
|
25722
25396
|
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25723
25397
|
*/
|
|
25724
25398
|
'processing_time_ms'?: number;
|
|
25399
|
+
/**
|
|
25400
|
+
* Related searches for query
|
|
25401
|
+
* @type {Array<QuerySuggestionsServiceQuerySuggestion>}
|
|
25402
|
+
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25403
|
+
*/
|
|
25404
|
+
'related_searches'?: Array<QuerySuggestionsServiceQuerySuggestion>;
|
|
25405
|
+
/**
|
|
25406
|
+
* Top searches (unfiltered)
|
|
25407
|
+
* @type {Array<QuerySuggestionsServiceTrendingSearch>}
|
|
25408
|
+
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25409
|
+
*/
|
|
25410
|
+
'top_searches'?: Array<QuerySuggestionsServiceTrendingSearch>;
|
|
25725
25411
|
/**
|
|
25726
25412
|
* Trending products
|
|
25727
25413
|
* @type {Array<QuerySuggestionsServiceTrendingProduct>}
|
|
@@ -25851,6 +25537,43 @@ export interface QuerySuggestionsServiceFacetUsage {
|
|
|
25851
25537
|
*/
|
|
25852
25538
|
'value'?: string;
|
|
25853
25539
|
}
|
|
25540
|
+
/**
|
|
25541
|
+
*
|
|
25542
|
+
* @export
|
|
25543
|
+
* @interface QuerySuggestionsServiceFilteredTabResult
|
|
25544
|
+
*/
|
|
25545
|
+
export interface QuerySuggestionsServiceFilteredTabResult {
|
|
25546
|
+
/**
|
|
25547
|
+
* Tab ID (matches FilteredTabConfig.ID)
|
|
25548
|
+
* @type {string}
|
|
25549
|
+
* @memberof QuerySuggestionsServiceFilteredTabResult
|
|
25550
|
+
*/
|
|
25551
|
+
'id'?: string;
|
|
25552
|
+
/**
|
|
25553
|
+
* Display label for the tab
|
|
25554
|
+
* @type {string}
|
|
25555
|
+
* @memberof QuerySuggestionsServiceFilteredTabResult
|
|
25556
|
+
*/
|
|
25557
|
+
'label'?: string;
|
|
25558
|
+
/**
|
|
25559
|
+
* Total number of products found
|
|
25560
|
+
* @type {number}
|
|
25561
|
+
* @memberof QuerySuggestionsServiceFilteredTabResult
|
|
25562
|
+
*/
|
|
25563
|
+
'nb_hits'?: number;
|
|
25564
|
+
/**
|
|
25565
|
+
* Processing time for this tab
|
|
25566
|
+
* @type {number}
|
|
25567
|
+
* @memberof QuerySuggestionsServiceFilteredTabResult
|
|
25568
|
+
*/
|
|
25569
|
+
'processing_time_ms'?: number;
|
|
25570
|
+
/**
|
|
25571
|
+
* Filtered products for this tab
|
|
25572
|
+
* @type {Array<QuerySuggestionsServiceTrendingProduct>}
|
|
25573
|
+
* @memberof QuerySuggestionsServiceFilteredTabResult
|
|
25574
|
+
*/
|
|
25575
|
+
'products'?: Array<QuerySuggestionsServiceTrendingProduct>;
|
|
25576
|
+
}
|
|
25854
25577
|
/**
|
|
25855
25578
|
*
|
|
25856
25579
|
* @export
|
|
@@ -29221,7 +28944,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
29221
28944
|
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
29222
28945
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
29223
28946
|
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
29224
|
-
* @param {boolean} [compareMode] Enable comparison mode
|
|
28947
|
+
* @param {boolean} [compareMode] Enable comparison mode (default: true, compares with previous week)
|
|
29225
28948
|
* @param {*} [options] Override http request option.
|
|
29226
28949
|
* @throws {RequiredError}
|
|
29227
28950
|
*/
|
|
@@ -29712,7 +29435,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
29712
29435
|
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
29713
29436
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
29714
29437
|
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
29715
|
-
* @param {boolean} [compareMode] Enable comparison mode
|
|
29438
|
+
* @param {boolean} [compareMode] Enable comparison mode (default: true, compares with previous week)
|
|
29716
29439
|
* @param {*} [options] Override http request option.
|
|
29717
29440
|
* @throws {RequiredError}
|
|
29718
29441
|
*/
|
|
@@ -30203,7 +29926,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
30203
29926
|
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
30204
29927
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
30205
29928
|
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
30206
|
-
* @param {boolean} [compareMode] Enable comparison mode
|
|
29929
|
+
* @param {boolean} [compareMode] Enable comparison mode (default: true, compares with previous week)
|
|
30207
29930
|
* @param {*} [options] Override http request option.
|
|
30208
29931
|
* @throws {RequiredError}
|
|
30209
29932
|
*/
|
|
@@ -30697,7 +30420,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
30697
30420
|
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
30698
30421
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
30699
30422
|
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
30700
|
-
* @param {boolean} [compareMode] Enable comparison mode
|
|
30423
|
+
* @param {boolean} [compareMode] Enable comparison mode (default: true, compares with previous week)
|
|
30701
30424
|
* @param {*} [options] Override http request option.
|
|
30702
30425
|
* @throws {RequiredError}
|
|
30703
30426
|
* @memberof AnalyticsApi
|
|
@@ -36440,163 +36163,6 @@ export declare class DocumentsApi extends BaseAPI {
|
|
|
36440
36163
|
*/
|
|
36441
36164
|
adminStoresXStoreIDUploadPost(xStoreID: string, file: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayString, any, {}>>;
|
|
36442
36165
|
}
|
|
36443
|
-
/**
|
|
36444
|
-
* DropdownRecommendationsApi - axios parameter creator
|
|
36445
|
-
* @export
|
|
36446
|
-
*/
|
|
36447
|
-
export declare const DropdownRecommendationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
36448
|
-
/**
|
|
36449
|
-
* Retrieve configuration settings for dropdown recommendations
|
|
36450
|
-
* @summary Get Dropdown Recommendations Configuration
|
|
36451
|
-
* @param {string} xStoreid Store ID
|
|
36452
|
-
* @param {string} xStoresecret Store Secret
|
|
36453
|
-
* @param {*} [options] Override http request option.
|
|
36454
|
-
* @throws {RequiredError}
|
|
36455
|
-
*/
|
|
36456
|
-
v1DropdownRecommendationsConfigGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
36457
|
-
/**
|
|
36458
|
-
* Update configuration settings for dropdown recommendations
|
|
36459
|
-
* @summary Update Dropdown Recommendations Configuration
|
|
36460
|
-
* @param {string} xStoreid Store ID
|
|
36461
|
-
* @param {string} xStoresecret Store Secret
|
|
36462
|
-
* @param {DropdownRecommendationsServiceUpdateDropdownConfigRequest} dropdownRecommendationsServiceUpdateDropdownConfigRequest Configuration to update
|
|
36463
|
-
* @param {*} [options] Override http request option.
|
|
36464
|
-
* @throws {RequiredError}
|
|
36465
|
-
*/
|
|
36466
|
-
v1DropdownRecommendationsConfigPut: (xStoreid: string, xStoresecret: string, dropdownRecommendationsServiceUpdateDropdownConfigRequest: DropdownRecommendationsServiceUpdateDropdownConfigRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
36467
|
-
/**
|
|
36468
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
36469
|
-
* @summary Get Dropdown Recommendations
|
|
36470
|
-
* @param {string} xStoreid Store ID
|
|
36471
|
-
* @param {string} xStoresecret Store Secret
|
|
36472
|
-
* @param {string} [xUserId] User ID for personalization
|
|
36473
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
36474
|
-
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
36475
|
-
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
36476
|
-
* @param {*} [options] Override http request option.
|
|
36477
|
-
* @throws {RequiredError}
|
|
36478
|
-
*/
|
|
36479
|
-
v1DropdownRecommendationsGet: (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, q?: string, query?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
36480
|
-
};
|
|
36481
|
-
/**
|
|
36482
|
-
* DropdownRecommendationsApi - functional programming interface
|
|
36483
|
-
* @export
|
|
36484
|
-
*/
|
|
36485
|
-
export declare const DropdownRecommendationsApiFp: (configuration?: Configuration) => {
|
|
36486
|
-
/**
|
|
36487
|
-
* Retrieve configuration settings for dropdown recommendations
|
|
36488
|
-
* @summary Get Dropdown Recommendations Configuration
|
|
36489
|
-
* @param {string} xStoreid Store ID
|
|
36490
|
-
* @param {string} xStoresecret Store Secret
|
|
36491
|
-
* @param {*} [options] Override http request option.
|
|
36492
|
-
* @throws {RequiredError}
|
|
36493
|
-
*/
|
|
36494
|
-
v1DropdownRecommendationsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DropdownRecommendationsServiceDropdownConfigResponse>>;
|
|
36495
|
-
/**
|
|
36496
|
-
* Update configuration settings for dropdown recommendations
|
|
36497
|
-
* @summary Update Dropdown Recommendations Configuration
|
|
36498
|
-
* @param {string} xStoreid Store ID
|
|
36499
|
-
* @param {string} xStoresecret Store Secret
|
|
36500
|
-
* @param {DropdownRecommendationsServiceUpdateDropdownConfigRequest} dropdownRecommendationsServiceUpdateDropdownConfigRequest Configuration to update
|
|
36501
|
-
* @param {*} [options] Override http request option.
|
|
36502
|
-
* @throws {RequiredError}
|
|
36503
|
-
*/
|
|
36504
|
-
v1DropdownRecommendationsConfigPut(xStoreid: string, xStoresecret: string, dropdownRecommendationsServiceUpdateDropdownConfigRequest: DropdownRecommendationsServiceUpdateDropdownConfigRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DropdownRecommendationsServiceDropdownConfigResponse>>;
|
|
36505
|
-
/**
|
|
36506
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
36507
|
-
* @summary Get Dropdown Recommendations
|
|
36508
|
-
* @param {string} xStoreid Store ID
|
|
36509
|
-
* @param {string} xStoresecret Store Secret
|
|
36510
|
-
* @param {string} [xUserId] User ID for personalization
|
|
36511
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
36512
|
-
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
36513
|
-
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
36514
|
-
* @param {*} [options] Override http request option.
|
|
36515
|
-
* @throws {RequiredError}
|
|
36516
|
-
*/
|
|
36517
|
-
v1DropdownRecommendationsGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, q?: string, query?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DropdownRecommendationsServiceDropdownRecommendationsAPIResponse>>;
|
|
36518
|
-
};
|
|
36519
|
-
/**
|
|
36520
|
-
* DropdownRecommendationsApi - factory interface
|
|
36521
|
-
* @export
|
|
36522
|
-
*/
|
|
36523
|
-
export declare const DropdownRecommendationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
36524
|
-
/**
|
|
36525
|
-
* Retrieve configuration settings for dropdown recommendations
|
|
36526
|
-
* @summary Get Dropdown Recommendations Configuration
|
|
36527
|
-
* @param {string} xStoreid Store ID
|
|
36528
|
-
* @param {string} xStoresecret Store Secret
|
|
36529
|
-
* @param {*} [options] Override http request option.
|
|
36530
|
-
* @throws {RequiredError}
|
|
36531
|
-
*/
|
|
36532
|
-
v1DropdownRecommendationsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DropdownRecommendationsServiceDropdownConfigResponse>;
|
|
36533
|
-
/**
|
|
36534
|
-
* Update configuration settings for dropdown recommendations
|
|
36535
|
-
* @summary Update Dropdown Recommendations Configuration
|
|
36536
|
-
* @param {string} xStoreid Store ID
|
|
36537
|
-
* @param {string} xStoresecret Store Secret
|
|
36538
|
-
* @param {DropdownRecommendationsServiceUpdateDropdownConfigRequest} dropdownRecommendationsServiceUpdateDropdownConfigRequest Configuration to update
|
|
36539
|
-
* @param {*} [options] Override http request option.
|
|
36540
|
-
* @throws {RequiredError}
|
|
36541
|
-
*/
|
|
36542
|
-
v1DropdownRecommendationsConfigPut(xStoreid: string, xStoresecret: string, dropdownRecommendationsServiceUpdateDropdownConfigRequest: DropdownRecommendationsServiceUpdateDropdownConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<DropdownRecommendationsServiceDropdownConfigResponse>;
|
|
36543
|
-
/**
|
|
36544
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
36545
|
-
* @summary Get Dropdown Recommendations
|
|
36546
|
-
* @param {string} xStoreid Store ID
|
|
36547
|
-
* @param {string} xStoresecret Store Secret
|
|
36548
|
-
* @param {string} [xUserId] User ID for personalization
|
|
36549
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
36550
|
-
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
36551
|
-
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
36552
|
-
* @param {*} [options] Override http request option.
|
|
36553
|
-
* @throws {RequiredError}
|
|
36554
|
-
*/
|
|
36555
|
-
v1DropdownRecommendationsGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, q?: string, query?: string, options?: RawAxiosRequestConfig): AxiosPromise<DropdownRecommendationsServiceDropdownRecommendationsAPIResponse>;
|
|
36556
|
-
};
|
|
36557
|
-
/**
|
|
36558
|
-
* DropdownRecommendationsApi - object-oriented interface
|
|
36559
|
-
* @export
|
|
36560
|
-
* @class DropdownRecommendationsApi
|
|
36561
|
-
* @extends {BaseAPI}
|
|
36562
|
-
*/
|
|
36563
|
-
export declare class DropdownRecommendationsApi extends BaseAPI {
|
|
36564
|
-
/**
|
|
36565
|
-
* Retrieve configuration settings for dropdown recommendations
|
|
36566
|
-
* @summary Get Dropdown Recommendations Configuration
|
|
36567
|
-
* @param {string} xStoreid Store ID
|
|
36568
|
-
* @param {string} xStoresecret Store Secret
|
|
36569
|
-
* @param {*} [options] Override http request option.
|
|
36570
|
-
* @throws {RequiredError}
|
|
36571
|
-
* @memberof DropdownRecommendationsApi
|
|
36572
|
-
*/
|
|
36573
|
-
v1DropdownRecommendationsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DropdownRecommendationsServiceDropdownConfigResponse, any, {}>>;
|
|
36574
|
-
/**
|
|
36575
|
-
* Update configuration settings for dropdown recommendations
|
|
36576
|
-
* @summary Update Dropdown Recommendations Configuration
|
|
36577
|
-
* @param {string} xStoreid Store ID
|
|
36578
|
-
* @param {string} xStoresecret Store Secret
|
|
36579
|
-
* @param {DropdownRecommendationsServiceUpdateDropdownConfigRequest} dropdownRecommendationsServiceUpdateDropdownConfigRequest Configuration to update
|
|
36580
|
-
* @param {*} [options] Override http request option.
|
|
36581
|
-
* @throws {RequiredError}
|
|
36582
|
-
* @memberof DropdownRecommendationsApi
|
|
36583
|
-
*/
|
|
36584
|
-
v1DropdownRecommendationsConfigPut(xStoreid: string, xStoresecret: string, dropdownRecommendationsServiceUpdateDropdownConfigRequest: DropdownRecommendationsServiceUpdateDropdownConfigRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DropdownRecommendationsServiceDropdownConfigResponse, any, {}>>;
|
|
36585
|
-
/**
|
|
36586
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
36587
|
-
* @summary Get Dropdown Recommendations
|
|
36588
|
-
* @param {string} xStoreid Store ID
|
|
36589
|
-
* @param {string} xStoresecret Store Secret
|
|
36590
|
-
* @param {string} [xUserId] User ID for personalization
|
|
36591
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
36592
|
-
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
36593
|
-
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
36594
|
-
* @param {*} [options] Override http request option.
|
|
36595
|
-
* @throws {RequiredError}
|
|
36596
|
-
* @memberof DropdownRecommendationsApi
|
|
36597
|
-
*/
|
|
36598
|
-
v1DropdownRecommendationsGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, q?: string, query?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DropdownRecommendationsServiceDropdownRecommendationsAPIResponse, any, {}>>;
|
|
36599
|
-
}
|
|
36600
36166
|
/**
|
|
36601
36167
|
* ExternalAPINotificationsApi - axios parameter creator
|
|
36602
36168
|
* @export
|
|
@@ -42507,6 +42073,14 @@ export declare const QuerySuggestionsManagementApiAxiosParamCreator: (configurat
|
|
|
42507
42073
|
* @throws {RequiredError}
|
|
42508
42074
|
*/
|
|
42509
42075
|
adminV1QuerySuggestionsXStoreIDCachedGet: (xStoreID: string, page?: number, pageSize?: number, minPopularity?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
42076
|
+
/**
|
|
42077
|
+
* Performs complete sync: refreshes auto-generated cache from analytics, promotes to management table, then syncs to Typesense. This is the recommended endpoint for periodic sync jobs.
|
|
42078
|
+
* @summary Complete Sync: Refresh + Promote + Sync to Typesense
|
|
42079
|
+
* @param {string} xStoreID Store ID
|
|
42080
|
+
* @param {*} [options] Override http request option.
|
|
42081
|
+
* @throws {RequiredError}
|
|
42082
|
+
*/
|
|
42083
|
+
adminV1QuerySuggestionsXStoreIDCompleteSyncPost: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
42510
42084
|
/**
|
|
42511
42085
|
* Retrieve the current configuration for query suggestions for a store
|
|
42512
42086
|
* @summary Get Query Suggestions Configuration
|
|
@@ -42790,6 +42364,14 @@ export declare const QuerySuggestionsManagementApiFp: (configuration?: Configura
|
|
|
42790
42364
|
* @throws {RequiredError}
|
|
42791
42365
|
*/
|
|
42792
42366
|
adminV1QuerySuggestionsXStoreIDCachedGet(xStoreID: string, page?: number, pageSize?: number, minPopularity?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDCachedGet200Response>>;
|
|
42367
|
+
/**
|
|
42368
|
+
* Performs complete sync: refreshes auto-generated cache from analytics, promotes to management table, then syncs to Typesense. This is the recommended endpoint for periodic sync jobs.
|
|
42369
|
+
* @summary Complete Sync: Refresh + Promote + Sync to Typesense
|
|
42370
|
+
* @param {string} xStoreID Store ID
|
|
42371
|
+
* @param {*} [options] Override http request option.
|
|
42372
|
+
* @throws {RequiredError}
|
|
42373
|
+
*/
|
|
42374
|
+
adminV1QuerySuggestionsXStoreIDCompleteSyncPost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>>;
|
|
42793
42375
|
/**
|
|
42794
42376
|
* Retrieve the current configuration for query suggestions for a store
|
|
42795
42377
|
* @summary Get Query Suggestions Configuration
|
|
@@ -43073,6 +42655,14 @@ export declare const QuerySuggestionsManagementApiFactory: (configuration?: Conf
|
|
|
43073
42655
|
* @throws {RequiredError}
|
|
43074
42656
|
*/
|
|
43075
42657
|
adminV1QuerySuggestionsXStoreIDCachedGet(xStoreID: string, page?: number, pageSize?: number, minPopularity?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDCachedGet200Response>;
|
|
42658
|
+
/**
|
|
42659
|
+
* Performs complete sync: refreshes auto-generated cache from analytics, promotes to management table, then syncs to Typesense. This is the recommended endpoint for periodic sync jobs.
|
|
42660
|
+
* @summary Complete Sync: Refresh + Promote + Sync to Typesense
|
|
42661
|
+
* @param {string} xStoreID Store ID
|
|
42662
|
+
* @param {*} [options] Override http request option.
|
|
42663
|
+
* @throws {RequiredError}
|
|
42664
|
+
*/
|
|
42665
|
+
adminV1QuerySuggestionsXStoreIDCompleteSyncPost(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse>;
|
|
43076
42666
|
/**
|
|
43077
42667
|
* Retrieve the current configuration for query suggestions for a store
|
|
43078
42668
|
* @summary Get Query Suggestions Configuration
|
|
@@ -43366,6 +42956,15 @@ export declare class QuerySuggestionsManagementApi extends BaseAPI {
|
|
|
43366
42956
|
* @memberof QuerySuggestionsManagementApi
|
|
43367
42957
|
*/
|
|
43368
42958
|
adminV1QuerySuggestionsXStoreIDCachedGet(xStoreID: string, page?: number, pageSize?: number, minPopularity?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDCachedGet200Response, any, {}>>;
|
|
42959
|
+
/**
|
|
42960
|
+
* Performs complete sync: refreshes auto-generated cache from analytics, promotes to management table, then syncs to Typesense. This is the recommended endpoint for periodic sync jobs.
|
|
42961
|
+
* @summary Complete Sync: Refresh + Promote + Sync to Typesense
|
|
42962
|
+
* @param {string} xStoreID Store ID
|
|
42963
|
+
* @param {*} [options] Override http request option.
|
|
42964
|
+
* @throws {RequiredError}
|
|
42965
|
+
* @memberof QuerySuggestionsManagementApi
|
|
42966
|
+
*/
|
|
42967
|
+
adminV1QuerySuggestionsXStoreIDCompleteSyncPost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsAnalyticsAPIResponse, any, {}>>;
|
|
43369
42968
|
/**
|
|
43370
42969
|
* Retrieve the current configuration for query suggestions for a store
|
|
43371
42970
|
* @summary Get Query Suggestions Configuration
|
|
@@ -46522,6 +46121,14 @@ export declare const StoresApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
46522
46121
|
* @throws {RequiredError}
|
|
46523
46122
|
*/
|
|
46524
46123
|
adminStoresXStoreIDAnalyticsDailyStatsGet: (xStoreID: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46124
|
+
/**
|
|
46125
|
+
* Ensures that Typesense analytics collections and rules exist for the store\'s collection. This is useful for retroactive fixes or ensuring analytics exist for existing stores.
|
|
46126
|
+
* @summary Ensure Analytics Collections and Rules for Store
|
|
46127
|
+
* @param {string} xStoreID Store ID
|
|
46128
|
+
* @param {*} [options] Override http request option.
|
|
46129
|
+
* @throws {RequiredError}
|
|
46130
|
+
*/
|
|
46131
|
+
adminStoresXStoreIDAnalyticsEnsurePost: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46525
46132
|
/**
|
|
46526
46133
|
* Retrieves time series data for a specific metric (records, search_response_time, operations, or search_requests) with date filtering for graphing.
|
|
46527
46134
|
* @summary Get Time Series Data for Store Metrics
|
|
@@ -46600,6 +46207,16 @@ export declare const StoresApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
46600
46207
|
* @throws {RequiredError}
|
|
46601
46208
|
*/
|
|
46602
46209
|
adminStoresXStoreIDDefaultsGet: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46210
|
+
/**
|
|
46211
|
+
* Syncs popular items from ClickHouse to Typesense for real-time boosting in search results
|
|
46212
|
+
* @summary Sync Popular Items to Typesense
|
|
46213
|
+
* @param {string} xStoreID Store ID
|
|
46214
|
+
* @param {number} [limit] Number of items to sync (default: 100)
|
|
46215
|
+
* @param {number} [daysBack] Number of days to look back (default: 30)
|
|
46216
|
+
* @param {*} [options] Override http request option.
|
|
46217
|
+
* @throws {RequiredError}
|
|
46218
|
+
*/
|
|
46219
|
+
adminStoresXStoreIDPopularItemsSyncPost: (xStoreID: string, limit?: number, daysBack?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46603
46220
|
/**
|
|
46604
46221
|
* Get schema options for a specific store by xStoreID
|
|
46605
46222
|
* @summary Get store schema options
|
|
@@ -46694,6 +46311,14 @@ export declare const StoresApiFp: (configuration?: Configuration) => {
|
|
|
46694
46311
|
* @throws {RequiredError}
|
|
46695
46312
|
*/
|
|
46696
46313
|
adminStoresXStoreIDAnalyticsDailyStatsGet(xStoreID: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StoreRouteDailyStatsResponse>>;
|
|
46314
|
+
/**
|
|
46315
|
+
* Ensures that Typesense analytics collections and rules exist for the store\'s collection. This is useful for retroactive fixes or ensuring analytics exist for existing stores.
|
|
46316
|
+
* @summary Ensure Analytics Collections and Rules for Store
|
|
46317
|
+
* @param {string} xStoreID Store ID
|
|
46318
|
+
* @param {*} [options] Override http request option.
|
|
46319
|
+
* @throws {RequiredError}
|
|
46320
|
+
*/
|
|
46321
|
+
adminStoresXStoreIDAnalyticsEnsurePost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
46697
46322
|
/**
|
|
46698
46323
|
* Retrieves time series data for a specific metric (records, search_response_time, operations, or search_requests) with date filtering for graphing.
|
|
46699
46324
|
* @summary Get Time Series Data for Store Metrics
|
|
@@ -46772,6 +46397,16 @@ export declare const StoresApiFp: (configuration?: Configuration) => {
|
|
|
46772
46397
|
* @throws {RequiredError}
|
|
46773
46398
|
*/
|
|
46774
46399
|
adminStoresXStoreIDDefaultsGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
|
|
46400
|
+
/**
|
|
46401
|
+
* Syncs popular items from ClickHouse to Typesense for real-time boosting in search results
|
|
46402
|
+
* @summary Sync Popular Items to Typesense
|
|
46403
|
+
* @param {string} xStoreID Store ID
|
|
46404
|
+
* @param {number} [limit] Number of items to sync (default: 100)
|
|
46405
|
+
* @param {number} [daysBack] Number of days to look back (default: 30)
|
|
46406
|
+
* @param {*} [options] Override http request option.
|
|
46407
|
+
* @throws {RequiredError}
|
|
46408
|
+
*/
|
|
46409
|
+
adminStoresXStoreIDPopularItemsSyncPost(xStoreID: string, limit?: number, daysBack?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
46775
46410
|
/**
|
|
46776
46411
|
* Get schema options for a specific store by xStoreID
|
|
46777
46412
|
* @summary Get store schema options
|
|
@@ -46866,6 +46501,14 @@ export declare const StoresApiFactory: (configuration?: Configuration, basePath?
|
|
|
46866
46501
|
* @throws {RequiredError}
|
|
46867
46502
|
*/
|
|
46868
46503
|
adminStoresXStoreIDAnalyticsDailyStatsGet(xStoreID: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): AxiosPromise<StoreRouteDailyStatsResponse>;
|
|
46504
|
+
/**
|
|
46505
|
+
* Ensures that Typesense analytics collections and rules exist for the store\'s collection. This is useful for retroactive fixes or ensuring analytics exist for existing stores.
|
|
46506
|
+
* @summary Ensure Analytics Collections and Rules for Store
|
|
46507
|
+
* @param {string} xStoreID Store ID
|
|
46508
|
+
* @param {*} [options] Override http request option.
|
|
46509
|
+
* @throws {RequiredError}
|
|
46510
|
+
*/
|
|
46511
|
+
adminStoresXStoreIDAnalyticsEnsurePost(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
46869
46512
|
/**
|
|
46870
46513
|
* Retrieves time series data for a specific metric (records, search_response_time, operations, or search_requests) with date filtering for graphing.
|
|
46871
46514
|
* @summary Get Time Series Data for Store Metrics
|
|
@@ -46944,6 +46587,16 @@ export declare const StoresApiFactory: (configuration?: Configuration, basePath?
|
|
|
46944
46587
|
* @throws {RequiredError}
|
|
46945
46588
|
*/
|
|
46946
46589
|
adminStoresXStoreIDDefaultsGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
|
|
46590
|
+
/**
|
|
46591
|
+
* Syncs popular items from ClickHouse to Typesense for real-time boosting in search results
|
|
46592
|
+
* @summary Sync Popular Items to Typesense
|
|
46593
|
+
* @param {string} xStoreID Store ID
|
|
46594
|
+
* @param {number} [limit] Number of items to sync (default: 100)
|
|
46595
|
+
* @param {number} [daysBack] Number of days to look back (default: 30)
|
|
46596
|
+
* @param {*} [options] Override http request option.
|
|
46597
|
+
* @throws {RequiredError}
|
|
46598
|
+
*/
|
|
46599
|
+
adminStoresXStoreIDPopularItemsSyncPost(xStoreID: string, limit?: number, daysBack?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
46947
46600
|
/**
|
|
46948
46601
|
* Get schema options for a specific store by xStoreID
|
|
46949
46602
|
* @summary Get store schema options
|
|
@@ -47046,6 +46699,15 @@ export declare class StoresApi extends BaseAPI {
|
|
|
47046
46699
|
* @memberof StoresApi
|
|
47047
46700
|
*/
|
|
47048
46701
|
adminStoresXStoreIDAnalyticsDailyStatsGet(xStoreID: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StoreRouteDailyStatsResponse, any, {}>>;
|
|
46702
|
+
/**
|
|
46703
|
+
* Ensures that Typesense analytics collections and rules exist for the store\'s collection. This is useful for retroactive fixes or ensuring analytics exist for existing stores.
|
|
46704
|
+
* @summary Ensure Analytics Collections and Rules for Store
|
|
46705
|
+
* @param {string} xStoreID Store ID
|
|
46706
|
+
* @param {*} [options] Override http request option.
|
|
46707
|
+
* @throws {RequiredError}
|
|
46708
|
+
* @memberof StoresApi
|
|
46709
|
+
*/
|
|
46710
|
+
adminStoresXStoreIDAnalyticsEnsurePost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
47049
46711
|
/**
|
|
47050
46712
|
* Retrieves time series data for a specific metric (records, search_response_time, operations, or search_requests) with date filtering for graphing.
|
|
47051
46713
|
* @summary Get Time Series Data for Store Metrics
|
|
@@ -47132,6 +46794,17 @@ export declare class StoresApi extends BaseAPI {
|
|
|
47132
46794
|
* @memberof StoresApi
|
|
47133
46795
|
*/
|
|
47134
46796
|
adminStoresXStoreIDDefaultsGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any, {}>>;
|
|
46797
|
+
/**
|
|
46798
|
+
* Syncs popular items from ClickHouse to Typesense for real-time boosting in search results
|
|
46799
|
+
* @summary Sync Popular Items to Typesense
|
|
46800
|
+
* @param {string} xStoreID Store ID
|
|
46801
|
+
* @param {number} [limit] Number of items to sync (default: 100)
|
|
46802
|
+
* @param {number} [daysBack] Number of days to look back (default: 30)
|
|
46803
|
+
* @param {*} [options] Override http request option.
|
|
46804
|
+
* @throws {RequiredError}
|
|
46805
|
+
* @memberof StoresApi
|
|
46806
|
+
*/
|
|
46807
|
+
adminStoresXStoreIDPopularItemsSyncPost(xStoreID: string, limit?: number, daysBack?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
47135
46808
|
/**
|
|
47136
46809
|
* Get schema options for a specific store by xStoreID
|
|
47137
46810
|
* @summary Get store schema options
|