@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/dist/esm/api.d.ts
CHANGED
|
@@ -746,6 +746,135 @@ export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
|
|
|
746
746
|
*/
|
|
747
747
|
'total'?: number;
|
|
748
748
|
}
|
|
749
|
+
/**
|
|
750
|
+
*
|
|
751
|
+
* @export
|
|
752
|
+
* @interface AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
753
|
+
*/
|
|
754
|
+
export interface AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response {
|
|
755
|
+
/**
|
|
756
|
+
* Comparison metadata when in compare mode
|
|
757
|
+
* @type {AnalyticsComparisonMeta}
|
|
758
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
759
|
+
*/
|
|
760
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
761
|
+
/**
|
|
762
|
+
*
|
|
763
|
+
* @type {Array<AnalyticsQuerySuggestionRecord>}
|
|
764
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
765
|
+
*/
|
|
766
|
+
'data'?: Array<AnalyticsQuerySuggestionRecord>;
|
|
767
|
+
/**
|
|
768
|
+
*
|
|
769
|
+
* @type {string}
|
|
770
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
771
|
+
*/
|
|
772
|
+
'error'?: string;
|
|
773
|
+
/**
|
|
774
|
+
*
|
|
775
|
+
* @type {string}
|
|
776
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
777
|
+
*/
|
|
778
|
+
'status'?: string;
|
|
779
|
+
/**
|
|
780
|
+
*
|
|
781
|
+
* @type {string}
|
|
782
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
783
|
+
*/
|
|
784
|
+
'timestamp'?: string;
|
|
785
|
+
/**
|
|
786
|
+
*
|
|
787
|
+
* @type {number}
|
|
788
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
789
|
+
*/
|
|
790
|
+
'total'?: number;
|
|
791
|
+
}
|
|
792
|
+
/**
|
|
793
|
+
*
|
|
794
|
+
* @export
|
|
795
|
+
* @interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
796
|
+
*/
|
|
797
|
+
export interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response {
|
|
798
|
+
/**
|
|
799
|
+
* Comparison metadata when in compare mode
|
|
800
|
+
* @type {AnalyticsComparisonMeta}
|
|
801
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
802
|
+
*/
|
|
803
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
804
|
+
/**
|
|
805
|
+
*
|
|
806
|
+
* @type {Array<AnalyticsBannedExpression>}
|
|
807
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
808
|
+
*/
|
|
809
|
+
'data'?: Array<AnalyticsBannedExpression>;
|
|
810
|
+
/**
|
|
811
|
+
*
|
|
812
|
+
* @type {string}
|
|
813
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
814
|
+
*/
|
|
815
|
+
'error'?: string;
|
|
816
|
+
/**
|
|
817
|
+
*
|
|
818
|
+
* @type {string}
|
|
819
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
820
|
+
*/
|
|
821
|
+
'status'?: string;
|
|
822
|
+
/**
|
|
823
|
+
*
|
|
824
|
+
* @type {string}
|
|
825
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
826
|
+
*/
|
|
827
|
+
'timestamp'?: string;
|
|
828
|
+
/**
|
|
829
|
+
*
|
|
830
|
+
* @type {number}
|
|
831
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
832
|
+
*/
|
|
833
|
+
'total'?: number;
|
|
834
|
+
}
|
|
835
|
+
/**
|
|
836
|
+
*
|
|
837
|
+
* @export
|
|
838
|
+
* @interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
839
|
+
*/
|
|
840
|
+
export interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response {
|
|
841
|
+
/**
|
|
842
|
+
* Comparison metadata when in compare mode
|
|
843
|
+
* @type {AnalyticsComparisonMeta}
|
|
844
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
845
|
+
*/
|
|
846
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
847
|
+
/**
|
|
848
|
+
*
|
|
849
|
+
* @type {AnalyticsBannedExpression}
|
|
850
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
851
|
+
*/
|
|
852
|
+
'data'?: AnalyticsBannedExpression;
|
|
853
|
+
/**
|
|
854
|
+
*
|
|
855
|
+
* @type {string}
|
|
856
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
857
|
+
*/
|
|
858
|
+
'error'?: string;
|
|
859
|
+
/**
|
|
860
|
+
*
|
|
861
|
+
* @type {string}
|
|
862
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
863
|
+
*/
|
|
864
|
+
'status'?: string;
|
|
865
|
+
/**
|
|
866
|
+
*
|
|
867
|
+
* @type {string}
|
|
868
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
869
|
+
*/
|
|
870
|
+
'timestamp'?: string;
|
|
871
|
+
/**
|
|
872
|
+
*
|
|
873
|
+
* @type {number}
|
|
874
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
875
|
+
*/
|
|
876
|
+
'total'?: number;
|
|
877
|
+
}
|
|
749
878
|
/**
|
|
750
879
|
*
|
|
751
880
|
* @export
|
|
@@ -835,86 +964,129 @@ export interface AdminV1QuerySuggestionsXStoreIDConfigGet200Response {
|
|
|
835
964
|
/**
|
|
836
965
|
*
|
|
837
966
|
* @export
|
|
838
|
-
* @interface
|
|
967
|
+
* @interface AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
839
968
|
*/
|
|
840
|
-
export interface
|
|
969
|
+
export interface AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response {
|
|
841
970
|
/**
|
|
842
971
|
* Comparison metadata when in compare mode
|
|
843
972
|
* @type {AnalyticsComparisonMeta}
|
|
844
|
-
* @memberof
|
|
973
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
845
974
|
*/
|
|
846
975
|
'comparison'?: AnalyticsComparisonMeta;
|
|
847
976
|
/**
|
|
848
977
|
*
|
|
849
|
-
* @type {
|
|
850
|
-
* @memberof
|
|
978
|
+
* @type {Array<AnalyticsEnhancedCategorySuggestion>}
|
|
979
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
851
980
|
*/
|
|
852
|
-
'data'?:
|
|
981
|
+
'data'?: Array<AnalyticsEnhancedCategorySuggestion>;
|
|
853
982
|
/**
|
|
854
983
|
*
|
|
855
984
|
* @type {string}
|
|
856
|
-
* @memberof
|
|
985
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
857
986
|
*/
|
|
858
987
|
'error'?: string;
|
|
859
988
|
/**
|
|
860
989
|
*
|
|
861
990
|
* @type {string}
|
|
862
|
-
* @memberof
|
|
991
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
863
992
|
*/
|
|
864
993
|
'status'?: string;
|
|
865
994
|
/**
|
|
866
995
|
*
|
|
867
996
|
* @type {string}
|
|
868
|
-
* @memberof
|
|
997
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
869
998
|
*/
|
|
870
999
|
'timestamp'?: string;
|
|
871
1000
|
/**
|
|
872
1001
|
*
|
|
873
1002
|
* @type {number}
|
|
874
|
-
* @memberof
|
|
1003
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
875
1004
|
*/
|
|
876
1005
|
'total'?: number;
|
|
877
1006
|
}
|
|
878
1007
|
/**
|
|
879
1008
|
*
|
|
880
1009
|
* @export
|
|
881
|
-
* @interface
|
|
1010
|
+
* @interface AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
882
1011
|
*/
|
|
883
|
-
export interface
|
|
1012
|
+
export interface AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response {
|
|
884
1013
|
/**
|
|
885
1014
|
* Comparison metadata when in compare mode
|
|
886
1015
|
* @type {AnalyticsComparisonMeta}
|
|
887
|
-
* @memberof
|
|
1016
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
888
1017
|
*/
|
|
889
1018
|
'comparison'?: AnalyticsComparisonMeta;
|
|
890
1019
|
/**
|
|
891
1020
|
*
|
|
892
|
-
* @type {Array<
|
|
893
|
-
* @memberof
|
|
1021
|
+
* @type {Array<AnalyticsFacetSuggestion>}
|
|
1022
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
894
1023
|
*/
|
|
895
|
-
'data'?: Array<
|
|
1024
|
+
'data'?: Array<AnalyticsFacetSuggestion>;
|
|
1025
|
+
/**
|
|
1026
|
+
*
|
|
1027
|
+
* @type {string}
|
|
1028
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1029
|
+
*/
|
|
1030
|
+
'error'?: string;
|
|
1031
|
+
/**
|
|
1032
|
+
*
|
|
1033
|
+
* @type {string}
|
|
1034
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1035
|
+
*/
|
|
1036
|
+
'status'?: string;
|
|
1037
|
+
/**
|
|
1038
|
+
*
|
|
1039
|
+
* @type {string}
|
|
1040
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1041
|
+
*/
|
|
1042
|
+
'timestamp'?: string;
|
|
1043
|
+
/**
|
|
1044
|
+
*
|
|
1045
|
+
* @type {number}
|
|
1046
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1047
|
+
*/
|
|
1048
|
+
'total'?: number;
|
|
1049
|
+
}
|
|
1050
|
+
/**
|
|
1051
|
+
*
|
|
1052
|
+
* @export
|
|
1053
|
+
* @interface AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
1054
|
+
*/
|
|
1055
|
+
export interface AdminV1QuerySuggestionsXStoreIDGet200Response {
|
|
1056
|
+
/**
|
|
1057
|
+
* Comparison metadata when in compare mode
|
|
1058
|
+
* @type {AnalyticsComparisonMeta}
|
|
1059
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
1060
|
+
*/
|
|
1061
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
1062
|
+
/**
|
|
1063
|
+
*
|
|
1064
|
+
* @type {AnalyticsQuerySuggestionManagementResponse}
|
|
1065
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
1066
|
+
*/
|
|
1067
|
+
'data'?: AnalyticsQuerySuggestionManagementResponse;
|
|
896
1068
|
/**
|
|
897
1069
|
*
|
|
898
1070
|
* @type {string}
|
|
899
|
-
* @memberof
|
|
1071
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
900
1072
|
*/
|
|
901
1073
|
'error'?: string;
|
|
902
1074
|
/**
|
|
903
1075
|
*
|
|
904
1076
|
* @type {string}
|
|
905
|
-
* @memberof
|
|
1077
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
906
1078
|
*/
|
|
907
1079
|
'status'?: string;
|
|
908
1080
|
/**
|
|
909
1081
|
*
|
|
910
1082
|
* @type {string}
|
|
911
|
-
* @memberof
|
|
1083
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
912
1084
|
*/
|
|
913
1085
|
'timestamp'?: string;
|
|
914
1086
|
/**
|
|
915
1087
|
*
|
|
916
1088
|
* @type {number}
|
|
917
|
-
* @memberof
|
|
1089
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
918
1090
|
*/
|
|
919
1091
|
'total'?: number;
|
|
920
1092
|
}
|
|
@@ -1280,6 +1452,68 @@ export interface AnalyticsArrayPositionAnalytic {
|
|
|
1280
1452
|
*/
|
|
1281
1453
|
'usage_count'?: number;
|
|
1282
1454
|
}
|
|
1455
|
+
/**
|
|
1456
|
+
*
|
|
1457
|
+
* @export
|
|
1458
|
+
* @interface AnalyticsBannedExpression
|
|
1459
|
+
*/
|
|
1460
|
+
export interface AnalyticsBannedExpression {
|
|
1461
|
+
/**
|
|
1462
|
+
* When this ban was created
|
|
1463
|
+
* @type {string}
|
|
1464
|
+
* @memberof AnalyticsBannedExpression
|
|
1465
|
+
*/
|
|
1466
|
+
'created_at'?: string;
|
|
1467
|
+
/**
|
|
1468
|
+
* Optional description
|
|
1469
|
+
* @type {string}
|
|
1470
|
+
* @memberof AnalyticsBannedExpression
|
|
1471
|
+
*/
|
|
1472
|
+
'description'?: string;
|
|
1473
|
+
/**
|
|
1474
|
+
* Whether this ban is active
|
|
1475
|
+
* @type {boolean}
|
|
1476
|
+
* @memberof AnalyticsBannedExpression
|
|
1477
|
+
*/
|
|
1478
|
+
'enabled'?: boolean;
|
|
1479
|
+
/**
|
|
1480
|
+
* The expression to ban
|
|
1481
|
+
* @type {string}
|
|
1482
|
+
* @memberof AnalyticsBannedExpression
|
|
1483
|
+
*/
|
|
1484
|
+
'expression'?: string;
|
|
1485
|
+
/**
|
|
1486
|
+
* Unique identifier for the banned expression
|
|
1487
|
+
* @type {string}
|
|
1488
|
+
* @memberof AnalyticsBannedExpression
|
|
1489
|
+
*/
|
|
1490
|
+
'id'?: string;
|
|
1491
|
+
/**
|
|
1492
|
+
* How to match the expression
|
|
1493
|
+
* @type {AnalyticsBannedMatchType}
|
|
1494
|
+
* @memberof AnalyticsBannedExpression
|
|
1495
|
+
*/
|
|
1496
|
+
'match_type'?: AnalyticsBannedMatchType;
|
|
1497
|
+
/**
|
|
1498
|
+
* When this ban was last updated
|
|
1499
|
+
* @type {string}
|
|
1500
|
+
* @memberof AnalyticsBannedExpression
|
|
1501
|
+
*/
|
|
1502
|
+
'updated_at'?: string;
|
|
1503
|
+
}
|
|
1504
|
+
/**
|
|
1505
|
+
*
|
|
1506
|
+
* @export
|
|
1507
|
+
* @enum {string}
|
|
1508
|
+
*/
|
|
1509
|
+
export declare const AnalyticsBannedMatchType: {
|
|
1510
|
+
readonly BannedMatchIs: "is";
|
|
1511
|
+
readonly BannedMatchContains: "contains";
|
|
1512
|
+
readonly BannedMatchStartsWith: "startsWith";
|
|
1513
|
+
readonly BannedMatchEndsWith: "endsWith";
|
|
1514
|
+
readonly BannedMatchCustom: "custom";
|
|
1515
|
+
};
|
|
1516
|
+
export type AnalyticsBannedMatchType = typeof AnalyticsBannedMatchType[keyof typeof AnalyticsBannedMatchType];
|
|
1283
1517
|
/**
|
|
1284
1518
|
*
|
|
1285
1519
|
* @export
|
|
@@ -1387,6 +1621,68 @@ export interface AnalyticsCachedSuggestionResponse {
|
|
|
1387
1621
|
*/
|
|
1388
1622
|
'suggestions'?: Array<AnalyticsCachedSuggestion>;
|
|
1389
1623
|
}
|
|
1624
|
+
/**
|
|
1625
|
+
*
|
|
1626
|
+
* @export
|
|
1627
|
+
* @interface AnalyticsCategoryAttributeConfig
|
|
1628
|
+
*/
|
|
1629
|
+
export interface AnalyticsCategoryAttributeConfig {
|
|
1630
|
+
/**
|
|
1631
|
+
* The attribute name (e.g., \"category\", \"brand\") - REQUIRED
|
|
1632
|
+
* @type {string}
|
|
1633
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1634
|
+
*/
|
|
1635
|
+
'attribute'?: string;
|
|
1636
|
+
/**
|
|
1637
|
+
* Optional description (default: auto-generated)
|
|
1638
|
+
* @type {string}
|
|
1639
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1640
|
+
*/
|
|
1641
|
+
'description'?: string;
|
|
1642
|
+
/**
|
|
1643
|
+
* Whether this attribute is enabled (default: true)
|
|
1644
|
+
* @type {boolean}
|
|
1645
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1646
|
+
*/
|
|
1647
|
+
'enabled'?: boolean;
|
|
1648
|
+
/**
|
|
1649
|
+
* Maximum number of categories to show for this attribute - REQUIRED
|
|
1650
|
+
* @type {number}
|
|
1651
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1652
|
+
*/
|
|
1653
|
+
'max_count'?: number;
|
|
1654
|
+
/**
|
|
1655
|
+
* Priority order (lower number = higher priority) (default: auto-assigned)
|
|
1656
|
+
* @type {number}
|
|
1657
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1658
|
+
*/
|
|
1659
|
+
'priority'?: number;
|
|
1660
|
+
}
|
|
1661
|
+
/**
|
|
1662
|
+
*
|
|
1663
|
+
* @export
|
|
1664
|
+
* @interface AnalyticsCategoryWithCount
|
|
1665
|
+
*/
|
|
1666
|
+
export interface AnalyticsCategoryWithCount {
|
|
1667
|
+
/**
|
|
1668
|
+
*
|
|
1669
|
+
* @type {number}
|
|
1670
|
+
* @memberof AnalyticsCategoryWithCount
|
|
1671
|
+
*/
|
|
1672
|
+
'count'?: number;
|
|
1673
|
+
/**
|
|
1674
|
+
* \"exact_matches\" or \"analytics\"
|
|
1675
|
+
* @type {string}
|
|
1676
|
+
* @memberof AnalyticsCategoryWithCount
|
|
1677
|
+
*/
|
|
1678
|
+
'type'?: string;
|
|
1679
|
+
/**
|
|
1680
|
+
*
|
|
1681
|
+
* @type {string}
|
|
1682
|
+
* @memberof AnalyticsCategoryWithCount
|
|
1683
|
+
*/
|
|
1684
|
+
'value'?: string;
|
|
1685
|
+
}
|
|
1390
1686
|
/**
|
|
1391
1687
|
*
|
|
1392
1688
|
* @export
|
|
@@ -1552,6 +1848,39 @@ export interface AnalyticsDeleteManualSuggestionsRequest {
|
|
|
1552
1848
|
*/
|
|
1553
1849
|
'suggestion_ids': Array<string>;
|
|
1554
1850
|
}
|
|
1851
|
+
/**
|
|
1852
|
+
*
|
|
1853
|
+
* @export
|
|
1854
|
+
* @interface AnalyticsEnhancedCategorySuggestion
|
|
1855
|
+
*/
|
|
1856
|
+
export interface AnalyticsEnhancedCategorySuggestion {
|
|
1857
|
+
/**
|
|
1858
|
+
*
|
|
1859
|
+
* @type {Array<AnalyticsCategoryWithCount>}
|
|
1860
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1861
|
+
*/
|
|
1862
|
+
'categories'?: Array<AnalyticsCategoryWithCount>;
|
|
1863
|
+
/**
|
|
1864
|
+
*
|
|
1865
|
+
* @type {{ [key: string]: any; }}
|
|
1866
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1867
|
+
*/
|
|
1868
|
+
'metadata'?: {
|
|
1869
|
+
[key: string]: any;
|
|
1870
|
+
};
|
|
1871
|
+
/**
|
|
1872
|
+
*
|
|
1873
|
+
* @type {number}
|
|
1874
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1875
|
+
*/
|
|
1876
|
+
'popularity'?: number;
|
|
1877
|
+
/**
|
|
1878
|
+
*
|
|
1879
|
+
* @type {string}
|
|
1880
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1881
|
+
*/
|
|
1882
|
+
'query'?: string;
|
|
1883
|
+
}
|
|
1555
1884
|
/**
|
|
1556
1885
|
*
|
|
1557
1886
|
* @export
|
|
@@ -1559,11 +1888,41 @@ export interface AnalyticsDeleteManualSuggestionsRequest {
|
|
|
1559
1888
|
*/
|
|
1560
1889
|
export interface AnalyticsEnrichedItemResultWithWidget {
|
|
1561
1890
|
/**
|
|
1562
|
-
*
|
|
1563
|
-
* @type {
|
|
1891
|
+
*
|
|
1892
|
+
* @type {number}
|
|
1893
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1894
|
+
*/
|
|
1895
|
+
'avg_position'?: number;
|
|
1896
|
+
/**
|
|
1897
|
+
*
|
|
1898
|
+
* @type {number}
|
|
1899
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1900
|
+
*/
|
|
1901
|
+
'avg_score'?: number;
|
|
1902
|
+
/**
|
|
1903
|
+
* Calculated metrics
|
|
1904
|
+
* @type {number}
|
|
1564
1905
|
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1565
1906
|
*/
|
|
1566
|
-
'
|
|
1907
|
+
'click_through_rate'?: number;
|
|
1908
|
+
/**
|
|
1909
|
+
* Future click and conversion metrics
|
|
1910
|
+
* @type {number}
|
|
1911
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1912
|
+
*/
|
|
1913
|
+
'clicks'?: number;
|
|
1914
|
+
/**
|
|
1915
|
+
*
|
|
1916
|
+
* @type {number}
|
|
1917
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1918
|
+
*/
|
|
1919
|
+
'conversion_rate'?: number;
|
|
1920
|
+
/**
|
|
1921
|
+
*
|
|
1922
|
+
* @type {number}
|
|
1923
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1924
|
+
*/
|
|
1925
|
+
'conversions'?: number;
|
|
1567
1926
|
/**
|
|
1568
1927
|
* Document data from Typesense index
|
|
1569
1928
|
* @type {{ [key: string]: any; }}
|
|
@@ -1578,6 +1937,84 @@ export interface AnalyticsEnrichedItemResultWithWidget {
|
|
|
1578
1937
|
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1579
1938
|
*/
|
|
1580
1939
|
'document_fetch_error'?: string;
|
|
1940
|
+
/**
|
|
1941
|
+
*
|
|
1942
|
+
* @type {number}
|
|
1943
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1944
|
+
*/
|
|
1945
|
+
'impressions'?: number;
|
|
1946
|
+
/**
|
|
1947
|
+
*
|
|
1948
|
+
* @type {string}
|
|
1949
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1950
|
+
*/
|
|
1951
|
+
'item_id'?: string;
|
|
1952
|
+
/**
|
|
1953
|
+
*
|
|
1954
|
+
* @type {string}
|
|
1955
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1956
|
+
*/
|
|
1957
|
+
'item_name'?: string;
|
|
1958
|
+
/**
|
|
1959
|
+
*
|
|
1960
|
+
* @type {number}
|
|
1961
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1962
|
+
*/
|
|
1963
|
+
'revenue'?: number;
|
|
1964
|
+
/**
|
|
1965
|
+
*
|
|
1966
|
+
* @type {number}
|
|
1967
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1968
|
+
*/
|
|
1969
|
+
'revenue_per_item'?: number;
|
|
1970
|
+
/**
|
|
1971
|
+
*
|
|
1972
|
+
* @type {number}
|
|
1973
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1974
|
+
*/
|
|
1975
|
+
'top_10_impressions'?: number;
|
|
1976
|
+
/**
|
|
1977
|
+
*
|
|
1978
|
+
* @type {number}
|
|
1979
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1980
|
+
*/
|
|
1981
|
+
'top_3_impression_rate'?: number;
|
|
1982
|
+
/**
|
|
1983
|
+
*
|
|
1984
|
+
* @type {number}
|
|
1985
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1986
|
+
*/
|
|
1987
|
+
'top_3_impressions'?: number;
|
|
1988
|
+
/**
|
|
1989
|
+
*
|
|
1990
|
+
* @type {number}
|
|
1991
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1992
|
+
*/
|
|
1993
|
+
'unique_filters'?: number;
|
|
1994
|
+
/**
|
|
1995
|
+
*
|
|
1996
|
+
* @type {number}
|
|
1997
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1998
|
+
*/
|
|
1999
|
+
'unique_queries'?: number;
|
|
2000
|
+
/**
|
|
2001
|
+
*
|
|
2002
|
+
* @type {number}
|
|
2003
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
2004
|
+
*/
|
|
2005
|
+
'unique_searches'?: number;
|
|
2006
|
+
/**
|
|
2007
|
+
*
|
|
2008
|
+
* @type {number}
|
|
2009
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
2010
|
+
*/
|
|
2011
|
+
'unique_sorts'?: number;
|
|
2012
|
+
/**
|
|
2013
|
+
*
|
|
2014
|
+
* @type {number}
|
|
2015
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
2016
|
+
*/
|
|
2017
|
+
'unique_users'?: number;
|
|
1581
2018
|
/**
|
|
1582
2019
|
* Widget display data for UI presentation
|
|
1583
2020
|
* @type {AnalyticsWidgetData}
|
|
@@ -1651,6 +2088,12 @@ export interface AnalyticsExtendedKPIResponse {
|
|
|
1651
2088
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1652
2089
|
*/
|
|
1653
2090
|
'summary'?: any;
|
|
2091
|
+
/**
|
|
2092
|
+
*
|
|
2093
|
+
* @type {string}
|
|
2094
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
2095
|
+
*/
|
|
2096
|
+
'target_currency'?: string;
|
|
1654
2097
|
/**
|
|
1655
2098
|
*
|
|
1656
2099
|
* @type {string}
|
|
@@ -1677,6 +2120,39 @@ export interface AnalyticsFacetMatch {
|
|
|
1677
2120
|
*/
|
|
1678
2121
|
'value'?: string;
|
|
1679
2122
|
}
|
|
2123
|
+
/**
|
|
2124
|
+
*
|
|
2125
|
+
* @export
|
|
2126
|
+
* @interface AnalyticsFacetSuggestion
|
|
2127
|
+
*/
|
|
2128
|
+
export interface AnalyticsFacetSuggestion {
|
|
2129
|
+
/**
|
|
2130
|
+
*
|
|
2131
|
+
* @type {number}
|
|
2132
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2133
|
+
*/
|
|
2134
|
+
'count'?: number;
|
|
2135
|
+
/**
|
|
2136
|
+
* e.g., {\"brand\": \"Nike\", \"color\": \"red\"}
|
|
2137
|
+
* @type {{ [key: string]: string; }}
|
|
2138
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2139
|
+
*/
|
|
2140
|
+
'facet_combination'?: {
|
|
2141
|
+
[key: string]: string;
|
|
2142
|
+
};
|
|
2143
|
+
/**
|
|
2144
|
+
*
|
|
2145
|
+
* @type {number}
|
|
2146
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2147
|
+
*/
|
|
2148
|
+
'popularity'?: number;
|
|
2149
|
+
/**
|
|
2150
|
+
*
|
|
2151
|
+
* @type {string}
|
|
2152
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2153
|
+
*/
|
|
2154
|
+
'query'?: string;
|
|
2155
|
+
}
|
|
1680
2156
|
/**
|
|
1681
2157
|
*
|
|
1682
2158
|
* @export
|
|
@@ -2357,6 +2833,20 @@ export interface AnalyticsGeoAnalytic {
|
|
|
2357
2833
|
* @memberof AnalyticsGeoAnalytic
|
|
2358
2834
|
*/
|
|
2359
2835
|
'revenue'?: number;
|
|
2836
|
+
/**
|
|
2837
|
+
*
|
|
2838
|
+
* @type {{ [key: string]: number; }}
|
|
2839
|
+
* @memberof AnalyticsGeoAnalytic
|
|
2840
|
+
*/
|
|
2841
|
+
'revenue_breakdown'?: {
|
|
2842
|
+
[key: string]: number;
|
|
2843
|
+
};
|
|
2844
|
+
/**
|
|
2845
|
+
*
|
|
2846
|
+
* @type {string}
|
|
2847
|
+
* @memberof AnalyticsGeoAnalytic
|
|
2848
|
+
*/
|
|
2849
|
+
'revenue_currency'?: string;
|
|
2360
2850
|
/**
|
|
2361
2851
|
*
|
|
2362
2852
|
* @type {number}
|
|
@@ -2699,6 +3189,12 @@ export interface AnalyticsGeoResponse {
|
|
|
2699
3189
|
* @memberof AnalyticsGeoResponse
|
|
2700
3190
|
*/
|
|
2701
3191
|
'start_time'?: string;
|
|
3192
|
+
/**
|
|
3193
|
+
*
|
|
3194
|
+
* @type {string}
|
|
3195
|
+
* @memberof AnalyticsGeoResponse
|
|
3196
|
+
*/
|
|
3197
|
+
'target_currency'?: string;
|
|
2702
3198
|
/**
|
|
2703
3199
|
*
|
|
2704
3200
|
* @type {number}
|
|
@@ -4178,6 +4674,20 @@ export interface AnalyticsKPIMetrics {
|
|
|
4178
4674
|
* @memberof AnalyticsKPIMetrics
|
|
4179
4675
|
*/
|
|
4180
4676
|
'revenue'?: number;
|
|
4677
|
+
/**
|
|
4678
|
+
*
|
|
4679
|
+
* @type {{ [key: string]: number; }}
|
|
4680
|
+
* @memberof AnalyticsKPIMetrics
|
|
4681
|
+
*/
|
|
4682
|
+
'revenue_breakdown'?: {
|
|
4683
|
+
[key: string]: number;
|
|
4684
|
+
};
|
|
4685
|
+
/**
|
|
4686
|
+
*
|
|
4687
|
+
* @type {string}
|
|
4688
|
+
* @memberof AnalyticsKPIMetrics
|
|
4689
|
+
*/
|
|
4690
|
+
'revenue_currency'?: string;
|
|
4181
4691
|
/**
|
|
4182
4692
|
*
|
|
4183
4693
|
* @type {number}
|
|
@@ -4257,6 +4767,20 @@ export interface AnalyticsKPIPointExtended {
|
|
|
4257
4767
|
* @memberof AnalyticsKPIPointExtended
|
|
4258
4768
|
*/
|
|
4259
4769
|
'revenue'?: number;
|
|
4770
|
+
/**
|
|
4771
|
+
*
|
|
4772
|
+
* @type {{ [key: string]: number; }}
|
|
4773
|
+
* @memberof AnalyticsKPIPointExtended
|
|
4774
|
+
*/
|
|
4775
|
+
'revenue_breakdown'?: {
|
|
4776
|
+
[key: string]: number;
|
|
4777
|
+
};
|
|
4778
|
+
/**
|
|
4779
|
+
*
|
|
4780
|
+
* @type {string}
|
|
4781
|
+
* @memberof AnalyticsKPIPointExtended
|
|
4782
|
+
*/
|
|
4783
|
+
'revenue_currency'?: string;
|
|
4260
4784
|
/**
|
|
4261
4785
|
*
|
|
4262
4786
|
* @type {number}
|
|
@@ -4437,6 +4961,20 @@ export interface AnalyticsQueryAnalytic {
|
|
|
4437
4961
|
* @memberof AnalyticsQueryAnalytic
|
|
4438
4962
|
*/
|
|
4439
4963
|
'revenue'?: number;
|
|
4964
|
+
/**
|
|
4965
|
+
*
|
|
4966
|
+
* @type {{ [key: string]: number; }}
|
|
4967
|
+
* @memberof AnalyticsQueryAnalytic
|
|
4968
|
+
*/
|
|
4969
|
+
'revenue_breakdown'?: {
|
|
4970
|
+
[key: string]: number;
|
|
4971
|
+
};
|
|
4972
|
+
/**
|
|
4973
|
+
*
|
|
4974
|
+
* @type {string}
|
|
4975
|
+
* @memberof AnalyticsQueryAnalytic
|
|
4976
|
+
*/
|
|
4977
|
+
'revenue_currency'?: string;
|
|
4440
4978
|
/**
|
|
4441
4979
|
*
|
|
4442
4980
|
* @type {number}
|
|
@@ -5303,6 +5841,12 @@ export interface AnalyticsQueryResponse {
|
|
|
5303
5841
|
* @memberof AnalyticsQueryResponse
|
|
5304
5842
|
*/
|
|
5305
5843
|
'start_time'?: string;
|
|
5844
|
+
/**
|
|
5845
|
+
*
|
|
5846
|
+
* @type {string}
|
|
5847
|
+
* @memberof AnalyticsQueryResponse
|
|
5848
|
+
*/
|
|
5849
|
+
'target_currency'?: string;
|
|
5306
5850
|
/**
|
|
5307
5851
|
*
|
|
5308
5852
|
* @type {number}
|
|
@@ -5380,11 +5924,29 @@ export interface AnalyticsQuerySuggestion {
|
|
|
5380
5924
|
*/
|
|
5381
5925
|
export interface AnalyticsQuerySuggestionConfig {
|
|
5382
5926
|
/**
|
|
5383
|
-
*
|
|
5927
|
+
* Expressions to exclude from suggestions with matching types
|
|
5928
|
+
* @type {Array<AnalyticsBannedExpression>}
|
|
5929
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5930
|
+
*/
|
|
5931
|
+
'banned_expressions'?: Array<AnalyticsBannedExpression>;
|
|
5932
|
+
/**
|
|
5933
|
+
* Per-attribute configuration with counts
|
|
5934
|
+
* @type {Array<AnalyticsCategoryAttributeConfig>}
|
|
5935
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5936
|
+
*/
|
|
5937
|
+
'category_attribute_configs'?: Array<AnalyticsCategoryAttributeConfig>;
|
|
5938
|
+
/**
|
|
5939
|
+
* Attributes to use for category suggestions (legacy)
|
|
5384
5940
|
* @type {Array<string>}
|
|
5385
5941
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5386
5942
|
*/
|
|
5387
5943
|
'category_attributes'?: Array<string>;
|
|
5944
|
+
/**
|
|
5945
|
+
* Whether to include count per attribute
|
|
5946
|
+
* @type {boolean}
|
|
5947
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5948
|
+
*/
|
|
5949
|
+
'category_counts'?: boolean;
|
|
5388
5950
|
/**
|
|
5389
5951
|
* Whether to include category-based suggestions
|
|
5390
5952
|
* @type {boolean}
|
|
@@ -5397,12 +5959,42 @@ export interface AnalyticsQuerySuggestionConfig {
|
|
|
5397
5959
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5398
5960
|
*/
|
|
5399
5961
|
'enable_facet_suggestions'?: boolean;
|
|
5962
|
+
/**
|
|
5963
|
+
* Personalization (boolean flag for now as requested)
|
|
5964
|
+
* @type {boolean}
|
|
5965
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5966
|
+
*/
|
|
5967
|
+
'enable_personalization'?: boolean;
|
|
5968
|
+
/**
|
|
5969
|
+
* Improve relevance using Rules
|
|
5970
|
+
* @type {boolean}
|
|
5971
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5972
|
+
*/
|
|
5973
|
+
'enable_rules'?: boolean;
|
|
5400
5974
|
/**
|
|
5401
5975
|
* Whether query suggestions are enabled for the store
|
|
5402
5976
|
* @type {boolean}
|
|
5403
5977
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5404
5978
|
*/
|
|
5405
5979
|
'enabled'?: boolean;
|
|
5980
|
+
/**
|
|
5981
|
+
* Facet data augmentation
|
|
5982
|
+
* @type {Array<string>}
|
|
5983
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5984
|
+
*/
|
|
5985
|
+
'facet_attributes'?: Array<string>;
|
|
5986
|
+
/**
|
|
5987
|
+
* Maximum number of facet combinations
|
|
5988
|
+
* @type {number}
|
|
5989
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5990
|
+
*/
|
|
5991
|
+
'facet_combination_limit'?: number;
|
|
5992
|
+
/**
|
|
5993
|
+
* Language for duplicate removal (singular/plural)
|
|
5994
|
+
* @type {string}
|
|
5995
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5996
|
+
*/
|
|
5997
|
+
'language'?: string;
|
|
5406
5998
|
/**
|
|
5407
5999
|
* Maximum number of suggestions to return
|
|
5408
6000
|
* @type {number}
|
|
@@ -5415,18 +6007,54 @@ export interface AnalyticsQuerySuggestionConfig {
|
|
|
5415
6007
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5416
6008
|
*/
|
|
5417
6009
|
'min_popularity'?: number;
|
|
6010
|
+
/**
|
|
6011
|
+
* Minimum search results for suggestions
|
|
6012
|
+
* @type {number}
|
|
6013
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6014
|
+
*/
|
|
6015
|
+
'minimum_hits'?: number;
|
|
6016
|
+
/**
|
|
6017
|
+
* Remove duplicate or unhelpful suggestions (from Algolia documentation)
|
|
6018
|
+
* @type {number}
|
|
6019
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6020
|
+
*/
|
|
6021
|
+
'minimum_letters'?: number;
|
|
6022
|
+
/**
|
|
6023
|
+
* Array of rules for suggestion promotion/hiding
|
|
6024
|
+
* @type {Array<AnalyticsQuerySuggestionRule>}
|
|
6025
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6026
|
+
*/
|
|
6027
|
+
'rules'?: Array<AnalyticsQuerySuggestionRule>;
|
|
6028
|
+
/**
|
|
6029
|
+
* Query Suggestions with categories - enhanced
|
|
6030
|
+
* @type {number}
|
|
6031
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6032
|
+
*/
|
|
6033
|
+
'show_top_categories'?: number;
|
|
5418
6034
|
/**
|
|
5419
6035
|
* Whether to sync enabled suggestions to Typesense
|
|
5420
6036
|
* @type {boolean}
|
|
5421
6037
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5422
6038
|
*/
|
|
5423
6039
|
'sync_to_typesense'?: boolean;
|
|
6040
|
+
/**
|
|
6041
|
+
* Tokenization method
|
|
6042
|
+
* @type {string}
|
|
6043
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6044
|
+
*/
|
|
6045
|
+
'tokenization'?: string;
|
|
5424
6046
|
/**
|
|
5425
6047
|
* Whether to sync to Typesense
|
|
5426
6048
|
* @type {boolean}
|
|
5427
6049
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5428
6050
|
*/
|
|
5429
6051
|
'typesense_collection_enabled'?: boolean;
|
|
6052
|
+
/**
|
|
6053
|
+
* Index settings
|
|
6054
|
+
* @type {number}
|
|
6055
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6056
|
+
*/
|
|
6057
|
+
'typo_tolerance'?: number;
|
|
5430
6058
|
/**
|
|
5431
6059
|
* Include auto-generated suggestions
|
|
5432
6060
|
* @type {boolean}
|
|
@@ -5632,6 +6260,73 @@ export interface AnalyticsQuerySuggestionRecord {
|
|
|
5632
6260
|
*/
|
|
5633
6261
|
'xstoreid'?: string;
|
|
5634
6262
|
}
|
|
6263
|
+
/**
|
|
6264
|
+
*
|
|
6265
|
+
* @export
|
|
6266
|
+
* @interface AnalyticsQuerySuggestionRule
|
|
6267
|
+
*/
|
|
6268
|
+
export interface AnalyticsQuerySuggestionRule {
|
|
6269
|
+
/**
|
|
6270
|
+
* Rule actions
|
|
6271
|
+
* @type {Array<AnalyticsRuleAction>}
|
|
6272
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6273
|
+
*/
|
|
6274
|
+
'actions'?: Array<AnalyticsRuleAction>;
|
|
6275
|
+
/**
|
|
6276
|
+
* Rule conditions
|
|
6277
|
+
* @type {Array<AnalyticsRuleCondition>}
|
|
6278
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6279
|
+
*/
|
|
6280
|
+
'conditions'?: Array<AnalyticsRuleCondition>;
|
|
6281
|
+
/**
|
|
6282
|
+
* Rule creation time
|
|
6283
|
+
* @type {string}
|
|
6284
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6285
|
+
*/
|
|
6286
|
+
'created_at'?: string;
|
|
6287
|
+
/**
|
|
6288
|
+
* Rule description
|
|
6289
|
+
* @type {string}
|
|
6290
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6291
|
+
*/
|
|
6292
|
+
'description'?: string;
|
|
6293
|
+
/**
|
|
6294
|
+
* Whether rule is enabled
|
|
6295
|
+
* @type {boolean}
|
|
6296
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6297
|
+
*/
|
|
6298
|
+
'enabled'?: boolean;
|
|
6299
|
+
/**
|
|
6300
|
+
* Unique rule identifier
|
|
6301
|
+
* @type {string}
|
|
6302
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6303
|
+
*/
|
|
6304
|
+
'id'?: string;
|
|
6305
|
+
/**
|
|
6306
|
+
* Rule name
|
|
6307
|
+
* @type {string}
|
|
6308
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6309
|
+
*/
|
|
6310
|
+
'name'?: string;
|
|
6311
|
+
/**
|
|
6312
|
+
* Rule priority (higher = executed first)
|
|
6313
|
+
* @type {number}
|
|
6314
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6315
|
+
*/
|
|
6316
|
+
'priority'?: number;
|
|
6317
|
+
/**
|
|
6318
|
+
* Rule type (promote, hide, redirect, etc.)
|
|
6319
|
+
* @type {AnalyticsRuleType}
|
|
6320
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6321
|
+
*/
|
|
6322
|
+
'type'?: AnalyticsRuleType;
|
|
6323
|
+
/**
|
|
6324
|
+
* Rule last update time
|
|
6325
|
+
* @type {string}
|
|
6326
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6327
|
+
*/
|
|
6328
|
+
'updated_at'?: string;
|
|
6329
|
+
}
|
|
5635
6330
|
/**
|
|
5636
6331
|
*
|
|
5637
6332
|
* @export
|
|
@@ -5905,6 +6600,68 @@ export interface AnalyticsQuerySuggestionsResponse {
|
|
|
5905
6600
|
*/
|
|
5906
6601
|
'userToken'?: string;
|
|
5907
6602
|
}
|
|
6603
|
+
/**
|
|
6604
|
+
*
|
|
6605
|
+
* @export
|
|
6606
|
+
* @interface AnalyticsRuleAction
|
|
6607
|
+
*/
|
|
6608
|
+
export interface AnalyticsRuleAction {
|
|
6609
|
+
/**
|
|
6610
|
+
* Optional message for banner actions
|
|
6611
|
+
* @type {string}
|
|
6612
|
+
* @memberof AnalyticsRuleAction
|
|
6613
|
+
*/
|
|
6614
|
+
'message'?: string;
|
|
6615
|
+
/**
|
|
6616
|
+
* Action type (promote, hide, change_query, show_banner)
|
|
6617
|
+
* @type {string}
|
|
6618
|
+
* @memberof AnalyticsRuleAction
|
|
6619
|
+
*/
|
|
6620
|
+
'type'?: string;
|
|
6621
|
+
/**
|
|
6622
|
+
* Action value
|
|
6623
|
+
* @type {any}
|
|
6624
|
+
* @memberof AnalyticsRuleAction
|
|
6625
|
+
*/
|
|
6626
|
+
'value'?: any;
|
|
6627
|
+
}
|
|
6628
|
+
/**
|
|
6629
|
+
*
|
|
6630
|
+
* @export
|
|
6631
|
+
* @interface AnalyticsRuleCondition
|
|
6632
|
+
*/
|
|
6633
|
+
export interface AnalyticsRuleCondition {
|
|
6634
|
+
/**
|
|
6635
|
+
* Attribute to match (query, category, etc.)
|
|
6636
|
+
* @type {string}
|
|
6637
|
+
* @memberof AnalyticsRuleCondition
|
|
6638
|
+
*/
|
|
6639
|
+
'attribute'?: string;
|
|
6640
|
+
/**
|
|
6641
|
+
* Operator (equals, contains, starts_with, etc.)
|
|
6642
|
+
* @type {string}
|
|
6643
|
+
* @memberof AnalyticsRuleCondition
|
|
6644
|
+
*/
|
|
6645
|
+
'operator'?: string;
|
|
6646
|
+
/**
|
|
6647
|
+
* Value to match against
|
|
6648
|
+
* @type {any}
|
|
6649
|
+
* @memberof AnalyticsRuleCondition
|
|
6650
|
+
*/
|
|
6651
|
+
'value'?: any;
|
|
6652
|
+
}
|
|
6653
|
+
/**
|
|
6654
|
+
*
|
|
6655
|
+
* @export
|
|
6656
|
+
* @enum {string}
|
|
6657
|
+
*/
|
|
6658
|
+
export declare const AnalyticsRuleType: {
|
|
6659
|
+
readonly RuleTypePromote: "promote";
|
|
6660
|
+
readonly RuleTypeHide: "hide";
|
|
6661
|
+
readonly RuleTypeRedirect: "redirect";
|
|
6662
|
+
readonly RuleTypeBanner: "banner";
|
|
6663
|
+
};
|
|
6664
|
+
export type AnalyticsRuleType = typeof AnalyticsRuleType[keyof typeof AnalyticsRuleType];
|
|
5908
6665
|
/**
|
|
5909
6666
|
*
|
|
5910
6667
|
* @export
|
|
@@ -5984,45 +6741,129 @@ export interface AnalyticsTimeSeriesPoint {
|
|
|
5984
6741
|
* @type {string}
|
|
5985
6742
|
* @memberof AnalyticsTimeSeriesPoint
|
|
5986
6743
|
*/
|
|
5987
|
-
'timestamp'?: string;
|
|
6744
|
+
'timestamp'?: string;
|
|
6745
|
+
/**
|
|
6746
|
+
*
|
|
6747
|
+
* @type {number}
|
|
6748
|
+
* @memberof AnalyticsTimeSeriesPoint
|
|
6749
|
+
*/
|
|
6750
|
+
'value'?: number;
|
|
6751
|
+
}
|
|
6752
|
+
/**
|
|
6753
|
+
*
|
|
6754
|
+
* @export
|
|
6755
|
+
* @interface AnalyticsToggleQuerySuggestionsRequest
|
|
6756
|
+
*/
|
|
6757
|
+
export interface AnalyticsToggleQuerySuggestionsRequest {
|
|
6758
|
+
/**
|
|
6759
|
+
* true to enable, false to disable
|
|
6760
|
+
* @type {boolean}
|
|
6761
|
+
* @memberof AnalyticsToggleQuerySuggestionsRequest
|
|
6762
|
+
*/
|
|
6763
|
+
'enabled': boolean;
|
|
6764
|
+
}
|
|
6765
|
+
/**
|
|
6766
|
+
*
|
|
6767
|
+
* @export
|
|
6768
|
+
* @interface AnalyticsUpdateSuggestionConfigRequest
|
|
6769
|
+
*/
|
|
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;
|
|
6789
|
+
/**
|
|
6790
|
+
* Enable/disable facet-based suggestions
|
|
6791
|
+
* @type {boolean}
|
|
6792
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6793
|
+
*/
|
|
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;
|
|
6807
|
+
/**
|
|
6808
|
+
* Enable/disable query suggestions for the store
|
|
6809
|
+
* @type {boolean}
|
|
6810
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6811
|
+
*/
|
|
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;
|
|
5988
6843
|
/**
|
|
5989
|
-
*
|
|
5990
|
-
* @type {
|
|
5991
|
-
* @memberof
|
|
6844
|
+
* Rules array
|
|
6845
|
+
* @type {Array<AnalyticsQuerySuggestionRule>}
|
|
6846
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
5992
6847
|
*/
|
|
5993
|
-
'
|
|
5994
|
-
}
|
|
5995
|
-
/**
|
|
5996
|
-
*
|
|
5997
|
-
* @export
|
|
5998
|
-
* @interface AnalyticsToggleQuerySuggestionsRequest
|
|
5999
|
-
*/
|
|
6000
|
-
export interface AnalyticsToggleQuerySuggestionsRequest {
|
|
6848
|
+
'rules'?: Array<AnalyticsQuerySuggestionRule>;
|
|
6001
6849
|
/**
|
|
6002
|
-
*
|
|
6003
|
-
* @type {
|
|
6004
|
-
* @memberof
|
|
6850
|
+
* Number of top categories (legacy)
|
|
6851
|
+
* @type {number}
|
|
6852
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6005
6853
|
*/
|
|
6006
|
-
'
|
|
6007
|
-
}
|
|
6008
|
-
/**
|
|
6009
|
-
*
|
|
6010
|
-
* @export
|
|
6011
|
-
* @interface AnalyticsUpdateSuggestionConfigRequest
|
|
6012
|
-
*/
|
|
6013
|
-
export interface AnalyticsUpdateSuggestionConfigRequest {
|
|
6854
|
+
'show_top_categories'?: number;
|
|
6014
6855
|
/**
|
|
6015
|
-
*
|
|
6016
|
-
* @type {
|
|
6856
|
+
* Tokenization method
|
|
6857
|
+
* @type {string}
|
|
6017
6858
|
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6018
6859
|
*/
|
|
6019
|
-
'
|
|
6860
|
+
'tokenization'?: string;
|
|
6020
6861
|
/**
|
|
6021
|
-
*
|
|
6022
|
-
* @type {
|
|
6862
|
+
* Typo tolerance
|
|
6863
|
+
* @type {number}
|
|
6023
6864
|
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6024
6865
|
*/
|
|
6025
|
-
'
|
|
6866
|
+
'typo_tolerance'?: number;
|
|
6026
6867
|
/**
|
|
6027
6868
|
* Enable/disable auto-generated suggestions
|
|
6028
6869
|
* @type {boolean}
|
|
@@ -6821,12 +7662,24 @@ export interface BillingServicePaymentTransactionSummary {
|
|
|
6821
7662
|
* @memberof BillingServicePaymentTransactionSummary
|
|
6822
7663
|
*/
|
|
6823
7664
|
'gateway'?: BillingServiceNullableString;
|
|
7665
|
+
/**
|
|
7666
|
+
* Gateway order identifier
|
|
7667
|
+
* @type {BillingServiceNullableString}
|
|
7668
|
+
* @memberof BillingServicePaymentTransactionSummary
|
|
7669
|
+
*/
|
|
7670
|
+
'gateway_order_id'?: BillingServiceNullableString;
|
|
6824
7671
|
/**
|
|
6825
7672
|
*
|
|
6826
7673
|
* @type {BillingServiceNullableString}
|
|
6827
7674
|
* @memberof BillingServicePaymentTransactionSummary
|
|
6828
7675
|
*/
|
|
6829
7676
|
'gateway_payment_id'?: BillingServiceNullableString;
|
|
7677
|
+
/**
|
|
7678
|
+
* Database primary key
|
|
7679
|
+
* @type {BillingServiceNullableInt64}
|
|
7680
|
+
* @memberof BillingServicePaymentTransactionSummary
|
|
7681
|
+
*/
|
|
7682
|
+
'order_id'?: BillingServiceNullableInt64;
|
|
6830
7683
|
/**
|
|
6831
7684
|
*
|
|
6832
7685
|
* @type {number}
|
|
@@ -6846,7 +7699,7 @@ export interface BillingServicePaymentTransactionSummary {
|
|
|
6846
7699
|
*/
|
|
6847
7700
|
'payment_date'?: string;
|
|
6848
7701
|
/**
|
|
6849
|
-
*
|
|
7702
|
+
* Database primary key
|
|
6850
7703
|
* @type {number}
|
|
6851
7704
|
* @memberof BillingServicePaymentTransactionSummary
|
|
6852
7705
|
*/
|
|
@@ -6875,6 +7728,12 @@ export interface BillingServicePaymentTransactionSummary {
|
|
|
6875
7728
|
* @memberof BillingServicePaymentTransactionSummary
|
|
6876
7729
|
*/
|
|
6877
7730
|
'refund_status'?: BillingServiceNullableString;
|
|
7731
|
+
/**
|
|
7732
|
+
* Actual payment identifier
|
|
7733
|
+
* @type {string}
|
|
7734
|
+
* @memberof BillingServicePaymentTransactionSummary
|
|
7735
|
+
*/
|
|
7736
|
+
'transaction_id'?: string;
|
|
6878
7737
|
}
|
|
6879
7738
|
/**
|
|
6880
7739
|
*
|
|
@@ -8092,6 +8951,12 @@ export interface DataTypesCreateRefundRequestDto {
|
|
|
8092
8951
|
* @memberof DataTypesCreateRefundRequestDto
|
|
8093
8952
|
*/
|
|
8094
8953
|
'auto_approve_after'?: string;
|
|
8954
|
+
/**
|
|
8955
|
+
*
|
|
8956
|
+
* @type {string}
|
|
8957
|
+
* @memberof DataTypesCreateRefundRequestDto
|
|
8958
|
+
*/
|
|
8959
|
+
'currency': string;
|
|
8095
8960
|
/**
|
|
8096
8961
|
*
|
|
8097
8962
|
* @type {string}
|
|
@@ -8107,13 +8972,13 @@ export interface DataTypesCreateRefundRequestDto {
|
|
|
8107
8972
|
[key: string]: any;
|
|
8108
8973
|
};
|
|
8109
8974
|
/**
|
|
8110
|
-
*
|
|
8111
|
-
* @type {
|
|
8975
|
+
* Gateway order ID (e.g., \"order_RMeeXimPIbrYqH\")
|
|
8976
|
+
* @type {string}
|
|
8112
8977
|
* @memberof DataTypesCreateRefundRequestDto
|
|
8113
8978
|
*/
|
|
8114
|
-
'order_id':
|
|
8979
|
+
'order_id': string;
|
|
8115
8980
|
/**
|
|
8116
|
-
*
|
|
8981
|
+
* Gateway payment ID (e.g., \"pay_RMeeuvyPSbZp2Y\")
|
|
8117
8982
|
* @type {string}
|
|
8118
8983
|
* @memberof DataTypesCreateRefundRequestDto
|
|
8119
8984
|
*/
|
|
@@ -13663,17 +14528,23 @@ export interface DataTypesRefundRequestResponseDto {
|
|
|
13663
14528
|
*/
|
|
13664
14529
|
'expires_at'?: string;
|
|
13665
14530
|
/**
|
|
13666
|
-
*
|
|
13667
|
-
* @type {
|
|
14531
|
+
* Gateway order ID
|
|
14532
|
+
* @type {string}
|
|
13668
14533
|
* @memberof DataTypesRefundRequestResponseDto
|
|
13669
14534
|
*/
|
|
13670
|
-
'order_id'?:
|
|
14535
|
+
'order_id'?: string;
|
|
13671
14536
|
/**
|
|
13672
|
-
*
|
|
14537
|
+
* Gateway payment ID
|
|
13673
14538
|
* @type {string}
|
|
13674
14539
|
* @memberof DataTypesRefundRequestResponseDto
|
|
13675
14540
|
*/
|
|
13676
14541
|
'payment_id'?: string;
|
|
14542
|
+
/**
|
|
14543
|
+
* UUID for external reference
|
|
14544
|
+
* @type {string}
|
|
14545
|
+
* @memberof DataTypesRefundRequestResponseDto
|
|
14546
|
+
*/
|
|
14547
|
+
'refund_id'?: string;
|
|
13677
14548
|
/**
|
|
13678
14549
|
*
|
|
13679
14550
|
* @type {number}
|
|
@@ -13786,6 +14657,12 @@ export interface DataTypesRefundStatusDto {
|
|
|
13786
14657
|
* @memberof DataTypesRefundStatusDto
|
|
13787
14658
|
*/
|
|
13788
14659
|
'credit_adjustments'?: Array<DataTypesCreditAdjustmentDto>;
|
|
14660
|
+
/**
|
|
14661
|
+
*
|
|
14662
|
+
* @type {string}
|
|
14663
|
+
* @memberof DataTypesRefundStatusDto
|
|
14664
|
+
*/
|
|
14665
|
+
'currency'?: string;
|
|
13789
14666
|
/**
|
|
13790
14667
|
* Processing information
|
|
13791
14668
|
* @type {string}
|
|
@@ -13816,6 +14693,12 @@ export interface DataTypesRefundStatusDto {
|
|
|
13816
14693
|
* @memberof DataTypesRefundStatusDto
|
|
13817
14694
|
*/
|
|
13818
14695
|
'reason'?: string;
|
|
14696
|
+
/**
|
|
14697
|
+
* UUID for external reference
|
|
14698
|
+
* @type {string}
|
|
14699
|
+
* @memberof DataTypesRefundStatusDto
|
|
14700
|
+
*/
|
|
14701
|
+
'refund_id'?: string;
|
|
13819
14702
|
/**
|
|
13820
14703
|
*
|
|
13821
14704
|
* @type {number}
|
|
@@ -17370,6 +18253,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
17370
18253
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
17371
18254
|
* @param {string} [endTime] End time in RFC3339 format
|
|
17372
18255
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum} [granularity] Time granularity
|
|
18256
|
+
* @param {string} [search] Search term to filter geographic locations (case-insensitive partial match on country, region, city)
|
|
17373
18257
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
17374
18258
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
17375
18259
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
@@ -17393,7 +18277,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
17393
18277
|
* @param {*} [options] Override http request option.
|
|
17394
18278
|
* @throws {RequiredError}
|
|
17395
18279
|
*/
|
|
17396
|
-
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<RequestArgs>;
|
|
18280
|
+
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<RequestArgs>;
|
|
17397
18281
|
/**
|
|
17398
18282
|
* 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
|
|
17399
18283
|
* @summary Get Geographic Insights
|
|
@@ -17418,14 +18302,17 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
17418
18302
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
17419
18303
|
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
17420
18304
|
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
18305
|
+
* @param {string} [geoQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
17421
18306
|
* @param {number} [resultsPage] Page number for top results pagination
|
|
17422
18307
|
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
18308
|
+
* @param {string} [geoResultsSearch] Search term to filter top results (case-insensitive partial match on item IDs)
|
|
17423
18309
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
17424
18310
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
18311
|
+
* @param {string} [geoFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
17425
18312
|
* @param {*} [options] Override http request option.
|
|
17426
18313
|
* @throws {RequiredError}
|
|
17427
18314
|
*/
|
|
17428
|
-
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<RequestArgs>;
|
|
18315
|
+
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<RequestArgs>;
|
|
17429
18316
|
/**
|
|
17430
18317
|
* Check the health status of analytics service and ClickHouse connection
|
|
17431
18318
|
* @summary Analytics Health Check
|
|
@@ -17572,6 +18459,12 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
17572
18459
|
* @param {string} query Search query to analyze
|
|
17573
18460
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
17574
18461
|
* @param {string} [endTime] End time in RFC3339 format
|
|
18462
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
18463
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
18464
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
18465
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
18466
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
18467
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
17575
18468
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
17576
18469
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
17577
18470
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -17582,15 +18475,18 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
17582
18475
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
17583
18476
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
17584
18477
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
18478
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
17585
18479
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
17586
18480
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
18481
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
17587
18482
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
17588
18483
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
18484
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
17589
18485
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
17590
18486
|
* @param {*} [options] Override http request option.
|
|
17591
18487
|
* @throws {RequiredError}
|
|
17592
18488
|
*/
|
|
17593
|
-
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<RequestArgs>;
|
|
18489
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17594
18490
|
/**
|
|
17595
18491
|
* 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.
|
|
17596
18492
|
* @summary Get Top Results Analytics
|
|
@@ -17626,11 +18522,11 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
17626
18522
|
*/
|
|
17627
18523
|
adminAnalyticsStoreXStoreIDResultsGet: (xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17628
18524
|
/**
|
|
17629
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
18525
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
17630
18526
|
* @summary Get Analytics Tags
|
|
17631
18527
|
* @param {string} xStoreID Store ID
|
|
17632
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
17633
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
18528
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
18529
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
17634
18530
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
17635
18531
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
17636
18532
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -17769,6 +18665,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
17769
18665
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
17770
18666
|
* @param {string} [endTime] End time in RFC3339 format
|
|
17771
18667
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum} [granularity] Time granularity
|
|
18668
|
+
* @param {string} [search] Search term to filter geographic locations (case-insensitive partial match on country, region, city)
|
|
17772
18669
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
17773
18670
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
17774
18671
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
@@ -17792,7 +18689,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
17792
18689
|
* @param {*} [options] Override http request option.
|
|
17793
18690
|
* @throws {RequiredError}
|
|
17794
18691
|
*/
|
|
17795
|
-
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>>;
|
|
18692
|
+
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>>;
|
|
17796
18693
|
/**
|
|
17797
18694
|
* 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
|
|
17798
18695
|
* @summary Get Geographic Insights
|
|
@@ -17817,14 +18714,17 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
17817
18714
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
17818
18715
|
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
17819
18716
|
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
18717
|
+
* @param {string} [geoQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
17820
18718
|
* @param {number} [resultsPage] Page number for top results pagination
|
|
17821
18719
|
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
18720
|
+
* @param {string} [geoResultsSearch] Search term to filter top results (case-insensitive partial match on item IDs)
|
|
17822
18721
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
17823
18722
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
18723
|
+
* @param {string} [geoFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
17824
18724
|
* @param {*} [options] Override http request option.
|
|
17825
18725
|
* @throws {RequiredError}
|
|
17826
18726
|
*/
|
|
17827
|
-
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>>;
|
|
18727
|
+
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>>;
|
|
17828
18728
|
/**
|
|
17829
18729
|
* Check the health status of analytics service and ClickHouse connection
|
|
17830
18730
|
* @summary Analytics Health Check
|
|
@@ -17971,6 +18871,12 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
17971
18871
|
* @param {string} query Search query to analyze
|
|
17972
18872
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
17973
18873
|
* @param {string} [endTime] End time in RFC3339 format
|
|
18874
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
18875
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
18876
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
18877
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
18878
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
18879
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
17974
18880
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
17975
18881
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
17976
18882
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -17981,15 +18887,18 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
17981
18887
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
17982
18888
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
17983
18889
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
18890
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
17984
18891
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
17985
18892
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
18893
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
17986
18894
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
17987
18895
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
18896
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
17988
18897
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
17989
18898
|
* @param {*} [options] Override http request option.
|
|
17990
18899
|
* @throws {RequiredError}
|
|
17991
18900
|
*/
|
|
17992
|
-
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>>;
|
|
18901
|
+
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>>;
|
|
17993
18902
|
/**
|
|
17994
18903
|
* 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.
|
|
17995
18904
|
* @summary Get Top Results Analytics
|
|
@@ -18025,11 +18934,11 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
18025
18934
|
*/
|
|
18026
18935
|
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response>>;
|
|
18027
18936
|
/**
|
|
18028
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
18937
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
18029
18938
|
* @summary Get Analytics Tags
|
|
18030
18939
|
* @param {string} xStoreID Store ID
|
|
18031
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
18032
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
18940
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
18941
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
18033
18942
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
18034
18943
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
18035
18944
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -18168,6 +19077,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
18168
19077
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
18169
19078
|
* @param {string} [endTime] End time in RFC3339 format
|
|
18170
19079
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum} [granularity] Time granularity
|
|
19080
|
+
* @param {string} [search] Search term to filter geographic locations (case-insensitive partial match on country, region, city)
|
|
18171
19081
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
18172
19082
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
18173
19083
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
@@ -18191,7 +19101,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
18191
19101
|
* @param {*} [options] Override http request option.
|
|
18192
19102
|
* @throws {RequiredError}
|
|
18193
19103
|
*/
|
|
18194
|
-
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>;
|
|
19104
|
+
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>;
|
|
18195
19105
|
/**
|
|
18196
19106
|
* 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
|
|
18197
19107
|
* @summary Get Geographic Insights
|
|
@@ -18216,14 +19126,17 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
18216
19126
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
18217
19127
|
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
18218
19128
|
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
19129
|
+
* @param {string} [geoQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
18219
19130
|
* @param {number} [resultsPage] Page number for top results pagination
|
|
18220
19131
|
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
19132
|
+
* @param {string} [geoResultsSearch] Search term to filter top results (case-insensitive partial match on item IDs)
|
|
18221
19133
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
18222
19134
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
19135
|
+
* @param {string} [geoFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
18223
19136
|
* @param {*} [options] Override http request option.
|
|
18224
19137
|
* @throws {RequiredError}
|
|
18225
19138
|
*/
|
|
18226
|
-
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>;
|
|
19139
|
+
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>;
|
|
18227
19140
|
/**
|
|
18228
19141
|
* Check the health status of analytics service and ClickHouse connection
|
|
18229
19142
|
* @summary Analytics Health Check
|
|
@@ -18370,6 +19283,12 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
18370
19283
|
* @param {string} query Search query to analyze
|
|
18371
19284
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
18372
19285
|
* @param {string} [endTime] End time in RFC3339 format
|
|
19286
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
19287
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
19288
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
19289
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
19290
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
19291
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
18373
19292
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
18374
19293
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
18375
19294
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -18380,15 +19299,18 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
18380
19299
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
18381
19300
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
18382
19301
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
19302
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
18383
19303
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
18384
19304
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
19305
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
18385
19306
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
18386
19307
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
19308
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
18387
19309
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
18388
19310
|
* @param {*} [options] Override http request option.
|
|
18389
19311
|
* @throws {RequiredError}
|
|
18390
19312
|
*/
|
|
18391
|
-
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>;
|
|
19313
|
+
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>;
|
|
18392
19314
|
/**
|
|
18393
19315
|
* 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.
|
|
18394
19316
|
* @summary Get Top Results Analytics
|
|
@@ -18424,11 +19346,11 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
18424
19346
|
*/
|
|
18425
19347
|
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response>;
|
|
18426
19348
|
/**
|
|
18427
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
19349
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
18428
19350
|
* @summary Get Analytics Tags
|
|
18429
19351
|
* @param {string} xStoreID Store ID
|
|
18430
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
18431
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
19352
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
19353
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
18432
19354
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
18433
19355
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
18434
19356
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -18575,6 +19497,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
18575
19497
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
18576
19498
|
* @param {string} [endTime] End time in RFC3339 format
|
|
18577
19499
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum} [granularity] Time granularity
|
|
19500
|
+
* @param {string} [search] Search term to filter geographic locations (case-insensitive partial match on country, region, city)
|
|
18578
19501
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
18579
19502
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
18580
19503
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
@@ -18599,7 +19522,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
18599
19522
|
* @throws {RequiredError}
|
|
18600
19523
|
* @memberof AnalyticsApi
|
|
18601
19524
|
*/
|
|
18602
|
-
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDGeoGet200Response, any, {}>>;
|
|
19525
|
+
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDGeoGet200Response, any, {}>>;
|
|
18603
19526
|
/**
|
|
18604
19527
|
* 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
|
|
18605
19528
|
* @summary Get Geographic Insights
|
|
@@ -18624,15 +19547,18 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
18624
19547
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
18625
19548
|
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
18626
19549
|
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
19550
|
+
* @param {string} [geoQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
18627
19551
|
* @param {number} [resultsPage] Page number for top results pagination
|
|
18628
19552
|
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
19553
|
+
* @param {string} [geoResultsSearch] Search term to filter top results (case-insensitive partial match on item IDs)
|
|
18629
19554
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
18630
19555
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
19556
|
+
* @param {string} [geoFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
18631
19557
|
* @param {*} [options] Override http request option.
|
|
18632
19558
|
* @throws {RequiredError}
|
|
18633
19559
|
* @memberof AnalyticsApi
|
|
18634
19560
|
*/
|
|
18635
|
-
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDGeoInsightsGet200Response, any, {}>>;
|
|
19561
|
+
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDGeoInsightsGet200Response, any, {}>>;
|
|
18636
19562
|
/**
|
|
18637
19563
|
* Check the health status of analytics service and ClickHouse connection
|
|
18638
19564
|
* @summary Analytics Health Check
|
|
@@ -18785,6 +19711,12 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
18785
19711
|
* @param {string} query Search query to analyze
|
|
18786
19712
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
18787
19713
|
* @param {string} [endTime] End time in RFC3339 format
|
|
19714
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
19715
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
19716
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
19717
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
19718
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
19719
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
18788
19720
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
18789
19721
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
18790
19722
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -18795,16 +19727,19 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
18795
19727
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
18796
19728
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
18797
19729
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
19730
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
18798
19731
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
18799
19732
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
19733
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
18800
19734
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
18801
19735
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
19736
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
18802
19737
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
18803
19738
|
* @param {*} [options] Override http request option.
|
|
18804
19739
|
* @throws {RequiredError}
|
|
18805
19740
|
* @memberof AnalyticsApi
|
|
18806
19741
|
*/
|
|
18807
|
-
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any, {}>>;
|
|
19742
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any, {}>>;
|
|
18808
19743
|
/**
|
|
18809
19744
|
* 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.
|
|
18810
19745
|
* @summary Get Top Results Analytics
|
|
@@ -18841,11 +19776,11 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
18841
19776
|
*/
|
|
18842
19777
|
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response, any, {}>>;
|
|
18843
19778
|
/**
|
|
18844
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
19779
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
18845
19780
|
* @summary Get Analytics Tags
|
|
18846
19781
|
* @param {string} xStoreID Store ID
|
|
18847
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
18848
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
19782
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
19783
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
18849
19784
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
18850
19785
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
18851
19786
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -19186,6 +20121,14 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum
|
|
|
19186
20121
|
readonly Desc: "desc";
|
|
19187
20122
|
};
|
|
19188
20123
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
20124
|
+
/**
|
|
20125
|
+
* @export
|
|
20126
|
+
*/
|
|
20127
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum: {
|
|
20128
|
+
readonly Any: "any";
|
|
20129
|
+
readonly All: "all";
|
|
20130
|
+
};
|
|
20131
|
+
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum];
|
|
19189
20132
|
/**
|
|
19190
20133
|
* @export
|
|
19191
20134
|
*/
|
|
@@ -21324,6 +22267,7 @@ export declare const ItemAnalyticsApiAxiosParamCreator: (configuration?: Configu
|
|
|
21324
22267
|
* @param {string} xStoreID Store ID
|
|
21325
22268
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
21326
22269
|
* @param {string} [endTime] End time in RFC3339 format
|
|
22270
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
21327
22271
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
21328
22272
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
21329
22273
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -21338,7 +22282,7 @@ export declare const ItemAnalyticsApiAxiosParamCreator: (configuration?: Configu
|
|
|
21338
22282
|
* @param {*} [options] Override http request option.
|
|
21339
22283
|
* @throws {RequiredError}
|
|
21340
22284
|
*/
|
|
21341
|
-
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<RequestArgs>;
|
|
22285
|
+
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<RequestArgs>;
|
|
21342
22286
|
/**
|
|
21343
22287
|
* Retrieve detailed analytics for a specific item including performance metrics and discovery data
|
|
21344
22288
|
* @summary Get Item Details
|
|
@@ -21372,15 +22316,18 @@ export declare const ItemAnalyticsApiAxiosParamCreator: (configuration?: Configu
|
|
|
21372
22316
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
21373
22317
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
21374
22318
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
22319
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
21375
22320
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
21376
22321
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
22322
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
21377
22323
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
21378
22324
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22325
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
21379
22326
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
21380
22327
|
* @param {*} [options] Override http request option.
|
|
21381
22328
|
* @throws {RequiredError}
|
|
21382
22329
|
*/
|
|
21383
|
-
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<RequestArgs>;
|
|
22330
|
+
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<RequestArgs>;
|
|
21384
22331
|
/**
|
|
21385
22332
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
21386
22333
|
* @summary Get Item Performance Analytics
|
|
@@ -21487,6 +22434,7 @@ export declare const ItemAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
21487
22434
|
* @param {string} xStoreID Store ID
|
|
21488
22435
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
21489
22436
|
* @param {string} [endTime] End time in RFC3339 format
|
|
22437
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
21490
22438
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
21491
22439
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
21492
22440
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -21501,7 +22449,7 @@ export declare const ItemAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
21501
22449
|
* @param {*} [options] Override http request option.
|
|
21502
22450
|
* @throws {RequiredError}
|
|
21503
22451
|
*/
|
|
21504
|
-
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>>;
|
|
22452
|
+
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>>;
|
|
21505
22453
|
/**
|
|
21506
22454
|
* Retrieve detailed analytics for a specific item including performance metrics and discovery data
|
|
21507
22455
|
* @summary Get Item Details
|
|
@@ -21535,15 +22483,18 @@ export declare const ItemAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
21535
22483
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
21536
22484
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
21537
22485
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
22486
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
21538
22487
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
21539
22488
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
22489
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
21540
22490
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
21541
22491
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22492
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
21542
22493
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
21543
22494
|
* @param {*} [options] Override http request option.
|
|
21544
22495
|
* @throws {RequiredError}
|
|
21545
22496
|
*/
|
|
21546
|
-
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>>;
|
|
22497
|
+
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>>;
|
|
21547
22498
|
/**
|
|
21548
22499
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
21549
22500
|
* @summary Get Item Performance Analytics
|
|
@@ -21650,6 +22601,7 @@ export declare const ItemAnalyticsApiFactory: (configuration?: Configuration, ba
|
|
|
21650
22601
|
* @param {string} xStoreID Store ID
|
|
21651
22602
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
21652
22603
|
* @param {string} [endTime] End time in RFC3339 format
|
|
22604
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
21653
22605
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
21654
22606
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
21655
22607
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -21664,7 +22616,7 @@ export declare const ItemAnalyticsApiFactory: (configuration?: Configuration, ba
|
|
|
21664
22616
|
* @param {*} [options] Override http request option.
|
|
21665
22617
|
* @throws {RequiredError}
|
|
21666
22618
|
*/
|
|
21667
|
-
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>;
|
|
22619
|
+
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>;
|
|
21668
22620
|
/**
|
|
21669
22621
|
* Retrieve detailed analytics for a specific item including performance metrics and discovery data
|
|
21670
22622
|
* @summary Get Item Details
|
|
@@ -21698,15 +22650,18 @@ export declare const ItemAnalyticsApiFactory: (configuration?: Configuration, ba
|
|
|
21698
22650
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
21699
22651
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
21700
22652
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
22653
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
21701
22654
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
21702
22655
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
22656
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
21703
22657
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
21704
22658
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22659
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
21705
22660
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
21706
22661
|
* @param {*} [options] Override http request option.
|
|
21707
22662
|
* @throws {RequiredError}
|
|
21708
22663
|
*/
|
|
21709
|
-
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>;
|
|
22664
|
+
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>;
|
|
21710
22665
|
/**
|
|
21711
22666
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
21712
22667
|
* @summary Get Item Performance Analytics
|
|
@@ -21817,6 +22772,7 @@ export declare class ItemAnalyticsApi extends BaseAPI {
|
|
|
21817
22772
|
* @param {string} xStoreID Store ID
|
|
21818
22773
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
21819
22774
|
* @param {string} [endTime] End time in RFC3339 format
|
|
22775
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
21820
22776
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
21821
22777
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
21822
22778
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -21832,7 +22788,7 @@ export declare class ItemAnalyticsApi extends BaseAPI {
|
|
|
21832
22788
|
* @throws {RequiredError}
|
|
21833
22789
|
* @memberof ItemAnalyticsApi
|
|
21834
22790
|
*/
|
|
21835
|
-
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<import("axios").AxiosResponse<AnalyticsAnalyticsAPIResponse, any, {}>>;
|
|
22791
|
+
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<import("axios").AxiosResponse<AnalyticsAnalyticsAPIResponse, any, {}>>;
|
|
21836
22792
|
/**
|
|
21837
22793
|
* Retrieve detailed analytics for a specific item including performance metrics and discovery data
|
|
21838
22794
|
* @summary Get Item Details
|
|
@@ -21867,16 +22823,19 @@ export declare class ItemAnalyticsApi extends BaseAPI {
|
|
|
21867
22823
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
21868
22824
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
21869
22825
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
22826
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
21870
22827
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
21871
22828
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
22829
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
21872
22830
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
21873
22831
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22832
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
21874
22833
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
21875
22834
|
* @param {*} [options] Override http request option.
|
|
21876
22835
|
* @throws {RequiredError}
|
|
21877
22836
|
* @memberof ItemAnalyticsApi
|
|
21878
22837
|
*/
|
|
21879
|
-
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response, any, {}>>;
|
|
22838
|
+
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response, any, {}>>;
|
|
21880
22839
|
/**
|
|
21881
22840
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
21882
22841
|
* @summary Get Item Performance Analytics
|
|
@@ -25327,6 +26286,51 @@ export declare const QuerySuggestionsManagementApiAxiosParamCreator: (configurat
|
|
|
25327
26286
|
* @throws {RequiredError}
|
|
25328
26287
|
*/
|
|
25329
26288
|
adminV1QuerySuggestionsMigrateAllPost: (daysBack?: number, minPopularity?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26289
|
+
/**
|
|
26290
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
26291
|
+
* @summary Apply Suggestion Filters
|
|
26292
|
+
* @param {string} xStoreID Store ID
|
|
26293
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
26294
|
+
* @param {*} [options] Override http request option.
|
|
26295
|
+
* @throws {RequiredError}
|
|
26296
|
+
*/
|
|
26297
|
+
adminV1QuerySuggestionsXStoreIDApplyFiltersPost: (xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26298
|
+
/**
|
|
26299
|
+
* Delete a banned expression
|
|
26300
|
+
* @summary Delete Banned Expression
|
|
26301
|
+
* @param {string} xStoreID Store ID
|
|
26302
|
+
* @param {string} expressionID Banned Expression ID
|
|
26303
|
+
* @param {*} [options] Override http request option.
|
|
26304
|
+
* @throws {RequiredError}
|
|
26305
|
+
*/
|
|
26306
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete: (xStoreID: string, expressionID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26307
|
+
/**
|
|
26308
|
+
* Update an existing banned expression
|
|
26309
|
+
* @summary Update Banned Expression
|
|
26310
|
+
* @param {string} xStoreID Store ID
|
|
26311
|
+
* @param {string} expressionID Banned Expression ID
|
|
26312
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
26313
|
+
* @param {*} [options] Override http request option.
|
|
26314
|
+
* @throws {RequiredError}
|
|
26315
|
+
*/
|
|
26316
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut: (xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26317
|
+
/**
|
|
26318
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
26319
|
+
* @summary Get Banned Expressions
|
|
26320
|
+
* @param {string} xStoreID Store ID
|
|
26321
|
+
* @param {*} [options] Override http request option.
|
|
26322
|
+
* @throws {RequiredError}
|
|
26323
|
+
*/
|
|
26324
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsGet: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26325
|
+
/**
|
|
26326
|
+
* Create a new banned expression with specified matching type
|
|
26327
|
+
* @summary Create Banned Expression
|
|
26328
|
+
* @param {string} xStoreID Store ID
|
|
26329
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
26330
|
+
* @param {*} [options] Override http request option.
|
|
26331
|
+
* @throws {RequiredError}
|
|
26332
|
+
*/
|
|
26333
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsPost: (xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25330
26334
|
/**
|
|
25331
26335
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
25332
26336
|
* @summary Bulk Update Suggestions
|
|
@@ -25364,6 +26368,22 @@ export declare const QuerySuggestionsManagementApiAxiosParamCreator: (configurat
|
|
|
25364
26368
|
* @throws {RequiredError}
|
|
25365
26369
|
*/
|
|
25366
26370
|
adminV1QuerySuggestionsXStoreIDConfigPut: (xStoreID: string, analyticsUpdateSuggestionConfigRequest: AnalyticsUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26371
|
+
/**
|
|
26372
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
26373
|
+
* @summary Generate Enhanced Category Suggestions
|
|
26374
|
+
* @param {string} xStoreID Store ID
|
|
26375
|
+
* @param {*} [options] Override http request option.
|
|
26376
|
+
* @throws {RequiredError}
|
|
26377
|
+
*/
|
|
26378
|
+
adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26379
|
+
/**
|
|
26380
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
26381
|
+
* @summary Generate Facet-Based Suggestions
|
|
26382
|
+
* @param {string} xStoreID Store ID
|
|
26383
|
+
* @param {*} [options] Override http request option.
|
|
26384
|
+
* @throws {RequiredError}
|
|
26385
|
+
*/
|
|
26386
|
+
adminV1QuerySuggestionsXStoreIDGenerateFacetsPost: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25367
26387
|
/**
|
|
25368
26388
|
* Retrieve query suggestions with filtering and pagination for management
|
|
25369
26389
|
* @summary Get Query Suggestions
|
|
@@ -25541,6 +26561,51 @@ export declare const QuerySuggestionsManagementApiFp: (configuration?: Configura
|
|
|
25541
26561
|
* @throws {RequiredError}
|
|
25542
26562
|
*/
|
|
25543
26563
|
adminV1QuerySuggestionsMigrateAllPost(daysBack?: number, minPopularity?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>>;
|
|
26564
|
+
/**
|
|
26565
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
26566
|
+
* @summary Apply Suggestion Filters
|
|
26567
|
+
* @param {string} xStoreID Store ID
|
|
26568
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
26569
|
+
* @param {*} [options] Override http request option.
|
|
26570
|
+
* @throws {RequiredError}
|
|
26571
|
+
*/
|
|
26572
|
+
adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>>;
|
|
26573
|
+
/**
|
|
26574
|
+
* Delete a banned expression
|
|
26575
|
+
* @summary Delete Banned Expression
|
|
26576
|
+
* @param {string} xStoreID Store ID
|
|
26577
|
+
* @param {string} expressionID Banned Expression ID
|
|
26578
|
+
* @param {*} [options] Override http request option.
|
|
26579
|
+
* @throws {RequiredError}
|
|
26580
|
+
*/
|
|
26581
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID: string, expressionID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>>;
|
|
26582
|
+
/**
|
|
26583
|
+
* Update an existing banned expression
|
|
26584
|
+
* @summary Update Banned Expression
|
|
26585
|
+
* @param {string} xStoreID Store ID
|
|
26586
|
+
* @param {string} expressionID Banned Expression ID
|
|
26587
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
26588
|
+
* @param {*} [options] Override http request option.
|
|
26589
|
+
* @throws {RequiredError}
|
|
26590
|
+
*/
|
|
26591
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response>>;
|
|
26592
|
+
/**
|
|
26593
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
26594
|
+
* @summary Get Banned Expressions
|
|
26595
|
+
* @param {string} xStoreID Store ID
|
|
26596
|
+
* @param {*} [options] Override http request option.
|
|
26597
|
+
* @throws {RequiredError}
|
|
26598
|
+
*/
|
|
26599
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response>>;
|
|
26600
|
+
/**
|
|
26601
|
+
* Create a new banned expression with specified matching type
|
|
26602
|
+
* @summary Create Banned Expression
|
|
26603
|
+
* @param {string} xStoreID Store ID
|
|
26604
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
26605
|
+
* @param {*} [options] Override http request option.
|
|
26606
|
+
* @throws {RequiredError}
|
|
26607
|
+
*/
|
|
26608
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response>>;
|
|
25544
26609
|
/**
|
|
25545
26610
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
25546
26611
|
* @summary Bulk Update Suggestions
|
|
@@ -25578,6 +26643,22 @@ export declare const QuerySuggestionsManagementApiFp: (configuration?: Configura
|
|
|
25578
26643
|
* @throws {RequiredError}
|
|
25579
26644
|
*/
|
|
25580
26645
|
adminV1QuerySuggestionsXStoreIDConfigPut(xStoreID: string, analyticsUpdateSuggestionConfigRequest: AnalyticsUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDConfigGet200Response>>;
|
|
26646
|
+
/**
|
|
26647
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
26648
|
+
* @summary Generate Enhanced Category Suggestions
|
|
26649
|
+
* @param {string} xStoreID Store ID
|
|
26650
|
+
* @param {*} [options] Override http request option.
|
|
26651
|
+
* @throws {RequiredError}
|
|
26652
|
+
*/
|
|
26653
|
+
adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response>>;
|
|
26654
|
+
/**
|
|
26655
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
26656
|
+
* @summary Generate Facet-Based Suggestions
|
|
26657
|
+
* @param {string} xStoreID Store ID
|
|
26658
|
+
* @param {*} [options] Override http request option.
|
|
26659
|
+
* @throws {RequiredError}
|
|
26660
|
+
*/
|
|
26661
|
+
adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response>>;
|
|
25581
26662
|
/**
|
|
25582
26663
|
* Retrieve query suggestions with filtering and pagination for management
|
|
25583
26664
|
* @summary Get Query Suggestions
|
|
@@ -25601,7 +26682,7 @@ export declare const QuerySuggestionsManagementApiFp: (configuration?: Configura
|
|
|
25601
26682
|
* @param {*} [options] Override http request option.
|
|
25602
26683
|
* @throws {RequiredError}
|
|
25603
26684
|
*/
|
|
25604
|
-
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
26685
|
+
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>>;
|
|
25605
26686
|
/**
|
|
25606
26687
|
* Delete manually added query suggestions for a store
|
|
25607
26688
|
* @summary Delete Manual Query Suggestions
|
|
@@ -25647,7 +26728,7 @@ export declare const QuerySuggestionsManagementApiFp: (configuration?: Configura
|
|
|
25647
26728
|
* @param {*} [options] Override http request option.
|
|
25648
26729
|
* @throws {RequiredError}
|
|
25649
26730
|
*/
|
|
25650
|
-
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
26731
|
+
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>>;
|
|
25651
26732
|
/**
|
|
25652
26733
|
* Refresh auto-generated suggestions from search analytics data
|
|
25653
26734
|
* @summary Refresh Auto-Generated Suggestions
|
|
@@ -25755,6 +26836,51 @@ export declare const QuerySuggestionsManagementApiFactory: (configuration?: Conf
|
|
|
25755
26836
|
* @throws {RequiredError}
|
|
25756
26837
|
*/
|
|
25757
26838
|
adminV1QuerySuggestionsMigrateAllPost(daysBack?: number, minPopularity?: number, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse>;
|
|
26839
|
+
/**
|
|
26840
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
26841
|
+
* @summary Apply Suggestion Filters
|
|
26842
|
+
* @param {string} xStoreID Store ID
|
|
26843
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
26844
|
+
* @param {*} [options] Override http request option.
|
|
26845
|
+
* @throws {RequiredError}
|
|
26846
|
+
*/
|
|
26847
|
+
adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>;
|
|
26848
|
+
/**
|
|
26849
|
+
* Delete a banned expression
|
|
26850
|
+
* @summary Delete Banned Expression
|
|
26851
|
+
* @param {string} xStoreID Store ID
|
|
26852
|
+
* @param {string} expressionID Banned Expression ID
|
|
26853
|
+
* @param {*} [options] Override http request option.
|
|
26854
|
+
* @throws {RequiredError}
|
|
26855
|
+
*/
|
|
26856
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID: string, expressionID: string, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse>;
|
|
26857
|
+
/**
|
|
26858
|
+
* Update an existing banned expression
|
|
26859
|
+
* @summary Update Banned Expression
|
|
26860
|
+
* @param {string} xStoreID Store ID
|
|
26861
|
+
* @param {string} expressionID Banned Expression ID
|
|
26862
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
26863
|
+
* @param {*} [options] Override http request option.
|
|
26864
|
+
* @throws {RequiredError}
|
|
26865
|
+
*/
|
|
26866
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response>;
|
|
26867
|
+
/**
|
|
26868
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
26869
|
+
* @summary Get Banned Expressions
|
|
26870
|
+
* @param {string} xStoreID Store ID
|
|
26871
|
+
* @param {*} [options] Override http request option.
|
|
26872
|
+
* @throws {RequiredError}
|
|
26873
|
+
*/
|
|
26874
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response>;
|
|
26875
|
+
/**
|
|
26876
|
+
* Create a new banned expression with specified matching type
|
|
26877
|
+
* @summary Create Banned Expression
|
|
26878
|
+
* @param {string} xStoreID Store ID
|
|
26879
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
26880
|
+
* @param {*} [options] Override http request option.
|
|
26881
|
+
* @throws {RequiredError}
|
|
26882
|
+
*/
|
|
26883
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response>;
|
|
25758
26884
|
/**
|
|
25759
26885
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
25760
26886
|
* @summary Bulk Update Suggestions
|
|
@@ -25792,6 +26918,22 @@ export declare const QuerySuggestionsManagementApiFactory: (configuration?: Conf
|
|
|
25792
26918
|
* @throws {RequiredError}
|
|
25793
26919
|
*/
|
|
25794
26920
|
adminV1QuerySuggestionsXStoreIDConfigPut(xStoreID: string, analyticsUpdateSuggestionConfigRequest: AnalyticsUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDConfigGet200Response>;
|
|
26921
|
+
/**
|
|
26922
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
26923
|
+
* @summary Generate Enhanced Category Suggestions
|
|
26924
|
+
* @param {string} xStoreID Store ID
|
|
26925
|
+
* @param {*} [options] Override http request option.
|
|
26926
|
+
* @throws {RequiredError}
|
|
26927
|
+
*/
|
|
26928
|
+
adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response>;
|
|
26929
|
+
/**
|
|
26930
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
26931
|
+
* @summary Generate Facet-Based Suggestions
|
|
26932
|
+
* @param {string} xStoreID Store ID
|
|
26933
|
+
* @param {*} [options] Override http request option.
|
|
26934
|
+
* @throws {RequiredError}
|
|
26935
|
+
*/
|
|
26936
|
+
adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response>;
|
|
25795
26937
|
/**
|
|
25796
26938
|
* Retrieve query suggestions with filtering and pagination for management
|
|
25797
26939
|
* @summary Get Query Suggestions
|
|
@@ -25815,7 +26957,7 @@ export declare const QuerySuggestionsManagementApiFactory: (configuration?: Conf
|
|
|
25815
26957
|
* @param {*} [options] Override http request option.
|
|
25816
26958
|
* @throws {RequiredError}
|
|
25817
26959
|
*/
|
|
25818
|
-
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
26960
|
+
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>;
|
|
25819
26961
|
/**
|
|
25820
26962
|
* Delete manually added query suggestions for a store
|
|
25821
26963
|
* @summary Delete Manual Query Suggestions
|
|
@@ -25861,7 +27003,7 @@ export declare const QuerySuggestionsManagementApiFactory: (configuration?: Conf
|
|
|
25861
27003
|
* @param {*} [options] Override http request option.
|
|
25862
27004
|
* @throws {RequiredError}
|
|
25863
27005
|
*/
|
|
25864
|
-
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
27006
|
+
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>;
|
|
25865
27007
|
/**
|
|
25866
27008
|
* Refresh auto-generated suggestions from search analytics data
|
|
25867
27009
|
* @summary Refresh Auto-Generated Suggestions
|
|
@@ -25972,6 +27114,56 @@ export declare class QuerySuggestionsManagementApi extends BaseAPI {
|
|
|
25972
27114
|
* @memberof QuerySuggestionsManagementApi
|
|
25973
27115
|
*/
|
|
25974
27116
|
adminV1QuerySuggestionsMigrateAllPost(daysBack?: number, minPopularity?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsAnalyticsAPIResponse, any, {}>>;
|
|
27117
|
+
/**
|
|
27118
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
27119
|
+
* @summary Apply Suggestion Filters
|
|
27120
|
+
* @param {string} xStoreID Store ID
|
|
27121
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
27122
|
+
* @param {*} [options] Override http request option.
|
|
27123
|
+
* @throws {RequiredError}
|
|
27124
|
+
* @memberof QuerySuggestionsManagementApi
|
|
27125
|
+
*/
|
|
27126
|
+
adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response, any, {}>>;
|
|
27127
|
+
/**
|
|
27128
|
+
* Delete a banned expression
|
|
27129
|
+
* @summary Delete Banned Expression
|
|
27130
|
+
* @param {string} xStoreID Store ID
|
|
27131
|
+
* @param {string} expressionID Banned Expression ID
|
|
27132
|
+
* @param {*} [options] Override http request option.
|
|
27133
|
+
* @throws {RequiredError}
|
|
27134
|
+
* @memberof QuerySuggestionsManagementApi
|
|
27135
|
+
*/
|
|
27136
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID: string, expressionID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsAnalyticsAPIResponse, any, {}>>;
|
|
27137
|
+
/**
|
|
27138
|
+
* Update an existing banned expression
|
|
27139
|
+
* @summary Update Banned Expression
|
|
27140
|
+
* @param {string} xStoreID Store ID
|
|
27141
|
+
* @param {string} expressionID Banned Expression ID
|
|
27142
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
27143
|
+
* @param {*} [options] Override http request option.
|
|
27144
|
+
* @throws {RequiredError}
|
|
27145
|
+
* @memberof QuerySuggestionsManagementApi
|
|
27146
|
+
*/
|
|
27147
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response, any, {}>>;
|
|
27148
|
+
/**
|
|
27149
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
27150
|
+
* @summary Get Banned Expressions
|
|
27151
|
+
* @param {string} xStoreID Store ID
|
|
27152
|
+
* @param {*} [options] Override http request option.
|
|
27153
|
+
* @throws {RequiredError}
|
|
27154
|
+
* @memberof QuerySuggestionsManagementApi
|
|
27155
|
+
*/
|
|
27156
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response, any, {}>>;
|
|
27157
|
+
/**
|
|
27158
|
+
* Create a new banned expression with specified matching type
|
|
27159
|
+
* @summary Create Banned Expression
|
|
27160
|
+
* @param {string} xStoreID Store ID
|
|
27161
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
27162
|
+
* @param {*} [options] Override http request option.
|
|
27163
|
+
* @throws {RequiredError}
|
|
27164
|
+
* @memberof QuerySuggestionsManagementApi
|
|
27165
|
+
*/
|
|
27166
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response, any, {}>>;
|
|
25975
27167
|
/**
|
|
25976
27168
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
25977
27169
|
* @summary Bulk Update Suggestions
|
|
@@ -26013,6 +27205,24 @@ export declare class QuerySuggestionsManagementApi extends BaseAPI {
|
|
|
26013
27205
|
* @memberof QuerySuggestionsManagementApi
|
|
26014
27206
|
*/
|
|
26015
27207
|
adminV1QuerySuggestionsXStoreIDConfigPut(xStoreID: string, analyticsUpdateSuggestionConfigRequest: AnalyticsUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDConfigGet200Response, any, {}>>;
|
|
27208
|
+
/**
|
|
27209
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
27210
|
+
* @summary Generate Enhanced Category Suggestions
|
|
27211
|
+
* @param {string} xStoreID Store ID
|
|
27212
|
+
* @param {*} [options] Override http request option.
|
|
27213
|
+
* @throws {RequiredError}
|
|
27214
|
+
* @memberof QuerySuggestionsManagementApi
|
|
27215
|
+
*/
|
|
27216
|
+
adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response, any, {}>>;
|
|
27217
|
+
/**
|
|
27218
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
27219
|
+
* @summary Generate Facet-Based Suggestions
|
|
27220
|
+
* @param {string} xStoreID Store ID
|
|
27221
|
+
* @param {*} [options] Override http request option.
|
|
27222
|
+
* @throws {RequiredError}
|
|
27223
|
+
* @memberof QuerySuggestionsManagementApi
|
|
27224
|
+
*/
|
|
27225
|
+
adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response, any, {}>>;
|
|
26016
27226
|
/**
|
|
26017
27227
|
* Retrieve query suggestions with filtering and pagination for management
|
|
26018
27228
|
* @summary Get Query Suggestions
|
|
@@ -26038,7 +27248,7 @@ export declare class QuerySuggestionsManagementApi extends BaseAPI {
|
|
|
26038
27248
|
* @throws {RequiredError}
|
|
26039
27249
|
* @memberof QuerySuggestionsManagementApi
|
|
26040
27250
|
*/
|
|
26041
|
-
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
27251
|
+
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response, any, {}>>;
|
|
26042
27252
|
/**
|
|
26043
27253
|
* Delete manually added query suggestions for a store
|
|
26044
27254
|
* @summary Delete Manual Query Suggestions
|
|
@@ -26089,7 +27299,7 @@ export declare class QuerySuggestionsManagementApi extends BaseAPI {
|
|
|
26089
27299
|
* @throws {RequiredError}
|
|
26090
27300
|
* @memberof QuerySuggestionsManagementApi
|
|
26091
27301
|
*/
|
|
26092
|
-
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
27302
|
+
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response, any, {}>>;
|
|
26093
27303
|
/**
|
|
26094
27304
|
* Refresh auto-generated suggestions from search analytics data
|
|
26095
27305
|
* @summary Refresh Auto-Generated Suggestions
|
|
@@ -26222,13 +27432,13 @@ export declare const RefundManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
26222
27432
|
*/
|
|
26223
27433
|
paymentGatewayRefundRequestPost: (dataTypesCreateRefundRequestDto: DataTypesCreateRefundRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26224
27434
|
/**
|
|
26225
|
-
* Gets the current status and details of a refund request
|
|
27435
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
26226
27436
|
* @summary Get refund request status
|
|
26227
|
-
* @param {
|
|
27437
|
+
* @param {string} id Refund ID (UUID)
|
|
26228
27438
|
* @param {*} [options] Override http request option.
|
|
26229
27439
|
* @throws {RequiredError}
|
|
26230
27440
|
*/
|
|
26231
|
-
paymentGatewayRefundStatusIdGet: (id:
|
|
27441
|
+
paymentGatewayRefundStatusIdGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26232
27442
|
/**
|
|
26233
27443
|
* Gets a paginated list of refund requests with filtering
|
|
26234
27444
|
* @summary List refund requests
|
|
@@ -26276,13 +27486,13 @@ export declare const RefundManagementApiFp: (configuration?: Configuration) => {
|
|
|
26276
27486
|
*/
|
|
26277
27487
|
paymentGatewayRefundRequestPost(dataTypesCreateRefundRequestDto: DataTypesCreateRefundRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRefundRequestResponseDto>>;
|
|
26278
27488
|
/**
|
|
26279
|
-
* Gets the current status and details of a refund request
|
|
27489
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
26280
27490
|
* @summary Get refund request status
|
|
26281
|
-
* @param {
|
|
27491
|
+
* @param {string} id Refund ID (UUID)
|
|
26282
27492
|
* @param {*} [options] Override http request option.
|
|
26283
27493
|
* @throws {RequiredError}
|
|
26284
27494
|
*/
|
|
26285
|
-
paymentGatewayRefundStatusIdGet(id:
|
|
27495
|
+
paymentGatewayRefundStatusIdGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRefundStatusDto>>;
|
|
26286
27496
|
/**
|
|
26287
27497
|
* Gets a paginated list of refund requests with filtering
|
|
26288
27498
|
* @summary List refund requests
|
|
@@ -26330,13 +27540,13 @@ export declare const RefundManagementApiFactory: (configuration?: Configuration,
|
|
|
26330
27540
|
*/
|
|
26331
27541
|
paymentGatewayRefundRequestPost(dataTypesCreateRefundRequestDto: DataTypesCreateRefundRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRefundRequestResponseDto>;
|
|
26332
27542
|
/**
|
|
26333
|
-
* Gets the current status and details of a refund request
|
|
27543
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
26334
27544
|
* @summary Get refund request status
|
|
26335
|
-
* @param {
|
|
27545
|
+
* @param {string} id Refund ID (UUID)
|
|
26336
27546
|
* @param {*} [options] Override http request option.
|
|
26337
27547
|
* @throws {RequiredError}
|
|
26338
27548
|
*/
|
|
26339
|
-
paymentGatewayRefundStatusIdGet(id:
|
|
27549
|
+
paymentGatewayRefundStatusIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRefundStatusDto>;
|
|
26340
27550
|
/**
|
|
26341
27551
|
* Gets a paginated list of refund requests with filtering
|
|
26342
27552
|
* @summary List refund requests
|
|
@@ -26389,14 +27599,14 @@ export declare class RefundManagementApi extends BaseAPI {
|
|
|
26389
27599
|
*/
|
|
26390
27600
|
paymentGatewayRefundRequestPost(dataTypesCreateRefundRequestDto: DataTypesCreateRefundRequestDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesRefundRequestResponseDto, any, {}>>;
|
|
26391
27601
|
/**
|
|
26392
|
-
* Gets the current status and details of a refund request
|
|
27602
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
26393
27603
|
* @summary Get refund request status
|
|
26394
|
-
* @param {
|
|
27604
|
+
* @param {string} id Refund ID (UUID)
|
|
26395
27605
|
* @param {*} [options] Override http request option.
|
|
26396
27606
|
* @throws {RequiredError}
|
|
26397
27607
|
* @memberof RefundManagementApi
|
|
26398
27608
|
*/
|
|
26399
|
-
paymentGatewayRefundStatusIdGet(id:
|
|
27609
|
+
paymentGatewayRefundStatusIdGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesRefundStatusDto, any, {}>>;
|
|
26400
27610
|
/**
|
|
26401
27611
|
* Gets a paginated list of refund requests with filtering
|
|
26402
27612
|
* @summary List refund requests
|