@seekora-ai/admin-api 1.0.63 → 1.0.65
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 +1668 -96
- package/common.ts +4 -4
- package/dist/api.d.ts +1322 -112
- package/dist/api.js +723 -60
- package/dist/esm/api.d.ts +1322 -112
- package/dist/esm/api.js +718 -55
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.65.tgz +0 -0
- package/seekora-ai-admin-api-1.0.63.tgz +0 -0
package/api.ts
CHANGED
|
@@ -754,6 +754,135 @@ export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
|
|
|
754
754
|
*/
|
|
755
755
|
'total'?: number;
|
|
756
756
|
}
|
|
757
|
+
/**
|
|
758
|
+
*
|
|
759
|
+
* @export
|
|
760
|
+
* @interface AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
761
|
+
*/
|
|
762
|
+
export interface AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response {
|
|
763
|
+
/**
|
|
764
|
+
* Comparison metadata when in compare mode
|
|
765
|
+
* @type {AnalyticsComparisonMeta}
|
|
766
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
767
|
+
*/
|
|
768
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
769
|
+
/**
|
|
770
|
+
*
|
|
771
|
+
* @type {Array<AnalyticsQuerySuggestionRecord>}
|
|
772
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
773
|
+
*/
|
|
774
|
+
'data'?: Array<AnalyticsQuerySuggestionRecord>;
|
|
775
|
+
/**
|
|
776
|
+
*
|
|
777
|
+
* @type {string}
|
|
778
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
779
|
+
*/
|
|
780
|
+
'error'?: string;
|
|
781
|
+
/**
|
|
782
|
+
*
|
|
783
|
+
* @type {string}
|
|
784
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
785
|
+
*/
|
|
786
|
+
'status'?: string;
|
|
787
|
+
/**
|
|
788
|
+
*
|
|
789
|
+
* @type {string}
|
|
790
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
791
|
+
*/
|
|
792
|
+
'timestamp'?: string;
|
|
793
|
+
/**
|
|
794
|
+
*
|
|
795
|
+
* @type {number}
|
|
796
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
797
|
+
*/
|
|
798
|
+
'total'?: number;
|
|
799
|
+
}
|
|
800
|
+
/**
|
|
801
|
+
*
|
|
802
|
+
* @export
|
|
803
|
+
* @interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
804
|
+
*/
|
|
805
|
+
export interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response {
|
|
806
|
+
/**
|
|
807
|
+
* Comparison metadata when in compare mode
|
|
808
|
+
* @type {AnalyticsComparisonMeta}
|
|
809
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
810
|
+
*/
|
|
811
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
812
|
+
/**
|
|
813
|
+
*
|
|
814
|
+
* @type {Array<AnalyticsBannedExpression>}
|
|
815
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
816
|
+
*/
|
|
817
|
+
'data'?: Array<AnalyticsBannedExpression>;
|
|
818
|
+
/**
|
|
819
|
+
*
|
|
820
|
+
* @type {string}
|
|
821
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
822
|
+
*/
|
|
823
|
+
'error'?: string;
|
|
824
|
+
/**
|
|
825
|
+
*
|
|
826
|
+
* @type {string}
|
|
827
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
828
|
+
*/
|
|
829
|
+
'status'?: string;
|
|
830
|
+
/**
|
|
831
|
+
*
|
|
832
|
+
* @type {string}
|
|
833
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
834
|
+
*/
|
|
835
|
+
'timestamp'?: string;
|
|
836
|
+
/**
|
|
837
|
+
*
|
|
838
|
+
* @type {number}
|
|
839
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
840
|
+
*/
|
|
841
|
+
'total'?: number;
|
|
842
|
+
}
|
|
843
|
+
/**
|
|
844
|
+
*
|
|
845
|
+
* @export
|
|
846
|
+
* @interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
847
|
+
*/
|
|
848
|
+
export interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response {
|
|
849
|
+
/**
|
|
850
|
+
* Comparison metadata when in compare mode
|
|
851
|
+
* @type {AnalyticsComparisonMeta}
|
|
852
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
853
|
+
*/
|
|
854
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
855
|
+
/**
|
|
856
|
+
*
|
|
857
|
+
* @type {AnalyticsBannedExpression}
|
|
858
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
859
|
+
*/
|
|
860
|
+
'data'?: AnalyticsBannedExpression;
|
|
861
|
+
/**
|
|
862
|
+
*
|
|
863
|
+
* @type {string}
|
|
864
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
865
|
+
*/
|
|
866
|
+
'error'?: string;
|
|
867
|
+
/**
|
|
868
|
+
*
|
|
869
|
+
* @type {string}
|
|
870
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
871
|
+
*/
|
|
872
|
+
'status'?: string;
|
|
873
|
+
/**
|
|
874
|
+
*
|
|
875
|
+
* @type {string}
|
|
876
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
877
|
+
*/
|
|
878
|
+
'timestamp'?: string;
|
|
879
|
+
/**
|
|
880
|
+
*
|
|
881
|
+
* @type {number}
|
|
882
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
883
|
+
*/
|
|
884
|
+
'total'?: number;
|
|
885
|
+
}
|
|
757
886
|
/**
|
|
758
887
|
*
|
|
759
888
|
* @export
|
|
@@ -843,86 +972,129 @@ export interface AdminV1QuerySuggestionsXStoreIDConfigGet200Response {
|
|
|
843
972
|
/**
|
|
844
973
|
*
|
|
845
974
|
* @export
|
|
846
|
-
* @interface
|
|
975
|
+
* @interface AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
847
976
|
*/
|
|
848
|
-
export interface
|
|
977
|
+
export interface AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response {
|
|
849
978
|
/**
|
|
850
979
|
* Comparison metadata when in compare mode
|
|
851
980
|
* @type {AnalyticsComparisonMeta}
|
|
852
|
-
* @memberof
|
|
981
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
853
982
|
*/
|
|
854
983
|
'comparison'?: AnalyticsComparisonMeta;
|
|
855
984
|
/**
|
|
856
985
|
*
|
|
857
|
-
* @type {
|
|
858
|
-
* @memberof
|
|
986
|
+
* @type {Array<AnalyticsEnhancedCategorySuggestion>}
|
|
987
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
859
988
|
*/
|
|
860
|
-
'data'?:
|
|
989
|
+
'data'?: Array<AnalyticsEnhancedCategorySuggestion>;
|
|
861
990
|
/**
|
|
862
991
|
*
|
|
863
992
|
* @type {string}
|
|
864
|
-
* @memberof
|
|
993
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
865
994
|
*/
|
|
866
995
|
'error'?: string;
|
|
867
996
|
/**
|
|
868
997
|
*
|
|
869
998
|
* @type {string}
|
|
870
|
-
* @memberof
|
|
999
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
871
1000
|
*/
|
|
872
1001
|
'status'?: string;
|
|
873
1002
|
/**
|
|
874
1003
|
*
|
|
875
1004
|
* @type {string}
|
|
876
|
-
* @memberof
|
|
1005
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
877
1006
|
*/
|
|
878
1007
|
'timestamp'?: string;
|
|
879
1008
|
/**
|
|
880
1009
|
*
|
|
881
1010
|
* @type {number}
|
|
882
|
-
* @memberof
|
|
1011
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
883
1012
|
*/
|
|
884
1013
|
'total'?: number;
|
|
885
1014
|
}
|
|
886
1015
|
/**
|
|
887
1016
|
*
|
|
888
1017
|
* @export
|
|
889
|
-
* @interface
|
|
1018
|
+
* @interface AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
890
1019
|
*/
|
|
891
|
-
export interface
|
|
1020
|
+
export interface AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response {
|
|
892
1021
|
/**
|
|
893
1022
|
* Comparison metadata when in compare mode
|
|
894
1023
|
* @type {AnalyticsComparisonMeta}
|
|
895
|
-
* @memberof
|
|
1024
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
896
1025
|
*/
|
|
897
1026
|
'comparison'?: AnalyticsComparisonMeta;
|
|
898
1027
|
/**
|
|
899
1028
|
*
|
|
900
|
-
* @type {Array<
|
|
901
|
-
* @memberof
|
|
1029
|
+
* @type {Array<AnalyticsFacetSuggestion>}
|
|
1030
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
902
1031
|
*/
|
|
903
|
-
'data'?: Array<
|
|
1032
|
+
'data'?: Array<AnalyticsFacetSuggestion>;
|
|
1033
|
+
/**
|
|
1034
|
+
*
|
|
1035
|
+
* @type {string}
|
|
1036
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1037
|
+
*/
|
|
1038
|
+
'error'?: string;
|
|
1039
|
+
/**
|
|
1040
|
+
*
|
|
1041
|
+
* @type {string}
|
|
1042
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1043
|
+
*/
|
|
1044
|
+
'status'?: string;
|
|
1045
|
+
/**
|
|
1046
|
+
*
|
|
1047
|
+
* @type {string}
|
|
1048
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1049
|
+
*/
|
|
1050
|
+
'timestamp'?: string;
|
|
1051
|
+
/**
|
|
1052
|
+
*
|
|
1053
|
+
* @type {number}
|
|
1054
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1055
|
+
*/
|
|
1056
|
+
'total'?: number;
|
|
1057
|
+
}
|
|
1058
|
+
/**
|
|
1059
|
+
*
|
|
1060
|
+
* @export
|
|
1061
|
+
* @interface AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
1062
|
+
*/
|
|
1063
|
+
export interface AdminV1QuerySuggestionsXStoreIDGet200Response {
|
|
1064
|
+
/**
|
|
1065
|
+
* Comparison metadata when in compare mode
|
|
1066
|
+
* @type {AnalyticsComparisonMeta}
|
|
1067
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
1068
|
+
*/
|
|
1069
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
1070
|
+
/**
|
|
1071
|
+
*
|
|
1072
|
+
* @type {AnalyticsQuerySuggestionManagementResponse}
|
|
1073
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
1074
|
+
*/
|
|
1075
|
+
'data'?: AnalyticsQuerySuggestionManagementResponse;
|
|
904
1076
|
/**
|
|
905
1077
|
*
|
|
906
1078
|
* @type {string}
|
|
907
|
-
* @memberof
|
|
1079
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
908
1080
|
*/
|
|
909
1081
|
'error'?: string;
|
|
910
1082
|
/**
|
|
911
1083
|
*
|
|
912
1084
|
* @type {string}
|
|
913
|
-
* @memberof
|
|
1085
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
914
1086
|
*/
|
|
915
1087
|
'status'?: string;
|
|
916
1088
|
/**
|
|
917
1089
|
*
|
|
918
1090
|
* @type {string}
|
|
919
|
-
* @memberof
|
|
1091
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
920
1092
|
*/
|
|
921
1093
|
'timestamp'?: string;
|
|
922
1094
|
/**
|
|
923
1095
|
*
|
|
924
1096
|
* @type {number}
|
|
925
|
-
* @memberof
|
|
1097
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
926
1098
|
*/
|
|
927
1099
|
'total'?: number;
|
|
928
1100
|
}
|
|
@@ -1288,6 +1460,74 @@ export interface AnalyticsArrayPositionAnalytic {
|
|
|
1288
1460
|
*/
|
|
1289
1461
|
'usage_count'?: number;
|
|
1290
1462
|
}
|
|
1463
|
+
/**
|
|
1464
|
+
*
|
|
1465
|
+
* @export
|
|
1466
|
+
* @interface AnalyticsBannedExpression
|
|
1467
|
+
*/
|
|
1468
|
+
export interface AnalyticsBannedExpression {
|
|
1469
|
+
/**
|
|
1470
|
+
* When this ban was created
|
|
1471
|
+
* @type {string}
|
|
1472
|
+
* @memberof AnalyticsBannedExpression
|
|
1473
|
+
*/
|
|
1474
|
+
'created_at'?: string;
|
|
1475
|
+
/**
|
|
1476
|
+
* Optional description
|
|
1477
|
+
* @type {string}
|
|
1478
|
+
* @memberof AnalyticsBannedExpression
|
|
1479
|
+
*/
|
|
1480
|
+
'description'?: string;
|
|
1481
|
+
/**
|
|
1482
|
+
* Whether this ban is active
|
|
1483
|
+
* @type {boolean}
|
|
1484
|
+
* @memberof AnalyticsBannedExpression
|
|
1485
|
+
*/
|
|
1486
|
+
'enabled'?: boolean;
|
|
1487
|
+
/**
|
|
1488
|
+
* The expression to ban
|
|
1489
|
+
* @type {string}
|
|
1490
|
+
* @memberof AnalyticsBannedExpression
|
|
1491
|
+
*/
|
|
1492
|
+
'expression'?: string;
|
|
1493
|
+
/**
|
|
1494
|
+
* Unique identifier for the banned expression
|
|
1495
|
+
* @type {string}
|
|
1496
|
+
* @memberof AnalyticsBannedExpression
|
|
1497
|
+
*/
|
|
1498
|
+
'id'?: string;
|
|
1499
|
+
/**
|
|
1500
|
+
* How to match the expression
|
|
1501
|
+
* @type {AnalyticsBannedMatchType}
|
|
1502
|
+
* @memberof AnalyticsBannedExpression
|
|
1503
|
+
*/
|
|
1504
|
+
'match_type'?: AnalyticsBannedMatchType;
|
|
1505
|
+
/**
|
|
1506
|
+
* When this ban was last updated
|
|
1507
|
+
* @type {string}
|
|
1508
|
+
* @memberof AnalyticsBannedExpression
|
|
1509
|
+
*/
|
|
1510
|
+
'updated_at'?: string;
|
|
1511
|
+
}
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
/**
|
|
1515
|
+
*
|
|
1516
|
+
* @export
|
|
1517
|
+
* @enum {string}
|
|
1518
|
+
*/
|
|
1519
|
+
|
|
1520
|
+
export const AnalyticsBannedMatchType = {
|
|
1521
|
+
BannedMatchIs: 'is',
|
|
1522
|
+
BannedMatchContains: 'contains',
|
|
1523
|
+
BannedMatchStartsWith: 'startsWith',
|
|
1524
|
+
BannedMatchEndsWith: 'endsWith',
|
|
1525
|
+
BannedMatchCustom: 'custom'
|
|
1526
|
+
} as const;
|
|
1527
|
+
|
|
1528
|
+
export type AnalyticsBannedMatchType = typeof AnalyticsBannedMatchType[keyof typeof AnalyticsBannedMatchType];
|
|
1529
|
+
|
|
1530
|
+
|
|
1291
1531
|
/**
|
|
1292
1532
|
*
|
|
1293
1533
|
* @export
|
|
@@ -1399,6 +1639,68 @@ export interface AnalyticsCachedSuggestionResponse {
|
|
|
1399
1639
|
*/
|
|
1400
1640
|
'suggestions'?: Array<AnalyticsCachedSuggestion>;
|
|
1401
1641
|
}
|
|
1642
|
+
/**
|
|
1643
|
+
*
|
|
1644
|
+
* @export
|
|
1645
|
+
* @interface AnalyticsCategoryAttributeConfig
|
|
1646
|
+
*/
|
|
1647
|
+
export interface AnalyticsCategoryAttributeConfig {
|
|
1648
|
+
/**
|
|
1649
|
+
* The attribute name (e.g., \"category\", \"brand\") - REQUIRED
|
|
1650
|
+
* @type {string}
|
|
1651
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1652
|
+
*/
|
|
1653
|
+
'attribute'?: string;
|
|
1654
|
+
/**
|
|
1655
|
+
* Optional description (default: auto-generated)
|
|
1656
|
+
* @type {string}
|
|
1657
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1658
|
+
*/
|
|
1659
|
+
'description'?: string;
|
|
1660
|
+
/**
|
|
1661
|
+
* Whether this attribute is enabled (default: true)
|
|
1662
|
+
* @type {boolean}
|
|
1663
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1664
|
+
*/
|
|
1665
|
+
'enabled'?: boolean;
|
|
1666
|
+
/**
|
|
1667
|
+
* Maximum number of categories to show for this attribute - REQUIRED
|
|
1668
|
+
* @type {number}
|
|
1669
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1670
|
+
*/
|
|
1671
|
+
'max_count'?: number;
|
|
1672
|
+
/**
|
|
1673
|
+
* Priority order (lower number = higher priority) (default: auto-assigned)
|
|
1674
|
+
* @type {number}
|
|
1675
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1676
|
+
*/
|
|
1677
|
+
'priority'?: number;
|
|
1678
|
+
}
|
|
1679
|
+
/**
|
|
1680
|
+
*
|
|
1681
|
+
* @export
|
|
1682
|
+
* @interface AnalyticsCategoryWithCount
|
|
1683
|
+
*/
|
|
1684
|
+
export interface AnalyticsCategoryWithCount {
|
|
1685
|
+
/**
|
|
1686
|
+
*
|
|
1687
|
+
* @type {number}
|
|
1688
|
+
* @memberof AnalyticsCategoryWithCount
|
|
1689
|
+
*/
|
|
1690
|
+
'count'?: number;
|
|
1691
|
+
/**
|
|
1692
|
+
* \"exact_matches\" or \"analytics\"
|
|
1693
|
+
* @type {string}
|
|
1694
|
+
* @memberof AnalyticsCategoryWithCount
|
|
1695
|
+
*/
|
|
1696
|
+
'type'?: string;
|
|
1697
|
+
/**
|
|
1698
|
+
*
|
|
1699
|
+
* @type {string}
|
|
1700
|
+
* @memberof AnalyticsCategoryWithCount
|
|
1701
|
+
*/
|
|
1702
|
+
'value'?: string;
|
|
1703
|
+
}
|
|
1402
1704
|
/**
|
|
1403
1705
|
*
|
|
1404
1706
|
* @export
|
|
@@ -1560,6 +1862,37 @@ export interface AnalyticsDeleteManualSuggestionsRequest {
|
|
|
1560
1862
|
*/
|
|
1561
1863
|
'suggestion_ids': Array<string>;
|
|
1562
1864
|
}
|
|
1865
|
+
/**
|
|
1866
|
+
*
|
|
1867
|
+
* @export
|
|
1868
|
+
* @interface AnalyticsEnhancedCategorySuggestion
|
|
1869
|
+
*/
|
|
1870
|
+
export interface AnalyticsEnhancedCategorySuggestion {
|
|
1871
|
+
/**
|
|
1872
|
+
*
|
|
1873
|
+
* @type {Array<AnalyticsCategoryWithCount>}
|
|
1874
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1875
|
+
*/
|
|
1876
|
+
'categories'?: Array<AnalyticsCategoryWithCount>;
|
|
1877
|
+
/**
|
|
1878
|
+
*
|
|
1879
|
+
* @type {{ [key: string]: any; }}
|
|
1880
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1881
|
+
*/
|
|
1882
|
+
'metadata'?: { [key: string]: any; };
|
|
1883
|
+
/**
|
|
1884
|
+
*
|
|
1885
|
+
* @type {number}
|
|
1886
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1887
|
+
*/
|
|
1888
|
+
'popularity'?: number;
|
|
1889
|
+
/**
|
|
1890
|
+
*
|
|
1891
|
+
* @type {string}
|
|
1892
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1893
|
+
*/
|
|
1894
|
+
'query'?: string;
|
|
1895
|
+
}
|
|
1563
1896
|
/**
|
|
1564
1897
|
*
|
|
1565
1898
|
* @export
|
|
@@ -1567,11 +1900,41 @@ export interface AnalyticsDeleteManualSuggestionsRequest {
|
|
|
1567
1900
|
*/
|
|
1568
1901
|
export interface AnalyticsEnrichedItemResultWithWidget {
|
|
1569
1902
|
/**
|
|
1570
|
-
*
|
|
1571
|
-
* @type {
|
|
1903
|
+
*
|
|
1904
|
+
* @type {number}
|
|
1572
1905
|
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1573
1906
|
*/
|
|
1574
|
-
'
|
|
1907
|
+
'avg_position'?: number;
|
|
1908
|
+
/**
|
|
1909
|
+
*
|
|
1910
|
+
* @type {number}
|
|
1911
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1912
|
+
*/
|
|
1913
|
+
'avg_score'?: number;
|
|
1914
|
+
/**
|
|
1915
|
+
* Calculated metrics
|
|
1916
|
+
* @type {number}
|
|
1917
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1918
|
+
*/
|
|
1919
|
+
'click_through_rate'?: number;
|
|
1920
|
+
/**
|
|
1921
|
+
* Future click and conversion metrics
|
|
1922
|
+
* @type {number}
|
|
1923
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1924
|
+
*/
|
|
1925
|
+
'clicks'?: number;
|
|
1926
|
+
/**
|
|
1927
|
+
*
|
|
1928
|
+
* @type {number}
|
|
1929
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1930
|
+
*/
|
|
1931
|
+
'conversion_rate'?: number;
|
|
1932
|
+
/**
|
|
1933
|
+
*
|
|
1934
|
+
* @type {number}
|
|
1935
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1936
|
+
*/
|
|
1937
|
+
'conversions'?: number;
|
|
1575
1938
|
/**
|
|
1576
1939
|
* Document data from Typesense index
|
|
1577
1940
|
* @type {{ [key: string]: any; }}
|
|
@@ -1584,6 +1947,84 @@ export interface AnalyticsEnrichedItemResultWithWidget {
|
|
|
1584
1947
|
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1585
1948
|
*/
|
|
1586
1949
|
'document_fetch_error'?: string;
|
|
1950
|
+
/**
|
|
1951
|
+
*
|
|
1952
|
+
* @type {number}
|
|
1953
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1954
|
+
*/
|
|
1955
|
+
'impressions'?: number;
|
|
1956
|
+
/**
|
|
1957
|
+
*
|
|
1958
|
+
* @type {string}
|
|
1959
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1960
|
+
*/
|
|
1961
|
+
'item_id'?: string;
|
|
1962
|
+
/**
|
|
1963
|
+
*
|
|
1964
|
+
* @type {string}
|
|
1965
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1966
|
+
*/
|
|
1967
|
+
'item_name'?: string;
|
|
1968
|
+
/**
|
|
1969
|
+
*
|
|
1970
|
+
* @type {number}
|
|
1971
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1972
|
+
*/
|
|
1973
|
+
'revenue'?: number;
|
|
1974
|
+
/**
|
|
1975
|
+
*
|
|
1976
|
+
* @type {number}
|
|
1977
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1978
|
+
*/
|
|
1979
|
+
'revenue_per_item'?: number;
|
|
1980
|
+
/**
|
|
1981
|
+
*
|
|
1982
|
+
* @type {number}
|
|
1983
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1984
|
+
*/
|
|
1985
|
+
'top_10_impressions'?: number;
|
|
1986
|
+
/**
|
|
1987
|
+
*
|
|
1988
|
+
* @type {number}
|
|
1989
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1990
|
+
*/
|
|
1991
|
+
'top_3_impression_rate'?: number;
|
|
1992
|
+
/**
|
|
1993
|
+
*
|
|
1994
|
+
* @type {number}
|
|
1995
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1996
|
+
*/
|
|
1997
|
+
'top_3_impressions'?: number;
|
|
1998
|
+
/**
|
|
1999
|
+
*
|
|
2000
|
+
* @type {number}
|
|
2001
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
2002
|
+
*/
|
|
2003
|
+
'unique_filters'?: number;
|
|
2004
|
+
/**
|
|
2005
|
+
*
|
|
2006
|
+
* @type {number}
|
|
2007
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
2008
|
+
*/
|
|
2009
|
+
'unique_queries'?: number;
|
|
2010
|
+
/**
|
|
2011
|
+
*
|
|
2012
|
+
* @type {number}
|
|
2013
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
2014
|
+
*/
|
|
2015
|
+
'unique_searches'?: number;
|
|
2016
|
+
/**
|
|
2017
|
+
*
|
|
2018
|
+
* @type {number}
|
|
2019
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
2020
|
+
*/
|
|
2021
|
+
'unique_sorts'?: number;
|
|
2022
|
+
/**
|
|
2023
|
+
*
|
|
2024
|
+
* @type {number}
|
|
2025
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
2026
|
+
*/
|
|
2027
|
+
'unique_users'?: number;
|
|
1587
2028
|
/**
|
|
1588
2029
|
* Widget display data for UI presentation
|
|
1589
2030
|
* @type {AnalyticsWidgetData}
|
|
@@ -1657,6 +2098,12 @@ export interface AnalyticsExtendedKPIResponse {
|
|
|
1657
2098
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1658
2099
|
*/
|
|
1659
2100
|
'summary'?: any;
|
|
2101
|
+
/**
|
|
2102
|
+
*
|
|
2103
|
+
* @type {string}
|
|
2104
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
2105
|
+
*/
|
|
2106
|
+
'target_currency'?: string;
|
|
1660
2107
|
/**
|
|
1661
2108
|
*
|
|
1662
2109
|
* @type {string}
|
|
@@ -1683,6 +2130,37 @@ export interface AnalyticsFacetMatch {
|
|
|
1683
2130
|
*/
|
|
1684
2131
|
'value'?: string;
|
|
1685
2132
|
}
|
|
2133
|
+
/**
|
|
2134
|
+
*
|
|
2135
|
+
* @export
|
|
2136
|
+
* @interface AnalyticsFacetSuggestion
|
|
2137
|
+
*/
|
|
2138
|
+
export interface AnalyticsFacetSuggestion {
|
|
2139
|
+
/**
|
|
2140
|
+
*
|
|
2141
|
+
* @type {number}
|
|
2142
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2143
|
+
*/
|
|
2144
|
+
'count'?: number;
|
|
2145
|
+
/**
|
|
2146
|
+
* e.g., {\"brand\": \"Nike\", \"color\": \"red\"}
|
|
2147
|
+
* @type {{ [key: string]: string; }}
|
|
2148
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2149
|
+
*/
|
|
2150
|
+
'facet_combination'?: { [key: string]: string; };
|
|
2151
|
+
/**
|
|
2152
|
+
*
|
|
2153
|
+
* @type {number}
|
|
2154
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2155
|
+
*/
|
|
2156
|
+
'popularity'?: number;
|
|
2157
|
+
/**
|
|
2158
|
+
*
|
|
2159
|
+
* @type {string}
|
|
2160
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2161
|
+
*/
|
|
2162
|
+
'query'?: string;
|
|
2163
|
+
}
|
|
1686
2164
|
/**
|
|
1687
2165
|
*
|
|
1688
2166
|
* @export
|
|
@@ -2361,6 +2839,18 @@ export interface AnalyticsGeoAnalytic {
|
|
|
2361
2839
|
* @memberof AnalyticsGeoAnalytic
|
|
2362
2840
|
*/
|
|
2363
2841
|
'revenue'?: number;
|
|
2842
|
+
/**
|
|
2843
|
+
*
|
|
2844
|
+
* @type {{ [key: string]: number; }}
|
|
2845
|
+
* @memberof AnalyticsGeoAnalytic
|
|
2846
|
+
*/
|
|
2847
|
+
'revenue_breakdown'?: { [key: string]: number; };
|
|
2848
|
+
/**
|
|
2849
|
+
*
|
|
2850
|
+
* @type {string}
|
|
2851
|
+
* @memberof AnalyticsGeoAnalytic
|
|
2852
|
+
*/
|
|
2853
|
+
'revenue_currency'?: string;
|
|
2364
2854
|
/**
|
|
2365
2855
|
*
|
|
2366
2856
|
* @type {number}
|
|
@@ -2703,6 +3193,12 @@ export interface AnalyticsGeoResponse {
|
|
|
2703
3193
|
* @memberof AnalyticsGeoResponse
|
|
2704
3194
|
*/
|
|
2705
3195
|
'start_time'?: string;
|
|
3196
|
+
/**
|
|
3197
|
+
*
|
|
3198
|
+
* @type {string}
|
|
3199
|
+
* @memberof AnalyticsGeoResponse
|
|
3200
|
+
*/
|
|
3201
|
+
'target_currency'?: string;
|
|
2706
3202
|
/**
|
|
2707
3203
|
*
|
|
2708
3204
|
* @type {number}
|
|
@@ -4180,6 +4676,18 @@ export interface AnalyticsKPIMetrics {
|
|
|
4180
4676
|
* @memberof AnalyticsKPIMetrics
|
|
4181
4677
|
*/
|
|
4182
4678
|
'revenue'?: number;
|
|
4679
|
+
/**
|
|
4680
|
+
*
|
|
4681
|
+
* @type {{ [key: string]: number; }}
|
|
4682
|
+
* @memberof AnalyticsKPIMetrics
|
|
4683
|
+
*/
|
|
4684
|
+
'revenue_breakdown'?: { [key: string]: number; };
|
|
4685
|
+
/**
|
|
4686
|
+
*
|
|
4687
|
+
* @type {string}
|
|
4688
|
+
* @memberof AnalyticsKPIMetrics
|
|
4689
|
+
*/
|
|
4690
|
+
'revenue_currency'?: string;
|
|
4183
4691
|
/**
|
|
4184
4692
|
*
|
|
4185
4693
|
* @type {number}
|
|
@@ -4259,6 +4767,18 @@ export interface AnalyticsKPIPointExtended {
|
|
|
4259
4767
|
* @memberof AnalyticsKPIPointExtended
|
|
4260
4768
|
*/
|
|
4261
4769
|
'revenue'?: number;
|
|
4770
|
+
/**
|
|
4771
|
+
*
|
|
4772
|
+
* @type {{ [key: string]: number; }}
|
|
4773
|
+
* @memberof AnalyticsKPIPointExtended
|
|
4774
|
+
*/
|
|
4775
|
+
'revenue_breakdown'?: { [key: string]: number; };
|
|
4776
|
+
/**
|
|
4777
|
+
*
|
|
4778
|
+
* @type {string}
|
|
4779
|
+
* @memberof AnalyticsKPIPointExtended
|
|
4780
|
+
*/
|
|
4781
|
+
'revenue_currency'?: string;
|
|
4262
4782
|
/**
|
|
4263
4783
|
*
|
|
4264
4784
|
* @type {number}
|
|
@@ -4437,6 +4957,18 @@ export interface AnalyticsQueryAnalytic {
|
|
|
4437
4957
|
* @memberof AnalyticsQueryAnalytic
|
|
4438
4958
|
*/
|
|
4439
4959
|
'revenue'?: number;
|
|
4960
|
+
/**
|
|
4961
|
+
*
|
|
4962
|
+
* @type {{ [key: string]: number; }}
|
|
4963
|
+
* @memberof AnalyticsQueryAnalytic
|
|
4964
|
+
*/
|
|
4965
|
+
'revenue_breakdown'?: { [key: string]: number; };
|
|
4966
|
+
/**
|
|
4967
|
+
*
|
|
4968
|
+
* @type {string}
|
|
4969
|
+
* @memberof AnalyticsQueryAnalytic
|
|
4970
|
+
*/
|
|
4971
|
+
'revenue_currency'?: string;
|
|
4440
4972
|
/**
|
|
4441
4973
|
*
|
|
4442
4974
|
* @type {number}
|
|
@@ -5303,6 +5835,12 @@ export interface AnalyticsQueryResponse {
|
|
|
5303
5835
|
* @memberof AnalyticsQueryResponse
|
|
5304
5836
|
*/
|
|
5305
5837
|
'start_time'?: string;
|
|
5838
|
+
/**
|
|
5839
|
+
*
|
|
5840
|
+
* @type {string}
|
|
5841
|
+
* @memberof AnalyticsQueryResponse
|
|
5842
|
+
*/
|
|
5843
|
+
'target_currency'?: string;
|
|
5306
5844
|
/**
|
|
5307
5845
|
*
|
|
5308
5846
|
* @type {number}
|
|
@@ -5378,11 +5916,29 @@ export interface AnalyticsQuerySuggestion {
|
|
|
5378
5916
|
*/
|
|
5379
5917
|
export interface AnalyticsQuerySuggestionConfig {
|
|
5380
5918
|
/**
|
|
5381
|
-
*
|
|
5919
|
+
* Expressions to exclude from suggestions with matching types
|
|
5920
|
+
* @type {Array<AnalyticsBannedExpression>}
|
|
5921
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5922
|
+
*/
|
|
5923
|
+
'banned_expressions'?: Array<AnalyticsBannedExpression>;
|
|
5924
|
+
/**
|
|
5925
|
+
* Per-attribute configuration with counts
|
|
5926
|
+
* @type {Array<AnalyticsCategoryAttributeConfig>}
|
|
5927
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5928
|
+
*/
|
|
5929
|
+
'category_attribute_configs'?: Array<AnalyticsCategoryAttributeConfig>;
|
|
5930
|
+
/**
|
|
5931
|
+
* Attributes to use for category suggestions (legacy)
|
|
5382
5932
|
* @type {Array<string>}
|
|
5383
5933
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5384
5934
|
*/
|
|
5385
5935
|
'category_attributes'?: Array<string>;
|
|
5936
|
+
/**
|
|
5937
|
+
* Whether to include count per attribute
|
|
5938
|
+
* @type {boolean}
|
|
5939
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5940
|
+
*/
|
|
5941
|
+
'category_counts'?: boolean;
|
|
5386
5942
|
/**
|
|
5387
5943
|
* Whether to include category-based suggestions
|
|
5388
5944
|
* @type {boolean}
|
|
@@ -5395,12 +5951,42 @@ export interface AnalyticsQuerySuggestionConfig {
|
|
|
5395
5951
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5396
5952
|
*/
|
|
5397
5953
|
'enable_facet_suggestions'?: boolean;
|
|
5954
|
+
/**
|
|
5955
|
+
* Personalization (boolean flag for now as requested)
|
|
5956
|
+
* @type {boolean}
|
|
5957
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5958
|
+
*/
|
|
5959
|
+
'enable_personalization'?: boolean;
|
|
5960
|
+
/**
|
|
5961
|
+
* Improve relevance using Rules
|
|
5962
|
+
* @type {boolean}
|
|
5963
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5964
|
+
*/
|
|
5965
|
+
'enable_rules'?: boolean;
|
|
5398
5966
|
/**
|
|
5399
5967
|
* Whether query suggestions are enabled for the store
|
|
5400
5968
|
* @type {boolean}
|
|
5401
5969
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5402
5970
|
*/
|
|
5403
5971
|
'enabled'?: boolean;
|
|
5972
|
+
/**
|
|
5973
|
+
* Facet data augmentation
|
|
5974
|
+
* @type {Array<string>}
|
|
5975
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5976
|
+
*/
|
|
5977
|
+
'facet_attributes'?: Array<string>;
|
|
5978
|
+
/**
|
|
5979
|
+
* Maximum number of facet combinations
|
|
5980
|
+
* @type {number}
|
|
5981
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5982
|
+
*/
|
|
5983
|
+
'facet_combination_limit'?: number;
|
|
5984
|
+
/**
|
|
5985
|
+
* Language for duplicate removal (singular/plural)
|
|
5986
|
+
* @type {string}
|
|
5987
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5988
|
+
*/
|
|
5989
|
+
'language'?: string;
|
|
5404
5990
|
/**
|
|
5405
5991
|
* Maximum number of suggestions to return
|
|
5406
5992
|
* @type {number}
|
|
@@ -5413,18 +5999,54 @@ export interface AnalyticsQuerySuggestionConfig {
|
|
|
5413
5999
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5414
6000
|
*/
|
|
5415
6001
|
'min_popularity'?: number;
|
|
6002
|
+
/**
|
|
6003
|
+
* Minimum search results for suggestions
|
|
6004
|
+
* @type {number}
|
|
6005
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6006
|
+
*/
|
|
6007
|
+
'minimum_hits'?: number;
|
|
6008
|
+
/**
|
|
6009
|
+
* Remove duplicate or unhelpful suggestions (from Algolia documentation)
|
|
6010
|
+
* @type {number}
|
|
6011
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6012
|
+
*/
|
|
6013
|
+
'minimum_letters'?: number;
|
|
6014
|
+
/**
|
|
6015
|
+
* Array of rules for suggestion promotion/hiding
|
|
6016
|
+
* @type {Array<AnalyticsQuerySuggestionRule>}
|
|
6017
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6018
|
+
*/
|
|
6019
|
+
'rules'?: Array<AnalyticsQuerySuggestionRule>;
|
|
6020
|
+
/**
|
|
6021
|
+
* Query Suggestions with categories - enhanced
|
|
6022
|
+
* @type {number}
|
|
6023
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6024
|
+
*/
|
|
6025
|
+
'show_top_categories'?: number;
|
|
5416
6026
|
/**
|
|
5417
6027
|
* Whether to sync enabled suggestions to Typesense
|
|
5418
6028
|
* @type {boolean}
|
|
5419
6029
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5420
6030
|
*/
|
|
5421
6031
|
'sync_to_typesense'?: boolean;
|
|
6032
|
+
/**
|
|
6033
|
+
* Tokenization method
|
|
6034
|
+
* @type {string}
|
|
6035
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6036
|
+
*/
|
|
6037
|
+
'tokenization'?: string;
|
|
5422
6038
|
/**
|
|
5423
6039
|
* Whether to sync to Typesense
|
|
5424
6040
|
* @type {boolean}
|
|
5425
6041
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5426
6042
|
*/
|
|
5427
6043
|
'typesense_collection_enabled'?: boolean;
|
|
6044
|
+
/**
|
|
6045
|
+
* Index settings
|
|
6046
|
+
* @type {number}
|
|
6047
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6048
|
+
*/
|
|
6049
|
+
'typo_tolerance'?: number;
|
|
5428
6050
|
/**
|
|
5429
6051
|
* Include auto-generated suggestions
|
|
5430
6052
|
* @type {boolean}
|
|
@@ -5626,6 +6248,75 @@ export interface AnalyticsQuerySuggestionRecord {
|
|
|
5626
6248
|
}
|
|
5627
6249
|
|
|
5628
6250
|
|
|
6251
|
+
/**
|
|
6252
|
+
*
|
|
6253
|
+
* @export
|
|
6254
|
+
* @interface AnalyticsQuerySuggestionRule
|
|
6255
|
+
*/
|
|
6256
|
+
export interface AnalyticsQuerySuggestionRule {
|
|
6257
|
+
/**
|
|
6258
|
+
* Rule actions
|
|
6259
|
+
* @type {Array<AnalyticsRuleAction>}
|
|
6260
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6261
|
+
*/
|
|
6262
|
+
'actions'?: Array<AnalyticsRuleAction>;
|
|
6263
|
+
/**
|
|
6264
|
+
* Rule conditions
|
|
6265
|
+
* @type {Array<AnalyticsRuleCondition>}
|
|
6266
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6267
|
+
*/
|
|
6268
|
+
'conditions'?: Array<AnalyticsRuleCondition>;
|
|
6269
|
+
/**
|
|
6270
|
+
* Rule creation time
|
|
6271
|
+
* @type {string}
|
|
6272
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6273
|
+
*/
|
|
6274
|
+
'created_at'?: string;
|
|
6275
|
+
/**
|
|
6276
|
+
* Rule description
|
|
6277
|
+
* @type {string}
|
|
6278
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6279
|
+
*/
|
|
6280
|
+
'description'?: string;
|
|
6281
|
+
/**
|
|
6282
|
+
* Whether rule is enabled
|
|
6283
|
+
* @type {boolean}
|
|
6284
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6285
|
+
*/
|
|
6286
|
+
'enabled'?: boolean;
|
|
6287
|
+
/**
|
|
6288
|
+
* Unique rule identifier
|
|
6289
|
+
* @type {string}
|
|
6290
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6291
|
+
*/
|
|
6292
|
+
'id'?: string;
|
|
6293
|
+
/**
|
|
6294
|
+
* Rule name
|
|
6295
|
+
* @type {string}
|
|
6296
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6297
|
+
*/
|
|
6298
|
+
'name'?: string;
|
|
6299
|
+
/**
|
|
6300
|
+
* Rule priority (higher = executed first)
|
|
6301
|
+
* @type {number}
|
|
6302
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6303
|
+
*/
|
|
6304
|
+
'priority'?: number;
|
|
6305
|
+
/**
|
|
6306
|
+
* Rule type (promote, hide, redirect, etc.)
|
|
6307
|
+
* @type {AnalyticsRuleType}
|
|
6308
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6309
|
+
*/
|
|
6310
|
+
'type'?: AnalyticsRuleType;
|
|
6311
|
+
/**
|
|
6312
|
+
* Rule last update time
|
|
6313
|
+
* @type {string}
|
|
6314
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6315
|
+
*/
|
|
6316
|
+
'updated_at'?: string;
|
|
6317
|
+
}
|
|
6318
|
+
|
|
6319
|
+
|
|
5629
6320
|
/**
|
|
5630
6321
|
*
|
|
5631
6322
|
* @export
|
|
@@ -5905,6 +6596,72 @@ export interface AnalyticsQuerySuggestionsResponse {
|
|
|
5905
6596
|
*/
|
|
5906
6597
|
'userToken'?: string;
|
|
5907
6598
|
}
|
|
6599
|
+
/**
|
|
6600
|
+
*
|
|
6601
|
+
* @export
|
|
6602
|
+
* @interface AnalyticsRuleAction
|
|
6603
|
+
*/
|
|
6604
|
+
export interface AnalyticsRuleAction {
|
|
6605
|
+
/**
|
|
6606
|
+
* Optional message for banner actions
|
|
6607
|
+
* @type {string}
|
|
6608
|
+
* @memberof AnalyticsRuleAction
|
|
6609
|
+
*/
|
|
6610
|
+
'message'?: string;
|
|
6611
|
+
/**
|
|
6612
|
+
* Action type (promote, hide, change_query, show_banner)
|
|
6613
|
+
* @type {string}
|
|
6614
|
+
* @memberof AnalyticsRuleAction
|
|
6615
|
+
*/
|
|
6616
|
+
'type'?: string;
|
|
6617
|
+
/**
|
|
6618
|
+
* Action value
|
|
6619
|
+
* @type {any}
|
|
6620
|
+
* @memberof AnalyticsRuleAction
|
|
6621
|
+
*/
|
|
6622
|
+
'value'?: any;
|
|
6623
|
+
}
|
|
6624
|
+
/**
|
|
6625
|
+
*
|
|
6626
|
+
* @export
|
|
6627
|
+
* @interface AnalyticsRuleCondition
|
|
6628
|
+
*/
|
|
6629
|
+
export interface AnalyticsRuleCondition {
|
|
6630
|
+
/**
|
|
6631
|
+
* Attribute to match (query, category, etc.)
|
|
6632
|
+
* @type {string}
|
|
6633
|
+
* @memberof AnalyticsRuleCondition
|
|
6634
|
+
*/
|
|
6635
|
+
'attribute'?: string;
|
|
6636
|
+
/**
|
|
6637
|
+
* Operator (equals, contains, starts_with, etc.)
|
|
6638
|
+
* @type {string}
|
|
6639
|
+
* @memberof AnalyticsRuleCondition
|
|
6640
|
+
*/
|
|
6641
|
+
'operator'?: string;
|
|
6642
|
+
/**
|
|
6643
|
+
* Value to match against
|
|
6644
|
+
* @type {any}
|
|
6645
|
+
* @memberof AnalyticsRuleCondition
|
|
6646
|
+
*/
|
|
6647
|
+
'value'?: any;
|
|
6648
|
+
}
|
|
6649
|
+
/**
|
|
6650
|
+
*
|
|
6651
|
+
* @export
|
|
6652
|
+
* @enum {string}
|
|
6653
|
+
*/
|
|
6654
|
+
|
|
6655
|
+
export const AnalyticsRuleType = {
|
|
6656
|
+
RuleTypePromote: 'promote',
|
|
6657
|
+
RuleTypeHide: 'hide',
|
|
6658
|
+
RuleTypeRedirect: 'redirect',
|
|
6659
|
+
RuleTypeBanner: 'banner'
|
|
6660
|
+
} as const;
|
|
6661
|
+
|
|
6662
|
+
export type AnalyticsRuleType = typeof AnalyticsRuleType[keyof typeof AnalyticsRuleType];
|
|
6663
|
+
|
|
6664
|
+
|
|
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}
|
|
@@ -6813,12 +7654,24 @@ export interface BillingServicePaymentTransactionSummary {
|
|
|
6813
7654
|
* @memberof BillingServicePaymentTransactionSummary
|
|
6814
7655
|
*/
|
|
6815
7656
|
'gateway'?: BillingServiceNullableString;
|
|
7657
|
+
/**
|
|
7658
|
+
* Gateway order identifier
|
|
7659
|
+
* @type {BillingServiceNullableString}
|
|
7660
|
+
* @memberof BillingServicePaymentTransactionSummary
|
|
7661
|
+
*/
|
|
7662
|
+
'gateway_order_id'?: BillingServiceNullableString;
|
|
6816
7663
|
/**
|
|
6817
7664
|
*
|
|
6818
7665
|
* @type {BillingServiceNullableString}
|
|
6819
7666
|
* @memberof BillingServicePaymentTransactionSummary
|
|
6820
7667
|
*/
|
|
6821
7668
|
'gateway_payment_id'?: BillingServiceNullableString;
|
|
7669
|
+
/**
|
|
7670
|
+
* Database primary key
|
|
7671
|
+
* @type {BillingServiceNullableInt64}
|
|
7672
|
+
* @memberof BillingServicePaymentTransactionSummary
|
|
7673
|
+
*/
|
|
7674
|
+
'order_id'?: BillingServiceNullableInt64;
|
|
6822
7675
|
/**
|
|
6823
7676
|
*
|
|
6824
7677
|
* @type {number}
|
|
@@ -6838,7 +7691,7 @@ export interface BillingServicePaymentTransactionSummary {
|
|
|
6838
7691
|
*/
|
|
6839
7692
|
'payment_date'?: string;
|
|
6840
7693
|
/**
|
|
6841
|
-
*
|
|
7694
|
+
* Database primary key
|
|
6842
7695
|
* @type {number}
|
|
6843
7696
|
* @memberof BillingServicePaymentTransactionSummary
|
|
6844
7697
|
*/
|
|
@@ -6867,6 +7720,12 @@ export interface BillingServicePaymentTransactionSummary {
|
|
|
6867
7720
|
* @memberof BillingServicePaymentTransactionSummary
|
|
6868
7721
|
*/
|
|
6869
7722
|
'refund_status'?: BillingServiceNullableString;
|
|
7723
|
+
/**
|
|
7724
|
+
* Actual payment identifier
|
|
7725
|
+
* @type {string}
|
|
7726
|
+
* @memberof BillingServicePaymentTransactionSummary
|
|
7727
|
+
*/
|
|
7728
|
+
'transaction_id'?: string;
|
|
6870
7729
|
}
|
|
6871
7730
|
/**
|
|
6872
7731
|
*
|
|
@@ -8081,6 +8940,12 @@ export interface DataTypesCreateRefundRequestDto {
|
|
|
8081
8940
|
* @memberof DataTypesCreateRefundRequestDto
|
|
8082
8941
|
*/
|
|
8083
8942
|
'auto_approve_after'?: string;
|
|
8943
|
+
/**
|
|
8944
|
+
*
|
|
8945
|
+
* @type {string}
|
|
8946
|
+
* @memberof DataTypesCreateRefundRequestDto
|
|
8947
|
+
*/
|
|
8948
|
+
'currency': string;
|
|
8084
8949
|
/**
|
|
8085
8950
|
*
|
|
8086
8951
|
* @type {string}
|
|
@@ -8094,13 +8959,13 @@ export interface DataTypesCreateRefundRequestDto {
|
|
|
8094
8959
|
*/
|
|
8095
8960
|
'metadata'?: { [key: string]: any; };
|
|
8096
8961
|
/**
|
|
8097
|
-
*
|
|
8098
|
-
* @type {
|
|
8962
|
+
* Gateway order ID (e.g., \"order_RMeeXimPIbrYqH\")
|
|
8963
|
+
* @type {string}
|
|
8099
8964
|
* @memberof DataTypesCreateRefundRequestDto
|
|
8100
8965
|
*/
|
|
8101
|
-
'order_id':
|
|
8966
|
+
'order_id': string;
|
|
8102
8967
|
/**
|
|
8103
|
-
*
|
|
8968
|
+
* Gateway payment ID (e.g., \"pay_RMeeuvyPSbZp2Y\")
|
|
8104
8969
|
* @type {string}
|
|
8105
8970
|
* @memberof DataTypesCreateRefundRequestDto
|
|
8106
8971
|
*/
|
|
@@ -13634,17 +14499,23 @@ export interface DataTypesRefundRequestResponseDto {
|
|
|
13634
14499
|
*/
|
|
13635
14500
|
'expires_at'?: string;
|
|
13636
14501
|
/**
|
|
13637
|
-
*
|
|
13638
|
-
* @type {
|
|
14502
|
+
* Gateway order ID
|
|
14503
|
+
* @type {string}
|
|
13639
14504
|
* @memberof DataTypesRefundRequestResponseDto
|
|
13640
14505
|
*/
|
|
13641
|
-
'order_id'?:
|
|
14506
|
+
'order_id'?: string;
|
|
13642
14507
|
/**
|
|
13643
|
-
*
|
|
14508
|
+
* Gateway payment ID
|
|
13644
14509
|
* @type {string}
|
|
13645
14510
|
* @memberof DataTypesRefundRequestResponseDto
|
|
13646
14511
|
*/
|
|
13647
14512
|
'payment_id'?: string;
|
|
14513
|
+
/**
|
|
14514
|
+
* UUID for external reference
|
|
14515
|
+
* @type {string}
|
|
14516
|
+
* @memberof DataTypesRefundRequestResponseDto
|
|
14517
|
+
*/
|
|
14518
|
+
'refund_id'?: string;
|
|
13648
14519
|
/**
|
|
13649
14520
|
*
|
|
13650
14521
|
* @type {number}
|
|
@@ -13755,6 +14626,12 @@ export interface DataTypesRefundStatusDto {
|
|
|
13755
14626
|
* @memberof DataTypesRefundStatusDto
|
|
13756
14627
|
*/
|
|
13757
14628
|
'credit_adjustments'?: Array<DataTypesCreditAdjustmentDto>;
|
|
14629
|
+
/**
|
|
14630
|
+
*
|
|
14631
|
+
* @type {string}
|
|
14632
|
+
* @memberof DataTypesRefundStatusDto
|
|
14633
|
+
*/
|
|
14634
|
+
'currency'?: string;
|
|
13758
14635
|
/**
|
|
13759
14636
|
* Processing information
|
|
13760
14637
|
* @type {string}
|
|
@@ -13785,6 +14662,12 @@ export interface DataTypesRefundStatusDto {
|
|
|
13785
14662
|
* @memberof DataTypesRefundStatusDto
|
|
13786
14663
|
*/
|
|
13787
14664
|
'reason'?: string;
|
|
14665
|
+
/**
|
|
14666
|
+
* UUID for external reference
|
|
14667
|
+
* @type {string}
|
|
14668
|
+
* @memberof DataTypesRefundStatusDto
|
|
14669
|
+
*/
|
|
14670
|
+
'refund_id'?: string;
|
|
13788
14671
|
/**
|
|
13789
14672
|
*
|
|
13790
14673
|
* @type {number}
|
|
@@ -18202,6 +19085,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
18202
19085
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
18203
19086
|
* @param {string} [endTime] End time in RFC3339 format
|
|
18204
19087
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum} [granularity] Time granularity
|
|
19088
|
+
* @param {string} [search] Search term to filter geographic locations (case-insensitive partial match on country, region, city)
|
|
18205
19089
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
18206
19090
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
18207
19091
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
@@ -18225,7 +19109,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
18225
19109
|
* @param {*} [options] Override http request option.
|
|
18226
19110
|
* @throws {RequiredError}
|
|
18227
19111
|
*/
|
|
18228
|
-
adminAnalyticsStoreXStoreIDGeoGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
19112
|
+
adminAnalyticsStoreXStoreIDGeoGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
18229
19113
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
18230
19114
|
assertParamExists('adminAnalyticsStoreXStoreIDGeoGet', 'xStoreID', xStoreID)
|
|
18231
19115
|
const localVarPath = `/admin/analytics/store/{xStoreID}/geo`
|
|
@@ -18256,6 +19140,10 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
18256
19140
|
localVarQueryParameter['granularity'] = granularity;
|
|
18257
19141
|
}
|
|
18258
19142
|
|
|
19143
|
+
if (search !== undefined) {
|
|
19144
|
+
localVarQueryParameter['search'] = search;
|
|
19145
|
+
}
|
|
19146
|
+
|
|
18259
19147
|
if (analyticsTags !== undefined) {
|
|
18260
19148
|
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
18261
19149
|
}
|
|
@@ -18371,14 +19259,17 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
18371
19259
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
18372
19260
|
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
18373
19261
|
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
19262
|
+
* @param {string} [geoQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
18374
19263
|
* @param {number} [resultsPage] Page number for top results pagination
|
|
18375
19264
|
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
19265
|
+
* @param {string} [geoResultsSearch] Search term to filter top results (case-insensitive partial match on item IDs)
|
|
18376
19266
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
18377
19267
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
19268
|
+
* @param {string} [geoFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
18378
19269
|
* @param {*} [options] Override http request option.
|
|
18379
19270
|
* @throws {RequiredError}
|
|
18380
19271
|
*/
|
|
18381
|
-
adminAnalyticsStoreXStoreIDGeoInsightsGet: async (xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
19272
|
+
adminAnalyticsStoreXStoreIDGeoInsightsGet: async (xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, geoQueriesSearch?: string, resultsPage?: number, resultsPageSize?: number, geoResultsSearch?: string, filtersPage?: number, filtersPageSize?: number, geoFiltersSearch?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
18382
19273
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
18383
19274
|
assertParamExists('adminAnalyticsStoreXStoreIDGeoInsightsGet', 'xStoreID', xStoreID)
|
|
18384
19275
|
const localVarPath = `/admin/analytics/store/{xStoreID}/geo/insights`
|
|
@@ -18477,6 +19368,10 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
18477
19368
|
localVarQueryParameter['queries_page_size'] = queriesPageSize;
|
|
18478
19369
|
}
|
|
18479
19370
|
|
|
19371
|
+
if (geoQueriesSearch !== undefined) {
|
|
19372
|
+
localVarQueryParameter['geo_queries_search'] = geoQueriesSearch;
|
|
19373
|
+
}
|
|
19374
|
+
|
|
18480
19375
|
if (resultsPage !== undefined) {
|
|
18481
19376
|
localVarQueryParameter['results_page'] = resultsPage;
|
|
18482
19377
|
}
|
|
@@ -18485,6 +19380,10 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
18485
19380
|
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
18486
19381
|
}
|
|
18487
19382
|
|
|
19383
|
+
if (geoResultsSearch !== undefined) {
|
|
19384
|
+
localVarQueryParameter['geo_results_search'] = geoResultsSearch;
|
|
19385
|
+
}
|
|
19386
|
+
|
|
18488
19387
|
if (filtersPage !== undefined) {
|
|
18489
19388
|
localVarQueryParameter['filters_page'] = filtersPage;
|
|
18490
19389
|
}
|
|
@@ -18493,6 +19392,10 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
18493
19392
|
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
18494
19393
|
}
|
|
18495
19394
|
|
|
19395
|
+
if (geoFiltersSearch !== undefined) {
|
|
19396
|
+
localVarQueryParameter['geo_filters_search'] = geoFiltersSearch;
|
|
19397
|
+
}
|
|
19398
|
+
|
|
18496
19399
|
|
|
18497
19400
|
|
|
18498
19401
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -19188,6 +20091,12 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
19188
20091
|
* @param {string} query Search query to analyze
|
|
19189
20092
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
19190
20093
|
* @param {string} [endTime] End time in RFC3339 format
|
|
20094
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
20095
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
20096
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
20097
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
20098
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
20099
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
19191
20100
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
19192
20101
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
19193
20102
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -19198,15 +20107,18 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
19198
20107
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
19199
20108
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
19200
20109
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
20110
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
19201
20111
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
19202
20112
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
20113
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
19203
20114
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
19204
20115
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
20116
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
19205
20117
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
19206
20118
|
* @param {*} [options] Override http request option.
|
|
19207
20119
|
* @throws {RequiredError}
|
|
19208
20120
|
*/
|
|
19209
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, includeWidget?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20121
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
19210
20122
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
19211
20123
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID)
|
|
19212
20124
|
// verify required parameter 'query' is not null or undefined
|
|
@@ -19236,6 +20148,30 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
19236
20148
|
localVarQueryParameter['end_time'] = endTime;
|
|
19237
20149
|
}
|
|
19238
20150
|
|
|
20151
|
+
if (analyticsTags !== undefined) {
|
|
20152
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
20153
|
+
}
|
|
20154
|
+
|
|
20155
|
+
if (tagsMatchMode !== undefined) {
|
|
20156
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
20157
|
+
}
|
|
20158
|
+
|
|
20159
|
+
if (tagsExclude !== undefined) {
|
|
20160
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
20161
|
+
}
|
|
20162
|
+
|
|
20163
|
+
if (tagKeyFilter !== undefined) {
|
|
20164
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
20165
|
+
}
|
|
20166
|
+
|
|
20167
|
+
if (tagValueFilter !== undefined) {
|
|
20168
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
20169
|
+
}
|
|
20170
|
+
|
|
20171
|
+
if (search !== undefined) {
|
|
20172
|
+
localVarQueryParameter['search'] = search;
|
|
20173
|
+
}
|
|
20174
|
+
|
|
19239
20175
|
if (compareMode !== undefined) {
|
|
19240
20176
|
localVarQueryParameter['compare_mode'] = compareMode;
|
|
19241
20177
|
}
|
|
@@ -19276,6 +20212,10 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
19276
20212
|
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
19277
20213
|
}
|
|
19278
20214
|
|
|
20215
|
+
if (resultsSearch !== undefined) {
|
|
20216
|
+
localVarQueryParameter['results_search'] = resultsSearch;
|
|
20217
|
+
}
|
|
20218
|
+
|
|
19279
20219
|
if (filtersPage !== undefined) {
|
|
19280
20220
|
localVarQueryParameter['filters_page'] = filtersPage;
|
|
19281
20221
|
}
|
|
@@ -19284,6 +20224,10 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
19284
20224
|
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
19285
20225
|
}
|
|
19286
20226
|
|
|
20227
|
+
if (filtersSearch !== undefined) {
|
|
20228
|
+
localVarQueryParameter['filters_search'] = filtersSearch;
|
|
20229
|
+
}
|
|
20230
|
+
|
|
19287
20231
|
if (geoPage !== undefined) {
|
|
19288
20232
|
localVarQueryParameter['geo_page'] = geoPage;
|
|
19289
20233
|
}
|
|
@@ -19292,6 +20236,10 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
19292
20236
|
localVarQueryParameter['geo_page_size'] = geoPageSize;
|
|
19293
20237
|
}
|
|
19294
20238
|
|
|
20239
|
+
if (geoSearch !== undefined) {
|
|
20240
|
+
localVarQueryParameter['geo_search'] = geoSearch;
|
|
20241
|
+
}
|
|
20242
|
+
|
|
19295
20243
|
if (includeWidget !== undefined) {
|
|
19296
20244
|
localVarQueryParameter['include_widget'] = includeWidget;
|
|
19297
20245
|
}
|
|
@@ -19475,11 +20423,11 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
19475
20423
|
};
|
|
19476
20424
|
},
|
|
19477
20425
|
/**
|
|
19478
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
20426
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
19479
20427
|
* @summary Get Analytics Tags
|
|
19480
20428
|
* @param {string} xStoreID Store ID
|
|
19481
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
19482
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
20429
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
20430
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
19483
20431
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
19484
20432
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
19485
20433
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -19792,6 +20740,7 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
19792
20740
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
19793
20741
|
* @param {string} [endTime] End time in RFC3339 format
|
|
19794
20742
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum} [granularity] Time granularity
|
|
20743
|
+
* @param {string} [search] Search term to filter geographic locations (case-insensitive partial match on country, region, city)
|
|
19795
20744
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
19796
20745
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
19797
20746
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
@@ -19815,8 +20764,8 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
19815
20764
|
* @param {*} [options] Override http request option.
|
|
19816
20765
|
* @throws {RequiredError}
|
|
19817
20766
|
*/
|
|
19818
|
-
async adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDGeoGet200Response>> {
|
|
19819
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
20767
|
+
async adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDGeoGet200Response>> {
|
|
20768
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
19820
20769
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
19821
20770
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDGeoGet']?.[localVarOperationServerIndex]?.url;
|
|
19822
20771
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -19845,15 +20794,18 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
19845
20794
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
19846
20795
|
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
19847
20796
|
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
20797
|
+
* @param {string} [geoQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
19848
20798
|
* @param {number} [resultsPage] Page number for top results pagination
|
|
19849
20799
|
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
20800
|
+
* @param {string} [geoResultsSearch] Search term to filter top results (case-insensitive partial match on item IDs)
|
|
19850
20801
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
19851
20802
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
20803
|
+
* @param {string} [geoFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
19852
20804
|
* @param {*} [options] Override http request option.
|
|
19853
20805
|
* @throws {RequiredError}
|
|
19854
20806
|
*/
|
|
19855
|
-
async adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDGeoInsightsGet200Response>> {
|
|
19856
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options);
|
|
20807
|
+
async adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, geoQueriesSearch?: string, resultsPage?: number, resultsPageSize?: number, geoResultsSearch?: string, filtersPage?: number, filtersPageSize?: number, geoFiltersSearch?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDGeoInsightsGet200Response>> {
|
|
20808
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, geoQueriesSearch, resultsPage, resultsPageSize, geoResultsSearch, filtersPage, filtersPageSize, geoFiltersSearch, options);
|
|
19857
20809
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
19858
20810
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDGeoInsightsGet']?.[localVarOperationServerIndex]?.url;
|
|
19859
20811
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -20034,6 +20986,12 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
20034
20986
|
* @param {string} query Search query to analyze
|
|
20035
20987
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
20036
20988
|
* @param {string} [endTime] End time in RFC3339 format
|
|
20989
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
20990
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
20991
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
20992
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
20993
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
20994
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
20037
20995
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
20038
20996
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
20039
20997
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -20044,16 +21002,19 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
20044
21002
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
20045
21003
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
20046
21004
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
21005
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
20047
21006
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
20048
21007
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
21008
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
20049
21009
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
20050
21010
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
21011
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
20051
21012
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
20052
21013
|
* @param {*} [options] Override http request option.
|
|
20053
21014
|
* @throws {RequiredError}
|
|
20054
21015
|
*/
|
|
20055
|
-
async adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>> {
|
|
20056
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options);
|
|
21016
|
+
async adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>> {
|
|
21017
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options);
|
|
20057
21018
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
20058
21019
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']?.[localVarOperationServerIndex]?.url;
|
|
20059
21020
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -20098,11 +21059,11 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
20098
21059
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20099
21060
|
},
|
|
20100
21061
|
/**
|
|
20101
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
21062
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
20102
21063
|
* @summary Get Analytics Tags
|
|
20103
21064
|
* @param {string} xStoreID Store ID
|
|
20104
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
20105
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
21065
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
21066
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
20106
21067
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
20107
21068
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
20108
21069
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -20267,6 +21228,7 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
20267
21228
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
20268
21229
|
* @param {string} [endTime] End time in RFC3339 format
|
|
20269
21230
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum} [granularity] Time granularity
|
|
21231
|
+
* @param {string} [search] Search term to filter geographic locations (case-insensitive partial match on country, region, city)
|
|
20270
21232
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
20271
21233
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
20272
21234
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
@@ -20290,8 +21252,8 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
20290
21252
|
* @param {*} [options] Override http request option.
|
|
20291
21253
|
* @throws {RequiredError}
|
|
20292
21254
|
*/
|
|
20293
|
-
adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDGeoGet200Response> {
|
|
20294
|
-
return localVarFp.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
21255
|
+
adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDGeoGet200Response> {
|
|
21256
|
+
return localVarFp.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
20295
21257
|
},
|
|
20296
21258
|
/**
|
|
20297
21259
|
* Retrieve comprehensive analytics insights for a specific geographic location including all core metrics (Total Searches, Total Clicks, CTR, Conversions, CVR, Revenue), popular queries with performance metrics, top results by region with average rankings, popular filters used per region with performance impact, and totals & rates with optional comparison mode and internal pagination for each subsection
|
|
@@ -20317,15 +21279,18 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
20317
21279
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
20318
21280
|
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
20319
21281
|
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
21282
|
+
* @param {string} [geoQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
20320
21283
|
* @param {number} [resultsPage] Page number for top results pagination
|
|
20321
21284
|
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
21285
|
+
* @param {string} [geoResultsSearch] Search term to filter top results (case-insensitive partial match on item IDs)
|
|
20322
21286
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
20323
21287
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
21288
|
+
* @param {string} [geoFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
20324
21289
|
* @param {*} [options] Override http request option.
|
|
20325
21290
|
* @throws {RequiredError}
|
|
20326
21291
|
*/
|
|
20327
|
-
adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDGeoInsightsGet200Response> {
|
|
20328
|
-
return localVarFp.adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options).then((request) => request(axios, basePath));
|
|
21292
|
+
adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, geoQueriesSearch?: string, resultsPage?: number, resultsPageSize?: number, geoResultsSearch?: string, filtersPage?: number, filtersPageSize?: number, geoFiltersSearch?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDGeoInsightsGet200Response> {
|
|
21293
|
+
return localVarFp.adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, geoQueriesSearch, resultsPage, resultsPageSize, geoResultsSearch, filtersPage, filtersPageSize, geoFiltersSearch, options).then((request) => request(axios, basePath));
|
|
20329
21294
|
},
|
|
20330
21295
|
/**
|
|
20331
21296
|
* Check the health status of analytics service and ClickHouse connection
|
|
@@ -20485,6 +21450,12 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
20485
21450
|
* @param {string} query Search query to analyze
|
|
20486
21451
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
20487
21452
|
* @param {string} [endTime] End time in RFC3339 format
|
|
21453
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
21454
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
21455
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
21456
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
21457
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
21458
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
20488
21459
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
20489
21460
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
20490
21461
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -20495,16 +21466,19 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
20495
21466
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
20496
21467
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
20497
21468
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
21469
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
20498
21470
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
20499
21471
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
21472
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
20500
21473
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
20501
21474
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
21475
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
20502
21476
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
20503
21477
|
* @param {*} [options] Override http request option.
|
|
20504
21478
|
* @throws {RequiredError}
|
|
20505
21479
|
*/
|
|
20506
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response> {
|
|
20507
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options).then((request) => request(axios, basePath));
|
|
21480
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response> {
|
|
21481
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options).then((request) => request(axios, basePath));
|
|
20508
21482
|
},
|
|
20509
21483
|
/**
|
|
20510
21484
|
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
@@ -20543,11 +21517,11 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
20543
21517
|
return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
20544
21518
|
},
|
|
20545
21519
|
/**
|
|
20546
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
21520
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
20547
21521
|
* @summary Get Analytics Tags
|
|
20548
21522
|
* @param {string} xStoreID Store ID
|
|
20549
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
20550
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
21523
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
21524
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
20551
21525
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
20552
21526
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
20553
21527
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -20718,6 +21692,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
20718
21692
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
20719
21693
|
* @param {string} [endTime] End time in RFC3339 format
|
|
20720
21694
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum} [granularity] Time granularity
|
|
21695
|
+
* @param {string} [search] Search term to filter geographic locations (case-insensitive partial match on country, region, city)
|
|
20721
21696
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
20722
21697
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
20723
21698
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
@@ -20742,8 +21717,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
20742
21717
|
* @throws {RequiredError}
|
|
20743
21718
|
* @memberof AnalyticsApi
|
|
20744
21719
|
*/
|
|
20745
|
-
public adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
|
|
20746
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
21720
|
+
public adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
|
|
21721
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
20747
21722
|
}
|
|
20748
21723
|
|
|
20749
21724
|
/**
|
|
@@ -20770,16 +21745,19 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
20770
21745
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
20771
21746
|
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
20772
21747
|
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
21748
|
+
* @param {string} [geoQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
20773
21749
|
* @param {number} [resultsPage] Page number for top results pagination
|
|
20774
21750
|
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
21751
|
+
* @param {string} [geoResultsSearch] Search term to filter top results (case-insensitive partial match on item IDs)
|
|
20775
21752
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
20776
21753
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
21754
|
+
* @param {string} [geoFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
20777
21755
|
* @param {*} [options] Override http request option.
|
|
20778
21756
|
* @throws {RequiredError}
|
|
20779
21757
|
* @memberof AnalyticsApi
|
|
20780
21758
|
*/
|
|
20781
|
-
public adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, options?: RawAxiosRequestConfig) {
|
|
20782
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options).then((request) => request(this.axios, this.basePath));
|
|
21759
|
+
public adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, geoQueriesSearch?: string, resultsPage?: number, resultsPageSize?: number, geoResultsSearch?: string, filtersPage?: number, filtersPageSize?: number, geoFiltersSearch?: string, options?: RawAxiosRequestConfig) {
|
|
21760
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, geoQueriesSearch, resultsPage, resultsPageSize, geoResultsSearch, filtersPage, filtersPageSize, geoFiltersSearch, options).then((request) => request(this.axios, this.basePath));
|
|
20783
21761
|
}
|
|
20784
21762
|
|
|
20785
21763
|
/**
|
|
@@ -20952,6 +21930,12 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
20952
21930
|
* @param {string} query Search query to analyze
|
|
20953
21931
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
20954
21932
|
* @param {string} [endTime] End time in RFC3339 format
|
|
21933
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
21934
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
21935
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
21936
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
21937
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
21938
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
20955
21939
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
20956
21940
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
20957
21941
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -20962,17 +21946,20 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
20962
21946
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
20963
21947
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
20964
21948
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
21949
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
20965
21950
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
20966
21951
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
21952
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
20967
21953
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
20968
21954
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
21955
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
20969
21956
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
20970
21957
|
* @param {*} [options] Override http request option.
|
|
20971
21958
|
* @throws {RequiredError}
|
|
20972
21959
|
* @memberof AnalyticsApi
|
|
20973
21960
|
*/
|
|
20974
|
-
public adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig) {
|
|
20975
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
21961
|
+
public adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig) {
|
|
21962
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
20976
21963
|
}
|
|
20977
21964
|
|
|
20978
21965
|
/**
|
|
@@ -21014,11 +22001,11 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
21014
22001
|
}
|
|
21015
22002
|
|
|
21016
22003
|
/**
|
|
21017
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
22004
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
21018
22005
|
* @summary Get Analytics Tags
|
|
21019
22006
|
* @param {string} xStoreID Store ID
|
|
21020
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
21021
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
22007
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
22008
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
21022
22009
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
21023
22010
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
21024
22011
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -21365,6 +22352,14 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
21365
22352
|
Desc: 'desc'
|
|
21366
22353
|
} as const;
|
|
21367
22354
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
22355
|
+
/**
|
|
22356
|
+
* @export
|
|
22357
|
+
*/
|
|
22358
|
+
export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = {
|
|
22359
|
+
Any: 'any',
|
|
22360
|
+
All: 'all'
|
|
22361
|
+
} as const;
|
|
22362
|
+
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum];
|
|
21368
22363
|
/**
|
|
21369
22364
|
* @export
|
|
21370
22365
|
*/
|
|
@@ -25804,6 +26799,7 @@ export const ItemAnalyticsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
25804
26799
|
* @param {string} xStoreID Store ID
|
|
25805
26800
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
25806
26801
|
* @param {string} [endTime] End time in RFC3339 format
|
|
26802
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
25807
26803
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
25808
26804
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
25809
26805
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -25818,7 +26814,7 @@ export const ItemAnalyticsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
25818
26814
|
* @param {*} [options] Override http request option.
|
|
25819
26815
|
* @throws {RequiredError}
|
|
25820
26816
|
*/
|
|
25821
|
-
adminAnalyticsStoreXStoreIDItemsGet: async (xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
26817
|
+
adminAnalyticsStoreXStoreIDItemsGet: async (xStoreID: string, startTime?: string, endTime?: string, search?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25822
26818
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
25823
26819
|
assertParamExists('adminAnalyticsStoreXStoreIDItemsGet', 'xStoreID', xStoreID)
|
|
25824
26820
|
const localVarPath = `/admin/analytics/store/{xStoreID}/items`
|
|
@@ -25845,6 +26841,10 @@ export const ItemAnalyticsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
25845
26841
|
localVarQueryParameter['end_time'] = endTime;
|
|
25846
26842
|
}
|
|
25847
26843
|
|
|
26844
|
+
if (search !== undefined) {
|
|
26845
|
+
localVarQueryParameter['search'] = search;
|
|
26846
|
+
}
|
|
26847
|
+
|
|
25848
26848
|
if (itemIds !== undefined) {
|
|
25849
26849
|
localVarQueryParameter['item_ids'] = itemIds;
|
|
25850
26850
|
}
|
|
@@ -25973,15 +26973,18 @@ export const ItemAnalyticsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
25973
26973
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
25974
26974
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
25975
26975
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
26976
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
25976
26977
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
25977
26978
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
26979
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
25978
26980
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
25979
26981
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
26982
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
25980
26983
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
25981
26984
|
* @param {*} [options] Override http request option.
|
|
25982
26985
|
* @throws {RequiredError}
|
|
25983
26986
|
*/
|
|
25984
|
-
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet: async (xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
26987
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet: async (xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, itemQueriesSearch?: string, filtersPage?: number, filtersPageSize?: number, itemFiltersSearch?: string, geoPage?: number, geoPageSize?: number, itemGeoSearch?: string, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25985
26988
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
25986
26989
|
assertParamExists('adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet', 'xStoreID', xStoreID)
|
|
25987
26990
|
// verify required parameter 'itemId' is not null or undefined
|
|
@@ -26071,6 +27074,10 @@ export const ItemAnalyticsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
26071
27074
|
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
26072
27075
|
}
|
|
26073
27076
|
|
|
27077
|
+
if (itemQueriesSearch !== undefined) {
|
|
27078
|
+
localVarQueryParameter['item_queries_search'] = itemQueriesSearch;
|
|
27079
|
+
}
|
|
27080
|
+
|
|
26074
27081
|
if (filtersPage !== undefined) {
|
|
26075
27082
|
localVarQueryParameter['filters_page'] = filtersPage;
|
|
26076
27083
|
}
|
|
@@ -26079,6 +27086,10 @@ export const ItemAnalyticsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
26079
27086
|
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
26080
27087
|
}
|
|
26081
27088
|
|
|
27089
|
+
if (itemFiltersSearch !== undefined) {
|
|
27090
|
+
localVarQueryParameter['item_filters_search'] = itemFiltersSearch;
|
|
27091
|
+
}
|
|
27092
|
+
|
|
26082
27093
|
if (geoPage !== undefined) {
|
|
26083
27094
|
localVarQueryParameter['geo_page'] = geoPage;
|
|
26084
27095
|
}
|
|
@@ -26087,6 +27098,10 @@ export const ItemAnalyticsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
26087
27098
|
localVarQueryParameter['geo_page_size'] = geoPageSize;
|
|
26088
27099
|
}
|
|
26089
27100
|
|
|
27101
|
+
if (itemGeoSearch !== undefined) {
|
|
27102
|
+
localVarQueryParameter['item_geo_search'] = itemGeoSearch;
|
|
27103
|
+
}
|
|
27104
|
+
|
|
26090
27105
|
if (groupBy !== undefined) {
|
|
26091
27106
|
localVarQueryParameter['group_by'] = groupBy;
|
|
26092
27107
|
}
|
|
@@ -26461,6 +27476,7 @@ export const ItemAnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
26461
27476
|
* @param {string} xStoreID Store ID
|
|
26462
27477
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
26463
27478
|
* @param {string} [endTime] End time in RFC3339 format
|
|
27479
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
26464
27480
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
26465
27481
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
26466
27482
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -26475,8 +27491,8 @@ export const ItemAnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
26475
27491
|
* @param {*} [options] Override http request option.
|
|
26476
27492
|
* @throws {RequiredError}
|
|
26477
27493
|
*/
|
|
26478
|
-
async adminAnalyticsStoreXStoreIDItemsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>> {
|
|
26479
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDItemsGet(xStoreID, startTime, endTime, itemIds, itemLimit, minImpressions, maxPosition, sortBy, sortOrder, sort, limit, offset, page, pageSize, options);
|
|
27494
|
+
async adminAnalyticsStoreXStoreIDItemsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>> {
|
|
27495
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDItemsGet(xStoreID, startTime, endTime, search, itemIds, itemLimit, minImpressions, maxPosition, sortBy, sortOrder, sort, limit, offset, page, pageSize, options);
|
|
26480
27496
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
26481
27497
|
const localVarOperationServerBasePath = operationServerMap['ItemAnalyticsApi.adminAnalyticsStoreXStoreIDItemsGet']?.[localVarOperationServerIndex]?.url;
|
|
26482
27498
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -26519,16 +27535,19 @@ export const ItemAnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
26519
27535
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
26520
27536
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
26521
27537
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
27538
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
26522
27539
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
26523
27540
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
27541
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
26524
27542
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
26525
27543
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
27544
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
26526
27545
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
26527
27546
|
* @param {*} [options] Override http request option.
|
|
26528
27547
|
* @throws {RequiredError}
|
|
26529
27548
|
*/
|
|
26530
|
-
async adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response>> {
|
|
26531
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options);
|
|
27549
|
+
async adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, itemQueriesSearch?: string, filtersPage?: number, filtersPageSize?: number, itemFiltersSearch?: string, geoPage?: number, geoPageSize?: number, itemGeoSearch?: string, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response>> {
|
|
27550
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, itemQueriesSearch, filtersPage, filtersPageSize, itemFiltersSearch, geoPage, geoPageSize, itemGeoSearch, groupBy, options);
|
|
26532
27551
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
26533
27552
|
const localVarOperationServerBasePath = operationServerMap['ItemAnalyticsApi.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet']?.[localVarOperationServerIndex]?.url;
|
|
26534
27553
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -26662,6 +27681,7 @@ export const ItemAnalyticsApiFactory = function (configuration?: Configuration,
|
|
|
26662
27681
|
* @param {string} xStoreID Store ID
|
|
26663
27682
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
26664
27683
|
* @param {string} [endTime] End time in RFC3339 format
|
|
27684
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
26665
27685
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
26666
27686
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
26667
27687
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -26676,8 +27696,8 @@ export const ItemAnalyticsApiFactory = function (configuration?: Configuration,
|
|
|
26676
27696
|
* @param {*} [options] Override http request option.
|
|
26677
27697
|
* @throws {RequiredError}
|
|
26678
27698
|
*/
|
|
26679
|
-
adminAnalyticsStoreXStoreIDItemsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse> {
|
|
26680
|
-
return localVarFp.adminAnalyticsStoreXStoreIDItemsGet(xStoreID, startTime, endTime, itemIds, itemLimit, minImpressions, maxPosition, sortBy, sortOrder, sort, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
27699
|
+
adminAnalyticsStoreXStoreIDItemsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse> {
|
|
27700
|
+
return localVarFp.adminAnalyticsStoreXStoreIDItemsGet(xStoreID, startTime, endTime, search, itemIds, itemLimit, minImpressions, maxPosition, sortBy, sortOrder, sort, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
26681
27701
|
},
|
|
26682
27702
|
/**
|
|
26683
27703
|
* Retrieve detailed analytics for a specific item including performance metrics and discovery data
|
|
@@ -26714,16 +27734,19 @@ export const ItemAnalyticsApiFactory = function (configuration?: Configuration,
|
|
|
26714
27734
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
26715
27735
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
26716
27736
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
27737
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
26717
27738
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
26718
27739
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
27740
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
26719
27741
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
26720
27742
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
27743
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
26721
27744
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
26722
27745
|
* @param {*} [options] Override http request option.
|
|
26723
27746
|
* @throws {RequiredError}
|
|
26724
27747
|
*/
|
|
26725
|
-
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response> {
|
|
26726
|
-
return localVarFp.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options).then((request) => request(axios, basePath));
|
|
27748
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, itemQueriesSearch?: string, filtersPage?: number, filtersPageSize?: number, itemFiltersSearch?: string, geoPage?: number, geoPageSize?: number, itemGeoSearch?: string, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response> {
|
|
27749
|
+
return localVarFp.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, itemQueriesSearch, filtersPage, filtersPageSize, itemFiltersSearch, geoPage, geoPageSize, itemGeoSearch, groupBy, options).then((request) => request(axios, basePath));
|
|
26727
27750
|
},
|
|
26728
27751
|
/**
|
|
26729
27752
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
@@ -26849,6 +27872,7 @@ export class ItemAnalyticsApi extends BaseAPI {
|
|
|
26849
27872
|
* @param {string} xStoreID Store ID
|
|
26850
27873
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
26851
27874
|
* @param {string} [endTime] End time in RFC3339 format
|
|
27875
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
26852
27876
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
26853
27877
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
26854
27878
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -26864,8 +27888,8 @@ export class ItemAnalyticsApi extends BaseAPI {
|
|
|
26864
27888
|
* @throws {RequiredError}
|
|
26865
27889
|
* @memberof ItemAnalyticsApi
|
|
26866
27890
|
*/
|
|
26867
|
-
public adminAnalyticsStoreXStoreIDItemsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) {
|
|
26868
|
-
return ItemAnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDItemsGet(xStoreID, startTime, endTime, itemIds, itemLimit, minImpressions, maxPosition, sortBy, sortOrder, sort, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
27891
|
+
public adminAnalyticsStoreXStoreIDItemsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) {
|
|
27892
|
+
return ItemAnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDItemsGet(xStoreID, startTime, endTime, search, itemIds, itemLimit, minImpressions, maxPosition, sortBy, sortOrder, sort, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
26869
27893
|
}
|
|
26870
27894
|
|
|
26871
27895
|
/**
|
|
@@ -26905,17 +27929,20 @@ export class ItemAnalyticsApi extends BaseAPI {
|
|
|
26905
27929
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
26906
27930
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
26907
27931
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
27932
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
26908
27933
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
26909
27934
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
27935
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
26910
27936
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
26911
27937
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
27938
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
26912
27939
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
26913
27940
|
* @param {*} [options] Override http request option.
|
|
26914
27941
|
* @throws {RequiredError}
|
|
26915
27942
|
* @memberof ItemAnalyticsApi
|
|
26916
27943
|
*/
|
|
26917
|
-
public adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig) {
|
|
26918
|
-
return ItemAnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options).then((request) => request(this.axios, this.basePath));
|
|
27944
|
+
public adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, itemQueriesSearch?: string, filtersPage?: number, filtersPageSize?: number, itemFiltersSearch?: string, geoPage?: number, geoPageSize?: number, itemGeoSearch?: string, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig) {
|
|
27945
|
+
return ItemAnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, itemQueriesSearch, filtersPage, filtersPageSize, itemFiltersSearch, geoPage, geoPageSize, itemGeoSearch, groupBy, options).then((request) => request(this.axios, this.basePath));
|
|
26919
27946
|
}
|
|
26920
27947
|
|
|
26921
27948
|
/**
|
|
@@ -34019,6 +35046,217 @@ export const QuerySuggestionsManagementApiAxiosParamCreator = function (configur
|
|
|
34019
35046
|
options: localVarRequestOptions,
|
|
34020
35047
|
};
|
|
34021
35048
|
},
|
|
35049
|
+
/**
|
|
35050
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
35051
|
+
* @summary Apply Suggestion Filters
|
|
35052
|
+
* @param {string} xStoreID Store ID
|
|
35053
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
35054
|
+
* @param {*} [options] Override http request option.
|
|
35055
|
+
* @throws {RequiredError}
|
|
35056
|
+
*/
|
|
35057
|
+
adminV1QuerySuggestionsXStoreIDApplyFiltersPost: async (xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35058
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
35059
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDApplyFiltersPost', 'xStoreID', xStoreID)
|
|
35060
|
+
// verify required parameter 'analyticsQuerySuggestionRecord' is not null or undefined
|
|
35061
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDApplyFiltersPost', 'analyticsQuerySuggestionRecord', analyticsQuerySuggestionRecord)
|
|
35062
|
+
const localVarPath = `/admin/v1/query-suggestions/{xStoreID}/apply-filters`
|
|
35063
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
35064
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35065
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35066
|
+
let baseOptions;
|
|
35067
|
+
if (configuration) {
|
|
35068
|
+
baseOptions = configuration.baseOptions;
|
|
35069
|
+
}
|
|
35070
|
+
|
|
35071
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
35072
|
+
const localVarHeaderParameter = {} as any;
|
|
35073
|
+
const localVarQueryParameter = {} as any;
|
|
35074
|
+
|
|
35075
|
+
// authentication BearerAuth required
|
|
35076
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
35077
|
+
|
|
35078
|
+
|
|
35079
|
+
|
|
35080
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
35081
|
+
|
|
35082
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35083
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35084
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35085
|
+
localVarRequestOptions.data = serializeDataIfNeeded(analyticsQuerySuggestionRecord, localVarRequestOptions, configuration)
|
|
35086
|
+
|
|
35087
|
+
return {
|
|
35088
|
+
url: toPathString(localVarUrlObj),
|
|
35089
|
+
options: localVarRequestOptions,
|
|
35090
|
+
};
|
|
35091
|
+
},
|
|
35092
|
+
/**
|
|
35093
|
+
* Delete a banned expression
|
|
35094
|
+
* @summary Delete Banned Expression
|
|
35095
|
+
* @param {string} xStoreID Store ID
|
|
35096
|
+
* @param {string} expressionID Banned Expression ID
|
|
35097
|
+
* @param {*} [options] Override http request option.
|
|
35098
|
+
* @throws {RequiredError}
|
|
35099
|
+
*/
|
|
35100
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete: async (xStoreID: string, expressionID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35101
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
35102
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete', 'xStoreID', xStoreID)
|
|
35103
|
+
// verify required parameter 'expressionID' is not null or undefined
|
|
35104
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete', 'expressionID', expressionID)
|
|
35105
|
+
const localVarPath = `/admin/v1/query-suggestions/{xStoreID}/banned-expressions/{expressionID}`
|
|
35106
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
35107
|
+
.replace(`{${"expressionID"}}`, encodeURIComponent(String(expressionID)));
|
|
35108
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35109
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35110
|
+
let baseOptions;
|
|
35111
|
+
if (configuration) {
|
|
35112
|
+
baseOptions = configuration.baseOptions;
|
|
35113
|
+
}
|
|
35114
|
+
|
|
35115
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
35116
|
+
const localVarHeaderParameter = {} as any;
|
|
35117
|
+
const localVarQueryParameter = {} as any;
|
|
35118
|
+
|
|
35119
|
+
// authentication BearerAuth required
|
|
35120
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
35121
|
+
|
|
35122
|
+
|
|
35123
|
+
|
|
35124
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35125
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35126
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35127
|
+
|
|
35128
|
+
return {
|
|
35129
|
+
url: toPathString(localVarUrlObj),
|
|
35130
|
+
options: localVarRequestOptions,
|
|
35131
|
+
};
|
|
35132
|
+
},
|
|
35133
|
+
/**
|
|
35134
|
+
* Update an existing banned expression
|
|
35135
|
+
* @summary Update Banned Expression
|
|
35136
|
+
* @param {string} xStoreID Store ID
|
|
35137
|
+
* @param {string} expressionID Banned Expression ID
|
|
35138
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
35139
|
+
* @param {*} [options] Override http request option.
|
|
35140
|
+
* @throws {RequiredError}
|
|
35141
|
+
*/
|
|
35142
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut: async (xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35143
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
35144
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut', 'xStoreID', xStoreID)
|
|
35145
|
+
// verify required parameter 'expressionID' is not null or undefined
|
|
35146
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut', 'expressionID', expressionID)
|
|
35147
|
+
// verify required parameter 'analyticsBannedExpression' is not null or undefined
|
|
35148
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut', 'analyticsBannedExpression', analyticsBannedExpression)
|
|
35149
|
+
const localVarPath = `/admin/v1/query-suggestions/{xStoreID}/banned-expressions/{expressionID}`
|
|
35150
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
35151
|
+
.replace(`{${"expressionID"}}`, encodeURIComponent(String(expressionID)));
|
|
35152
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35153
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35154
|
+
let baseOptions;
|
|
35155
|
+
if (configuration) {
|
|
35156
|
+
baseOptions = configuration.baseOptions;
|
|
35157
|
+
}
|
|
35158
|
+
|
|
35159
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
35160
|
+
const localVarHeaderParameter = {} as any;
|
|
35161
|
+
const localVarQueryParameter = {} as any;
|
|
35162
|
+
|
|
35163
|
+
// authentication BearerAuth required
|
|
35164
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
35165
|
+
|
|
35166
|
+
|
|
35167
|
+
|
|
35168
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
35169
|
+
|
|
35170
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35171
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35172
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35173
|
+
localVarRequestOptions.data = serializeDataIfNeeded(analyticsBannedExpression, localVarRequestOptions, configuration)
|
|
35174
|
+
|
|
35175
|
+
return {
|
|
35176
|
+
url: toPathString(localVarUrlObj),
|
|
35177
|
+
options: localVarRequestOptions,
|
|
35178
|
+
};
|
|
35179
|
+
},
|
|
35180
|
+
/**
|
|
35181
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
35182
|
+
* @summary Get Banned Expressions
|
|
35183
|
+
* @param {string} xStoreID Store ID
|
|
35184
|
+
* @param {*} [options] Override http request option.
|
|
35185
|
+
* @throws {RequiredError}
|
|
35186
|
+
*/
|
|
35187
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35188
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
35189
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsGet', 'xStoreID', xStoreID)
|
|
35190
|
+
const localVarPath = `/admin/v1/query-suggestions/{xStoreID}/banned-expressions`
|
|
35191
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
35192
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35193
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35194
|
+
let baseOptions;
|
|
35195
|
+
if (configuration) {
|
|
35196
|
+
baseOptions = configuration.baseOptions;
|
|
35197
|
+
}
|
|
35198
|
+
|
|
35199
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
35200
|
+
const localVarHeaderParameter = {} as any;
|
|
35201
|
+
const localVarQueryParameter = {} as any;
|
|
35202
|
+
|
|
35203
|
+
// authentication BearerAuth required
|
|
35204
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
35205
|
+
|
|
35206
|
+
|
|
35207
|
+
|
|
35208
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35209
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35210
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35211
|
+
|
|
35212
|
+
return {
|
|
35213
|
+
url: toPathString(localVarUrlObj),
|
|
35214
|
+
options: localVarRequestOptions,
|
|
35215
|
+
};
|
|
35216
|
+
},
|
|
35217
|
+
/**
|
|
35218
|
+
* Create a new banned expression with specified matching type
|
|
35219
|
+
* @summary Create Banned Expression
|
|
35220
|
+
* @param {string} xStoreID Store ID
|
|
35221
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
35222
|
+
* @param {*} [options] Override http request option.
|
|
35223
|
+
* @throws {RequiredError}
|
|
35224
|
+
*/
|
|
35225
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsPost: async (xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35226
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
35227
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsPost', 'xStoreID', xStoreID)
|
|
35228
|
+
// verify required parameter 'analyticsBannedExpression' is not null or undefined
|
|
35229
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsPost', 'analyticsBannedExpression', analyticsBannedExpression)
|
|
35230
|
+
const localVarPath = `/admin/v1/query-suggestions/{xStoreID}/banned-expressions`
|
|
35231
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
35232
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35233
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35234
|
+
let baseOptions;
|
|
35235
|
+
if (configuration) {
|
|
35236
|
+
baseOptions = configuration.baseOptions;
|
|
35237
|
+
}
|
|
35238
|
+
|
|
35239
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
35240
|
+
const localVarHeaderParameter = {} as any;
|
|
35241
|
+
const localVarQueryParameter = {} as any;
|
|
35242
|
+
|
|
35243
|
+
// authentication BearerAuth required
|
|
35244
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
35245
|
+
|
|
35246
|
+
|
|
35247
|
+
|
|
35248
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
35249
|
+
|
|
35250
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35251
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35252
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35253
|
+
localVarRequestOptions.data = serializeDataIfNeeded(analyticsBannedExpression, localVarRequestOptions, configuration)
|
|
35254
|
+
|
|
35255
|
+
return {
|
|
35256
|
+
url: toPathString(localVarUrlObj),
|
|
35257
|
+
options: localVarRequestOptions,
|
|
35258
|
+
};
|
|
35259
|
+
},
|
|
34022
35260
|
/**
|
|
34023
35261
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
34024
35262
|
* @summary Bulk Update Suggestions
|
|
@@ -34194,6 +35432,80 @@ export const QuerySuggestionsManagementApiAxiosParamCreator = function (configur
|
|
|
34194
35432
|
options: localVarRequestOptions,
|
|
34195
35433
|
};
|
|
34196
35434
|
},
|
|
35435
|
+
/**
|
|
35436
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
35437
|
+
* @summary Generate Enhanced Category Suggestions
|
|
35438
|
+
* @param {string} xStoreID Store ID
|
|
35439
|
+
* @param {*} [options] Override http request option.
|
|
35440
|
+
* @throws {RequiredError}
|
|
35441
|
+
*/
|
|
35442
|
+
adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35443
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
35444
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost', 'xStoreID', xStoreID)
|
|
35445
|
+
const localVarPath = `/admin/v1/query-suggestions/{xStoreID}/generate-categories`
|
|
35446
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
35447
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35448
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35449
|
+
let baseOptions;
|
|
35450
|
+
if (configuration) {
|
|
35451
|
+
baseOptions = configuration.baseOptions;
|
|
35452
|
+
}
|
|
35453
|
+
|
|
35454
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
35455
|
+
const localVarHeaderParameter = {} as any;
|
|
35456
|
+
const localVarQueryParameter = {} as any;
|
|
35457
|
+
|
|
35458
|
+
// authentication BearerAuth required
|
|
35459
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
35460
|
+
|
|
35461
|
+
|
|
35462
|
+
|
|
35463
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35464
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35465
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35466
|
+
|
|
35467
|
+
return {
|
|
35468
|
+
url: toPathString(localVarUrlObj),
|
|
35469
|
+
options: localVarRequestOptions,
|
|
35470
|
+
};
|
|
35471
|
+
},
|
|
35472
|
+
/**
|
|
35473
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
35474
|
+
* @summary Generate Facet-Based Suggestions
|
|
35475
|
+
* @param {string} xStoreID Store ID
|
|
35476
|
+
* @param {*} [options] Override http request option.
|
|
35477
|
+
* @throws {RequiredError}
|
|
35478
|
+
*/
|
|
35479
|
+
adminV1QuerySuggestionsXStoreIDGenerateFacetsPost: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35480
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
35481
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDGenerateFacetsPost', 'xStoreID', xStoreID)
|
|
35482
|
+
const localVarPath = `/admin/v1/query-suggestions/{xStoreID}/generate-facets`
|
|
35483
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
35484
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35485
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35486
|
+
let baseOptions;
|
|
35487
|
+
if (configuration) {
|
|
35488
|
+
baseOptions = configuration.baseOptions;
|
|
35489
|
+
}
|
|
35490
|
+
|
|
35491
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
35492
|
+
const localVarHeaderParameter = {} as any;
|
|
35493
|
+
const localVarQueryParameter = {} as any;
|
|
35494
|
+
|
|
35495
|
+
// authentication BearerAuth required
|
|
35496
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
35497
|
+
|
|
35498
|
+
|
|
35499
|
+
|
|
35500
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35501
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35502
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35503
|
+
|
|
35504
|
+
return {
|
|
35505
|
+
url: toPathString(localVarUrlObj),
|
|
35506
|
+
options: localVarRequestOptions,
|
|
35507
|
+
};
|
|
35508
|
+
},
|
|
34197
35509
|
/**
|
|
34198
35510
|
* Retrieve query suggestions with filtering and pagination for management
|
|
34199
35511
|
* @summary Get Query Suggestions
|
|
@@ -34981,6 +36293,76 @@ export const QuerySuggestionsManagementApiFp = function(configuration?: Configur
|
|
|
34981
36293
|
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsMigrateAllPost']?.[localVarOperationServerIndex]?.url;
|
|
34982
36294
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34983
36295
|
},
|
|
36296
|
+
/**
|
|
36297
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
36298
|
+
* @summary Apply Suggestion Filters
|
|
36299
|
+
* @param {string} xStoreID Store ID
|
|
36300
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
36301
|
+
* @param {*} [options] Override http request option.
|
|
36302
|
+
* @throws {RequiredError}
|
|
36303
|
+
*/
|
|
36304
|
+
async adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>> {
|
|
36305
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID, analyticsQuerySuggestionRecord, options);
|
|
36306
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36307
|
+
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDApplyFiltersPost']?.[localVarOperationServerIndex]?.url;
|
|
36308
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36309
|
+
},
|
|
36310
|
+
/**
|
|
36311
|
+
* Delete a banned expression
|
|
36312
|
+
* @summary Delete Banned Expression
|
|
36313
|
+
* @param {string} xStoreID Store ID
|
|
36314
|
+
* @param {string} expressionID Banned Expression ID
|
|
36315
|
+
* @param {*} [options] Override http request option.
|
|
36316
|
+
* @throws {RequiredError}
|
|
36317
|
+
*/
|
|
36318
|
+
async adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID: string, expressionID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>> {
|
|
36319
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID, expressionID, options);
|
|
36320
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36321
|
+
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete']?.[localVarOperationServerIndex]?.url;
|
|
36322
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36323
|
+
},
|
|
36324
|
+
/**
|
|
36325
|
+
* Update an existing banned expression
|
|
36326
|
+
* @summary Update Banned Expression
|
|
36327
|
+
* @param {string} xStoreID Store ID
|
|
36328
|
+
* @param {string} expressionID Banned Expression ID
|
|
36329
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
36330
|
+
* @param {*} [options] Override http request option.
|
|
36331
|
+
* @throws {RequiredError}
|
|
36332
|
+
*/
|
|
36333
|
+
async adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response>> {
|
|
36334
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID, expressionID, analyticsBannedExpression, options);
|
|
36335
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36336
|
+
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut']?.[localVarOperationServerIndex]?.url;
|
|
36337
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36338
|
+
},
|
|
36339
|
+
/**
|
|
36340
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
36341
|
+
* @summary Get Banned Expressions
|
|
36342
|
+
* @param {string} xStoreID Store ID
|
|
36343
|
+
* @param {*} [options] Override http request option.
|
|
36344
|
+
* @throws {RequiredError}
|
|
36345
|
+
*/
|
|
36346
|
+
async adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response>> {
|
|
36347
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID, options);
|
|
36348
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36349
|
+
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDBannedExpressionsGet']?.[localVarOperationServerIndex]?.url;
|
|
36350
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36351
|
+
},
|
|
36352
|
+
/**
|
|
36353
|
+
* Create a new banned expression with specified matching type
|
|
36354
|
+
* @summary Create Banned Expression
|
|
36355
|
+
* @param {string} xStoreID Store ID
|
|
36356
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
36357
|
+
* @param {*} [options] Override http request option.
|
|
36358
|
+
* @throws {RequiredError}
|
|
36359
|
+
*/
|
|
36360
|
+
async adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response>> {
|
|
36361
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID, analyticsBannedExpression, options);
|
|
36362
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36363
|
+
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDBannedExpressionsPost']?.[localVarOperationServerIndex]?.url;
|
|
36364
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36365
|
+
},
|
|
34984
36366
|
/**
|
|
34985
36367
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
34986
36368
|
* @summary Bulk Update Suggestions
|
|
@@ -35038,6 +36420,32 @@ export const QuerySuggestionsManagementApiFp = function(configuration?: Configur
|
|
|
35038
36420
|
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDConfigPut']?.[localVarOperationServerIndex]?.url;
|
|
35039
36421
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
35040
36422
|
},
|
|
36423
|
+
/**
|
|
36424
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
36425
|
+
* @summary Generate Enhanced Category Suggestions
|
|
36426
|
+
* @param {string} xStoreID Store ID
|
|
36427
|
+
* @param {*} [options] Override http request option.
|
|
36428
|
+
* @throws {RequiredError}
|
|
36429
|
+
*/
|
|
36430
|
+
async adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response>> {
|
|
36431
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID, options);
|
|
36432
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36433
|
+
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost']?.[localVarOperationServerIndex]?.url;
|
|
36434
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36435
|
+
},
|
|
36436
|
+
/**
|
|
36437
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
36438
|
+
* @summary Generate Facet-Based Suggestions
|
|
36439
|
+
* @param {string} xStoreID Store ID
|
|
36440
|
+
* @param {*} [options] Override http request option.
|
|
36441
|
+
* @throws {RequiredError}
|
|
36442
|
+
*/
|
|
36443
|
+
async adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response>> {
|
|
36444
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID, options);
|
|
36445
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36446
|
+
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDGenerateFacetsPost']?.[localVarOperationServerIndex]?.url;
|
|
36447
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36448
|
+
},
|
|
35041
36449
|
/**
|
|
35042
36450
|
* Retrieve query suggestions with filtering and pagination for management
|
|
35043
36451
|
* @summary Get Query Suggestions
|
|
@@ -35066,7 +36474,7 @@ export const QuerySuggestionsManagementApiFp = function(configuration?: Configur
|
|
|
35066
36474
|
* @param {*} [options] Override http request option.
|
|
35067
36475
|
* @throws {RequiredError}
|
|
35068
36476
|
*/
|
|
35069
|
-
async adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
36477
|
+
async adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>> {
|
|
35070
36478
|
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDImportPost(xStoreID, analyticsImportQuerySuggestionsRequest, options);
|
|
35071
36479
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
35072
36480
|
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDImportPost']?.[localVarOperationServerIndex]?.url;
|
|
@@ -35137,7 +36545,7 @@ export const QuerySuggestionsManagementApiFp = function(configuration?: Configur
|
|
|
35137
36545
|
* @param {*} [options] Override http request option.
|
|
35138
36546
|
* @throws {RequiredError}
|
|
35139
36547
|
*/
|
|
35140
|
-
async adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
36548
|
+
async adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>> {
|
|
35141
36549
|
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID, analyticsPromoteSuggestionsRequest, options);
|
|
35142
36550
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
35143
36551
|
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDPromotePost']?.[localVarOperationServerIndex]?.url;
|
|
@@ -35306,6 +36714,61 @@ export const QuerySuggestionsManagementApiFactory = function (configuration?: Co
|
|
|
35306
36714
|
adminV1QuerySuggestionsMigrateAllPost(daysBack?: number, minPopularity?: number, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse> {
|
|
35307
36715
|
return localVarFp.adminV1QuerySuggestionsMigrateAllPost(daysBack, minPopularity, options).then((request) => request(axios, basePath));
|
|
35308
36716
|
},
|
|
36717
|
+
/**
|
|
36718
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
36719
|
+
* @summary Apply Suggestion Filters
|
|
36720
|
+
* @param {string} xStoreID Store ID
|
|
36721
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
36722
|
+
* @param {*} [options] Override http request option.
|
|
36723
|
+
* @throws {RequiredError}
|
|
36724
|
+
*/
|
|
36725
|
+
adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response> {
|
|
36726
|
+
return localVarFp.adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID, analyticsQuerySuggestionRecord, options).then((request) => request(axios, basePath));
|
|
36727
|
+
},
|
|
36728
|
+
/**
|
|
36729
|
+
* Delete a banned expression
|
|
36730
|
+
* @summary Delete Banned Expression
|
|
36731
|
+
* @param {string} xStoreID Store ID
|
|
36732
|
+
* @param {string} expressionID Banned Expression ID
|
|
36733
|
+
* @param {*} [options] Override http request option.
|
|
36734
|
+
* @throws {RequiredError}
|
|
36735
|
+
*/
|
|
36736
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID: string, expressionID: string, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse> {
|
|
36737
|
+
return localVarFp.adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID, expressionID, options).then((request) => request(axios, basePath));
|
|
36738
|
+
},
|
|
36739
|
+
/**
|
|
36740
|
+
* Update an existing banned expression
|
|
36741
|
+
* @summary Update Banned Expression
|
|
36742
|
+
* @param {string} xStoreID Store ID
|
|
36743
|
+
* @param {string} expressionID Banned Expression ID
|
|
36744
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
36745
|
+
* @param {*} [options] Override http request option.
|
|
36746
|
+
* @throws {RequiredError}
|
|
36747
|
+
*/
|
|
36748
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response> {
|
|
36749
|
+
return localVarFp.adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID, expressionID, analyticsBannedExpression, options).then((request) => request(axios, basePath));
|
|
36750
|
+
},
|
|
36751
|
+
/**
|
|
36752
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
36753
|
+
* @summary Get Banned Expressions
|
|
36754
|
+
* @param {string} xStoreID Store ID
|
|
36755
|
+
* @param {*} [options] Override http request option.
|
|
36756
|
+
* @throws {RequiredError}
|
|
36757
|
+
*/
|
|
36758
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response> {
|
|
36759
|
+
return localVarFp.adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
36760
|
+
},
|
|
36761
|
+
/**
|
|
36762
|
+
* Create a new banned expression with specified matching type
|
|
36763
|
+
* @summary Create Banned Expression
|
|
36764
|
+
* @param {string} xStoreID Store ID
|
|
36765
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
36766
|
+
* @param {*} [options] Override http request option.
|
|
36767
|
+
* @throws {RequiredError}
|
|
36768
|
+
*/
|
|
36769
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response> {
|
|
36770
|
+
return localVarFp.adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID, analyticsBannedExpression, options).then((request) => request(axios, basePath));
|
|
36771
|
+
},
|
|
35309
36772
|
/**
|
|
35310
36773
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
35311
36774
|
* @summary Bulk Update Suggestions
|
|
@@ -35351,6 +36814,26 @@ export const QuerySuggestionsManagementApiFactory = function (configuration?: Co
|
|
|
35351
36814
|
adminV1QuerySuggestionsXStoreIDConfigPut(xStoreID: string, analyticsUpdateSuggestionConfigRequest: AnalyticsUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDConfigGet200Response> {
|
|
35352
36815
|
return localVarFp.adminV1QuerySuggestionsXStoreIDConfigPut(xStoreID, analyticsUpdateSuggestionConfigRequest, options).then((request) => request(axios, basePath));
|
|
35353
36816
|
},
|
|
36817
|
+
/**
|
|
36818
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
36819
|
+
* @summary Generate Enhanced Category Suggestions
|
|
36820
|
+
* @param {string} xStoreID Store ID
|
|
36821
|
+
* @param {*} [options] Override http request option.
|
|
36822
|
+
* @throws {RequiredError}
|
|
36823
|
+
*/
|
|
36824
|
+
adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response> {
|
|
36825
|
+
return localVarFp.adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID, options).then((request) => request(axios, basePath));
|
|
36826
|
+
},
|
|
36827
|
+
/**
|
|
36828
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
36829
|
+
* @summary Generate Facet-Based Suggestions
|
|
36830
|
+
* @param {string} xStoreID Store ID
|
|
36831
|
+
* @param {*} [options] Override http request option.
|
|
36832
|
+
* @throws {RequiredError}
|
|
36833
|
+
*/
|
|
36834
|
+
adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response> {
|
|
36835
|
+
return localVarFp.adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID, options).then((request) => request(axios, basePath));
|
|
36836
|
+
},
|
|
35354
36837
|
/**
|
|
35355
36838
|
* Retrieve query suggestions with filtering and pagination for management
|
|
35356
36839
|
* @summary Get Query Suggestions
|
|
@@ -35376,7 +36859,7 @@ export const QuerySuggestionsManagementApiFactory = function (configuration?: Co
|
|
|
35376
36859
|
* @param {*} [options] Override http request option.
|
|
35377
36860
|
* @throws {RequiredError}
|
|
35378
36861
|
*/
|
|
35379
|
-
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
36862
|
+
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response> {
|
|
35380
36863
|
return localVarFp.adminV1QuerySuggestionsXStoreIDImportPost(xStoreID, analyticsImportQuerySuggestionsRequest, options).then((request) => request(axios, basePath));
|
|
35381
36864
|
},
|
|
35382
36865
|
/**
|
|
@@ -35432,7 +36915,7 @@ export const QuerySuggestionsManagementApiFactory = function (configuration?: Co
|
|
|
35432
36915
|
* @param {*} [options] Override http request option.
|
|
35433
36916
|
* @throws {RequiredError}
|
|
35434
36917
|
*/
|
|
35435
|
-
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
36918
|
+
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response> {
|
|
35436
36919
|
return localVarFp.adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID, analyticsPromoteSuggestionsRequest, options).then((request) => request(axios, basePath));
|
|
35437
36920
|
},
|
|
35438
36921
|
/**
|
|
@@ -35570,6 +37053,71 @@ export class QuerySuggestionsManagementApi extends BaseAPI {
|
|
|
35570
37053
|
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsMigrateAllPost(daysBack, minPopularity, options).then((request) => request(this.axios, this.basePath));
|
|
35571
37054
|
}
|
|
35572
37055
|
|
|
37056
|
+
/**
|
|
37057
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
37058
|
+
* @summary Apply Suggestion Filters
|
|
37059
|
+
* @param {string} xStoreID Store ID
|
|
37060
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
37061
|
+
* @param {*} [options] Override http request option.
|
|
37062
|
+
* @throws {RequiredError}
|
|
37063
|
+
* @memberof QuerySuggestionsManagementApi
|
|
37064
|
+
*/
|
|
37065
|
+
public adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options?: RawAxiosRequestConfig) {
|
|
37066
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID, analyticsQuerySuggestionRecord, options).then((request) => request(this.axios, this.basePath));
|
|
37067
|
+
}
|
|
37068
|
+
|
|
37069
|
+
/**
|
|
37070
|
+
* Delete a banned expression
|
|
37071
|
+
* @summary Delete Banned Expression
|
|
37072
|
+
* @param {string} xStoreID Store ID
|
|
37073
|
+
* @param {string} expressionID Banned Expression ID
|
|
37074
|
+
* @param {*} [options] Override http request option.
|
|
37075
|
+
* @throws {RequiredError}
|
|
37076
|
+
* @memberof QuerySuggestionsManagementApi
|
|
37077
|
+
*/
|
|
37078
|
+
public adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID: string, expressionID: string, options?: RawAxiosRequestConfig) {
|
|
37079
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID, expressionID, options).then((request) => request(this.axios, this.basePath));
|
|
37080
|
+
}
|
|
37081
|
+
|
|
37082
|
+
/**
|
|
37083
|
+
* Update an existing banned expression
|
|
37084
|
+
* @summary Update Banned Expression
|
|
37085
|
+
* @param {string} xStoreID Store ID
|
|
37086
|
+
* @param {string} expressionID Banned Expression ID
|
|
37087
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
37088
|
+
* @param {*} [options] Override http request option.
|
|
37089
|
+
* @throws {RequiredError}
|
|
37090
|
+
* @memberof QuerySuggestionsManagementApi
|
|
37091
|
+
*/
|
|
37092
|
+
public adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig) {
|
|
37093
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID, expressionID, analyticsBannedExpression, options).then((request) => request(this.axios, this.basePath));
|
|
37094
|
+
}
|
|
37095
|
+
|
|
37096
|
+
/**
|
|
37097
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
37098
|
+
* @summary Get Banned Expressions
|
|
37099
|
+
* @param {string} xStoreID Store ID
|
|
37100
|
+
* @param {*} [options] Override http request option.
|
|
37101
|
+
* @throws {RequiredError}
|
|
37102
|
+
* @memberof QuerySuggestionsManagementApi
|
|
37103
|
+
*/
|
|
37104
|
+
public adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID: string, options?: RawAxiosRequestConfig) {
|
|
37105
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
37106
|
+
}
|
|
37107
|
+
|
|
37108
|
+
/**
|
|
37109
|
+
* Create a new banned expression with specified matching type
|
|
37110
|
+
* @summary Create Banned Expression
|
|
37111
|
+
* @param {string} xStoreID Store ID
|
|
37112
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
37113
|
+
* @param {*} [options] Override http request option.
|
|
37114
|
+
* @throws {RequiredError}
|
|
37115
|
+
* @memberof QuerySuggestionsManagementApi
|
|
37116
|
+
*/
|
|
37117
|
+
public adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig) {
|
|
37118
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID, analyticsBannedExpression, options).then((request) => request(this.axios, this.basePath));
|
|
37119
|
+
}
|
|
37120
|
+
|
|
35573
37121
|
/**
|
|
35574
37122
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
35575
37123
|
* @summary Bulk Update Suggestions
|
|
@@ -35623,6 +37171,30 @@ export class QuerySuggestionsManagementApi extends BaseAPI {
|
|
|
35623
37171
|
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDConfigPut(xStoreID, analyticsUpdateSuggestionConfigRequest, options).then((request) => request(this.axios, this.basePath));
|
|
35624
37172
|
}
|
|
35625
37173
|
|
|
37174
|
+
/**
|
|
37175
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
37176
|
+
* @summary Generate Enhanced Category Suggestions
|
|
37177
|
+
* @param {string} xStoreID Store ID
|
|
37178
|
+
* @param {*} [options] Override http request option.
|
|
37179
|
+
* @throws {RequiredError}
|
|
37180
|
+
* @memberof QuerySuggestionsManagementApi
|
|
37181
|
+
*/
|
|
37182
|
+
public adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID: string, options?: RawAxiosRequestConfig) {
|
|
37183
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
37184
|
+
}
|
|
37185
|
+
|
|
37186
|
+
/**
|
|
37187
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
37188
|
+
* @summary Generate Facet-Based Suggestions
|
|
37189
|
+
* @param {string} xStoreID Store ID
|
|
37190
|
+
* @param {*} [options] Override http request option.
|
|
37191
|
+
* @throws {RequiredError}
|
|
37192
|
+
* @memberof QuerySuggestionsManagementApi
|
|
37193
|
+
*/
|
|
37194
|
+
public adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID: string, options?: RawAxiosRequestConfig) {
|
|
37195
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
37196
|
+
}
|
|
37197
|
+
|
|
35626
37198
|
/**
|
|
35627
37199
|
* Retrieve query suggestions with filtering and pagination for management
|
|
35628
37200
|
* @summary Get Query Suggestions
|
|
@@ -35974,13 +37546,13 @@ export const RefundManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
35974
37546
|
};
|
|
35975
37547
|
},
|
|
35976
37548
|
/**
|
|
35977
|
-
* Gets the current status and details of a refund request
|
|
37549
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
35978
37550
|
* @summary Get refund request status
|
|
35979
|
-
* @param {
|
|
37551
|
+
* @param {string} id Refund ID (UUID)
|
|
35980
37552
|
* @param {*} [options] Override http request option.
|
|
35981
37553
|
* @throws {RequiredError}
|
|
35982
37554
|
*/
|
|
35983
|
-
paymentGatewayRefundStatusIdGet: async (id:
|
|
37555
|
+
paymentGatewayRefundStatusIdGet: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35984
37556
|
// verify required parameter 'id' is not null or undefined
|
|
35985
37557
|
assertParamExists('paymentGatewayRefundStatusIdGet', 'id', id)
|
|
35986
37558
|
const localVarPath = `/payment-gateway/refund-status/{id}`
|
|
@@ -36142,13 +37714,13 @@ export const RefundManagementApiFp = function(configuration?: Configuration) {
|
|
|
36142
37714
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36143
37715
|
},
|
|
36144
37716
|
/**
|
|
36145
|
-
* Gets the current status and details of a refund request
|
|
37717
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
36146
37718
|
* @summary Get refund request status
|
|
36147
|
-
* @param {
|
|
37719
|
+
* @param {string} id Refund ID (UUID)
|
|
36148
37720
|
* @param {*} [options] Override http request option.
|
|
36149
37721
|
* @throws {RequiredError}
|
|
36150
37722
|
*/
|
|
36151
|
-
async paymentGatewayRefundStatusIdGet(id:
|
|
37723
|
+
async paymentGatewayRefundStatusIdGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRefundStatusDto>> {
|
|
36152
37724
|
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayRefundStatusIdGet(id, options);
|
|
36153
37725
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36154
37726
|
const localVarOperationServerBasePath = operationServerMap['RefundManagementApi.paymentGatewayRefundStatusIdGet']?.[localVarOperationServerIndex]?.url;
|
|
@@ -36216,13 +37788,13 @@ export const RefundManagementApiFactory = function (configuration?: Configuratio
|
|
|
36216
37788
|
return localVarFp.paymentGatewayRefundRequestPost(dataTypesCreateRefundRequestDto, options).then((request) => request(axios, basePath));
|
|
36217
37789
|
},
|
|
36218
37790
|
/**
|
|
36219
|
-
* Gets the current status and details of a refund request
|
|
37791
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
36220
37792
|
* @summary Get refund request status
|
|
36221
|
-
* @param {
|
|
37793
|
+
* @param {string} id Refund ID (UUID)
|
|
36222
37794
|
* @param {*} [options] Override http request option.
|
|
36223
37795
|
* @throws {RequiredError}
|
|
36224
37796
|
*/
|
|
36225
|
-
paymentGatewayRefundStatusIdGet(id:
|
|
37797
|
+
paymentGatewayRefundStatusIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRefundStatusDto> {
|
|
36226
37798
|
return localVarFp.paymentGatewayRefundStatusIdGet(id, options).then((request) => request(axios, basePath));
|
|
36227
37799
|
},
|
|
36228
37800
|
/**
|
|
@@ -36290,14 +37862,14 @@ export class RefundManagementApi extends BaseAPI {
|
|
|
36290
37862
|
}
|
|
36291
37863
|
|
|
36292
37864
|
/**
|
|
36293
|
-
* Gets the current status and details of a refund request
|
|
37865
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
36294
37866
|
* @summary Get refund request status
|
|
36295
|
-
* @param {
|
|
37867
|
+
* @param {string} id Refund ID (UUID)
|
|
36296
37868
|
* @param {*} [options] Override http request option.
|
|
36297
37869
|
* @throws {RequiredError}
|
|
36298
37870
|
* @memberof RefundManagementApi
|
|
36299
37871
|
*/
|
|
36300
|
-
public paymentGatewayRefundStatusIdGet(id:
|
|
37872
|
+
public paymentGatewayRefundStatusIdGet(id: string, options?: RawAxiosRequestConfig) {
|
|
36301
37873
|
return RefundManagementApiFp(this.configuration).paymentGatewayRefundStatusIdGet(id, options).then((request) => request(this.axios, this.basePath));
|
|
36302
37874
|
}
|
|
36303
37875
|
|