@seekora-ai/admin-api 1.0.63 → 1.0.64
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/.openapi-generator/VERSION +1 -1
- package/README.md +24 -3
- package/api.ts +1426 -40
- package/common.ts +4 -4
- package/dist/api.d.ts +1186 -94
- package/dist/api.js +554 -17
- package/dist/esm/api.d.ts +1186 -94
- package/dist/esm/api.js +549 -12
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.64.tgz +0 -0
- package/seekora-ai-admin-api-1.0.63.tgz +0 -0
package/dist/api.d.ts
CHANGED
|
@@ -746,6 +746,135 @@ export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
|
|
|
746
746
|
*/
|
|
747
747
|
'total'?: number;
|
|
748
748
|
}
|
|
749
|
+
/**
|
|
750
|
+
*
|
|
751
|
+
* @export
|
|
752
|
+
* @interface AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
753
|
+
*/
|
|
754
|
+
export interface AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response {
|
|
755
|
+
/**
|
|
756
|
+
* Comparison metadata when in compare mode
|
|
757
|
+
* @type {AnalyticsComparisonMeta}
|
|
758
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
759
|
+
*/
|
|
760
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
761
|
+
/**
|
|
762
|
+
*
|
|
763
|
+
* @type {Array<AnalyticsQuerySuggestionRecord>}
|
|
764
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
765
|
+
*/
|
|
766
|
+
'data'?: Array<AnalyticsQuerySuggestionRecord>;
|
|
767
|
+
/**
|
|
768
|
+
*
|
|
769
|
+
* @type {string}
|
|
770
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
771
|
+
*/
|
|
772
|
+
'error'?: string;
|
|
773
|
+
/**
|
|
774
|
+
*
|
|
775
|
+
* @type {string}
|
|
776
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
777
|
+
*/
|
|
778
|
+
'status'?: string;
|
|
779
|
+
/**
|
|
780
|
+
*
|
|
781
|
+
* @type {string}
|
|
782
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
783
|
+
*/
|
|
784
|
+
'timestamp'?: string;
|
|
785
|
+
/**
|
|
786
|
+
*
|
|
787
|
+
* @type {number}
|
|
788
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
789
|
+
*/
|
|
790
|
+
'total'?: number;
|
|
791
|
+
}
|
|
792
|
+
/**
|
|
793
|
+
*
|
|
794
|
+
* @export
|
|
795
|
+
* @interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
796
|
+
*/
|
|
797
|
+
export interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response {
|
|
798
|
+
/**
|
|
799
|
+
* Comparison metadata when in compare mode
|
|
800
|
+
* @type {AnalyticsComparisonMeta}
|
|
801
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
802
|
+
*/
|
|
803
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
804
|
+
/**
|
|
805
|
+
*
|
|
806
|
+
* @type {Array<AnalyticsBannedExpression>}
|
|
807
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
808
|
+
*/
|
|
809
|
+
'data'?: Array<AnalyticsBannedExpression>;
|
|
810
|
+
/**
|
|
811
|
+
*
|
|
812
|
+
* @type {string}
|
|
813
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
814
|
+
*/
|
|
815
|
+
'error'?: string;
|
|
816
|
+
/**
|
|
817
|
+
*
|
|
818
|
+
* @type {string}
|
|
819
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
820
|
+
*/
|
|
821
|
+
'status'?: string;
|
|
822
|
+
/**
|
|
823
|
+
*
|
|
824
|
+
* @type {string}
|
|
825
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
826
|
+
*/
|
|
827
|
+
'timestamp'?: string;
|
|
828
|
+
/**
|
|
829
|
+
*
|
|
830
|
+
* @type {number}
|
|
831
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
832
|
+
*/
|
|
833
|
+
'total'?: number;
|
|
834
|
+
}
|
|
835
|
+
/**
|
|
836
|
+
*
|
|
837
|
+
* @export
|
|
838
|
+
* @interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
839
|
+
*/
|
|
840
|
+
export interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response {
|
|
841
|
+
/**
|
|
842
|
+
* Comparison metadata when in compare mode
|
|
843
|
+
* @type {AnalyticsComparisonMeta}
|
|
844
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
845
|
+
*/
|
|
846
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
847
|
+
/**
|
|
848
|
+
*
|
|
849
|
+
* @type {AnalyticsBannedExpression}
|
|
850
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
851
|
+
*/
|
|
852
|
+
'data'?: AnalyticsBannedExpression;
|
|
853
|
+
/**
|
|
854
|
+
*
|
|
855
|
+
* @type {string}
|
|
856
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
857
|
+
*/
|
|
858
|
+
'error'?: string;
|
|
859
|
+
/**
|
|
860
|
+
*
|
|
861
|
+
* @type {string}
|
|
862
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
863
|
+
*/
|
|
864
|
+
'status'?: string;
|
|
865
|
+
/**
|
|
866
|
+
*
|
|
867
|
+
* @type {string}
|
|
868
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
869
|
+
*/
|
|
870
|
+
'timestamp'?: string;
|
|
871
|
+
/**
|
|
872
|
+
*
|
|
873
|
+
* @type {number}
|
|
874
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
875
|
+
*/
|
|
876
|
+
'total'?: number;
|
|
877
|
+
}
|
|
749
878
|
/**
|
|
750
879
|
*
|
|
751
880
|
* @export
|
|
@@ -835,86 +964,129 @@ export interface AdminV1QuerySuggestionsXStoreIDConfigGet200Response {
|
|
|
835
964
|
/**
|
|
836
965
|
*
|
|
837
966
|
* @export
|
|
838
|
-
* @interface
|
|
967
|
+
* @interface AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
839
968
|
*/
|
|
840
|
-
export interface
|
|
969
|
+
export interface AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response {
|
|
841
970
|
/**
|
|
842
971
|
* Comparison metadata when in compare mode
|
|
843
972
|
* @type {AnalyticsComparisonMeta}
|
|
844
|
-
* @memberof
|
|
973
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
845
974
|
*/
|
|
846
975
|
'comparison'?: AnalyticsComparisonMeta;
|
|
847
976
|
/**
|
|
848
977
|
*
|
|
849
|
-
* @type {
|
|
850
|
-
* @memberof
|
|
978
|
+
* @type {Array<AnalyticsEnhancedCategorySuggestion>}
|
|
979
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
851
980
|
*/
|
|
852
|
-
'data'?:
|
|
981
|
+
'data'?: Array<AnalyticsEnhancedCategorySuggestion>;
|
|
853
982
|
/**
|
|
854
983
|
*
|
|
855
984
|
* @type {string}
|
|
856
|
-
* @memberof
|
|
985
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
857
986
|
*/
|
|
858
987
|
'error'?: string;
|
|
859
988
|
/**
|
|
860
989
|
*
|
|
861
990
|
* @type {string}
|
|
862
|
-
* @memberof
|
|
991
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
863
992
|
*/
|
|
864
993
|
'status'?: string;
|
|
865
994
|
/**
|
|
866
995
|
*
|
|
867
996
|
* @type {string}
|
|
868
|
-
* @memberof
|
|
997
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
869
998
|
*/
|
|
870
999
|
'timestamp'?: string;
|
|
871
1000
|
/**
|
|
872
1001
|
*
|
|
873
1002
|
* @type {number}
|
|
874
|
-
* @memberof
|
|
1003
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
875
1004
|
*/
|
|
876
1005
|
'total'?: number;
|
|
877
1006
|
}
|
|
878
1007
|
/**
|
|
879
1008
|
*
|
|
880
1009
|
* @export
|
|
881
|
-
* @interface
|
|
1010
|
+
* @interface AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
882
1011
|
*/
|
|
883
|
-
export interface
|
|
1012
|
+
export interface AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response {
|
|
884
1013
|
/**
|
|
885
1014
|
* Comparison metadata when in compare mode
|
|
886
1015
|
* @type {AnalyticsComparisonMeta}
|
|
887
|
-
* @memberof
|
|
1016
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
888
1017
|
*/
|
|
889
1018
|
'comparison'?: AnalyticsComparisonMeta;
|
|
890
1019
|
/**
|
|
891
1020
|
*
|
|
892
|
-
* @type {Array<
|
|
893
|
-
* @memberof
|
|
1021
|
+
* @type {Array<AnalyticsFacetSuggestion>}
|
|
1022
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
894
1023
|
*/
|
|
895
|
-
'data'?: Array<
|
|
1024
|
+
'data'?: Array<AnalyticsFacetSuggestion>;
|
|
1025
|
+
/**
|
|
1026
|
+
*
|
|
1027
|
+
* @type {string}
|
|
1028
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1029
|
+
*/
|
|
1030
|
+
'error'?: string;
|
|
1031
|
+
/**
|
|
1032
|
+
*
|
|
1033
|
+
* @type {string}
|
|
1034
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1035
|
+
*/
|
|
1036
|
+
'status'?: string;
|
|
1037
|
+
/**
|
|
1038
|
+
*
|
|
1039
|
+
* @type {string}
|
|
1040
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1041
|
+
*/
|
|
1042
|
+
'timestamp'?: string;
|
|
1043
|
+
/**
|
|
1044
|
+
*
|
|
1045
|
+
* @type {number}
|
|
1046
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1047
|
+
*/
|
|
1048
|
+
'total'?: number;
|
|
1049
|
+
}
|
|
1050
|
+
/**
|
|
1051
|
+
*
|
|
1052
|
+
* @export
|
|
1053
|
+
* @interface AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
1054
|
+
*/
|
|
1055
|
+
export interface AdminV1QuerySuggestionsXStoreIDGet200Response {
|
|
1056
|
+
/**
|
|
1057
|
+
* Comparison metadata when in compare mode
|
|
1058
|
+
* @type {AnalyticsComparisonMeta}
|
|
1059
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
1060
|
+
*/
|
|
1061
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
1062
|
+
/**
|
|
1063
|
+
*
|
|
1064
|
+
* @type {AnalyticsQuerySuggestionManagementResponse}
|
|
1065
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
1066
|
+
*/
|
|
1067
|
+
'data'?: AnalyticsQuerySuggestionManagementResponse;
|
|
896
1068
|
/**
|
|
897
1069
|
*
|
|
898
1070
|
* @type {string}
|
|
899
|
-
* @memberof
|
|
1071
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
900
1072
|
*/
|
|
901
1073
|
'error'?: string;
|
|
902
1074
|
/**
|
|
903
1075
|
*
|
|
904
1076
|
* @type {string}
|
|
905
|
-
* @memberof
|
|
1077
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
906
1078
|
*/
|
|
907
1079
|
'status'?: string;
|
|
908
1080
|
/**
|
|
909
1081
|
*
|
|
910
1082
|
* @type {string}
|
|
911
|
-
* @memberof
|
|
1083
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
912
1084
|
*/
|
|
913
1085
|
'timestamp'?: string;
|
|
914
1086
|
/**
|
|
915
1087
|
*
|
|
916
1088
|
* @type {number}
|
|
917
|
-
* @memberof
|
|
1089
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
918
1090
|
*/
|
|
919
1091
|
'total'?: number;
|
|
920
1092
|
}
|
|
@@ -1280,6 +1452,68 @@ export interface AnalyticsArrayPositionAnalytic {
|
|
|
1280
1452
|
*/
|
|
1281
1453
|
'usage_count'?: number;
|
|
1282
1454
|
}
|
|
1455
|
+
/**
|
|
1456
|
+
*
|
|
1457
|
+
* @export
|
|
1458
|
+
* @interface AnalyticsBannedExpression
|
|
1459
|
+
*/
|
|
1460
|
+
export interface AnalyticsBannedExpression {
|
|
1461
|
+
/**
|
|
1462
|
+
* When this ban was created
|
|
1463
|
+
* @type {string}
|
|
1464
|
+
* @memberof AnalyticsBannedExpression
|
|
1465
|
+
*/
|
|
1466
|
+
'created_at'?: string;
|
|
1467
|
+
/**
|
|
1468
|
+
* Optional description
|
|
1469
|
+
* @type {string}
|
|
1470
|
+
* @memberof AnalyticsBannedExpression
|
|
1471
|
+
*/
|
|
1472
|
+
'description'?: string;
|
|
1473
|
+
/**
|
|
1474
|
+
* Whether this ban is active
|
|
1475
|
+
* @type {boolean}
|
|
1476
|
+
* @memberof AnalyticsBannedExpression
|
|
1477
|
+
*/
|
|
1478
|
+
'enabled'?: boolean;
|
|
1479
|
+
/**
|
|
1480
|
+
* The expression to ban
|
|
1481
|
+
* @type {string}
|
|
1482
|
+
* @memberof AnalyticsBannedExpression
|
|
1483
|
+
*/
|
|
1484
|
+
'expression'?: string;
|
|
1485
|
+
/**
|
|
1486
|
+
* Unique identifier for the banned expression
|
|
1487
|
+
* @type {string}
|
|
1488
|
+
* @memberof AnalyticsBannedExpression
|
|
1489
|
+
*/
|
|
1490
|
+
'id'?: string;
|
|
1491
|
+
/**
|
|
1492
|
+
* How to match the expression
|
|
1493
|
+
* @type {AnalyticsBannedMatchType}
|
|
1494
|
+
* @memberof AnalyticsBannedExpression
|
|
1495
|
+
*/
|
|
1496
|
+
'match_type'?: AnalyticsBannedMatchType;
|
|
1497
|
+
/**
|
|
1498
|
+
* When this ban was last updated
|
|
1499
|
+
* @type {string}
|
|
1500
|
+
* @memberof AnalyticsBannedExpression
|
|
1501
|
+
*/
|
|
1502
|
+
'updated_at'?: string;
|
|
1503
|
+
}
|
|
1504
|
+
/**
|
|
1505
|
+
*
|
|
1506
|
+
* @export
|
|
1507
|
+
* @enum {string}
|
|
1508
|
+
*/
|
|
1509
|
+
export declare const AnalyticsBannedMatchType: {
|
|
1510
|
+
readonly BannedMatchIs: "is";
|
|
1511
|
+
readonly BannedMatchContains: "contains";
|
|
1512
|
+
readonly BannedMatchStartsWith: "startsWith";
|
|
1513
|
+
readonly BannedMatchEndsWith: "endsWith";
|
|
1514
|
+
readonly BannedMatchCustom: "custom";
|
|
1515
|
+
};
|
|
1516
|
+
export type AnalyticsBannedMatchType = typeof AnalyticsBannedMatchType[keyof typeof AnalyticsBannedMatchType];
|
|
1283
1517
|
/**
|
|
1284
1518
|
*
|
|
1285
1519
|
* @export
|
|
@@ -1387,6 +1621,68 @@ export interface AnalyticsCachedSuggestionResponse {
|
|
|
1387
1621
|
*/
|
|
1388
1622
|
'suggestions'?: Array<AnalyticsCachedSuggestion>;
|
|
1389
1623
|
}
|
|
1624
|
+
/**
|
|
1625
|
+
*
|
|
1626
|
+
* @export
|
|
1627
|
+
* @interface AnalyticsCategoryAttributeConfig
|
|
1628
|
+
*/
|
|
1629
|
+
export interface AnalyticsCategoryAttributeConfig {
|
|
1630
|
+
/**
|
|
1631
|
+
* The attribute name (e.g., \"category\", \"brand\") - REQUIRED
|
|
1632
|
+
* @type {string}
|
|
1633
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1634
|
+
*/
|
|
1635
|
+
'attribute'?: string;
|
|
1636
|
+
/**
|
|
1637
|
+
* Optional description (default: auto-generated)
|
|
1638
|
+
* @type {string}
|
|
1639
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1640
|
+
*/
|
|
1641
|
+
'description'?: string;
|
|
1642
|
+
/**
|
|
1643
|
+
* Whether this attribute is enabled (default: true)
|
|
1644
|
+
* @type {boolean}
|
|
1645
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1646
|
+
*/
|
|
1647
|
+
'enabled'?: boolean;
|
|
1648
|
+
/**
|
|
1649
|
+
* Maximum number of categories to show for this attribute - REQUIRED
|
|
1650
|
+
* @type {number}
|
|
1651
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1652
|
+
*/
|
|
1653
|
+
'max_count'?: number;
|
|
1654
|
+
/**
|
|
1655
|
+
* Priority order (lower number = higher priority) (default: auto-assigned)
|
|
1656
|
+
* @type {number}
|
|
1657
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1658
|
+
*/
|
|
1659
|
+
'priority'?: number;
|
|
1660
|
+
}
|
|
1661
|
+
/**
|
|
1662
|
+
*
|
|
1663
|
+
* @export
|
|
1664
|
+
* @interface AnalyticsCategoryWithCount
|
|
1665
|
+
*/
|
|
1666
|
+
export interface AnalyticsCategoryWithCount {
|
|
1667
|
+
/**
|
|
1668
|
+
*
|
|
1669
|
+
* @type {number}
|
|
1670
|
+
* @memberof AnalyticsCategoryWithCount
|
|
1671
|
+
*/
|
|
1672
|
+
'count'?: number;
|
|
1673
|
+
/**
|
|
1674
|
+
* \"exact_matches\" or \"analytics\"
|
|
1675
|
+
* @type {string}
|
|
1676
|
+
* @memberof AnalyticsCategoryWithCount
|
|
1677
|
+
*/
|
|
1678
|
+
'type'?: string;
|
|
1679
|
+
/**
|
|
1680
|
+
*
|
|
1681
|
+
* @type {string}
|
|
1682
|
+
* @memberof AnalyticsCategoryWithCount
|
|
1683
|
+
*/
|
|
1684
|
+
'value'?: string;
|
|
1685
|
+
}
|
|
1390
1686
|
/**
|
|
1391
1687
|
*
|
|
1392
1688
|
* @export
|
|
@@ -1504,80 +1800,221 @@ export interface AnalyticsCustomQueryRequest {
|
|
|
1504
1800
|
* @type {string}
|
|
1505
1801
|
* @memberof AnalyticsCustomQueryRequest
|
|
1506
1802
|
*/
|
|
1507
|
-
'start_time'?: string;
|
|
1508
|
-
}
|
|
1509
|
-
/**
|
|
1510
|
-
*
|
|
1511
|
-
* @export
|
|
1512
|
-
* @interface AnalyticsCustomQueryResponse
|
|
1513
|
-
*/
|
|
1514
|
-
export interface AnalyticsCustomQueryResponse {
|
|
1803
|
+
'start_time'?: string;
|
|
1804
|
+
}
|
|
1805
|
+
/**
|
|
1806
|
+
*
|
|
1807
|
+
* @export
|
|
1808
|
+
* @interface AnalyticsCustomQueryResponse
|
|
1809
|
+
*/
|
|
1810
|
+
export interface AnalyticsCustomQueryResponse {
|
|
1811
|
+
/**
|
|
1812
|
+
*
|
|
1813
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
1814
|
+
* @memberof AnalyticsCustomQueryResponse
|
|
1815
|
+
*/
|
|
1816
|
+
'data'?: Array<{
|
|
1817
|
+
[key: string]: any;
|
|
1818
|
+
}>;
|
|
1819
|
+
/**
|
|
1820
|
+
*
|
|
1821
|
+
* @type {string}
|
|
1822
|
+
* @memberof AnalyticsCustomQueryResponse
|
|
1823
|
+
*/
|
|
1824
|
+
'query'?: string;
|
|
1825
|
+
/**
|
|
1826
|
+
*
|
|
1827
|
+
* @type {string}
|
|
1828
|
+
* @memberof AnalyticsCustomQueryResponse
|
|
1829
|
+
*/
|
|
1830
|
+
'timestamp'?: string;
|
|
1831
|
+
/**
|
|
1832
|
+
*
|
|
1833
|
+
* @type {number}
|
|
1834
|
+
* @memberof AnalyticsCustomQueryResponse
|
|
1835
|
+
*/
|
|
1836
|
+
'total'?: number;
|
|
1837
|
+
}
|
|
1838
|
+
/**
|
|
1839
|
+
*
|
|
1840
|
+
* @export
|
|
1841
|
+
* @interface AnalyticsDeleteManualSuggestionsRequest
|
|
1842
|
+
*/
|
|
1843
|
+
export interface AnalyticsDeleteManualSuggestionsRequest {
|
|
1844
|
+
/**
|
|
1845
|
+
* IDs of manual suggestions to delete
|
|
1846
|
+
* @type {Array<string>}
|
|
1847
|
+
* @memberof AnalyticsDeleteManualSuggestionsRequest
|
|
1848
|
+
*/
|
|
1849
|
+
'suggestion_ids': Array<string>;
|
|
1850
|
+
}
|
|
1851
|
+
/**
|
|
1852
|
+
*
|
|
1853
|
+
* @export
|
|
1854
|
+
* @interface AnalyticsEnhancedCategorySuggestion
|
|
1855
|
+
*/
|
|
1856
|
+
export interface AnalyticsEnhancedCategorySuggestion {
|
|
1857
|
+
/**
|
|
1858
|
+
*
|
|
1859
|
+
* @type {Array<AnalyticsCategoryWithCount>}
|
|
1860
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1861
|
+
*/
|
|
1862
|
+
'categories'?: Array<AnalyticsCategoryWithCount>;
|
|
1863
|
+
/**
|
|
1864
|
+
*
|
|
1865
|
+
* @type {{ [key: string]: any; }}
|
|
1866
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1867
|
+
*/
|
|
1868
|
+
'metadata'?: {
|
|
1869
|
+
[key: string]: any;
|
|
1870
|
+
};
|
|
1871
|
+
/**
|
|
1872
|
+
*
|
|
1873
|
+
* @type {number}
|
|
1874
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1875
|
+
*/
|
|
1876
|
+
'popularity'?: number;
|
|
1877
|
+
/**
|
|
1878
|
+
*
|
|
1879
|
+
* @type {string}
|
|
1880
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1881
|
+
*/
|
|
1882
|
+
'query'?: string;
|
|
1883
|
+
}
|
|
1884
|
+
/**
|
|
1885
|
+
*
|
|
1886
|
+
* @export
|
|
1887
|
+
* @interface AnalyticsEnrichedItemResultWithWidget
|
|
1888
|
+
*/
|
|
1889
|
+
export interface AnalyticsEnrichedItemResultWithWidget {
|
|
1890
|
+
/**
|
|
1891
|
+
*
|
|
1892
|
+
* @type {number}
|
|
1893
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1894
|
+
*/
|
|
1895
|
+
'avg_position'?: number;
|
|
1896
|
+
/**
|
|
1897
|
+
*
|
|
1898
|
+
* @type {number}
|
|
1899
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1900
|
+
*/
|
|
1901
|
+
'avg_score'?: number;
|
|
1902
|
+
/**
|
|
1903
|
+
* Calculated metrics
|
|
1904
|
+
* @type {number}
|
|
1905
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1906
|
+
*/
|
|
1907
|
+
'click_through_rate'?: number;
|
|
1908
|
+
/**
|
|
1909
|
+
* Future click and conversion metrics
|
|
1910
|
+
* @type {number}
|
|
1911
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1912
|
+
*/
|
|
1913
|
+
'clicks'?: number;
|
|
1914
|
+
/**
|
|
1915
|
+
*
|
|
1916
|
+
* @type {number}
|
|
1917
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1918
|
+
*/
|
|
1919
|
+
'conversion_rate'?: number;
|
|
1920
|
+
/**
|
|
1921
|
+
*
|
|
1922
|
+
* @type {number}
|
|
1923
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1924
|
+
*/
|
|
1925
|
+
'conversions'?: number;
|
|
1926
|
+
/**
|
|
1927
|
+
* Document data from Typesense index
|
|
1928
|
+
* @type {{ [key: string]: any; }}
|
|
1929
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1930
|
+
*/
|
|
1931
|
+
'document'?: {
|
|
1932
|
+
[key: string]: any;
|
|
1933
|
+
};
|
|
1934
|
+
/**
|
|
1935
|
+
* Error if document fetch failed
|
|
1936
|
+
* @type {string}
|
|
1937
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1938
|
+
*/
|
|
1939
|
+
'document_fetch_error'?: string;
|
|
1940
|
+
/**
|
|
1941
|
+
*
|
|
1942
|
+
* @type {number}
|
|
1943
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1944
|
+
*/
|
|
1945
|
+
'impressions'?: number;
|
|
1946
|
+
/**
|
|
1947
|
+
*
|
|
1948
|
+
* @type {string}
|
|
1949
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1950
|
+
*/
|
|
1951
|
+
'item_id'?: string;
|
|
1952
|
+
/**
|
|
1953
|
+
*
|
|
1954
|
+
* @type {string}
|
|
1955
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1956
|
+
*/
|
|
1957
|
+
'item_name'?: string;
|
|
1958
|
+
/**
|
|
1959
|
+
*
|
|
1960
|
+
* @type {number}
|
|
1961
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1962
|
+
*/
|
|
1963
|
+
'revenue'?: number;
|
|
1964
|
+
/**
|
|
1965
|
+
*
|
|
1966
|
+
* @type {number}
|
|
1967
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1968
|
+
*/
|
|
1969
|
+
'revenue_per_item'?: number;
|
|
1515
1970
|
/**
|
|
1516
1971
|
*
|
|
1517
|
-
* @type {
|
|
1518
|
-
* @memberof
|
|
1972
|
+
* @type {number}
|
|
1973
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1519
1974
|
*/
|
|
1520
|
-
'
|
|
1521
|
-
[key: string]: any;
|
|
1522
|
-
}>;
|
|
1975
|
+
'top_10_impressions'?: number;
|
|
1523
1976
|
/**
|
|
1524
1977
|
*
|
|
1525
|
-
* @type {
|
|
1526
|
-
* @memberof
|
|
1978
|
+
* @type {number}
|
|
1979
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1527
1980
|
*/
|
|
1528
|
-
'
|
|
1981
|
+
'top_3_impression_rate'?: number;
|
|
1529
1982
|
/**
|
|
1530
1983
|
*
|
|
1531
|
-
* @type {
|
|
1532
|
-
* @memberof
|
|
1984
|
+
* @type {number}
|
|
1985
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1533
1986
|
*/
|
|
1534
|
-
'
|
|
1987
|
+
'top_3_impressions'?: number;
|
|
1535
1988
|
/**
|
|
1536
1989
|
*
|
|
1537
1990
|
* @type {number}
|
|
1538
|
-
* @memberof
|
|
1991
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1539
1992
|
*/
|
|
1540
|
-
'
|
|
1541
|
-
}
|
|
1542
|
-
/**
|
|
1543
|
-
*
|
|
1544
|
-
* @export
|
|
1545
|
-
* @interface AnalyticsDeleteManualSuggestionsRequest
|
|
1546
|
-
*/
|
|
1547
|
-
export interface AnalyticsDeleteManualSuggestionsRequest {
|
|
1993
|
+
'unique_filters'?: number;
|
|
1548
1994
|
/**
|
|
1549
|
-
*
|
|
1550
|
-
* @type {
|
|
1551
|
-
* @memberof
|
|
1995
|
+
*
|
|
1996
|
+
* @type {number}
|
|
1997
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1552
1998
|
*/
|
|
1553
|
-
'
|
|
1554
|
-
}
|
|
1555
|
-
/**
|
|
1556
|
-
*
|
|
1557
|
-
* @export
|
|
1558
|
-
* @interface AnalyticsEnrichedItemResultWithWidget
|
|
1559
|
-
*/
|
|
1560
|
-
export interface AnalyticsEnrichedItemResultWithWidget {
|
|
1999
|
+
'unique_queries'?: number;
|
|
1561
2000
|
/**
|
|
1562
|
-
*
|
|
1563
|
-
* @type {
|
|
2001
|
+
*
|
|
2002
|
+
* @type {number}
|
|
1564
2003
|
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1565
2004
|
*/
|
|
1566
|
-
'
|
|
2005
|
+
'unique_searches'?: number;
|
|
1567
2006
|
/**
|
|
1568
|
-
*
|
|
1569
|
-
* @type {
|
|
2007
|
+
*
|
|
2008
|
+
* @type {number}
|
|
1570
2009
|
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1571
2010
|
*/
|
|
1572
|
-
'
|
|
1573
|
-
[key: string]: any;
|
|
1574
|
-
};
|
|
2011
|
+
'unique_sorts'?: number;
|
|
1575
2012
|
/**
|
|
1576
|
-
*
|
|
1577
|
-
* @type {
|
|
2013
|
+
*
|
|
2014
|
+
* @type {number}
|
|
1578
2015
|
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1579
2016
|
*/
|
|
1580
|
-
'
|
|
2017
|
+
'unique_users'?: number;
|
|
1581
2018
|
/**
|
|
1582
2019
|
* Widget display data for UI presentation
|
|
1583
2020
|
* @type {AnalyticsWidgetData}
|
|
@@ -1651,6 +2088,12 @@ export interface AnalyticsExtendedKPIResponse {
|
|
|
1651
2088
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1652
2089
|
*/
|
|
1653
2090
|
'summary'?: any;
|
|
2091
|
+
/**
|
|
2092
|
+
*
|
|
2093
|
+
* @type {string}
|
|
2094
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
2095
|
+
*/
|
|
2096
|
+
'target_currency'?: string;
|
|
1654
2097
|
/**
|
|
1655
2098
|
*
|
|
1656
2099
|
* @type {string}
|
|
@@ -1677,6 +2120,39 @@ export interface AnalyticsFacetMatch {
|
|
|
1677
2120
|
*/
|
|
1678
2121
|
'value'?: string;
|
|
1679
2122
|
}
|
|
2123
|
+
/**
|
|
2124
|
+
*
|
|
2125
|
+
* @export
|
|
2126
|
+
* @interface AnalyticsFacetSuggestion
|
|
2127
|
+
*/
|
|
2128
|
+
export interface AnalyticsFacetSuggestion {
|
|
2129
|
+
/**
|
|
2130
|
+
*
|
|
2131
|
+
* @type {number}
|
|
2132
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2133
|
+
*/
|
|
2134
|
+
'count'?: number;
|
|
2135
|
+
/**
|
|
2136
|
+
* e.g., {\"brand\": \"Nike\", \"color\": \"red\"}
|
|
2137
|
+
* @type {{ [key: string]: string; }}
|
|
2138
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2139
|
+
*/
|
|
2140
|
+
'facet_combination'?: {
|
|
2141
|
+
[key: string]: string;
|
|
2142
|
+
};
|
|
2143
|
+
/**
|
|
2144
|
+
*
|
|
2145
|
+
* @type {number}
|
|
2146
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2147
|
+
*/
|
|
2148
|
+
'popularity'?: number;
|
|
2149
|
+
/**
|
|
2150
|
+
*
|
|
2151
|
+
* @type {string}
|
|
2152
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2153
|
+
*/
|
|
2154
|
+
'query'?: string;
|
|
2155
|
+
}
|
|
1680
2156
|
/**
|
|
1681
2157
|
*
|
|
1682
2158
|
* @export
|
|
@@ -2357,6 +2833,20 @@ export interface AnalyticsGeoAnalytic {
|
|
|
2357
2833
|
* @memberof AnalyticsGeoAnalytic
|
|
2358
2834
|
*/
|
|
2359
2835
|
'revenue'?: number;
|
|
2836
|
+
/**
|
|
2837
|
+
*
|
|
2838
|
+
* @type {{ [key: string]: number; }}
|
|
2839
|
+
* @memberof AnalyticsGeoAnalytic
|
|
2840
|
+
*/
|
|
2841
|
+
'revenue_breakdown'?: {
|
|
2842
|
+
[key: string]: number;
|
|
2843
|
+
};
|
|
2844
|
+
/**
|
|
2845
|
+
*
|
|
2846
|
+
* @type {string}
|
|
2847
|
+
* @memberof AnalyticsGeoAnalytic
|
|
2848
|
+
*/
|
|
2849
|
+
'revenue_currency'?: string;
|
|
2360
2850
|
/**
|
|
2361
2851
|
*
|
|
2362
2852
|
* @type {number}
|
|
@@ -2699,6 +3189,12 @@ export interface AnalyticsGeoResponse {
|
|
|
2699
3189
|
* @memberof AnalyticsGeoResponse
|
|
2700
3190
|
*/
|
|
2701
3191
|
'start_time'?: string;
|
|
3192
|
+
/**
|
|
3193
|
+
*
|
|
3194
|
+
* @type {string}
|
|
3195
|
+
* @memberof AnalyticsGeoResponse
|
|
3196
|
+
*/
|
|
3197
|
+
'target_currency'?: string;
|
|
2702
3198
|
/**
|
|
2703
3199
|
*
|
|
2704
3200
|
* @type {number}
|
|
@@ -4178,6 +4674,20 @@ export interface AnalyticsKPIMetrics {
|
|
|
4178
4674
|
* @memberof AnalyticsKPIMetrics
|
|
4179
4675
|
*/
|
|
4180
4676
|
'revenue'?: number;
|
|
4677
|
+
/**
|
|
4678
|
+
*
|
|
4679
|
+
* @type {{ [key: string]: number; }}
|
|
4680
|
+
* @memberof AnalyticsKPIMetrics
|
|
4681
|
+
*/
|
|
4682
|
+
'revenue_breakdown'?: {
|
|
4683
|
+
[key: string]: number;
|
|
4684
|
+
};
|
|
4685
|
+
/**
|
|
4686
|
+
*
|
|
4687
|
+
* @type {string}
|
|
4688
|
+
* @memberof AnalyticsKPIMetrics
|
|
4689
|
+
*/
|
|
4690
|
+
'revenue_currency'?: string;
|
|
4181
4691
|
/**
|
|
4182
4692
|
*
|
|
4183
4693
|
* @type {number}
|
|
@@ -4257,6 +4767,20 @@ export interface AnalyticsKPIPointExtended {
|
|
|
4257
4767
|
* @memberof AnalyticsKPIPointExtended
|
|
4258
4768
|
*/
|
|
4259
4769
|
'revenue'?: number;
|
|
4770
|
+
/**
|
|
4771
|
+
*
|
|
4772
|
+
* @type {{ [key: string]: number; }}
|
|
4773
|
+
* @memberof AnalyticsKPIPointExtended
|
|
4774
|
+
*/
|
|
4775
|
+
'revenue_breakdown'?: {
|
|
4776
|
+
[key: string]: number;
|
|
4777
|
+
};
|
|
4778
|
+
/**
|
|
4779
|
+
*
|
|
4780
|
+
* @type {string}
|
|
4781
|
+
* @memberof AnalyticsKPIPointExtended
|
|
4782
|
+
*/
|
|
4783
|
+
'revenue_currency'?: string;
|
|
4260
4784
|
/**
|
|
4261
4785
|
*
|
|
4262
4786
|
* @type {number}
|
|
@@ -4437,6 +4961,20 @@ export interface AnalyticsQueryAnalytic {
|
|
|
4437
4961
|
* @memberof AnalyticsQueryAnalytic
|
|
4438
4962
|
*/
|
|
4439
4963
|
'revenue'?: number;
|
|
4964
|
+
/**
|
|
4965
|
+
*
|
|
4966
|
+
* @type {{ [key: string]: number; }}
|
|
4967
|
+
* @memberof AnalyticsQueryAnalytic
|
|
4968
|
+
*/
|
|
4969
|
+
'revenue_breakdown'?: {
|
|
4970
|
+
[key: string]: number;
|
|
4971
|
+
};
|
|
4972
|
+
/**
|
|
4973
|
+
*
|
|
4974
|
+
* @type {string}
|
|
4975
|
+
* @memberof AnalyticsQueryAnalytic
|
|
4976
|
+
*/
|
|
4977
|
+
'revenue_currency'?: string;
|
|
4440
4978
|
/**
|
|
4441
4979
|
*
|
|
4442
4980
|
* @type {number}
|
|
@@ -5303,6 +5841,12 @@ export interface AnalyticsQueryResponse {
|
|
|
5303
5841
|
* @memberof AnalyticsQueryResponse
|
|
5304
5842
|
*/
|
|
5305
5843
|
'start_time'?: string;
|
|
5844
|
+
/**
|
|
5845
|
+
*
|
|
5846
|
+
* @type {string}
|
|
5847
|
+
* @memberof AnalyticsQueryResponse
|
|
5848
|
+
*/
|
|
5849
|
+
'target_currency'?: string;
|
|
5306
5850
|
/**
|
|
5307
5851
|
*
|
|
5308
5852
|
* @type {number}
|
|
@@ -5380,11 +5924,29 @@ export interface AnalyticsQuerySuggestion {
|
|
|
5380
5924
|
*/
|
|
5381
5925
|
export interface AnalyticsQuerySuggestionConfig {
|
|
5382
5926
|
/**
|
|
5383
|
-
*
|
|
5927
|
+
* Expressions to exclude from suggestions with matching types
|
|
5928
|
+
* @type {Array<AnalyticsBannedExpression>}
|
|
5929
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5930
|
+
*/
|
|
5931
|
+
'banned_expressions'?: Array<AnalyticsBannedExpression>;
|
|
5932
|
+
/**
|
|
5933
|
+
* Per-attribute configuration with counts
|
|
5934
|
+
* @type {Array<AnalyticsCategoryAttributeConfig>}
|
|
5935
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5936
|
+
*/
|
|
5937
|
+
'category_attribute_configs'?: Array<AnalyticsCategoryAttributeConfig>;
|
|
5938
|
+
/**
|
|
5939
|
+
* Attributes to use for category suggestions (legacy)
|
|
5384
5940
|
* @type {Array<string>}
|
|
5385
5941
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5386
5942
|
*/
|
|
5387
5943
|
'category_attributes'?: Array<string>;
|
|
5944
|
+
/**
|
|
5945
|
+
* Whether to include count per attribute
|
|
5946
|
+
* @type {boolean}
|
|
5947
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5948
|
+
*/
|
|
5949
|
+
'category_counts'?: boolean;
|
|
5388
5950
|
/**
|
|
5389
5951
|
* Whether to include category-based suggestions
|
|
5390
5952
|
* @type {boolean}
|
|
@@ -5397,12 +5959,42 @@ export interface AnalyticsQuerySuggestionConfig {
|
|
|
5397
5959
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5398
5960
|
*/
|
|
5399
5961
|
'enable_facet_suggestions'?: boolean;
|
|
5962
|
+
/**
|
|
5963
|
+
* Personalization (boolean flag for now as requested)
|
|
5964
|
+
* @type {boolean}
|
|
5965
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5966
|
+
*/
|
|
5967
|
+
'enable_personalization'?: boolean;
|
|
5968
|
+
/**
|
|
5969
|
+
* Improve relevance using Rules
|
|
5970
|
+
* @type {boolean}
|
|
5971
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5972
|
+
*/
|
|
5973
|
+
'enable_rules'?: boolean;
|
|
5400
5974
|
/**
|
|
5401
5975
|
* Whether query suggestions are enabled for the store
|
|
5402
5976
|
* @type {boolean}
|
|
5403
5977
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5404
5978
|
*/
|
|
5405
5979
|
'enabled'?: boolean;
|
|
5980
|
+
/**
|
|
5981
|
+
* Facet data augmentation
|
|
5982
|
+
* @type {Array<string>}
|
|
5983
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5984
|
+
*/
|
|
5985
|
+
'facet_attributes'?: Array<string>;
|
|
5986
|
+
/**
|
|
5987
|
+
* Maximum number of facet combinations
|
|
5988
|
+
* @type {number}
|
|
5989
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5990
|
+
*/
|
|
5991
|
+
'facet_combination_limit'?: number;
|
|
5992
|
+
/**
|
|
5993
|
+
* Language for duplicate removal (singular/plural)
|
|
5994
|
+
* @type {string}
|
|
5995
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5996
|
+
*/
|
|
5997
|
+
'language'?: string;
|
|
5406
5998
|
/**
|
|
5407
5999
|
* Maximum number of suggestions to return
|
|
5408
6000
|
* @type {number}
|
|
@@ -5415,18 +6007,54 @@ export interface AnalyticsQuerySuggestionConfig {
|
|
|
5415
6007
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5416
6008
|
*/
|
|
5417
6009
|
'min_popularity'?: number;
|
|
6010
|
+
/**
|
|
6011
|
+
* Minimum search results for suggestions
|
|
6012
|
+
* @type {number}
|
|
6013
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6014
|
+
*/
|
|
6015
|
+
'minimum_hits'?: number;
|
|
6016
|
+
/**
|
|
6017
|
+
* Remove duplicate or unhelpful suggestions (from Algolia documentation)
|
|
6018
|
+
* @type {number}
|
|
6019
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6020
|
+
*/
|
|
6021
|
+
'minimum_letters'?: number;
|
|
6022
|
+
/**
|
|
6023
|
+
* Array of rules for suggestion promotion/hiding
|
|
6024
|
+
* @type {Array<AnalyticsQuerySuggestionRule>}
|
|
6025
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6026
|
+
*/
|
|
6027
|
+
'rules'?: Array<AnalyticsQuerySuggestionRule>;
|
|
6028
|
+
/**
|
|
6029
|
+
* Query Suggestions with categories - enhanced
|
|
6030
|
+
* @type {number}
|
|
6031
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6032
|
+
*/
|
|
6033
|
+
'show_top_categories'?: number;
|
|
5418
6034
|
/**
|
|
5419
6035
|
* Whether to sync enabled suggestions to Typesense
|
|
5420
6036
|
* @type {boolean}
|
|
5421
6037
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5422
6038
|
*/
|
|
5423
6039
|
'sync_to_typesense'?: boolean;
|
|
6040
|
+
/**
|
|
6041
|
+
* Tokenization method
|
|
6042
|
+
* @type {string}
|
|
6043
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6044
|
+
*/
|
|
6045
|
+
'tokenization'?: string;
|
|
5424
6046
|
/**
|
|
5425
6047
|
* Whether to sync to Typesense
|
|
5426
6048
|
* @type {boolean}
|
|
5427
6049
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5428
6050
|
*/
|
|
5429
6051
|
'typesense_collection_enabled'?: boolean;
|
|
6052
|
+
/**
|
|
6053
|
+
* Index settings
|
|
6054
|
+
* @type {number}
|
|
6055
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6056
|
+
*/
|
|
6057
|
+
'typo_tolerance'?: number;
|
|
5430
6058
|
/**
|
|
5431
6059
|
* Include auto-generated suggestions
|
|
5432
6060
|
* @type {boolean}
|
|
@@ -5622,15 +6250,82 @@ export interface AnalyticsQuerySuggestionRecord {
|
|
|
5622
6250
|
/**
|
|
5623
6251
|
*
|
|
5624
6252
|
* @type {number}
|
|
5625
|
-
* @memberof AnalyticsQuerySuggestionRecord
|
|
6253
|
+
* @memberof AnalyticsQuerySuggestionRecord
|
|
6254
|
+
*/
|
|
6255
|
+
'updated_by'?: number;
|
|
6256
|
+
/**
|
|
6257
|
+
*
|
|
6258
|
+
* @type {string}
|
|
6259
|
+
* @memberof AnalyticsQuerySuggestionRecord
|
|
6260
|
+
*/
|
|
6261
|
+
'xstoreid'?: string;
|
|
6262
|
+
}
|
|
6263
|
+
/**
|
|
6264
|
+
*
|
|
6265
|
+
* @export
|
|
6266
|
+
* @interface AnalyticsQuerySuggestionRule
|
|
6267
|
+
*/
|
|
6268
|
+
export interface AnalyticsQuerySuggestionRule {
|
|
6269
|
+
/**
|
|
6270
|
+
* Rule actions
|
|
6271
|
+
* @type {Array<AnalyticsRuleAction>}
|
|
6272
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6273
|
+
*/
|
|
6274
|
+
'actions'?: Array<AnalyticsRuleAction>;
|
|
6275
|
+
/**
|
|
6276
|
+
* Rule conditions
|
|
6277
|
+
* @type {Array<AnalyticsRuleCondition>}
|
|
6278
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6279
|
+
*/
|
|
6280
|
+
'conditions'?: Array<AnalyticsRuleCondition>;
|
|
6281
|
+
/**
|
|
6282
|
+
* Rule creation time
|
|
6283
|
+
* @type {string}
|
|
6284
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6285
|
+
*/
|
|
6286
|
+
'created_at'?: string;
|
|
6287
|
+
/**
|
|
6288
|
+
* Rule description
|
|
6289
|
+
* @type {string}
|
|
6290
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6291
|
+
*/
|
|
6292
|
+
'description'?: string;
|
|
6293
|
+
/**
|
|
6294
|
+
* Whether rule is enabled
|
|
6295
|
+
* @type {boolean}
|
|
6296
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6297
|
+
*/
|
|
6298
|
+
'enabled'?: boolean;
|
|
6299
|
+
/**
|
|
6300
|
+
* Unique rule identifier
|
|
6301
|
+
* @type {string}
|
|
6302
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6303
|
+
*/
|
|
6304
|
+
'id'?: string;
|
|
6305
|
+
/**
|
|
6306
|
+
* Rule name
|
|
6307
|
+
* @type {string}
|
|
6308
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6309
|
+
*/
|
|
6310
|
+
'name'?: string;
|
|
6311
|
+
/**
|
|
6312
|
+
* Rule priority (higher = executed first)
|
|
6313
|
+
* @type {number}
|
|
6314
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
5626
6315
|
*/
|
|
5627
|
-
'
|
|
6316
|
+
'priority'?: number;
|
|
5628
6317
|
/**
|
|
5629
|
-
*
|
|
6318
|
+
* Rule type (promote, hide, redirect, etc.)
|
|
6319
|
+
* @type {AnalyticsRuleType}
|
|
6320
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6321
|
+
*/
|
|
6322
|
+
'type'?: AnalyticsRuleType;
|
|
6323
|
+
/**
|
|
6324
|
+
* Rule last update time
|
|
5630
6325
|
* @type {string}
|
|
5631
|
-
* @memberof
|
|
6326
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
5632
6327
|
*/
|
|
5633
|
-
'
|
|
6328
|
+
'updated_at'?: string;
|
|
5634
6329
|
}
|
|
5635
6330
|
/**
|
|
5636
6331
|
*
|
|
@@ -5905,6 +6600,68 @@ export interface AnalyticsQuerySuggestionsResponse {
|
|
|
5905
6600
|
*/
|
|
5906
6601
|
'userToken'?: string;
|
|
5907
6602
|
}
|
|
6603
|
+
/**
|
|
6604
|
+
*
|
|
6605
|
+
* @export
|
|
6606
|
+
* @interface AnalyticsRuleAction
|
|
6607
|
+
*/
|
|
6608
|
+
export interface AnalyticsRuleAction {
|
|
6609
|
+
/**
|
|
6610
|
+
* Optional message for banner actions
|
|
6611
|
+
* @type {string}
|
|
6612
|
+
* @memberof AnalyticsRuleAction
|
|
6613
|
+
*/
|
|
6614
|
+
'message'?: string;
|
|
6615
|
+
/**
|
|
6616
|
+
* Action type (promote, hide, change_query, show_banner)
|
|
6617
|
+
* @type {string}
|
|
6618
|
+
* @memberof AnalyticsRuleAction
|
|
6619
|
+
*/
|
|
6620
|
+
'type'?: string;
|
|
6621
|
+
/**
|
|
6622
|
+
* Action value
|
|
6623
|
+
* @type {any}
|
|
6624
|
+
* @memberof AnalyticsRuleAction
|
|
6625
|
+
*/
|
|
6626
|
+
'value'?: any;
|
|
6627
|
+
}
|
|
6628
|
+
/**
|
|
6629
|
+
*
|
|
6630
|
+
* @export
|
|
6631
|
+
* @interface AnalyticsRuleCondition
|
|
6632
|
+
*/
|
|
6633
|
+
export interface AnalyticsRuleCondition {
|
|
6634
|
+
/**
|
|
6635
|
+
* Attribute to match (query, category, etc.)
|
|
6636
|
+
* @type {string}
|
|
6637
|
+
* @memberof AnalyticsRuleCondition
|
|
6638
|
+
*/
|
|
6639
|
+
'attribute'?: string;
|
|
6640
|
+
/**
|
|
6641
|
+
* Operator (equals, contains, starts_with, etc.)
|
|
6642
|
+
* @type {string}
|
|
6643
|
+
* @memberof AnalyticsRuleCondition
|
|
6644
|
+
*/
|
|
6645
|
+
'operator'?: string;
|
|
6646
|
+
/**
|
|
6647
|
+
* Value to match against
|
|
6648
|
+
* @type {any}
|
|
6649
|
+
* @memberof AnalyticsRuleCondition
|
|
6650
|
+
*/
|
|
6651
|
+
'value'?: any;
|
|
6652
|
+
}
|
|
6653
|
+
/**
|
|
6654
|
+
*
|
|
6655
|
+
* @export
|
|
6656
|
+
* @enum {string}
|
|
6657
|
+
*/
|
|
6658
|
+
export declare const AnalyticsRuleType: {
|
|
6659
|
+
readonly RuleTypePromote: "promote";
|
|
6660
|
+
readonly RuleTypeHide: "hide";
|
|
6661
|
+
readonly RuleTypeRedirect: "redirect";
|
|
6662
|
+
readonly RuleTypeBanner: "banner";
|
|
6663
|
+
};
|
|
6664
|
+
export type AnalyticsRuleType = typeof AnalyticsRuleType[keyof typeof AnalyticsRuleType];
|
|
5908
6665
|
/**
|
|
5909
6666
|
*
|
|
5910
6667
|
* @export
|
|
@@ -6011,18 +6768,102 @@ export interface AnalyticsToggleQuerySuggestionsRequest {
|
|
|
6011
6768
|
* @interface AnalyticsUpdateSuggestionConfigRequest
|
|
6012
6769
|
*/
|
|
6013
6770
|
export interface AnalyticsUpdateSuggestionConfigRequest {
|
|
6771
|
+
/**
|
|
6772
|
+
* Banned expressions with matching types
|
|
6773
|
+
* @type {Array<AnalyticsBannedExpression>}
|
|
6774
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6775
|
+
*/
|
|
6776
|
+
'banned_expressions'?: Array<AnalyticsBannedExpression>;
|
|
6777
|
+
/**
|
|
6778
|
+
* Per-attribute configuration with counts
|
|
6779
|
+
* @type {Array<AnalyticsCategoryAttributeConfig>}
|
|
6780
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6781
|
+
*/
|
|
6782
|
+
'category_attribute_configs'?: Array<AnalyticsCategoryAttributeConfig>;
|
|
6783
|
+
/**
|
|
6784
|
+
* Include category counts
|
|
6785
|
+
* @type {boolean}
|
|
6786
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6787
|
+
*/
|
|
6788
|
+
'category_counts'?: boolean;
|
|
6014
6789
|
/**
|
|
6015
6790
|
* Enable/disable facet-based suggestions
|
|
6016
6791
|
* @type {boolean}
|
|
6017
6792
|
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6018
6793
|
*/
|
|
6019
6794
|
'enable_facet_suggestions'?: boolean;
|
|
6795
|
+
/**
|
|
6796
|
+
* Enable personalization
|
|
6797
|
+
* @type {boolean}
|
|
6798
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6799
|
+
*/
|
|
6800
|
+
'enable_personalization'?: boolean;
|
|
6801
|
+
/**
|
|
6802
|
+
* Enable rules
|
|
6803
|
+
* @type {boolean}
|
|
6804
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6805
|
+
*/
|
|
6806
|
+
'enable_rules'?: boolean;
|
|
6020
6807
|
/**
|
|
6021
6808
|
* Enable/disable query suggestions for the store
|
|
6022
6809
|
* @type {boolean}
|
|
6023
6810
|
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6024
6811
|
*/
|
|
6025
6812
|
'enabled'?: boolean;
|
|
6813
|
+
/**
|
|
6814
|
+
* Facet attributes
|
|
6815
|
+
* @type {Array<string>}
|
|
6816
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6817
|
+
*/
|
|
6818
|
+
'facet_attributes'?: Array<string>;
|
|
6819
|
+
/**
|
|
6820
|
+
* Facet combination limit
|
|
6821
|
+
* @type {number}
|
|
6822
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6823
|
+
*/
|
|
6824
|
+
'facet_combination_limit'?: number;
|
|
6825
|
+
/**
|
|
6826
|
+
* Language for duplicate removal
|
|
6827
|
+
* @type {string}
|
|
6828
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6829
|
+
*/
|
|
6830
|
+
'language'?: string;
|
|
6831
|
+
/**
|
|
6832
|
+
* Minimum hits for suggestions
|
|
6833
|
+
* @type {number}
|
|
6834
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6835
|
+
*/
|
|
6836
|
+
'minimum_hits'?: number;
|
|
6837
|
+
/**
|
|
6838
|
+
* New fields from Algolia documentation
|
|
6839
|
+
* @type {number}
|
|
6840
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6841
|
+
*/
|
|
6842
|
+
'minimum_letters'?: number;
|
|
6843
|
+
/**
|
|
6844
|
+
* Rules array
|
|
6845
|
+
* @type {Array<AnalyticsQuerySuggestionRule>}
|
|
6846
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6847
|
+
*/
|
|
6848
|
+
'rules'?: Array<AnalyticsQuerySuggestionRule>;
|
|
6849
|
+
/**
|
|
6850
|
+
* Number of top categories (legacy)
|
|
6851
|
+
* @type {number}
|
|
6852
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6853
|
+
*/
|
|
6854
|
+
'show_top_categories'?: number;
|
|
6855
|
+
/**
|
|
6856
|
+
* Tokenization method
|
|
6857
|
+
* @type {string}
|
|
6858
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6859
|
+
*/
|
|
6860
|
+
'tokenization'?: string;
|
|
6861
|
+
/**
|
|
6862
|
+
* Typo tolerance
|
|
6863
|
+
* @type {number}
|
|
6864
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6865
|
+
*/
|
|
6866
|
+
'typo_tolerance'?: number;
|
|
6026
6867
|
/**
|
|
6027
6868
|
* Enable/disable auto-generated suggestions
|
|
6028
6869
|
* @type {boolean}
|
|
@@ -17626,11 +18467,11 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
17626
18467
|
*/
|
|
17627
18468
|
adminAnalyticsStoreXStoreIDResultsGet: (xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17628
18469
|
/**
|
|
17629
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
18470
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
17630
18471
|
* @summary Get Analytics Tags
|
|
17631
18472
|
* @param {string} xStoreID Store ID
|
|
17632
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
17633
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
18473
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
18474
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
17634
18475
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
17635
18476
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
17636
18477
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -18025,11 +18866,11 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
18025
18866
|
*/
|
|
18026
18867
|
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response>>;
|
|
18027
18868
|
/**
|
|
18028
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
18869
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
18029
18870
|
* @summary Get Analytics Tags
|
|
18030
18871
|
* @param {string} xStoreID Store ID
|
|
18031
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
18032
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
18872
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
18873
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
18033
18874
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
18034
18875
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
18035
18876
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -18424,11 +19265,11 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
18424
19265
|
*/
|
|
18425
19266
|
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response>;
|
|
18426
19267
|
/**
|
|
18427
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
19268
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
18428
19269
|
* @summary Get Analytics Tags
|
|
18429
19270
|
* @param {string} xStoreID Store ID
|
|
18430
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
18431
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
19271
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
19272
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
18432
19273
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
18433
19274
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
18434
19275
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -18841,11 +19682,11 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
18841
19682
|
*/
|
|
18842
19683
|
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response, any, {}>>;
|
|
18843
19684
|
/**
|
|
18844
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
19685
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
18845
19686
|
* @summary Get Analytics Tags
|
|
18846
19687
|
* @param {string} xStoreID Store ID
|
|
18847
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
18848
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
19688
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
19689
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
18849
19690
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
18850
19691
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
18851
19692
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -25327,6 +26168,51 @@ export declare const QuerySuggestionsManagementApiAxiosParamCreator: (configurat
|
|
|
25327
26168
|
* @throws {RequiredError}
|
|
25328
26169
|
*/
|
|
25329
26170
|
adminV1QuerySuggestionsMigrateAllPost: (daysBack?: number, minPopularity?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26171
|
+
/**
|
|
26172
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
26173
|
+
* @summary Apply Suggestion Filters
|
|
26174
|
+
* @param {string} xStoreID Store ID
|
|
26175
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
26176
|
+
* @param {*} [options] Override http request option.
|
|
26177
|
+
* @throws {RequiredError}
|
|
26178
|
+
*/
|
|
26179
|
+
adminV1QuerySuggestionsXStoreIDApplyFiltersPost: (xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26180
|
+
/**
|
|
26181
|
+
* Delete a banned expression
|
|
26182
|
+
* @summary Delete Banned Expression
|
|
26183
|
+
* @param {string} xStoreID Store ID
|
|
26184
|
+
* @param {string} expressionID Banned Expression ID
|
|
26185
|
+
* @param {*} [options] Override http request option.
|
|
26186
|
+
* @throws {RequiredError}
|
|
26187
|
+
*/
|
|
26188
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete: (xStoreID: string, expressionID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26189
|
+
/**
|
|
26190
|
+
* Update an existing banned expression
|
|
26191
|
+
* @summary Update Banned Expression
|
|
26192
|
+
* @param {string} xStoreID Store ID
|
|
26193
|
+
* @param {string} expressionID Banned Expression ID
|
|
26194
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
26195
|
+
* @param {*} [options] Override http request option.
|
|
26196
|
+
* @throws {RequiredError}
|
|
26197
|
+
*/
|
|
26198
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut: (xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26199
|
+
/**
|
|
26200
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
26201
|
+
* @summary Get Banned Expressions
|
|
26202
|
+
* @param {string} xStoreID Store ID
|
|
26203
|
+
* @param {*} [options] Override http request option.
|
|
26204
|
+
* @throws {RequiredError}
|
|
26205
|
+
*/
|
|
26206
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsGet: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26207
|
+
/**
|
|
26208
|
+
* Create a new banned expression with specified matching type
|
|
26209
|
+
* @summary Create Banned Expression
|
|
26210
|
+
* @param {string} xStoreID Store ID
|
|
26211
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
26212
|
+
* @param {*} [options] Override http request option.
|
|
26213
|
+
* @throws {RequiredError}
|
|
26214
|
+
*/
|
|
26215
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsPost: (xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25330
26216
|
/**
|
|
25331
26217
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
25332
26218
|
* @summary Bulk Update Suggestions
|
|
@@ -25364,6 +26250,22 @@ export declare const QuerySuggestionsManagementApiAxiosParamCreator: (configurat
|
|
|
25364
26250
|
* @throws {RequiredError}
|
|
25365
26251
|
*/
|
|
25366
26252
|
adminV1QuerySuggestionsXStoreIDConfigPut: (xStoreID: string, analyticsUpdateSuggestionConfigRequest: AnalyticsUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26253
|
+
/**
|
|
26254
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
26255
|
+
* @summary Generate Enhanced Category Suggestions
|
|
26256
|
+
* @param {string} xStoreID Store ID
|
|
26257
|
+
* @param {*} [options] Override http request option.
|
|
26258
|
+
* @throws {RequiredError}
|
|
26259
|
+
*/
|
|
26260
|
+
adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26261
|
+
/**
|
|
26262
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
26263
|
+
* @summary Generate Facet-Based Suggestions
|
|
26264
|
+
* @param {string} xStoreID Store ID
|
|
26265
|
+
* @param {*} [options] Override http request option.
|
|
26266
|
+
* @throws {RequiredError}
|
|
26267
|
+
*/
|
|
26268
|
+
adminV1QuerySuggestionsXStoreIDGenerateFacetsPost: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25367
26269
|
/**
|
|
25368
26270
|
* Retrieve query suggestions with filtering and pagination for management
|
|
25369
26271
|
* @summary Get Query Suggestions
|
|
@@ -25541,6 +26443,51 @@ export declare const QuerySuggestionsManagementApiFp: (configuration?: Configura
|
|
|
25541
26443
|
* @throws {RequiredError}
|
|
25542
26444
|
*/
|
|
25543
26445
|
adminV1QuerySuggestionsMigrateAllPost(daysBack?: number, minPopularity?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>>;
|
|
26446
|
+
/**
|
|
26447
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
26448
|
+
* @summary Apply Suggestion Filters
|
|
26449
|
+
* @param {string} xStoreID Store ID
|
|
26450
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
26451
|
+
* @param {*} [options] Override http request option.
|
|
26452
|
+
* @throws {RequiredError}
|
|
26453
|
+
*/
|
|
26454
|
+
adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>>;
|
|
26455
|
+
/**
|
|
26456
|
+
* Delete a banned expression
|
|
26457
|
+
* @summary Delete Banned Expression
|
|
26458
|
+
* @param {string} xStoreID Store ID
|
|
26459
|
+
* @param {string} expressionID Banned Expression ID
|
|
26460
|
+
* @param {*} [options] Override http request option.
|
|
26461
|
+
* @throws {RequiredError}
|
|
26462
|
+
*/
|
|
26463
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID: string, expressionID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>>;
|
|
26464
|
+
/**
|
|
26465
|
+
* Update an existing banned expression
|
|
26466
|
+
* @summary Update Banned Expression
|
|
26467
|
+
* @param {string} xStoreID Store ID
|
|
26468
|
+
* @param {string} expressionID Banned Expression ID
|
|
26469
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
26470
|
+
* @param {*} [options] Override http request option.
|
|
26471
|
+
* @throws {RequiredError}
|
|
26472
|
+
*/
|
|
26473
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response>>;
|
|
26474
|
+
/**
|
|
26475
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
26476
|
+
* @summary Get Banned Expressions
|
|
26477
|
+
* @param {string} xStoreID Store ID
|
|
26478
|
+
* @param {*} [options] Override http request option.
|
|
26479
|
+
* @throws {RequiredError}
|
|
26480
|
+
*/
|
|
26481
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response>>;
|
|
26482
|
+
/**
|
|
26483
|
+
* Create a new banned expression with specified matching type
|
|
26484
|
+
* @summary Create Banned Expression
|
|
26485
|
+
* @param {string} xStoreID Store ID
|
|
26486
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
26487
|
+
* @param {*} [options] Override http request option.
|
|
26488
|
+
* @throws {RequiredError}
|
|
26489
|
+
*/
|
|
26490
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response>>;
|
|
25544
26491
|
/**
|
|
25545
26492
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
25546
26493
|
* @summary Bulk Update Suggestions
|
|
@@ -25578,6 +26525,22 @@ export declare const QuerySuggestionsManagementApiFp: (configuration?: Configura
|
|
|
25578
26525
|
* @throws {RequiredError}
|
|
25579
26526
|
*/
|
|
25580
26527
|
adminV1QuerySuggestionsXStoreIDConfigPut(xStoreID: string, analyticsUpdateSuggestionConfigRequest: AnalyticsUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDConfigGet200Response>>;
|
|
26528
|
+
/**
|
|
26529
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
26530
|
+
* @summary Generate Enhanced Category Suggestions
|
|
26531
|
+
* @param {string} xStoreID Store ID
|
|
26532
|
+
* @param {*} [options] Override http request option.
|
|
26533
|
+
* @throws {RequiredError}
|
|
26534
|
+
*/
|
|
26535
|
+
adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response>>;
|
|
26536
|
+
/**
|
|
26537
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
26538
|
+
* @summary Generate Facet-Based Suggestions
|
|
26539
|
+
* @param {string} xStoreID Store ID
|
|
26540
|
+
* @param {*} [options] Override http request option.
|
|
26541
|
+
* @throws {RequiredError}
|
|
26542
|
+
*/
|
|
26543
|
+
adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response>>;
|
|
25581
26544
|
/**
|
|
25582
26545
|
* Retrieve query suggestions with filtering and pagination for management
|
|
25583
26546
|
* @summary Get Query Suggestions
|
|
@@ -25601,7 +26564,7 @@ export declare const QuerySuggestionsManagementApiFp: (configuration?: Configura
|
|
|
25601
26564
|
* @param {*} [options] Override http request option.
|
|
25602
26565
|
* @throws {RequiredError}
|
|
25603
26566
|
*/
|
|
25604
|
-
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
26567
|
+
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>>;
|
|
25605
26568
|
/**
|
|
25606
26569
|
* Delete manually added query suggestions for a store
|
|
25607
26570
|
* @summary Delete Manual Query Suggestions
|
|
@@ -25647,7 +26610,7 @@ export declare const QuerySuggestionsManagementApiFp: (configuration?: Configura
|
|
|
25647
26610
|
* @param {*} [options] Override http request option.
|
|
25648
26611
|
* @throws {RequiredError}
|
|
25649
26612
|
*/
|
|
25650
|
-
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
26613
|
+
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>>;
|
|
25651
26614
|
/**
|
|
25652
26615
|
* Refresh auto-generated suggestions from search analytics data
|
|
25653
26616
|
* @summary Refresh Auto-Generated Suggestions
|
|
@@ -25755,6 +26718,51 @@ export declare const QuerySuggestionsManagementApiFactory: (configuration?: Conf
|
|
|
25755
26718
|
* @throws {RequiredError}
|
|
25756
26719
|
*/
|
|
25757
26720
|
adminV1QuerySuggestionsMigrateAllPost(daysBack?: number, minPopularity?: number, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse>;
|
|
26721
|
+
/**
|
|
26722
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
26723
|
+
* @summary Apply Suggestion Filters
|
|
26724
|
+
* @param {string} xStoreID Store ID
|
|
26725
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
26726
|
+
* @param {*} [options] Override http request option.
|
|
26727
|
+
* @throws {RequiredError}
|
|
26728
|
+
*/
|
|
26729
|
+
adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>;
|
|
26730
|
+
/**
|
|
26731
|
+
* Delete a banned expression
|
|
26732
|
+
* @summary Delete Banned Expression
|
|
26733
|
+
* @param {string} xStoreID Store ID
|
|
26734
|
+
* @param {string} expressionID Banned Expression ID
|
|
26735
|
+
* @param {*} [options] Override http request option.
|
|
26736
|
+
* @throws {RequiredError}
|
|
26737
|
+
*/
|
|
26738
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID: string, expressionID: string, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse>;
|
|
26739
|
+
/**
|
|
26740
|
+
* Update an existing banned expression
|
|
26741
|
+
* @summary Update Banned Expression
|
|
26742
|
+
* @param {string} xStoreID Store ID
|
|
26743
|
+
* @param {string} expressionID Banned Expression ID
|
|
26744
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
26745
|
+
* @param {*} [options] Override http request option.
|
|
26746
|
+
* @throws {RequiredError}
|
|
26747
|
+
*/
|
|
26748
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response>;
|
|
26749
|
+
/**
|
|
26750
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
26751
|
+
* @summary Get Banned Expressions
|
|
26752
|
+
* @param {string} xStoreID Store ID
|
|
26753
|
+
* @param {*} [options] Override http request option.
|
|
26754
|
+
* @throws {RequiredError}
|
|
26755
|
+
*/
|
|
26756
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response>;
|
|
26757
|
+
/**
|
|
26758
|
+
* Create a new banned expression with specified matching type
|
|
26759
|
+
* @summary Create Banned Expression
|
|
26760
|
+
* @param {string} xStoreID Store ID
|
|
26761
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
26762
|
+
* @param {*} [options] Override http request option.
|
|
26763
|
+
* @throws {RequiredError}
|
|
26764
|
+
*/
|
|
26765
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response>;
|
|
25758
26766
|
/**
|
|
25759
26767
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
25760
26768
|
* @summary Bulk Update Suggestions
|
|
@@ -25792,6 +26800,22 @@ export declare const QuerySuggestionsManagementApiFactory: (configuration?: Conf
|
|
|
25792
26800
|
* @throws {RequiredError}
|
|
25793
26801
|
*/
|
|
25794
26802
|
adminV1QuerySuggestionsXStoreIDConfigPut(xStoreID: string, analyticsUpdateSuggestionConfigRequest: AnalyticsUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDConfigGet200Response>;
|
|
26803
|
+
/**
|
|
26804
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
26805
|
+
* @summary Generate Enhanced Category Suggestions
|
|
26806
|
+
* @param {string} xStoreID Store ID
|
|
26807
|
+
* @param {*} [options] Override http request option.
|
|
26808
|
+
* @throws {RequiredError}
|
|
26809
|
+
*/
|
|
26810
|
+
adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response>;
|
|
26811
|
+
/**
|
|
26812
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
26813
|
+
* @summary Generate Facet-Based Suggestions
|
|
26814
|
+
* @param {string} xStoreID Store ID
|
|
26815
|
+
* @param {*} [options] Override http request option.
|
|
26816
|
+
* @throws {RequiredError}
|
|
26817
|
+
*/
|
|
26818
|
+
adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response>;
|
|
25795
26819
|
/**
|
|
25796
26820
|
* Retrieve query suggestions with filtering and pagination for management
|
|
25797
26821
|
* @summary Get Query Suggestions
|
|
@@ -25815,7 +26839,7 @@ export declare const QuerySuggestionsManagementApiFactory: (configuration?: Conf
|
|
|
25815
26839
|
* @param {*} [options] Override http request option.
|
|
25816
26840
|
* @throws {RequiredError}
|
|
25817
26841
|
*/
|
|
25818
|
-
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
26842
|
+
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>;
|
|
25819
26843
|
/**
|
|
25820
26844
|
* Delete manually added query suggestions for a store
|
|
25821
26845
|
* @summary Delete Manual Query Suggestions
|
|
@@ -25861,7 +26885,7 @@ export declare const QuerySuggestionsManagementApiFactory: (configuration?: Conf
|
|
|
25861
26885
|
* @param {*} [options] Override http request option.
|
|
25862
26886
|
* @throws {RequiredError}
|
|
25863
26887
|
*/
|
|
25864
|
-
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
26888
|
+
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>;
|
|
25865
26889
|
/**
|
|
25866
26890
|
* Refresh auto-generated suggestions from search analytics data
|
|
25867
26891
|
* @summary Refresh Auto-Generated Suggestions
|
|
@@ -25972,6 +26996,56 @@ export declare class QuerySuggestionsManagementApi extends BaseAPI {
|
|
|
25972
26996
|
* @memberof QuerySuggestionsManagementApi
|
|
25973
26997
|
*/
|
|
25974
26998
|
adminV1QuerySuggestionsMigrateAllPost(daysBack?: number, minPopularity?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsAnalyticsAPIResponse, any, {}>>;
|
|
26999
|
+
/**
|
|
27000
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
27001
|
+
* @summary Apply Suggestion Filters
|
|
27002
|
+
* @param {string} xStoreID Store ID
|
|
27003
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
27004
|
+
* @param {*} [options] Override http request option.
|
|
27005
|
+
* @throws {RequiredError}
|
|
27006
|
+
* @memberof QuerySuggestionsManagementApi
|
|
27007
|
+
*/
|
|
27008
|
+
adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response, any, {}>>;
|
|
27009
|
+
/**
|
|
27010
|
+
* Delete a banned expression
|
|
27011
|
+
* @summary Delete Banned Expression
|
|
27012
|
+
* @param {string} xStoreID Store ID
|
|
27013
|
+
* @param {string} expressionID Banned Expression ID
|
|
27014
|
+
* @param {*} [options] Override http request option.
|
|
27015
|
+
* @throws {RequiredError}
|
|
27016
|
+
* @memberof QuerySuggestionsManagementApi
|
|
27017
|
+
*/
|
|
27018
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID: string, expressionID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsAnalyticsAPIResponse, any, {}>>;
|
|
27019
|
+
/**
|
|
27020
|
+
* Update an existing banned expression
|
|
27021
|
+
* @summary Update Banned Expression
|
|
27022
|
+
* @param {string} xStoreID Store ID
|
|
27023
|
+
* @param {string} expressionID Banned Expression ID
|
|
27024
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
27025
|
+
* @param {*} [options] Override http request option.
|
|
27026
|
+
* @throws {RequiredError}
|
|
27027
|
+
* @memberof QuerySuggestionsManagementApi
|
|
27028
|
+
*/
|
|
27029
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response, any, {}>>;
|
|
27030
|
+
/**
|
|
27031
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
27032
|
+
* @summary Get Banned Expressions
|
|
27033
|
+
* @param {string} xStoreID Store ID
|
|
27034
|
+
* @param {*} [options] Override http request option.
|
|
27035
|
+
* @throws {RequiredError}
|
|
27036
|
+
* @memberof QuerySuggestionsManagementApi
|
|
27037
|
+
*/
|
|
27038
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response, any, {}>>;
|
|
27039
|
+
/**
|
|
27040
|
+
* Create a new banned expression with specified matching type
|
|
27041
|
+
* @summary Create Banned Expression
|
|
27042
|
+
* @param {string} xStoreID Store ID
|
|
27043
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
27044
|
+
* @param {*} [options] Override http request option.
|
|
27045
|
+
* @throws {RequiredError}
|
|
27046
|
+
* @memberof QuerySuggestionsManagementApi
|
|
27047
|
+
*/
|
|
27048
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response, any, {}>>;
|
|
25975
27049
|
/**
|
|
25976
27050
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
25977
27051
|
* @summary Bulk Update Suggestions
|
|
@@ -26013,6 +27087,24 @@ export declare class QuerySuggestionsManagementApi extends BaseAPI {
|
|
|
26013
27087
|
* @memberof QuerySuggestionsManagementApi
|
|
26014
27088
|
*/
|
|
26015
27089
|
adminV1QuerySuggestionsXStoreIDConfigPut(xStoreID: string, analyticsUpdateSuggestionConfigRequest: AnalyticsUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDConfigGet200Response, any, {}>>;
|
|
27090
|
+
/**
|
|
27091
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
27092
|
+
* @summary Generate Enhanced Category Suggestions
|
|
27093
|
+
* @param {string} xStoreID Store ID
|
|
27094
|
+
* @param {*} [options] Override http request option.
|
|
27095
|
+
* @throws {RequiredError}
|
|
27096
|
+
* @memberof QuerySuggestionsManagementApi
|
|
27097
|
+
*/
|
|
27098
|
+
adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response, any, {}>>;
|
|
27099
|
+
/**
|
|
27100
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
27101
|
+
* @summary Generate Facet-Based Suggestions
|
|
27102
|
+
* @param {string} xStoreID Store ID
|
|
27103
|
+
* @param {*} [options] Override http request option.
|
|
27104
|
+
* @throws {RequiredError}
|
|
27105
|
+
* @memberof QuerySuggestionsManagementApi
|
|
27106
|
+
*/
|
|
27107
|
+
adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response, any, {}>>;
|
|
26016
27108
|
/**
|
|
26017
27109
|
* Retrieve query suggestions with filtering and pagination for management
|
|
26018
27110
|
* @summary Get Query Suggestions
|
|
@@ -26038,7 +27130,7 @@ export declare class QuerySuggestionsManagementApi extends BaseAPI {
|
|
|
26038
27130
|
* @throws {RequiredError}
|
|
26039
27131
|
* @memberof QuerySuggestionsManagementApi
|
|
26040
27132
|
*/
|
|
26041
|
-
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
27133
|
+
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response, any, {}>>;
|
|
26042
27134
|
/**
|
|
26043
27135
|
* Delete manually added query suggestions for a store
|
|
26044
27136
|
* @summary Delete Manual Query Suggestions
|
|
@@ -26089,7 +27181,7 @@ export declare class QuerySuggestionsManagementApi extends BaseAPI {
|
|
|
26089
27181
|
* @throws {RequiredError}
|
|
26090
27182
|
* @memberof QuerySuggestionsManagementApi
|
|
26091
27183
|
*/
|
|
26092
|
-
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
27184
|
+
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response, any, {}>>;
|
|
26093
27185
|
/**
|
|
26094
27186
|
* Refresh auto-generated suggestions from search analytics data
|
|
26095
27187
|
* @summary Refresh Auto-Generated Suggestions
|