@seekora-ai/admin-api 1.1.66 → 1.1.68
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -13
- package/api.ts +1771 -1321
- package/dist/api.d.ts +987 -703
- package/dist/api.js +606 -315
- package/dist/esm/api.d.ts +987 -703
- package/dist/esm/api.js +600 -305
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.68.tgz +0 -0
- package/seekora-ai-admin-api-1.1.66.tgz +0 -0
package/api.ts
CHANGED
|
@@ -883,6 +883,92 @@ export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
|
|
|
883
883
|
*/
|
|
884
884
|
'total'?: number;
|
|
885
885
|
}
|
|
886
|
+
/**
|
|
887
|
+
*
|
|
888
|
+
* @export
|
|
889
|
+
* @interface AdminAnalyticsStoreXStoreIDSuggestionsPopularGet200Response
|
|
890
|
+
*/
|
|
891
|
+
export interface AdminAnalyticsStoreXStoreIDSuggestionsPopularGet200Response {
|
|
892
|
+
/**
|
|
893
|
+
* Comparison metadata when in compare mode
|
|
894
|
+
* @type {AnalyticsComparisonMeta}
|
|
895
|
+
* @memberof AdminAnalyticsStoreXStoreIDSuggestionsPopularGet200Response
|
|
896
|
+
*/
|
|
897
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
898
|
+
/**
|
|
899
|
+
*
|
|
900
|
+
* @type {AnalyticsQuerySuggestionsResponse}
|
|
901
|
+
* @memberof AdminAnalyticsStoreXStoreIDSuggestionsPopularGet200Response
|
|
902
|
+
*/
|
|
903
|
+
'data'?: AnalyticsQuerySuggestionsResponse;
|
|
904
|
+
/**
|
|
905
|
+
*
|
|
906
|
+
* @type {string}
|
|
907
|
+
* @memberof AdminAnalyticsStoreXStoreIDSuggestionsPopularGet200Response
|
|
908
|
+
*/
|
|
909
|
+
'error'?: string;
|
|
910
|
+
/**
|
|
911
|
+
*
|
|
912
|
+
* @type {string}
|
|
913
|
+
* @memberof AdminAnalyticsStoreXStoreIDSuggestionsPopularGet200Response
|
|
914
|
+
*/
|
|
915
|
+
'status'?: string;
|
|
916
|
+
/**
|
|
917
|
+
*
|
|
918
|
+
* @type {string}
|
|
919
|
+
* @memberof AdminAnalyticsStoreXStoreIDSuggestionsPopularGet200Response
|
|
920
|
+
*/
|
|
921
|
+
'timestamp'?: string;
|
|
922
|
+
/**
|
|
923
|
+
*
|
|
924
|
+
* @type {number}
|
|
925
|
+
* @memberof AdminAnalyticsStoreXStoreIDSuggestionsPopularGet200Response
|
|
926
|
+
*/
|
|
927
|
+
'total'?: number;
|
|
928
|
+
}
|
|
929
|
+
/**
|
|
930
|
+
*
|
|
931
|
+
* @export
|
|
932
|
+
* @interface AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet200Response
|
|
933
|
+
*/
|
|
934
|
+
export interface AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet200Response {
|
|
935
|
+
/**
|
|
936
|
+
* Comparison metadata when in compare mode
|
|
937
|
+
* @type {AnalyticsComparisonMeta}
|
|
938
|
+
* @memberof AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet200Response
|
|
939
|
+
*/
|
|
940
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
941
|
+
/**
|
|
942
|
+
*
|
|
943
|
+
* @type {AnalyticsQuerySuggestionsInsight}
|
|
944
|
+
* @memberof AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet200Response
|
|
945
|
+
*/
|
|
946
|
+
'data'?: AnalyticsQuerySuggestionsInsight;
|
|
947
|
+
/**
|
|
948
|
+
*
|
|
949
|
+
* @type {string}
|
|
950
|
+
* @memberof AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet200Response
|
|
951
|
+
*/
|
|
952
|
+
'error'?: string;
|
|
953
|
+
/**
|
|
954
|
+
*
|
|
955
|
+
* @type {string}
|
|
956
|
+
* @memberof AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet200Response
|
|
957
|
+
*/
|
|
958
|
+
'status'?: string;
|
|
959
|
+
/**
|
|
960
|
+
*
|
|
961
|
+
* @type {string}
|
|
962
|
+
* @memberof AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet200Response
|
|
963
|
+
*/
|
|
964
|
+
'timestamp'?: string;
|
|
965
|
+
/**
|
|
966
|
+
*
|
|
967
|
+
* @type {number}
|
|
968
|
+
* @memberof AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet200Response
|
|
969
|
+
*/
|
|
970
|
+
'total'?: number;
|
|
971
|
+
}
|
|
886
972
|
/**
|
|
887
973
|
*
|
|
888
974
|
* @export
|
|
@@ -2319,6 +2405,12 @@ export interface AnalyticsExtendedKPIResponse {
|
|
|
2319
2405
|
* @memberof AnalyticsExtendedKPIResponse
|
|
2320
2406
|
*/
|
|
2321
2407
|
'start_time'?: string;
|
|
2408
|
+
/**
|
|
2409
|
+
* Store-level breakdown
|
|
2410
|
+
* @type {Array<AnalyticsStoreBreakdown>}
|
|
2411
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
2412
|
+
*/
|
|
2413
|
+
'store_breakdown'?: Array<AnalyticsStoreBreakdown>;
|
|
2322
2414
|
/**
|
|
2323
2415
|
* Can be KPIMetrics or ComparisonMetrics
|
|
2324
2416
|
* @type {any}
|
|
@@ -3339,6 +3431,12 @@ export interface AnalyticsGeoResponse {
|
|
|
3339
3431
|
* @memberof AnalyticsGeoResponse
|
|
3340
3432
|
*/
|
|
3341
3433
|
'start_time'?: string;
|
|
3434
|
+
/**
|
|
3435
|
+
* Store-level breakdown
|
|
3436
|
+
* @type {Array<AnalyticsStoreGeoBreakdown>}
|
|
3437
|
+
* @memberof AnalyticsGeoResponse
|
|
3438
|
+
*/
|
|
3439
|
+
'store_breakdown'?: Array<AnalyticsStoreGeoBreakdown>;
|
|
3342
3440
|
/**
|
|
3343
3441
|
*
|
|
3344
3442
|
* @type {string}
|
|
@@ -5820,6 +5918,12 @@ export interface AnalyticsQueryResponse {
|
|
|
5820
5918
|
* @memberof AnalyticsQueryResponse
|
|
5821
5919
|
*/
|
|
5822
5920
|
'start_time'?: string;
|
|
5921
|
+
/**
|
|
5922
|
+
* Store-level breakdown
|
|
5923
|
+
* @type {Array<AnalyticsStoreQueryBreakdown>}
|
|
5924
|
+
* @memberof AnalyticsQueryResponse
|
|
5925
|
+
*/
|
|
5926
|
+
'store_breakdown'?: Array<AnalyticsStoreQueryBreakdown>;
|
|
5823
5927
|
/**
|
|
5824
5928
|
*
|
|
5825
5929
|
* @type {string}
|
|
@@ -5839,6 +5943,237 @@ export interface AnalyticsQueryResponse {
|
|
|
5839
5943
|
*/
|
|
5840
5944
|
'xstoreid'?: string;
|
|
5841
5945
|
}
|
|
5946
|
+
/**
|
|
5947
|
+
*
|
|
5948
|
+
* @export
|
|
5949
|
+
* @interface AnalyticsQuerySuggestionsAnalytic
|
|
5950
|
+
*/
|
|
5951
|
+
export interface AnalyticsQuerySuggestionsAnalytic {
|
|
5952
|
+
/**
|
|
5953
|
+
* Average processing time
|
|
5954
|
+
* @type {number}
|
|
5955
|
+
* @memberof AnalyticsQuerySuggestionsAnalytic
|
|
5956
|
+
*/
|
|
5957
|
+
'avg_processing_time_ms'?: number;
|
|
5958
|
+
/**
|
|
5959
|
+
* Average suggestions per request
|
|
5960
|
+
* @type {number}
|
|
5961
|
+
* @memberof AnalyticsQuerySuggestionsAnalytic
|
|
5962
|
+
*/
|
|
5963
|
+
'avg_suggestions_per_request'?: number;
|
|
5964
|
+
/**
|
|
5965
|
+
* Last time this query was used
|
|
5966
|
+
* @type {string}
|
|
5967
|
+
* @memberof AnalyticsQuerySuggestionsAnalytic
|
|
5968
|
+
*/
|
|
5969
|
+
'last_seen_date'?: string;
|
|
5970
|
+
/**
|
|
5971
|
+
*
|
|
5972
|
+
* @type {string}
|
|
5973
|
+
* @memberof AnalyticsQuerySuggestionsAnalytic
|
|
5974
|
+
*/
|
|
5975
|
+
'query'?: string;
|
|
5976
|
+
/**
|
|
5977
|
+
* Number of suggestion requests
|
|
5978
|
+
* @type {number}
|
|
5979
|
+
* @memberof AnalyticsQuerySuggestionsAnalytic
|
|
5980
|
+
*/
|
|
5981
|
+
'requests'?: number;
|
|
5982
|
+
/**
|
|
5983
|
+
* Requests with dropdown recommendations
|
|
5984
|
+
* @type {number}
|
|
5985
|
+
* @memberof AnalyticsQuerySuggestionsAnalytic
|
|
5986
|
+
*/
|
|
5987
|
+
'requests_with_dropdown'?: number;
|
|
5988
|
+
/**
|
|
5989
|
+
* Requests with filtered tabs
|
|
5990
|
+
* @type {number}
|
|
5991
|
+
* @memberof AnalyticsQuerySuggestionsAnalytic
|
|
5992
|
+
*/
|
|
5993
|
+
'requests_with_filtered_tabs'?: number;
|
|
5994
|
+
/**
|
|
5995
|
+
* Total processing time
|
|
5996
|
+
* @type {number}
|
|
5997
|
+
* @memberof AnalyticsQuerySuggestionsAnalytic
|
|
5998
|
+
*/
|
|
5999
|
+
'total_processing_time_ms'?: number;
|
|
6000
|
+
/**
|
|
6001
|
+
* Total suggestions shown
|
|
6002
|
+
* @type {number}
|
|
6003
|
+
* @memberof AnalyticsQuerySuggestionsAnalytic
|
|
6004
|
+
*/
|
|
6005
|
+
'total_suggestions_returned'?: number;
|
|
6006
|
+
/**
|
|
6007
|
+
* Unique sessions
|
|
6008
|
+
* @type {number}
|
|
6009
|
+
* @memberof AnalyticsQuerySuggestionsAnalytic
|
|
6010
|
+
*/
|
|
6011
|
+
'unique_sessions'?: number;
|
|
6012
|
+
/**
|
|
6013
|
+
* Unique users
|
|
6014
|
+
* @type {number}
|
|
6015
|
+
* @memberof AnalyticsQuerySuggestionsAnalytic
|
|
6016
|
+
*/
|
|
6017
|
+
'unique_users'?: number;
|
|
6018
|
+
}
|
|
6019
|
+
/**
|
|
6020
|
+
*
|
|
6021
|
+
* @export
|
|
6022
|
+
* @interface AnalyticsQuerySuggestionsInsight
|
|
6023
|
+
*/
|
|
6024
|
+
export interface AnalyticsQuerySuggestionsInsight {
|
|
6025
|
+
/**
|
|
6026
|
+
*
|
|
6027
|
+
* @type {number}
|
|
6028
|
+
* @memberof AnalyticsQuerySuggestionsInsight
|
|
6029
|
+
*/
|
|
6030
|
+
'avg_processing_time_ms'?: number;
|
|
6031
|
+
/**
|
|
6032
|
+
*
|
|
6033
|
+
* @type {number}
|
|
6034
|
+
* @memberof AnalyticsQuerySuggestionsInsight
|
|
6035
|
+
*/
|
|
6036
|
+
'avg_suggestions_per_request'?: number;
|
|
6037
|
+
/**
|
|
6038
|
+
*
|
|
6039
|
+
* @type {string}
|
|
6040
|
+
* @memberof AnalyticsQuerySuggestionsInsight
|
|
6041
|
+
*/
|
|
6042
|
+
'end_time'?: string;
|
|
6043
|
+
/**
|
|
6044
|
+
*
|
|
6045
|
+
* @type {number}
|
|
6046
|
+
* @memberof AnalyticsQuerySuggestionsInsight
|
|
6047
|
+
*/
|
|
6048
|
+
'p50_processing_time_ms'?: number;
|
|
6049
|
+
/**
|
|
6050
|
+
*
|
|
6051
|
+
* @type {number}
|
|
6052
|
+
* @memberof AnalyticsQuerySuggestionsInsight
|
|
6053
|
+
*/
|
|
6054
|
+
'p95_processing_time_ms'?: number;
|
|
6055
|
+
/**
|
|
6056
|
+
*
|
|
6057
|
+
* @type {number}
|
|
6058
|
+
* @memberof AnalyticsQuerySuggestionsInsight
|
|
6059
|
+
*/
|
|
6060
|
+
'p99_processing_time_ms'?: number;
|
|
6061
|
+
/**
|
|
6062
|
+
*
|
|
6063
|
+
* @type {string}
|
|
6064
|
+
* @memberof AnalyticsQuerySuggestionsInsight
|
|
6065
|
+
*/
|
|
6066
|
+
'query'?: string;
|
|
6067
|
+
/**
|
|
6068
|
+
*
|
|
6069
|
+
* @type {number}
|
|
6070
|
+
* @memberof AnalyticsQuerySuggestionsInsight
|
|
6071
|
+
*/
|
|
6072
|
+
'requests'?: number;
|
|
6073
|
+
/**
|
|
6074
|
+
*
|
|
6075
|
+
* @type {number}
|
|
6076
|
+
* @memberof AnalyticsQuerySuggestionsInsight
|
|
6077
|
+
*/
|
|
6078
|
+
'requests_with_dropdown'?: number;
|
|
6079
|
+
/**
|
|
6080
|
+
*
|
|
6081
|
+
* @type {number}
|
|
6082
|
+
* @memberof AnalyticsQuerySuggestionsInsight
|
|
6083
|
+
*/
|
|
6084
|
+
'requests_with_filtered_tabs'?: number;
|
|
6085
|
+
/**
|
|
6086
|
+
*
|
|
6087
|
+
* @type {string}
|
|
6088
|
+
* @memberof AnalyticsQuerySuggestionsInsight
|
|
6089
|
+
*/
|
|
6090
|
+
'start_time'?: string;
|
|
6091
|
+
/**
|
|
6092
|
+
* Optional time series data
|
|
6093
|
+
* @type {Array<AnalyticsTimePoint>}
|
|
6094
|
+
* @memberof AnalyticsQuerySuggestionsInsight
|
|
6095
|
+
*/
|
|
6096
|
+
'time_series'?: Array<AnalyticsTimePoint>;
|
|
6097
|
+
/**
|
|
6098
|
+
*
|
|
6099
|
+
* @type {number}
|
|
6100
|
+
* @memberof AnalyticsQuerySuggestionsInsight
|
|
6101
|
+
*/
|
|
6102
|
+
'total_suggestions_returned'?: number;
|
|
6103
|
+
/**
|
|
6104
|
+
*
|
|
6105
|
+
* @type {number}
|
|
6106
|
+
* @memberof AnalyticsQuerySuggestionsInsight
|
|
6107
|
+
*/
|
|
6108
|
+
'unique_sessions'?: number;
|
|
6109
|
+
/**
|
|
6110
|
+
*
|
|
6111
|
+
* @type {number}
|
|
6112
|
+
* @memberof AnalyticsQuerySuggestionsInsight
|
|
6113
|
+
*/
|
|
6114
|
+
'unique_users'?: number;
|
|
6115
|
+
}
|
|
6116
|
+
/**
|
|
6117
|
+
*
|
|
6118
|
+
* @export
|
|
6119
|
+
* @interface AnalyticsQuerySuggestionsResponse
|
|
6120
|
+
*/
|
|
6121
|
+
export interface AnalyticsQuerySuggestionsResponse {
|
|
6122
|
+
/**
|
|
6123
|
+
*
|
|
6124
|
+
* @type {Array<AnalyticsQuerySuggestionsAnalytic>}
|
|
6125
|
+
* @memberof AnalyticsQuerySuggestionsResponse
|
|
6126
|
+
*/
|
|
6127
|
+
'data'?: Array<AnalyticsQuerySuggestionsAnalytic>;
|
|
6128
|
+
/**
|
|
6129
|
+
*
|
|
6130
|
+
* @type {string}
|
|
6131
|
+
* @memberof AnalyticsQuerySuggestionsResponse
|
|
6132
|
+
*/
|
|
6133
|
+
'end_time'?: string;
|
|
6134
|
+
/**
|
|
6135
|
+
*
|
|
6136
|
+
* @type {number}
|
|
6137
|
+
* @memberof AnalyticsQuerySuggestionsResponse
|
|
6138
|
+
*/
|
|
6139
|
+
'limit'?: number;
|
|
6140
|
+
/**
|
|
6141
|
+
*
|
|
6142
|
+
* @type {string}
|
|
6143
|
+
* @memberof AnalyticsQuerySuggestionsResponse
|
|
6144
|
+
*/
|
|
6145
|
+
'orgcode'?: string;
|
|
6146
|
+
/**
|
|
6147
|
+
*
|
|
6148
|
+
* @type {number}
|
|
6149
|
+
* @memberof AnalyticsQuerySuggestionsResponse
|
|
6150
|
+
*/
|
|
6151
|
+
'page'?: number;
|
|
6152
|
+
/**
|
|
6153
|
+
*
|
|
6154
|
+
* @type {string}
|
|
6155
|
+
* @memberof AnalyticsQuerySuggestionsResponse
|
|
6156
|
+
*/
|
|
6157
|
+
'search_query'?: string;
|
|
6158
|
+
/**
|
|
6159
|
+
*
|
|
6160
|
+
* @type {string}
|
|
6161
|
+
* @memberof AnalyticsQuerySuggestionsResponse
|
|
6162
|
+
*/
|
|
6163
|
+
'start_time'?: string;
|
|
6164
|
+
/**
|
|
6165
|
+
*
|
|
6166
|
+
* @type {number}
|
|
6167
|
+
* @memberof AnalyticsQuerySuggestionsResponse
|
|
6168
|
+
*/
|
|
6169
|
+
'total'?: number;
|
|
6170
|
+
/**
|
|
6171
|
+
*
|
|
6172
|
+
* @type {string}
|
|
6173
|
+
* @memberof AnalyticsQuerySuggestionsResponse
|
|
6174
|
+
*/
|
|
6175
|
+
'xstoreid'?: string;
|
|
6176
|
+
}
|
|
5842
6177
|
/**
|
|
5843
6178
|
*
|
|
5844
6179
|
* @export
|
|
@@ -5926,6 +6261,160 @@ export interface AnalyticsSharedQueryAnalysis {
|
|
|
5926
6261
|
*/
|
|
5927
6262
|
'this_item_position'?: number;
|
|
5928
6263
|
}
|
|
6264
|
+
/**
|
|
6265
|
+
*
|
|
6266
|
+
* @export
|
|
6267
|
+
* @interface AnalyticsStoreBreakdown
|
|
6268
|
+
*/
|
|
6269
|
+
export interface AnalyticsStoreBreakdown {
|
|
6270
|
+
/**
|
|
6271
|
+
*
|
|
6272
|
+
* @type {AnalyticsKPIMetrics}
|
|
6273
|
+
* @memberof AnalyticsStoreBreakdown
|
|
6274
|
+
*/
|
|
6275
|
+
'compare_summary'?: AnalyticsKPIMetrics;
|
|
6276
|
+
/**
|
|
6277
|
+
*
|
|
6278
|
+
* @type {number}
|
|
6279
|
+
* @memberof AnalyticsStoreBreakdown
|
|
6280
|
+
*/
|
|
6281
|
+
'store_id'?: number;
|
|
6282
|
+
/**
|
|
6283
|
+
*
|
|
6284
|
+
* @type {string}
|
|
6285
|
+
* @memberof AnalyticsStoreBreakdown
|
|
6286
|
+
*/
|
|
6287
|
+
'store_name'?: string;
|
|
6288
|
+
/**
|
|
6289
|
+
*
|
|
6290
|
+
* @type {AnalyticsKPIMetrics}
|
|
6291
|
+
* @memberof AnalyticsStoreBreakdown
|
|
6292
|
+
*/
|
|
6293
|
+
'summary'?: AnalyticsKPIMetrics;
|
|
6294
|
+
/**
|
|
6295
|
+
* Can be []KPIPointExtended or []ComparisonMetrics
|
|
6296
|
+
* @type {any}
|
|
6297
|
+
* @memberof AnalyticsStoreBreakdown
|
|
6298
|
+
*/
|
|
6299
|
+
'time_series'?: any;
|
|
6300
|
+
/**
|
|
6301
|
+
*
|
|
6302
|
+
* @type {string}
|
|
6303
|
+
* @memberof AnalyticsStoreBreakdown
|
|
6304
|
+
*/
|
|
6305
|
+
'xstoreid'?: string;
|
|
6306
|
+
}
|
|
6307
|
+
/**
|
|
6308
|
+
*
|
|
6309
|
+
* @export
|
|
6310
|
+
* @interface AnalyticsStoreGeoBreakdown
|
|
6311
|
+
*/
|
|
6312
|
+
export interface AnalyticsStoreGeoBreakdown {
|
|
6313
|
+
/**
|
|
6314
|
+
* Can be []GeoAnalytic or []ComparisonMetrics
|
|
6315
|
+
* @type {any}
|
|
6316
|
+
* @memberof AnalyticsStoreGeoBreakdown
|
|
6317
|
+
*/
|
|
6318
|
+
'data'?: any;
|
|
6319
|
+
/**
|
|
6320
|
+
*
|
|
6321
|
+
* @type {number}
|
|
6322
|
+
* @memberof AnalyticsStoreGeoBreakdown
|
|
6323
|
+
*/
|
|
6324
|
+
'store_id'?: number;
|
|
6325
|
+
/**
|
|
6326
|
+
*
|
|
6327
|
+
* @type {string}
|
|
6328
|
+
* @memberof AnalyticsStoreGeoBreakdown
|
|
6329
|
+
*/
|
|
6330
|
+
'store_name'?: string;
|
|
6331
|
+
/**
|
|
6332
|
+
*
|
|
6333
|
+
* @type {number}
|
|
6334
|
+
* @memberof AnalyticsStoreGeoBreakdown
|
|
6335
|
+
*/
|
|
6336
|
+
'total'?: number;
|
|
6337
|
+
/**
|
|
6338
|
+
*
|
|
6339
|
+
* @type {string}
|
|
6340
|
+
* @memberof AnalyticsStoreGeoBreakdown
|
|
6341
|
+
*/
|
|
6342
|
+
'xstoreid'?: string;
|
|
6343
|
+
}
|
|
6344
|
+
/**
|
|
6345
|
+
*
|
|
6346
|
+
* @export
|
|
6347
|
+
* @interface AnalyticsStoreQueryBreakdown
|
|
6348
|
+
*/
|
|
6349
|
+
export interface AnalyticsStoreQueryBreakdown {
|
|
6350
|
+
/**
|
|
6351
|
+
* Can be []QueryAnalytic or []ComparisonMetrics
|
|
6352
|
+
* @type {any}
|
|
6353
|
+
* @memberof AnalyticsStoreQueryBreakdown
|
|
6354
|
+
*/
|
|
6355
|
+
'data'?: any;
|
|
6356
|
+
/**
|
|
6357
|
+
*
|
|
6358
|
+
* @type {number}
|
|
6359
|
+
* @memberof AnalyticsStoreQueryBreakdown
|
|
6360
|
+
*/
|
|
6361
|
+
'store_id'?: number;
|
|
6362
|
+
/**
|
|
6363
|
+
*
|
|
6364
|
+
* @type {string}
|
|
6365
|
+
* @memberof AnalyticsStoreQueryBreakdown
|
|
6366
|
+
*/
|
|
6367
|
+
'store_name'?: string;
|
|
6368
|
+
/**
|
|
6369
|
+
*
|
|
6370
|
+
* @type {number}
|
|
6371
|
+
* @memberof AnalyticsStoreQueryBreakdown
|
|
6372
|
+
*/
|
|
6373
|
+
'total'?: number;
|
|
6374
|
+
/**
|
|
6375
|
+
*
|
|
6376
|
+
* @type {string}
|
|
6377
|
+
* @memberof AnalyticsStoreQueryBreakdown
|
|
6378
|
+
*/
|
|
6379
|
+
'xstoreid'?: string;
|
|
6380
|
+
}
|
|
6381
|
+
/**
|
|
6382
|
+
*
|
|
6383
|
+
* @export
|
|
6384
|
+
* @interface AnalyticsTimePoint
|
|
6385
|
+
*/
|
|
6386
|
+
export interface AnalyticsTimePoint {
|
|
6387
|
+
/**
|
|
6388
|
+
*
|
|
6389
|
+
* @type {number}
|
|
6390
|
+
* @memberof AnalyticsTimePoint
|
|
6391
|
+
*/
|
|
6392
|
+
'avg_processing_time_ms'?: number;
|
|
6393
|
+
/**
|
|
6394
|
+
*
|
|
6395
|
+
* @type {number}
|
|
6396
|
+
* @memberof AnalyticsTimePoint
|
|
6397
|
+
*/
|
|
6398
|
+
'avg_suggestions_per_request'?: number;
|
|
6399
|
+
/**
|
|
6400
|
+
*
|
|
6401
|
+
* @type {number}
|
|
6402
|
+
* @memberof AnalyticsTimePoint
|
|
6403
|
+
*/
|
|
6404
|
+
'requests'?: number;
|
|
6405
|
+
/**
|
|
6406
|
+
*
|
|
6407
|
+
* @type {string}
|
|
6408
|
+
* @memberof AnalyticsTimePoint
|
|
6409
|
+
*/
|
|
6410
|
+
'time'?: string;
|
|
6411
|
+
/**
|
|
6412
|
+
*
|
|
6413
|
+
* @type {number}
|
|
6414
|
+
* @memberof AnalyticsTimePoint
|
|
6415
|
+
*/
|
|
6416
|
+
'total_suggestions_returned'?: number;
|
|
6417
|
+
}
|
|
5929
6418
|
/**
|
|
5930
6419
|
*
|
|
5931
6420
|
* @export
|
|
@@ -9857,6 +10346,48 @@ export interface DataTypesDropdownRecommendationsConfig {
|
|
|
9857
10346
|
* @memberof DataTypesDropdownRecommendationsConfig
|
|
9858
10347
|
*/
|
|
9859
10348
|
'category_field_mappings'?: { [key: string]: string; };
|
|
10349
|
+
/**
|
|
10350
|
+
* Fields to consider for dynamic tabs (default: uses facet_by or empty)
|
|
10351
|
+
* @type {Array<string>}
|
|
10352
|
+
* @memberof DataTypesDropdownRecommendationsConfig
|
|
10353
|
+
*/
|
|
10354
|
+
'dynamic_tabs_fields'?: Array<string>;
|
|
10355
|
+
/**
|
|
10356
|
+
* Maximum number of dynamic tabs (default: 5)
|
|
10357
|
+
* @type {number}
|
|
10358
|
+
* @memberof DataTypesDropdownRecommendationsConfig
|
|
10359
|
+
*/
|
|
10360
|
+
'dynamic_tabs_max_count'?: number;
|
|
10361
|
+
/**
|
|
10362
|
+
* Method: \"groupBy\" (uses Typesense groupBy), \"facets\" (uses facet discovery), \"manual\" (uses FilteredTabs config only) (default: \"groupBy\")
|
|
10363
|
+
* @type {string}
|
|
10364
|
+
* @memberof DataTypesDropdownRecommendationsConfig
|
|
10365
|
+
*/
|
|
10366
|
+
'dynamic_tabs_method'?: string;
|
|
10367
|
+
/**
|
|
10368
|
+
* Minimum results required for a tab (default: 10)
|
|
10369
|
+
* @type {number}
|
|
10370
|
+
* @memberof DataTypesDropdownRecommendationsConfig
|
|
10371
|
+
*/
|
|
10372
|
+
'dynamic_tabs_min_results'?: number;
|
|
10373
|
+
/**
|
|
10374
|
+
* Priority offset for dynamic tabs (default: 100, manual tabs use 0-99)
|
|
10375
|
+
* @type {number}
|
|
10376
|
+
* @memberof DataTypesDropdownRecommendationsConfig
|
|
10377
|
+
*/
|
|
10378
|
+
'dynamic_tabs_priority'?: number;
|
|
10379
|
+
/**
|
|
10380
|
+
* Dynamic tabs configuration (auto-generated tabs based on query and facets)
|
|
10381
|
+
* @type {boolean}
|
|
10382
|
+
* @memberof DataTypesDropdownRecommendationsConfig
|
|
10383
|
+
*/
|
|
10384
|
+
'enable_dynamic_tabs'?: boolean;
|
|
10385
|
+
/**
|
|
10386
|
+
* Filtered tabs configuration (for tabbed product recommendations)
|
|
10387
|
+
* @type {boolean}
|
|
10388
|
+
* @memberof DataTypesDropdownRecommendationsConfig
|
|
10389
|
+
*/
|
|
10390
|
+
'enable_filtered_tabs'?: boolean;
|
|
9860
10391
|
/**
|
|
9861
10392
|
* Enable popular brands section
|
|
9862
10393
|
* @type {boolean}
|
|
@@ -9887,6 +10418,12 @@ export interface DataTypesDropdownRecommendationsConfig {
|
|
|
9887
10418
|
* @memberof DataTypesDropdownRecommendationsConfig
|
|
9888
10419
|
*/
|
|
9889
10420
|
'exclude_out_of_stock'?: boolean;
|
|
10421
|
+
/**
|
|
10422
|
+
* Configuration for each filtered tab
|
|
10423
|
+
* @type {Array<DataTypesFilteredTabConfig>}
|
|
10424
|
+
* @memberof DataTypesDropdownRecommendationsConfig
|
|
10425
|
+
*/
|
|
10426
|
+
'filtered_tabs'?: Array<DataTypesFilteredTabConfig>;
|
|
9890
10427
|
/**
|
|
9891
10428
|
* Include only in stock products
|
|
9892
10429
|
* @type {boolean}
|
|
@@ -10607,6 +11144,61 @@ export interface DataTypesFieldMetadata {
|
|
|
10607
11144
|
*/
|
|
10608
11145
|
'type'?: string;
|
|
10609
11146
|
}
|
|
11147
|
+
/**
|
|
11148
|
+
*
|
|
11149
|
+
* @export
|
|
11150
|
+
* @interface DataTypesFilteredTabConfig
|
|
11151
|
+
*/
|
|
11152
|
+
export interface DataTypesFilteredTabConfig {
|
|
11153
|
+
/**
|
|
11154
|
+
* Optional description for the tab
|
|
11155
|
+
* @type {string}
|
|
11156
|
+
* @memberof DataTypesFilteredTabConfig
|
|
11157
|
+
*/
|
|
11158
|
+
'description'?: string;
|
|
11159
|
+
/**
|
|
11160
|
+
* Whether this tab is enabled
|
|
11161
|
+
* @type {boolean}
|
|
11162
|
+
* @memberof DataTypesFilteredTabConfig
|
|
11163
|
+
*/
|
|
11164
|
+
'enabled'?: boolean;
|
|
11165
|
+
/**
|
|
11166
|
+
* Facet filters to apply (e.g., {\"brand\": \"Nike\"}, {\"category\": \"Electronics\"})
|
|
11167
|
+
* @type {{ [key: string]: string; }}
|
|
11168
|
+
* @memberof DataTypesFilteredTabConfig
|
|
11169
|
+
*/
|
|
11170
|
+
'filters'?: { [key: string]: string; };
|
|
11171
|
+
/**
|
|
11172
|
+
* Unique tab ID (e.g., \"all\", \"brands\", \"categories\")
|
|
11173
|
+
* @type {string}
|
|
11174
|
+
* @memberof DataTypesFilteredTabConfig
|
|
11175
|
+
*/
|
|
11176
|
+
'id'?: string;
|
|
11177
|
+
/**
|
|
11178
|
+
* Display label for the tab (e.g., \"All Results\", \"Brands\", \"Categories\")
|
|
11179
|
+
* @type {string}
|
|
11180
|
+
* @memberof DataTypesFilteredTabConfig
|
|
11181
|
+
*/
|
|
11182
|
+
'label'?: string;
|
|
11183
|
+
/**
|
|
11184
|
+
* Max number of products to show in this tab (default: 8, max: 50)
|
|
11185
|
+
* @type {number}
|
|
11186
|
+
* @memberof DataTypesFilteredTabConfig
|
|
11187
|
+
*/
|
|
11188
|
+
'limit'?: number;
|
|
11189
|
+
/**
|
|
11190
|
+
* Display order priority (lower = higher priority, default: 0)
|
|
11191
|
+
* @type {number}
|
|
11192
|
+
* @memberof DataTypesFilteredTabConfig
|
|
11193
|
+
*/
|
|
11194
|
+
'priority'?: number;
|
|
11195
|
+
/**
|
|
11196
|
+
* Sort method: \"relevance\", \"popularity\", \"price_asc\", \"price_desc\" (default: \"relevance\")
|
|
11197
|
+
* @type {string}
|
|
11198
|
+
* @memberof DataTypesFilteredTabConfig
|
|
11199
|
+
*/
|
|
11200
|
+
'sort_by'?: string;
|
|
11201
|
+
}
|
|
10610
11202
|
/**
|
|
10611
11203
|
*
|
|
10612
11204
|
* @export
|
|
@@ -24387,536 +24979,6 @@ export interface DefaultMenuRoutesUpdateMenuVisibilityResponse {
|
|
|
24387
24979
|
*/
|
|
24388
24980
|
'menuName'?: string;
|
|
24389
24981
|
}
|
|
24390
|
-
/**
|
|
24391
|
-
*
|
|
24392
|
-
* @export
|
|
24393
|
-
* @interface DropdownRecommendationsServiceDropdownConfigResponse
|
|
24394
|
-
*/
|
|
24395
|
-
export interface DropdownRecommendationsServiceDropdownConfigResponse {
|
|
24396
|
-
/**
|
|
24397
|
-
*
|
|
24398
|
-
* @type {DropdownRecommendationsServiceDropdownRecommendationsConfig}
|
|
24399
|
-
* @memberof DropdownRecommendationsServiceDropdownConfigResponse
|
|
24400
|
-
*/
|
|
24401
|
-
'data'?: DropdownRecommendationsServiceDropdownRecommendationsConfig;
|
|
24402
|
-
/**
|
|
24403
|
-
*
|
|
24404
|
-
* @type {string}
|
|
24405
|
-
* @memberof DropdownRecommendationsServiceDropdownConfigResponse
|
|
24406
|
-
*/
|
|
24407
|
-
'message'?: string;
|
|
24408
|
-
/**
|
|
24409
|
-
*
|
|
24410
|
-
* @type {string}
|
|
24411
|
-
* @memberof DropdownRecommendationsServiceDropdownConfigResponse
|
|
24412
|
-
*/
|
|
24413
|
-
'status'?: string;
|
|
24414
|
-
/**
|
|
24415
|
-
*
|
|
24416
|
-
* @type {string}
|
|
24417
|
-
* @memberof DropdownRecommendationsServiceDropdownConfigResponse
|
|
24418
|
-
*/
|
|
24419
|
-
'timestamp'?: string;
|
|
24420
|
-
/**
|
|
24421
|
-
*
|
|
24422
|
-
* @type {string}
|
|
24423
|
-
* @memberof DropdownRecommendationsServiceDropdownConfigResponse
|
|
24424
|
-
*/
|
|
24425
|
-
'version'?: string;
|
|
24426
|
-
}
|
|
24427
|
-
/**
|
|
24428
|
-
*
|
|
24429
|
-
* @export
|
|
24430
|
-
* @interface DropdownRecommendationsServiceDropdownRecommendationsAPIResponse
|
|
24431
|
-
*/
|
|
24432
|
-
export interface DropdownRecommendationsServiceDropdownRecommendationsAPIResponse {
|
|
24433
|
-
/**
|
|
24434
|
-
*
|
|
24435
|
-
* @type {DropdownRecommendationsServiceDropdownRecommendationsResponse}
|
|
24436
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsAPIResponse
|
|
24437
|
-
*/
|
|
24438
|
-
'data'?: DropdownRecommendationsServiceDropdownRecommendationsResponse;
|
|
24439
|
-
/**
|
|
24440
|
-
*
|
|
24441
|
-
* @type {string}
|
|
24442
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsAPIResponse
|
|
24443
|
-
*/
|
|
24444
|
-
'error'?: string;
|
|
24445
|
-
/**
|
|
24446
|
-
*
|
|
24447
|
-
* @type {string}
|
|
24448
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsAPIResponse
|
|
24449
|
-
*/
|
|
24450
|
-
'status'?: string;
|
|
24451
|
-
/**
|
|
24452
|
-
*
|
|
24453
|
-
* @type {string}
|
|
24454
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsAPIResponse
|
|
24455
|
-
*/
|
|
24456
|
-
'timestamp'?: string;
|
|
24457
|
-
/**
|
|
24458
|
-
*
|
|
24459
|
-
* @type {string}
|
|
24460
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsAPIResponse
|
|
24461
|
-
*/
|
|
24462
|
-
'version'?: string;
|
|
24463
|
-
}
|
|
24464
|
-
/**
|
|
24465
|
-
*
|
|
24466
|
-
* @export
|
|
24467
|
-
* @interface DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24468
|
-
*/
|
|
24469
|
-
export interface DropdownRecommendationsServiceDropdownRecommendationsConfig {
|
|
24470
|
-
/**
|
|
24471
|
-
*
|
|
24472
|
-
* @type {{ [key: string]: string; }}
|
|
24473
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24474
|
-
*/
|
|
24475
|
-
'brand_field_mappings'?: { [key: string]: string; };
|
|
24476
|
-
/**
|
|
24477
|
-
* \'searches\', \'clicks\', \'conversions\'
|
|
24478
|
-
* @type {string}
|
|
24479
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24480
|
-
*/
|
|
24481
|
-
'brand_sort_by'?: string;
|
|
24482
|
-
/**
|
|
24483
|
-
* Caching configuration
|
|
24484
|
-
* @type {number}
|
|
24485
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24486
|
-
*/
|
|
24487
|
-
'cache_ttl_seconds'?: number;
|
|
24488
|
-
/**
|
|
24489
|
-
*
|
|
24490
|
-
* @type {{ [key: string]: string; }}
|
|
24491
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24492
|
-
*/
|
|
24493
|
-
'category_field_mappings'?: { [key: string]: string; };
|
|
24494
|
-
/**
|
|
24495
|
-
*
|
|
24496
|
-
* @type {string}
|
|
24497
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24498
|
-
*/
|
|
24499
|
-
'created_at'?: string;
|
|
24500
|
-
/**
|
|
24501
|
-
*
|
|
24502
|
-
* @type {boolean}
|
|
24503
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24504
|
-
*/
|
|
24505
|
-
'enable_popular_brands'?: boolean;
|
|
24506
|
-
/**
|
|
24507
|
-
*
|
|
24508
|
-
* @type {boolean}
|
|
24509
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24510
|
-
*/
|
|
24511
|
-
'enable_trending_products'?: boolean;
|
|
24512
|
-
/**
|
|
24513
|
-
*
|
|
24514
|
-
* @type {boolean}
|
|
24515
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24516
|
-
*/
|
|
24517
|
-
'enable_trending_search'?: boolean;
|
|
24518
|
-
/**
|
|
24519
|
-
* Feature enable/disable flags
|
|
24520
|
-
* @type {boolean}
|
|
24521
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24522
|
-
*/
|
|
24523
|
-
'enabled'?: boolean;
|
|
24524
|
-
/**
|
|
24525
|
-
* Additional filters
|
|
24526
|
-
* @type {boolean}
|
|
24527
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24528
|
-
*/
|
|
24529
|
-
'exclude_out_of_stock'?: boolean;
|
|
24530
|
-
/**
|
|
24531
|
-
*
|
|
24532
|
-
* @type {boolean}
|
|
24533
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24534
|
-
*/
|
|
24535
|
-
'include_only_in_stock'?: boolean;
|
|
24536
|
-
/**
|
|
24537
|
-
* Brand selection criteria
|
|
24538
|
-
* @type {number}
|
|
24539
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24540
|
-
*/
|
|
24541
|
-
'min_brand_searches'?: number;
|
|
24542
|
-
/**
|
|
24543
|
-
* Product selection criteria
|
|
24544
|
-
* @type {number}
|
|
24545
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24546
|
-
*/
|
|
24547
|
-
'min_product_clicks'?: number;
|
|
24548
|
-
/**
|
|
24549
|
-
*
|
|
24550
|
-
* @type {number}
|
|
24551
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24552
|
-
*/
|
|
24553
|
-
'min_product_conversions'?: number;
|
|
24554
|
-
/**
|
|
24555
|
-
*
|
|
24556
|
-
* @type {number}
|
|
24557
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24558
|
-
*/
|
|
24559
|
-
'popular_brands_limit'?: number;
|
|
24560
|
-
/**
|
|
24561
|
-
* Dataset-agnostic field mappings
|
|
24562
|
-
* @type {{ [key: string]: string; }}
|
|
24563
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24564
|
-
*/
|
|
24565
|
-
'product_field_mappings'?: { [key: string]: string; };
|
|
24566
|
-
/**
|
|
24567
|
-
* \'clicks\', \'conversions\', \'revenue\', \'trend_score\'
|
|
24568
|
-
* @type {string}
|
|
24569
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24570
|
-
*/
|
|
24571
|
-
'product_sort_by'?: string;
|
|
24572
|
-
/**
|
|
24573
|
-
*
|
|
24574
|
-
* @type {number}
|
|
24575
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24576
|
-
*/
|
|
24577
|
-
'trending_products_limit'?: number;
|
|
24578
|
-
/**
|
|
24579
|
-
* Limits for each section
|
|
24580
|
-
* @type {number}
|
|
24581
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24582
|
-
*/
|
|
24583
|
-
'trending_search_limit'?: number;
|
|
24584
|
-
/**
|
|
24585
|
-
* Time range configuration
|
|
24586
|
-
* @type {number}
|
|
24587
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24588
|
-
*/
|
|
24589
|
-
'trending_time_range_days'?: number;
|
|
24590
|
-
/**
|
|
24591
|
-
*
|
|
24592
|
-
* @type {string}
|
|
24593
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24594
|
-
*/
|
|
24595
|
-
'updated_at'?: string;
|
|
24596
|
-
/**
|
|
24597
|
-
* Trending search configuration
|
|
24598
|
-
* @type {boolean}
|
|
24599
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsConfig
|
|
24600
|
-
*/
|
|
24601
|
-
'use_query_suggestions_config'?: boolean;
|
|
24602
|
-
}
|
|
24603
|
-
/**
|
|
24604
|
-
*
|
|
24605
|
-
* @export
|
|
24606
|
-
* @interface DropdownRecommendationsServiceDropdownRecommendationsResponse
|
|
24607
|
-
*/
|
|
24608
|
-
export interface DropdownRecommendationsServiceDropdownRecommendationsResponse {
|
|
24609
|
-
/**
|
|
24610
|
-
*
|
|
24611
|
-
* @type {Array<DropdownRecommendationsServicePopularBrand>}
|
|
24612
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsResponse
|
|
24613
|
-
*/
|
|
24614
|
-
'popular_brands'?: Array<DropdownRecommendationsServicePopularBrand>;
|
|
24615
|
-
/**
|
|
24616
|
-
*
|
|
24617
|
-
* @type {number}
|
|
24618
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsResponse
|
|
24619
|
-
*/
|
|
24620
|
-
'processing_time_ms'?: number;
|
|
24621
|
-
/**
|
|
24622
|
-
*
|
|
24623
|
-
* @type {string}
|
|
24624
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsResponse
|
|
24625
|
-
*/
|
|
24626
|
-
'timestamp'?: string;
|
|
24627
|
-
/**
|
|
24628
|
-
*
|
|
24629
|
-
* @type {Array<DropdownRecommendationsServiceTrendingProduct>}
|
|
24630
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsResponse
|
|
24631
|
-
*/
|
|
24632
|
-
'trending_products'?: Array<DropdownRecommendationsServiceTrendingProduct>;
|
|
24633
|
-
/**
|
|
24634
|
-
*
|
|
24635
|
-
* @type {Array<DropdownRecommendationsServiceTrendingSearchItem>}
|
|
24636
|
-
* @memberof DropdownRecommendationsServiceDropdownRecommendationsResponse
|
|
24637
|
-
*/
|
|
24638
|
-
'trending_search'?: Array<DropdownRecommendationsServiceTrendingSearchItem>;
|
|
24639
|
-
}
|
|
24640
|
-
/**
|
|
24641
|
-
*
|
|
24642
|
-
* @export
|
|
24643
|
-
* @interface DropdownRecommendationsServicePopularBrand
|
|
24644
|
-
*/
|
|
24645
|
-
export interface DropdownRecommendationsServicePopularBrand {
|
|
24646
|
-
/**
|
|
24647
|
-
*
|
|
24648
|
-
* @type {number}
|
|
24649
|
-
* @memberof DropdownRecommendationsServicePopularBrand
|
|
24650
|
-
*/
|
|
24651
|
-
'clicks'?: number;
|
|
24652
|
-
/**
|
|
24653
|
-
*
|
|
24654
|
-
* @type {number}
|
|
24655
|
-
* @memberof DropdownRecommendationsServicePopularBrand
|
|
24656
|
-
*/
|
|
24657
|
-
'conversions'?: number;
|
|
24658
|
-
/**
|
|
24659
|
-
*
|
|
24660
|
-
* @type {string}
|
|
24661
|
-
* @memberof DropdownRecommendationsServicePopularBrand
|
|
24662
|
-
*/
|
|
24663
|
-
'name'?: string;
|
|
24664
|
-
/**
|
|
24665
|
-
*
|
|
24666
|
-
* @type {number}
|
|
24667
|
-
* @memberof DropdownRecommendationsServicePopularBrand
|
|
24668
|
-
*/
|
|
24669
|
-
'searches'?: number;
|
|
24670
|
-
}
|
|
24671
|
-
/**
|
|
24672
|
-
*
|
|
24673
|
-
* @export
|
|
24674
|
-
* @interface DropdownRecommendationsServiceTrendingProduct
|
|
24675
|
-
*/
|
|
24676
|
-
export interface DropdownRecommendationsServiceTrendingProduct {
|
|
24677
|
-
/**
|
|
24678
|
-
*
|
|
24679
|
-
* @type {string}
|
|
24680
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24681
|
-
*/
|
|
24682
|
-
'brand'?: string;
|
|
24683
|
-
/**
|
|
24684
|
-
*
|
|
24685
|
-
* @type {string}
|
|
24686
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24687
|
-
*/
|
|
24688
|
-
'category'?: string;
|
|
24689
|
-
/**
|
|
24690
|
-
* Analytics metrics
|
|
24691
|
-
* @type {number}
|
|
24692
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24693
|
-
*/
|
|
24694
|
-
'clicks'?: number;
|
|
24695
|
-
/**
|
|
24696
|
-
*
|
|
24697
|
-
* @type {number}
|
|
24698
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24699
|
-
*/
|
|
24700
|
-
'conversions'?: number;
|
|
24701
|
-
/**
|
|
24702
|
-
*
|
|
24703
|
-
* @type {string}
|
|
24704
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24705
|
-
*/
|
|
24706
|
-
'description'?: string;
|
|
24707
|
-
/**
|
|
24708
|
-
*
|
|
24709
|
-
* @type {number}
|
|
24710
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24711
|
-
*/
|
|
24712
|
-
'discount'?: number;
|
|
24713
|
-
/**
|
|
24714
|
-
*
|
|
24715
|
-
* @type {number}
|
|
24716
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24717
|
-
*/
|
|
24718
|
-
'discount_percentage'?: number;
|
|
24719
|
-
/**
|
|
24720
|
-
*
|
|
24721
|
-
* @type {string}
|
|
24722
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24723
|
-
*/
|
|
24724
|
-
'id'?: string;
|
|
24725
|
-
/**
|
|
24726
|
-
*
|
|
24727
|
-
* @type {string}
|
|
24728
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24729
|
-
*/
|
|
24730
|
-
'image'?: string;
|
|
24731
|
-
/**
|
|
24732
|
-
*
|
|
24733
|
-
* @type {boolean}
|
|
24734
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24735
|
-
*/
|
|
24736
|
-
'in_stock'?: boolean;
|
|
24737
|
-
/**
|
|
24738
|
-
*
|
|
24739
|
-
* @type {string}
|
|
24740
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24741
|
-
*/
|
|
24742
|
-
'name'?: string;
|
|
24743
|
-
/**
|
|
24744
|
-
*
|
|
24745
|
-
* @type {number}
|
|
24746
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24747
|
-
*/
|
|
24748
|
-
'price'?: number;
|
|
24749
|
-
/**
|
|
24750
|
-
*
|
|
24751
|
-
* @type {number}
|
|
24752
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24753
|
-
*/
|
|
24754
|
-
'revenue'?: number;
|
|
24755
|
-
/**
|
|
24756
|
-
*
|
|
24757
|
-
* @type {number}
|
|
24758
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24759
|
-
*/
|
|
24760
|
-
'selling_price'?: number;
|
|
24761
|
-
/**
|
|
24762
|
-
*
|
|
24763
|
-
* @type {string}
|
|
24764
|
-
* @memberof DropdownRecommendationsServiceTrendingProduct
|
|
24765
|
-
*/
|
|
24766
|
-
'url'?: string;
|
|
24767
|
-
}
|
|
24768
|
-
/**
|
|
24769
|
-
*
|
|
24770
|
-
* @export
|
|
24771
|
-
* @interface DropdownRecommendationsServiceTrendingSearchItem
|
|
24772
|
-
*/
|
|
24773
|
-
export interface DropdownRecommendationsServiceTrendingSearchItem {
|
|
24774
|
-
/**
|
|
24775
|
-
*
|
|
24776
|
-
* @type {string}
|
|
24777
|
-
* @memberof DropdownRecommendationsServiceTrendingSearchItem
|
|
24778
|
-
*/
|
|
24779
|
-
'category'?: string;
|
|
24780
|
-
/**
|
|
24781
|
-
*
|
|
24782
|
-
* @type {number}
|
|
24783
|
-
* @memberof DropdownRecommendationsServiceTrendingSearchItem
|
|
24784
|
-
*/
|
|
24785
|
-
'popularity'?: number;
|
|
24786
|
-
/**
|
|
24787
|
-
*
|
|
24788
|
-
* @type {string}
|
|
24789
|
-
* @memberof DropdownRecommendationsServiceTrendingSearchItem
|
|
24790
|
-
*/
|
|
24791
|
-
'query'?: string;
|
|
24792
|
-
}
|
|
24793
|
-
/**
|
|
24794
|
-
*
|
|
24795
|
-
* @export
|
|
24796
|
-
* @interface DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24797
|
-
*/
|
|
24798
|
-
export interface DropdownRecommendationsServiceUpdateDropdownConfigRequest {
|
|
24799
|
-
/**
|
|
24800
|
-
*
|
|
24801
|
-
* @type {{ [key: string]: string; }}
|
|
24802
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24803
|
-
*/
|
|
24804
|
-
'brand_field_mappings'?: { [key: string]: string; };
|
|
24805
|
-
/**
|
|
24806
|
-
*
|
|
24807
|
-
* @type {string}
|
|
24808
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24809
|
-
*/
|
|
24810
|
-
'brand_sort_by'?: string;
|
|
24811
|
-
/**
|
|
24812
|
-
*
|
|
24813
|
-
* @type {number}
|
|
24814
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24815
|
-
*/
|
|
24816
|
-
'cache_ttl_seconds'?: number;
|
|
24817
|
-
/**
|
|
24818
|
-
*
|
|
24819
|
-
* @type {{ [key: string]: string; }}
|
|
24820
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24821
|
-
*/
|
|
24822
|
-
'category_field_mappings'?: { [key: string]: string; };
|
|
24823
|
-
/**
|
|
24824
|
-
*
|
|
24825
|
-
* @type {boolean}
|
|
24826
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24827
|
-
*/
|
|
24828
|
-
'enable_popular_brands'?: boolean;
|
|
24829
|
-
/**
|
|
24830
|
-
*
|
|
24831
|
-
* @type {boolean}
|
|
24832
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24833
|
-
*/
|
|
24834
|
-
'enable_trending_products'?: boolean;
|
|
24835
|
-
/**
|
|
24836
|
-
*
|
|
24837
|
-
* @type {boolean}
|
|
24838
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24839
|
-
*/
|
|
24840
|
-
'enable_trending_search'?: boolean;
|
|
24841
|
-
/**
|
|
24842
|
-
*
|
|
24843
|
-
* @type {boolean}
|
|
24844
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24845
|
-
*/
|
|
24846
|
-
'enabled'?: boolean;
|
|
24847
|
-
/**
|
|
24848
|
-
*
|
|
24849
|
-
* @type {boolean}
|
|
24850
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24851
|
-
*/
|
|
24852
|
-
'exclude_out_of_stock'?: boolean;
|
|
24853
|
-
/**
|
|
24854
|
-
*
|
|
24855
|
-
* @type {boolean}
|
|
24856
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24857
|
-
*/
|
|
24858
|
-
'include_only_in_stock'?: boolean;
|
|
24859
|
-
/**
|
|
24860
|
-
*
|
|
24861
|
-
* @type {number}
|
|
24862
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24863
|
-
*/
|
|
24864
|
-
'min_brand_searches'?: number;
|
|
24865
|
-
/**
|
|
24866
|
-
*
|
|
24867
|
-
* @type {number}
|
|
24868
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24869
|
-
*/
|
|
24870
|
-
'min_product_clicks'?: number;
|
|
24871
|
-
/**
|
|
24872
|
-
*
|
|
24873
|
-
* @type {number}
|
|
24874
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24875
|
-
*/
|
|
24876
|
-
'min_product_conversions'?: number;
|
|
24877
|
-
/**
|
|
24878
|
-
*
|
|
24879
|
-
* @type {number}
|
|
24880
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24881
|
-
*/
|
|
24882
|
-
'popular_brands_limit'?: number;
|
|
24883
|
-
/**
|
|
24884
|
-
*
|
|
24885
|
-
* @type {{ [key: string]: string; }}
|
|
24886
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24887
|
-
*/
|
|
24888
|
-
'product_field_mappings'?: { [key: string]: string; };
|
|
24889
|
-
/**
|
|
24890
|
-
*
|
|
24891
|
-
* @type {string}
|
|
24892
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24893
|
-
*/
|
|
24894
|
-
'product_sort_by'?: string;
|
|
24895
|
-
/**
|
|
24896
|
-
*
|
|
24897
|
-
* @type {number}
|
|
24898
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24899
|
-
*/
|
|
24900
|
-
'trending_products_limit'?: number;
|
|
24901
|
-
/**
|
|
24902
|
-
*
|
|
24903
|
-
* @type {number}
|
|
24904
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24905
|
-
*/
|
|
24906
|
-
'trending_search_limit'?: number;
|
|
24907
|
-
/**
|
|
24908
|
-
*
|
|
24909
|
-
* @type {number}
|
|
24910
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24911
|
-
*/
|
|
24912
|
-
'trending_time_range_days'?: number;
|
|
24913
|
-
/**
|
|
24914
|
-
*
|
|
24915
|
-
* @type {boolean}
|
|
24916
|
-
* @memberof DropdownRecommendationsServiceUpdateDropdownConfigRequest
|
|
24917
|
-
*/
|
|
24918
|
-
'use_query_suggestions_config'?: boolean;
|
|
24919
|
-
}
|
|
24920
24982
|
/**
|
|
24921
24983
|
*
|
|
24922
24984
|
* @export
|
|
@@ -25638,6 +25700,18 @@ export interface QuerySuggestionsServiceDropdownRecommendations {
|
|
|
25638
25700
|
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25639
25701
|
*/
|
|
25640
25702
|
'cached_at'?: string;
|
|
25703
|
+
/**
|
|
25704
|
+
* Filtered product tabs (e.g., \"All\", \"Brands\", \"Categories\")
|
|
25705
|
+
* @type {Array<QuerySuggestionsServiceFilteredTabResult>}
|
|
25706
|
+
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25707
|
+
*/
|
|
25708
|
+
'filtered_tabs'?: Array<QuerySuggestionsServiceFilteredTabResult>;
|
|
25709
|
+
/**
|
|
25710
|
+
* Item recommendations for query
|
|
25711
|
+
* @type {Array<QuerySuggestionsServiceTrendingProduct>}
|
|
25712
|
+
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25713
|
+
*/
|
|
25714
|
+
'item_recommendations'?: Array<QuerySuggestionsServiceTrendingProduct>;
|
|
25641
25715
|
/**
|
|
25642
25716
|
* Popular brands
|
|
25643
25717
|
* @type {Array<QuerySuggestionsServicePopularBrand>}
|
|
@@ -25650,6 +25724,18 @@ export interface QuerySuggestionsServiceDropdownRecommendations {
|
|
|
25650
25724
|
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25651
25725
|
*/
|
|
25652
25726
|
'processing_time_ms'?: number;
|
|
25727
|
+
/**
|
|
25728
|
+
* Related searches for query
|
|
25729
|
+
* @type {Array<QuerySuggestionsServiceQuerySuggestion>}
|
|
25730
|
+
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25731
|
+
*/
|
|
25732
|
+
'related_searches'?: Array<QuerySuggestionsServiceQuerySuggestion>;
|
|
25733
|
+
/**
|
|
25734
|
+
* Top searches (unfiltered)
|
|
25735
|
+
* @type {Array<QuerySuggestionsServiceTrendingSearch>}
|
|
25736
|
+
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25737
|
+
*/
|
|
25738
|
+
'top_searches'?: Array<QuerySuggestionsServiceTrendingSearch>;
|
|
25653
25739
|
/**
|
|
25654
25740
|
* Trending products
|
|
25655
25741
|
* @type {Array<QuerySuggestionsServiceTrendingProduct>}
|
|
@@ -25775,6 +25861,43 @@ export interface QuerySuggestionsServiceFacetUsage {
|
|
|
25775
25861
|
*/
|
|
25776
25862
|
'value'?: string;
|
|
25777
25863
|
}
|
|
25864
|
+
/**
|
|
25865
|
+
*
|
|
25866
|
+
* @export
|
|
25867
|
+
* @interface QuerySuggestionsServiceFilteredTabResult
|
|
25868
|
+
*/
|
|
25869
|
+
export interface QuerySuggestionsServiceFilteredTabResult {
|
|
25870
|
+
/**
|
|
25871
|
+
* Tab ID (matches FilteredTabConfig.ID)
|
|
25872
|
+
* @type {string}
|
|
25873
|
+
* @memberof QuerySuggestionsServiceFilteredTabResult
|
|
25874
|
+
*/
|
|
25875
|
+
'id'?: string;
|
|
25876
|
+
/**
|
|
25877
|
+
* Display label for the tab
|
|
25878
|
+
* @type {string}
|
|
25879
|
+
* @memberof QuerySuggestionsServiceFilteredTabResult
|
|
25880
|
+
*/
|
|
25881
|
+
'label'?: string;
|
|
25882
|
+
/**
|
|
25883
|
+
* Total number of products found
|
|
25884
|
+
* @type {number}
|
|
25885
|
+
* @memberof QuerySuggestionsServiceFilteredTabResult
|
|
25886
|
+
*/
|
|
25887
|
+
'nb_hits'?: number;
|
|
25888
|
+
/**
|
|
25889
|
+
* Processing time for this tab
|
|
25890
|
+
* @type {number}
|
|
25891
|
+
* @memberof QuerySuggestionsServiceFilteredTabResult
|
|
25892
|
+
*/
|
|
25893
|
+
'processing_time_ms'?: number;
|
|
25894
|
+
/**
|
|
25895
|
+
* Filtered products for this tab
|
|
25896
|
+
* @type {Array<QuerySuggestionsServiceTrendingProduct>}
|
|
25897
|
+
* @memberof QuerySuggestionsServiceFilteredTabResult
|
|
25898
|
+
*/
|
|
25899
|
+
'products'?: Array<QuerySuggestionsServiceTrendingProduct>;
|
|
25900
|
+
}
|
|
25778
25901
|
/**
|
|
25779
25902
|
*
|
|
25780
25903
|
* @export
|
|
@@ -30568,7 +30691,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
30568
30691
|
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
30569
30692
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
30570
30693
|
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
30571
|
-
* @param {boolean} [compareMode] Enable comparison mode
|
|
30694
|
+
* @param {boolean} [compareMode] Enable comparison mode (default: true, compares with previous week)
|
|
30572
30695
|
* @param {*} [options] Override http request option.
|
|
30573
30696
|
* @throws {RequiredError}
|
|
30574
30697
|
*/
|
|
@@ -31655,41 +31778,203 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
31655
31778
|
}
|
|
31656
31779
|
|
|
31657
31780
|
|
|
31658
|
-
|
|
31659
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31660
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31661
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31662
|
-
|
|
31663
|
-
return {
|
|
31664
|
-
url: toPathString(localVarUrlObj),
|
|
31665
|
-
options: localVarRequestOptions,
|
|
31666
|
-
};
|
|
31667
|
-
},
|
|
31668
|
-
/**
|
|
31669
|
-
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
31670
|
-
* @summary Get Realtime KPI Analytics
|
|
31671
|
-
* @param {string} xStoreID Store ID
|
|
31672
|
-
* @param {*} [options] Override http request option.
|
|
31673
|
-
* @throws {RequiredError}
|
|
31674
|
-
*/
|
|
31675
|
-
adminAnalyticsStoreXStoreIDKpiRealtimeGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31676
|
-
// verify required parameter 'xStoreID' is not null or undefined
|
|
31677
|
-
assertParamExists('adminAnalyticsStoreXStoreIDKpiRealtimeGet', 'xStoreID', xStoreID)
|
|
31678
|
-
const localVarPath = `/admin/analytics/store/{xStoreID}/kpi/realtime`
|
|
31679
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
31680
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31681
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31682
|
-
let baseOptions;
|
|
31683
|
-
if (configuration) {
|
|
31684
|
-
baseOptions = configuration.baseOptions;
|
|
31781
|
+
|
|
31782
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31783
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31784
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31785
|
+
|
|
31786
|
+
return {
|
|
31787
|
+
url: toPathString(localVarUrlObj),
|
|
31788
|
+
options: localVarRequestOptions,
|
|
31789
|
+
};
|
|
31790
|
+
},
|
|
31791
|
+
/**
|
|
31792
|
+
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
31793
|
+
* @summary Get Realtime KPI Analytics
|
|
31794
|
+
* @param {string} xStoreID Store ID
|
|
31795
|
+
* @param {*} [options] Override http request option.
|
|
31796
|
+
* @throws {RequiredError}
|
|
31797
|
+
*/
|
|
31798
|
+
adminAnalyticsStoreXStoreIDKpiRealtimeGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31799
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
31800
|
+
assertParamExists('adminAnalyticsStoreXStoreIDKpiRealtimeGet', 'xStoreID', xStoreID)
|
|
31801
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/kpi/realtime`
|
|
31802
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
31803
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31804
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31805
|
+
let baseOptions;
|
|
31806
|
+
if (configuration) {
|
|
31807
|
+
baseOptions = configuration.baseOptions;
|
|
31808
|
+
}
|
|
31809
|
+
|
|
31810
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
31811
|
+
const localVarHeaderParameter = {} as any;
|
|
31812
|
+
const localVarQueryParameter = {} as any;
|
|
31813
|
+
|
|
31814
|
+
// authentication BearerAuth required
|
|
31815
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
31816
|
+
|
|
31817
|
+
|
|
31818
|
+
|
|
31819
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31820
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31821
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31822
|
+
|
|
31823
|
+
return {
|
|
31824
|
+
url: toPathString(localVarUrlObj),
|
|
31825
|
+
options: localVarRequestOptions,
|
|
31826
|
+
};
|
|
31827
|
+
},
|
|
31828
|
+
/**
|
|
31829
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
31830
|
+
* @summary Get Query Analytics
|
|
31831
|
+
* @param {string} xStoreID Store ID
|
|
31832
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
31833
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
31834
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum} [granularity] Time granularity
|
|
31835
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
31836
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
31837
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
31838
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
31839
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
31840
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
31841
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
31842
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
31843
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
31844
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
31845
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
31846
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
31847
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
31848
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
31849
|
+
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
31850
|
+
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
31851
|
+
* @param {number} [page] Page number for pagination
|
|
31852
|
+
* @param {number} [pageSize] Number of results per page
|
|
31853
|
+
* @param {string} [orderBy] Order by field (legacy - use sort_by instead)
|
|
31854
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum} [sortBy] Field to sort by
|
|
31855
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum} [sortOrder] Sort direction
|
|
31856
|
+
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
31857
|
+
* @param {*} [options] Override http request option.
|
|
31858
|
+
* @throws {RequiredError}
|
|
31859
|
+
*/
|
|
31860
|
+
adminAnalyticsStoreXStoreIDQueriesGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31861
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
31862
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQueriesGet', 'xStoreID', xStoreID)
|
|
31863
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/queries`
|
|
31864
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
31865
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31866
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31867
|
+
let baseOptions;
|
|
31868
|
+
if (configuration) {
|
|
31869
|
+
baseOptions = configuration.baseOptions;
|
|
31870
|
+
}
|
|
31871
|
+
|
|
31872
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
31873
|
+
const localVarHeaderParameter = {} as any;
|
|
31874
|
+
const localVarQueryParameter = {} as any;
|
|
31875
|
+
|
|
31876
|
+
// authentication BearerAuth required
|
|
31877
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
31878
|
+
|
|
31879
|
+
if (startTime !== undefined) {
|
|
31880
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
31881
|
+
}
|
|
31882
|
+
|
|
31883
|
+
if (endTime !== undefined) {
|
|
31884
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
31885
|
+
}
|
|
31886
|
+
|
|
31887
|
+
if (granularity !== undefined) {
|
|
31888
|
+
localVarQueryParameter['granularity'] = granularity;
|
|
31889
|
+
}
|
|
31890
|
+
|
|
31891
|
+
if (search !== undefined) {
|
|
31892
|
+
localVarQueryParameter['search'] = search;
|
|
31893
|
+
}
|
|
31894
|
+
|
|
31895
|
+
if (analyticsTags !== undefined) {
|
|
31896
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
31897
|
+
}
|
|
31898
|
+
|
|
31899
|
+
if (tagsMatchMode !== undefined) {
|
|
31900
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
31901
|
+
}
|
|
31902
|
+
|
|
31903
|
+
if (tagsExclude !== undefined) {
|
|
31904
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
31905
|
+
}
|
|
31906
|
+
|
|
31907
|
+
if (tagKeyFilter !== undefined) {
|
|
31908
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
31909
|
+
}
|
|
31910
|
+
|
|
31911
|
+
if (tagValueFilter !== undefined) {
|
|
31912
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
31913
|
+
}
|
|
31914
|
+
|
|
31915
|
+
if (compareMode !== undefined) {
|
|
31916
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
31917
|
+
}
|
|
31918
|
+
|
|
31919
|
+
if (compareStartTime !== undefined) {
|
|
31920
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
31921
|
+
}
|
|
31922
|
+
|
|
31923
|
+
if (compareEndTime !== undefined) {
|
|
31924
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
31925
|
+
}
|
|
31926
|
+
|
|
31927
|
+
if (compareAnalyticsTags !== undefined) {
|
|
31928
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
31929
|
+
}
|
|
31930
|
+
|
|
31931
|
+
if (compareTagsMatchMode !== undefined) {
|
|
31932
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
31933
|
+
}
|
|
31934
|
+
|
|
31935
|
+
if (compareTagsExclude !== undefined) {
|
|
31936
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
31937
|
+
}
|
|
31938
|
+
|
|
31939
|
+
if (compareTagKeyFilter !== undefined) {
|
|
31940
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
31941
|
+
}
|
|
31942
|
+
|
|
31943
|
+
if (compareTagValueFilter !== undefined) {
|
|
31944
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
31945
|
+
}
|
|
31946
|
+
|
|
31947
|
+
if (limit !== undefined) {
|
|
31948
|
+
localVarQueryParameter['limit'] = limit;
|
|
31949
|
+
}
|
|
31950
|
+
|
|
31951
|
+
if (offset !== undefined) {
|
|
31952
|
+
localVarQueryParameter['offset'] = offset;
|
|
31953
|
+
}
|
|
31954
|
+
|
|
31955
|
+
if (page !== undefined) {
|
|
31956
|
+
localVarQueryParameter['page'] = page;
|
|
31957
|
+
}
|
|
31958
|
+
|
|
31959
|
+
if (pageSize !== undefined) {
|
|
31960
|
+
localVarQueryParameter['page_size'] = pageSize;
|
|
31961
|
+
}
|
|
31962
|
+
|
|
31963
|
+
if (orderBy !== undefined) {
|
|
31964
|
+
localVarQueryParameter['order_by'] = orderBy;
|
|
31965
|
+
}
|
|
31966
|
+
|
|
31967
|
+
if (sortBy !== undefined) {
|
|
31968
|
+
localVarQueryParameter['sort_by'] = sortBy;
|
|
31685
31969
|
}
|
|
31686
31970
|
|
|
31687
|
-
|
|
31688
|
-
|
|
31689
|
-
|
|
31971
|
+
if (sortOrder !== undefined) {
|
|
31972
|
+
localVarQueryParameter['sort_order'] = sortOrder;
|
|
31973
|
+
}
|
|
31690
31974
|
|
|
31691
|
-
|
|
31692
|
-
|
|
31975
|
+
if (sort !== undefined) {
|
|
31976
|
+
localVarQueryParameter['sort'] = sort;
|
|
31977
|
+
}
|
|
31693
31978
|
|
|
31694
31979
|
|
|
31695
31980
|
|
|
@@ -31703,15 +31988,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
31703
31988
|
};
|
|
31704
31989
|
},
|
|
31705
31990
|
/**
|
|
31706
|
-
* Retrieve
|
|
31707
|
-
* @summary Get
|
|
31991
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
31992
|
+
* @summary Get No-Clicks Queries
|
|
31708
31993
|
* @param {string} xStoreID Store ID
|
|
31709
31994
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
31710
31995
|
* @param {string} [endTime] End time in RFC3339 format
|
|
31711
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum} [granularity] Time granularity
|
|
31712
31996
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
31713
31997
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
31714
|
-
* @param {
|
|
31998
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
31715
31999
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
31716
32000
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
31717
32001
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
@@ -31719,7 +32003,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
31719
32003
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
31720
32004
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
31721
32005
|
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
31722
|
-
* @param {
|
|
32006
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
31723
32007
|
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
31724
32008
|
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
31725
32009
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
@@ -31727,17 +32011,16 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
31727
32011
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
31728
32012
|
* @param {number} [page] Page number for pagination
|
|
31729
32013
|
* @param {number} [pageSize] Number of results per page
|
|
31730
|
-
* @param {
|
|
31731
|
-
* @param {
|
|
31732
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum} [sortOrder] Sort direction
|
|
32014
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum} [sortBy] Field to sort by
|
|
32015
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum} [sortOrder] Sort direction
|
|
31733
32016
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
31734
32017
|
* @param {*} [options] Override http request option.
|
|
31735
32018
|
* @throws {RequiredError}
|
|
31736
32019
|
*/
|
|
31737
|
-
|
|
32020
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet: async (xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31738
32021
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
31739
|
-
assertParamExists('
|
|
31740
|
-
const localVarPath = `/admin/analytics/store/{xStoreID}/queries`
|
|
32022
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoClicksGet', 'xStoreID', xStoreID)
|
|
32023
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-clicks`
|
|
31741
32024
|
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
31742
32025
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31743
32026
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -31761,10 +32044,6 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
31761
32044
|
localVarQueryParameter['end_time'] = endTime;
|
|
31762
32045
|
}
|
|
31763
32046
|
|
|
31764
|
-
if (granularity !== undefined) {
|
|
31765
|
-
localVarQueryParameter['granularity'] = granularity;
|
|
31766
|
-
}
|
|
31767
|
-
|
|
31768
32047
|
if (search !== undefined) {
|
|
31769
32048
|
localVarQueryParameter['search'] = search;
|
|
31770
32049
|
}
|
|
@@ -31837,10 +32116,6 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
31837
32116
|
localVarQueryParameter['page_size'] = pageSize;
|
|
31838
32117
|
}
|
|
31839
32118
|
|
|
31840
|
-
if (orderBy !== undefined) {
|
|
31841
|
-
localVarQueryParameter['order_by'] = orderBy;
|
|
31842
|
-
}
|
|
31843
|
-
|
|
31844
32119
|
if (sortBy !== undefined) {
|
|
31845
32120
|
localVarQueryParameter['sort_by'] = sortBy;
|
|
31846
32121
|
}
|
|
@@ -31865,14 +32140,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
31865
32140
|
};
|
|
31866
32141
|
},
|
|
31867
32142
|
/**
|
|
31868
|
-
* Retrieve queries that
|
|
31869
|
-
* @summary Get No-
|
|
32143
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
32144
|
+
* @summary Get No-Results Queries
|
|
31870
32145
|
* @param {string} xStoreID Store ID
|
|
31871
32146
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
31872
32147
|
* @param {string} [endTime] End time in RFC3339 format
|
|
31873
32148
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
31874
32149
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
31875
|
-
* @param {
|
|
32150
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
31876
32151
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
31877
32152
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
31878
32153
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
@@ -31880,7 +32155,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
31880
32155
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
31881
32156
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
31882
32157
|
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
31883
|
-
* @param {
|
|
32158
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
31884
32159
|
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
31885
32160
|
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
31886
32161
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
@@ -31888,16 +32163,16 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
31888
32163
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
31889
32164
|
* @param {number} [page] Page number for pagination
|
|
31890
32165
|
* @param {number} [pageSize] Number of results per page
|
|
31891
|
-
* @param {
|
|
31892
|
-
* @param {
|
|
32166
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum} [sortBy] Field to sort by
|
|
32167
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
31893
32168
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
31894
32169
|
* @param {*} [options] Override http request option.
|
|
31895
32170
|
* @throws {RequiredError}
|
|
31896
32171
|
*/
|
|
31897
|
-
|
|
32172
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: async (xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31898
32173
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
31899
|
-
assertParamExists('
|
|
31900
|
-
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-
|
|
32174
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoResultsGet', 'xStoreID', xStoreID)
|
|
32175
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-results`
|
|
31901
32176
|
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
31902
32177
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31903
32178
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -32017,40 +32292,48 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
32017
32292
|
};
|
|
32018
32293
|
},
|
|
32019
32294
|
/**
|
|
32020
|
-
* Retrieve
|
|
32021
|
-
* @summary Get
|
|
32295
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
32296
|
+
* @summary Get Query Insights
|
|
32022
32297
|
* @param {string} xStoreID Store ID
|
|
32298
|
+
* @param {string} query Search query to analyze
|
|
32023
32299
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
32024
32300
|
* @param {string} [endTime] End time in RFC3339 format
|
|
32025
|
-
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
32026
32301
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
32027
|
-
* @param {
|
|
32302
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
32028
32303
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
32029
32304
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
32030
32305
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
32306
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
32031
32307
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
32032
32308
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
32033
32309
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
32034
32310
|
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
32035
|
-
* @param {
|
|
32311
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
32036
32312
|
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
32037
32313
|
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
32038
32314
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
32039
|
-
* @param {number} [
|
|
32040
|
-
* @param {number} [
|
|
32041
|
-
* @param {
|
|
32042
|
-
* @param {number} [
|
|
32043
|
-
* @param {
|
|
32044
|
-
* @param {
|
|
32045
|
-
* @param {
|
|
32315
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
32316
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
32317
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
32318
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
32319
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
32320
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
32321
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
32322
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
32323
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
32324
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
32325
|
+
* @param {boolean} [noClicksOnly] Filter to show insights only for searches that had no clicks (useful when clicking on queries from \'searches without clicks\' list)
|
|
32046
32326
|
* @param {*} [options] Override http request option.
|
|
32047
32327
|
* @throws {RequiredError}
|
|
32048
32328
|
*/
|
|
32049
|
-
|
|
32329
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, noClicksOnly?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
32050
32330
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
32051
|
-
assertParamExists('
|
|
32052
|
-
|
|
32053
|
-
|
|
32331
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID)
|
|
32332
|
+
// verify required parameter 'query' is not null or undefined
|
|
32333
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'query', query)
|
|
32334
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/{query}/insights`
|
|
32335
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
32336
|
+
.replace(`{${"query"}}`, encodeURIComponent(String(query)));
|
|
32054
32337
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
32055
32338
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
32056
32339
|
let baseOptions;
|
|
@@ -32073,10 +32356,6 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
32073
32356
|
localVarQueryParameter['end_time'] = endTime;
|
|
32074
32357
|
}
|
|
32075
32358
|
|
|
32076
|
-
if (search !== undefined) {
|
|
32077
|
-
localVarQueryParameter['search'] = search;
|
|
32078
|
-
}
|
|
32079
|
-
|
|
32080
32359
|
if (analyticsTags !== undefined) {
|
|
32081
32360
|
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
32082
32361
|
}
|
|
@@ -32097,6 +32376,10 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
32097
32376
|
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
32098
32377
|
}
|
|
32099
32378
|
|
|
32379
|
+
if (search !== undefined) {
|
|
32380
|
+
localVarQueryParameter['search'] = search;
|
|
32381
|
+
}
|
|
32382
|
+
|
|
32100
32383
|
if (compareMode !== undefined) {
|
|
32101
32384
|
localVarQueryParameter['compare_mode'] = compareMode;
|
|
32102
32385
|
}
|
|
@@ -32129,32 +32412,48 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
32129
32412
|
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
32130
32413
|
}
|
|
32131
32414
|
|
|
32132
|
-
if (
|
|
32133
|
-
localVarQueryParameter['
|
|
32415
|
+
if (resultsPage !== undefined) {
|
|
32416
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
32134
32417
|
}
|
|
32135
32418
|
|
|
32136
|
-
if (
|
|
32137
|
-
localVarQueryParameter['
|
|
32419
|
+
if (resultsPageSize !== undefined) {
|
|
32420
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
32138
32421
|
}
|
|
32139
32422
|
|
|
32140
|
-
if (
|
|
32141
|
-
localVarQueryParameter['
|
|
32423
|
+
if (resultsSearch !== undefined) {
|
|
32424
|
+
localVarQueryParameter['results_search'] = resultsSearch;
|
|
32142
32425
|
}
|
|
32143
32426
|
|
|
32144
|
-
if (
|
|
32145
|
-
localVarQueryParameter['
|
|
32427
|
+
if (filtersPage !== undefined) {
|
|
32428
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
32146
32429
|
}
|
|
32147
32430
|
|
|
32148
|
-
if (
|
|
32149
|
-
localVarQueryParameter['
|
|
32431
|
+
if (filtersPageSize !== undefined) {
|
|
32432
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
32150
32433
|
}
|
|
32151
32434
|
|
|
32152
|
-
if (
|
|
32153
|
-
localVarQueryParameter['
|
|
32435
|
+
if (filtersSearch !== undefined) {
|
|
32436
|
+
localVarQueryParameter['filters_search'] = filtersSearch;
|
|
32154
32437
|
}
|
|
32155
32438
|
|
|
32156
|
-
if (
|
|
32157
|
-
localVarQueryParameter['
|
|
32439
|
+
if (geoPage !== undefined) {
|
|
32440
|
+
localVarQueryParameter['geo_page'] = geoPage;
|
|
32441
|
+
}
|
|
32442
|
+
|
|
32443
|
+
if (geoPageSize !== undefined) {
|
|
32444
|
+
localVarQueryParameter['geo_page_size'] = geoPageSize;
|
|
32445
|
+
}
|
|
32446
|
+
|
|
32447
|
+
if (geoSearch !== undefined) {
|
|
32448
|
+
localVarQueryParameter['geo_search'] = geoSearch;
|
|
32449
|
+
}
|
|
32450
|
+
|
|
32451
|
+
if (includeWidget !== undefined) {
|
|
32452
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
32453
|
+
}
|
|
32454
|
+
|
|
32455
|
+
if (noClicksOnly !== undefined) {
|
|
32456
|
+
localVarQueryParameter['no_clicks_only'] = noClicksOnly;
|
|
32158
32457
|
}
|
|
32159
32458
|
|
|
32160
32459
|
|
|
@@ -32169,48 +32468,44 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
32169
32468
|
};
|
|
32170
32469
|
},
|
|
32171
32470
|
/**
|
|
32172
|
-
* Retrieve
|
|
32173
|
-
* @summary Get
|
|
32471
|
+
* 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.
|
|
32472
|
+
* @summary Get Top Results Analytics
|
|
32174
32473
|
* @param {string} xStoreID Store ID
|
|
32175
|
-
* @param {string} query Search query to analyze
|
|
32176
32474
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
32177
32475
|
* @param {string} [endTime] End time in RFC3339 format
|
|
32476
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs)
|
|
32477
|
+
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
32178
32478
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
32179
|
-
* @param {
|
|
32479
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
32180
32480
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
32181
32481
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
32182
32482
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
32183
|
-
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
32184
32483
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
32185
32484
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
32186
32485
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
32187
32486
|
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
32188
|
-
* @param {
|
|
32487
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
32189
32488
|
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
32190
32489
|
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
32191
32490
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
32192
|
-
* @param {number} [
|
|
32193
|
-
* @param {
|
|
32194
|
-
* @param {
|
|
32195
|
-
* @param {
|
|
32196
|
-
* @param {
|
|
32197
|
-
* @param {
|
|
32198
|
-
* @param {number} [
|
|
32199
|
-
* @param {number} [
|
|
32200
|
-
* @param {
|
|
32201
|
-
* @param {
|
|
32202
|
-
* @param {boolean} [noClicksOnly] Filter to show insights only for searches that had no clicks (useful when clicking on queries from \'searches without clicks\' list)
|
|
32491
|
+
* @param {number} [minImpressions] Minimum number of impressions required
|
|
32492
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
32493
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
32494
|
+
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
32495
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
32496
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
32497
|
+
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
32498
|
+
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
32499
|
+
* @param {number} [page] Page number for pagination
|
|
32500
|
+
* @param {number} [pageSize] Number of results per page
|
|
32203
32501
|
* @param {*} [options] Override http request option.
|
|
32204
32502
|
* @throws {RequiredError}
|
|
32205
32503
|
*/
|
|
32206
|
-
|
|
32504
|
+
adminAnalyticsStoreXStoreIDResultsGet: async (xStoreID: string, startTime?: string, endTime?: string, search?: 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> => {
|
|
32207
32505
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
32208
|
-
assertParamExists('
|
|
32209
|
-
|
|
32210
|
-
|
|
32211
|
-
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/{query}/insights`
|
|
32212
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
32213
|
-
.replace(`{${"query"}}`, encodeURIComponent(String(query)));
|
|
32506
|
+
assertParamExists('adminAnalyticsStoreXStoreIDResultsGet', 'xStoreID', xStoreID)
|
|
32507
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/results`
|
|
32508
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
32214
32509
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
32215
32510
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
32216
32511
|
let baseOptions;
|
|
@@ -32233,6 +32528,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
32233
32528
|
localVarQueryParameter['end_time'] = endTime;
|
|
32234
32529
|
}
|
|
32235
32530
|
|
|
32531
|
+
if (search !== undefined) {
|
|
32532
|
+
localVarQueryParameter['search'] = search;
|
|
32533
|
+
}
|
|
32534
|
+
|
|
32535
|
+
if (itemIds !== undefined) {
|
|
32536
|
+
localVarQueryParameter['item_ids'] = itemIds;
|
|
32537
|
+
}
|
|
32538
|
+
|
|
32236
32539
|
if (analyticsTags !== undefined) {
|
|
32237
32540
|
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
32238
32541
|
}
|
|
@@ -32253,10 +32556,6 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
32253
32556
|
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
32254
32557
|
}
|
|
32255
32558
|
|
|
32256
|
-
if (search !== undefined) {
|
|
32257
|
-
localVarQueryParameter['search'] = search;
|
|
32258
|
-
}
|
|
32259
|
-
|
|
32260
32559
|
if (compareMode !== undefined) {
|
|
32261
32560
|
localVarQueryParameter['compare_mode'] = compareMode;
|
|
32262
32561
|
}
|
|
@@ -32289,48 +32588,44 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
32289
32588
|
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
32290
32589
|
}
|
|
32291
32590
|
|
|
32292
|
-
if (
|
|
32293
|
-
localVarQueryParameter['
|
|
32294
|
-
}
|
|
32295
|
-
|
|
32296
|
-
if (resultsPageSize !== undefined) {
|
|
32297
|
-
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
32591
|
+
if (minImpressions !== undefined) {
|
|
32592
|
+
localVarQueryParameter['min_impressions'] = minImpressions;
|
|
32298
32593
|
}
|
|
32299
32594
|
|
|
32300
|
-
if (
|
|
32301
|
-
localVarQueryParameter['
|
|
32595
|
+
if (sortBy !== undefined) {
|
|
32596
|
+
localVarQueryParameter['sort_by'] = sortBy;
|
|
32302
32597
|
}
|
|
32303
32598
|
|
|
32304
|
-
if (
|
|
32305
|
-
localVarQueryParameter['
|
|
32599
|
+
if (sortOrder !== undefined) {
|
|
32600
|
+
localVarQueryParameter['sort_order'] = sortOrder;
|
|
32306
32601
|
}
|
|
32307
32602
|
|
|
32308
|
-
if (
|
|
32309
|
-
localVarQueryParameter['
|
|
32603
|
+
if (sort !== undefined) {
|
|
32604
|
+
localVarQueryParameter['sort'] = sort;
|
|
32310
32605
|
}
|
|
32311
32606
|
|
|
32312
|
-
if (
|
|
32313
|
-
localVarQueryParameter['
|
|
32607
|
+
if (includeDocuments !== undefined) {
|
|
32608
|
+
localVarQueryParameter['include_documents'] = includeDocuments;
|
|
32314
32609
|
}
|
|
32315
32610
|
|
|
32316
|
-
if (
|
|
32317
|
-
localVarQueryParameter['
|
|
32611
|
+
if (includeWidget !== undefined) {
|
|
32612
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
32318
32613
|
}
|
|
32319
32614
|
|
|
32320
|
-
if (
|
|
32321
|
-
localVarQueryParameter['
|
|
32615
|
+
if (limit !== undefined) {
|
|
32616
|
+
localVarQueryParameter['limit'] = limit;
|
|
32322
32617
|
}
|
|
32323
32618
|
|
|
32324
|
-
if (
|
|
32325
|
-
localVarQueryParameter['
|
|
32619
|
+
if (offset !== undefined) {
|
|
32620
|
+
localVarQueryParameter['offset'] = offset;
|
|
32326
32621
|
}
|
|
32327
32622
|
|
|
32328
|
-
if (
|
|
32329
|
-
localVarQueryParameter['
|
|
32623
|
+
if (page !== undefined) {
|
|
32624
|
+
localVarQueryParameter['page'] = page;
|
|
32330
32625
|
}
|
|
32331
32626
|
|
|
32332
|
-
if (
|
|
32333
|
-
localVarQueryParameter['
|
|
32627
|
+
if (pageSize !== undefined) {
|
|
32628
|
+
localVarQueryParameter['page_size'] = pageSize;
|
|
32334
32629
|
}
|
|
32335
32630
|
|
|
32336
32631
|
|
|
@@ -32345,43 +32640,19 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
32345
32640
|
};
|
|
32346
32641
|
},
|
|
32347
32642
|
/**
|
|
32348
|
-
* Retrieve
|
|
32349
|
-
* @summary Get
|
|
32643
|
+
* Retrieve most popular queries used for getting suggestions, ordered by request count
|
|
32644
|
+
* @summary Get Popular Suggestion Queries
|
|
32350
32645
|
* @param {string} xStoreID Store ID
|
|
32351
32646
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
32352
32647
|
* @param {string} [endTime] End time in RFC3339 format
|
|
32353
|
-
* @param {
|
|
32354
|
-
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
32355
|
-
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
32356
|
-
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
32357
|
-
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
32358
|
-
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
32359
|
-
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
32360
|
-
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
32361
|
-
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
32362
|
-
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
32363
|
-
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
32364
|
-
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
32365
|
-
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
32366
|
-
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
32367
|
-
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
32368
|
-
* @param {number} [minImpressions] Minimum number of impressions required
|
|
32369
|
-
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
32370
|
-
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
32371
|
-
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
32372
|
-
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
32373
|
-
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
32374
|
-
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
32375
|
-
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
32376
|
-
* @param {number} [page] Page number for pagination
|
|
32377
|
-
* @param {number} [pageSize] Number of results per page
|
|
32648
|
+
* @param {number} [limit] Number of results to return
|
|
32378
32649
|
* @param {*} [options] Override http request option.
|
|
32379
32650
|
* @throws {RequiredError}
|
|
32380
32651
|
*/
|
|
32381
|
-
|
|
32652
|
+
adminAnalyticsStoreXStoreIDSuggestionsPopularGet: async (xStoreID: string, startTime?: string, endTime?: string, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
32382
32653
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
32383
|
-
assertParamExists('
|
|
32384
|
-
const localVarPath = `/admin/analytics/store/{xStoreID}/
|
|
32654
|
+
assertParamExists('adminAnalyticsStoreXStoreIDSuggestionsPopularGet', 'xStoreID', xStoreID)
|
|
32655
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/suggestions/popular`
|
|
32385
32656
|
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
32386
32657
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
32387
32658
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -32405,68 +32676,87 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
32405
32676
|
localVarQueryParameter['end_time'] = endTime;
|
|
32406
32677
|
}
|
|
32407
32678
|
|
|
32408
|
-
if (
|
|
32409
|
-
localVarQueryParameter['
|
|
32410
|
-
}
|
|
32411
|
-
|
|
32412
|
-
if (itemIds !== undefined) {
|
|
32413
|
-
localVarQueryParameter['item_ids'] = itemIds;
|
|
32414
|
-
}
|
|
32415
|
-
|
|
32416
|
-
if (analyticsTags !== undefined) {
|
|
32417
|
-
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
32679
|
+
if (limit !== undefined) {
|
|
32680
|
+
localVarQueryParameter['limit'] = limit;
|
|
32418
32681
|
}
|
|
32419
32682
|
|
|
32420
|
-
if (tagsMatchMode !== undefined) {
|
|
32421
|
-
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
32422
|
-
}
|
|
32423
32683
|
|
|
32424
|
-
|
|
32425
|
-
|
|
32426
|
-
}
|
|
32684
|
+
|
|
32685
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
32686
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
32687
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
32427
32688
|
|
|
32428
|
-
|
|
32429
|
-
|
|
32689
|
+
return {
|
|
32690
|
+
url: toPathString(localVarUrlObj),
|
|
32691
|
+
options: localVarRequestOptions,
|
|
32692
|
+
};
|
|
32693
|
+
},
|
|
32694
|
+
/**
|
|
32695
|
+
* Retrieve analytics for query suggestions including request counts, suggestions returned, processing time, and usage metrics. Supports filtering by query, analytics tags, and time range.
|
|
32696
|
+
* @summary Get Query Suggestions Analytics
|
|
32697
|
+
* @param {string} xStoreID Store ID
|
|
32698
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
32699
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
32700
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
32701
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
32702
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
32703
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
32704
|
+
* @param {number} [page] Page number for pagination
|
|
32705
|
+
* @param {number} [pageSize] Number of results per page
|
|
32706
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortByEnum} [sortBy] Field to sort by
|
|
32707
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortOrderEnum} [sortOrder] Sort direction
|
|
32708
|
+
* @param {*} [options] Override http request option.
|
|
32709
|
+
* @throws {RequiredError}
|
|
32710
|
+
*/
|
|
32711
|
+
adminAnalyticsStoreXStoreIDSuggestionsQueriesGet: async (xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetTagsMatchModeEnum, tagsExclude?: string, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortOrderEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
32712
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
32713
|
+
assertParamExists('adminAnalyticsStoreXStoreIDSuggestionsQueriesGet', 'xStoreID', xStoreID)
|
|
32714
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/suggestions/queries`
|
|
32715
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
32716
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
32717
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
32718
|
+
let baseOptions;
|
|
32719
|
+
if (configuration) {
|
|
32720
|
+
baseOptions = configuration.baseOptions;
|
|
32430
32721
|
}
|
|
32431
32722
|
|
|
32432
|
-
|
|
32433
|
-
|
|
32434
|
-
}
|
|
32723
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
32724
|
+
const localVarHeaderParameter = {} as any;
|
|
32725
|
+
const localVarQueryParameter = {} as any;
|
|
32435
32726
|
|
|
32436
|
-
|
|
32437
|
-
|
|
32438
|
-
}
|
|
32727
|
+
// authentication BearerAuth required
|
|
32728
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
32439
32729
|
|
|
32440
|
-
if (
|
|
32441
|
-
localVarQueryParameter['
|
|
32730
|
+
if (startTime !== undefined) {
|
|
32731
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
32442
32732
|
}
|
|
32443
32733
|
|
|
32444
|
-
if (
|
|
32445
|
-
localVarQueryParameter['
|
|
32734
|
+
if (endTime !== undefined) {
|
|
32735
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
32446
32736
|
}
|
|
32447
32737
|
|
|
32448
|
-
if (
|
|
32449
|
-
localVarQueryParameter['
|
|
32738
|
+
if (search !== undefined) {
|
|
32739
|
+
localVarQueryParameter['search'] = search;
|
|
32450
32740
|
}
|
|
32451
32741
|
|
|
32452
|
-
if (
|
|
32453
|
-
localVarQueryParameter['
|
|
32742
|
+
if (analyticsTags !== undefined) {
|
|
32743
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
32454
32744
|
}
|
|
32455
32745
|
|
|
32456
|
-
if (
|
|
32457
|
-
localVarQueryParameter['
|
|
32746
|
+
if (tagsMatchMode !== undefined) {
|
|
32747
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
32458
32748
|
}
|
|
32459
32749
|
|
|
32460
|
-
if (
|
|
32461
|
-
localVarQueryParameter['
|
|
32750
|
+
if (tagsExclude !== undefined) {
|
|
32751
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
32462
32752
|
}
|
|
32463
32753
|
|
|
32464
|
-
if (
|
|
32465
|
-
localVarQueryParameter['
|
|
32754
|
+
if (page !== undefined) {
|
|
32755
|
+
localVarQueryParameter['page'] = page;
|
|
32466
32756
|
}
|
|
32467
32757
|
|
|
32468
|
-
if (
|
|
32469
|
-
localVarQueryParameter['
|
|
32758
|
+
if (pageSize !== undefined) {
|
|
32759
|
+
localVarQueryParameter['page_size'] = pageSize;
|
|
32470
32760
|
}
|
|
32471
32761
|
|
|
32472
32762
|
if (sortBy !== undefined) {
|
|
@@ -32477,32 +32767,70 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
32477
32767
|
localVarQueryParameter['sort_order'] = sortOrder;
|
|
32478
32768
|
}
|
|
32479
32769
|
|
|
32480
|
-
if (sort !== undefined) {
|
|
32481
|
-
localVarQueryParameter['sort'] = sort;
|
|
32482
|
-
}
|
|
32483
32770
|
|
|
32484
|
-
|
|
32485
|
-
|
|
32771
|
+
|
|
32772
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
32773
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
32774
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
32775
|
+
|
|
32776
|
+
return {
|
|
32777
|
+
url: toPathString(localVarUrlObj),
|
|
32778
|
+
options: localVarRequestOptions,
|
|
32779
|
+
};
|
|
32780
|
+
},
|
|
32781
|
+
/**
|
|
32782
|
+
* Retrieve comprehensive insights for a specific query suggestion including metrics, performance data, and optional time series
|
|
32783
|
+
* @summary Get Query Suggestions Insights
|
|
32784
|
+
* @param {string} xStoreID Store ID
|
|
32785
|
+
* @param {string} query Query suggestion to analyze
|
|
32786
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
32787
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
32788
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetGranularityEnum} [granularity] Time granularity for time series
|
|
32789
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
32790
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
32791
|
+
* @param {*} [options] Override http request option.
|
|
32792
|
+
* @throws {RequiredError}
|
|
32793
|
+
*/
|
|
32794
|
+
adminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetTagsMatchModeEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
32795
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
32796
|
+
assertParamExists('adminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet', 'xStoreID', xStoreID)
|
|
32797
|
+
// verify required parameter 'query' is not null or undefined
|
|
32798
|
+
assertParamExists('adminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet', 'query', query)
|
|
32799
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/suggestions/{query}/insights`
|
|
32800
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
32801
|
+
.replace(`{${"query"}}`, encodeURIComponent(String(query)));
|
|
32802
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
32803
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
32804
|
+
let baseOptions;
|
|
32805
|
+
if (configuration) {
|
|
32806
|
+
baseOptions = configuration.baseOptions;
|
|
32486
32807
|
}
|
|
32487
32808
|
|
|
32488
|
-
|
|
32489
|
-
|
|
32809
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
32810
|
+
const localVarHeaderParameter = {} as any;
|
|
32811
|
+
const localVarQueryParameter = {} as any;
|
|
32812
|
+
|
|
32813
|
+
// authentication BearerAuth required
|
|
32814
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
32815
|
+
|
|
32816
|
+
if (startTime !== undefined) {
|
|
32817
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
32490
32818
|
}
|
|
32491
32819
|
|
|
32492
|
-
if (
|
|
32493
|
-
localVarQueryParameter['
|
|
32820
|
+
if (endTime !== undefined) {
|
|
32821
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
32494
32822
|
}
|
|
32495
32823
|
|
|
32496
|
-
if (
|
|
32497
|
-
localVarQueryParameter['
|
|
32824
|
+
if (granularity !== undefined) {
|
|
32825
|
+
localVarQueryParameter['granularity'] = granularity;
|
|
32498
32826
|
}
|
|
32499
32827
|
|
|
32500
|
-
if (
|
|
32501
|
-
localVarQueryParameter['
|
|
32828
|
+
if (analyticsTags !== undefined) {
|
|
32829
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
32502
32830
|
}
|
|
32503
32831
|
|
|
32504
|
-
if (
|
|
32505
|
-
localVarQueryParameter['
|
|
32832
|
+
if (tagsMatchMode !== undefined) {
|
|
32833
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
32506
32834
|
}
|
|
32507
32835
|
|
|
32508
32836
|
|
|
@@ -32894,7 +33222,7 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
32894
33222
|
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
32895
33223
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
32896
33224
|
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
32897
|
-
* @param {boolean} [compareMode] Enable comparison mode
|
|
33225
|
+
* @param {boolean} [compareMode] Enable comparison mode (default: true, compares with previous week)
|
|
32898
33226
|
* @param {*} [options] Override http request option.
|
|
32899
33227
|
* @throws {RequiredError}
|
|
32900
33228
|
*/
|
|
@@ -33383,6 +33711,64 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
33383
33711
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDResultsGet']?.[localVarOperationServerIndex]?.url;
|
|
33384
33712
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
33385
33713
|
},
|
|
33714
|
+
/**
|
|
33715
|
+
* Retrieve most popular queries used for getting suggestions, ordered by request count
|
|
33716
|
+
* @summary Get Popular Suggestion Queries
|
|
33717
|
+
* @param {string} xStoreID Store ID
|
|
33718
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
33719
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
33720
|
+
* @param {number} [limit] Number of results to return
|
|
33721
|
+
* @param {*} [options] Override http request option.
|
|
33722
|
+
* @throws {RequiredError}
|
|
33723
|
+
*/
|
|
33724
|
+
async adminAnalyticsStoreXStoreIDSuggestionsPopularGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDSuggestionsPopularGet200Response>> {
|
|
33725
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDSuggestionsPopularGet(xStoreID, startTime, endTime, limit, options);
|
|
33726
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
33727
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDSuggestionsPopularGet']?.[localVarOperationServerIndex]?.url;
|
|
33728
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
33729
|
+
},
|
|
33730
|
+
/**
|
|
33731
|
+
* Retrieve analytics for query suggestions including request counts, suggestions returned, processing time, and usage metrics. Supports filtering by query, analytics tags, and time range.
|
|
33732
|
+
* @summary Get Query Suggestions Analytics
|
|
33733
|
+
* @param {string} xStoreID Store ID
|
|
33734
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
33735
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
33736
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
33737
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
33738
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
33739
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
33740
|
+
* @param {number} [page] Page number for pagination
|
|
33741
|
+
* @param {number} [pageSize] Number of results per page
|
|
33742
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortByEnum} [sortBy] Field to sort by
|
|
33743
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortOrderEnum} [sortOrder] Sort direction
|
|
33744
|
+
* @param {*} [options] Override http request option.
|
|
33745
|
+
* @throws {RequiredError}
|
|
33746
|
+
*/
|
|
33747
|
+
async adminAnalyticsStoreXStoreIDSuggestionsQueriesGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetTagsMatchModeEnum, tagsExclude?: string, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDSuggestionsPopularGet200Response>> {
|
|
33748
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDSuggestionsQueriesGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, page, pageSize, sortBy, sortOrder, options);
|
|
33749
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
33750
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDSuggestionsQueriesGet']?.[localVarOperationServerIndex]?.url;
|
|
33751
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
33752
|
+
},
|
|
33753
|
+
/**
|
|
33754
|
+
* Retrieve comprehensive insights for a specific query suggestion including metrics, performance data, and optional time series
|
|
33755
|
+
* @summary Get Query Suggestions Insights
|
|
33756
|
+
* @param {string} xStoreID Store ID
|
|
33757
|
+
* @param {string} query Query suggestion to analyze
|
|
33758
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
33759
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
33760
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetGranularityEnum} [granularity] Time granularity for time series
|
|
33761
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
33762
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
33763
|
+
* @param {*} [options] Override http request option.
|
|
33764
|
+
* @throws {RequiredError}
|
|
33765
|
+
*/
|
|
33766
|
+
async adminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetTagsMatchModeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet200Response>> {
|
|
33767
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet(xStoreID, query, startTime, endTime, granularity, analyticsTags, tagsMatchMode, options);
|
|
33768
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
33769
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet']?.[localVarOperationServerIndex]?.url;
|
|
33770
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
33771
|
+
},
|
|
33386
33772
|
/**
|
|
33387
33773
|
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
33388
33774
|
* @summary Get Analytics Tags
|
|
@@ -33511,7 +33897,7 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
33511
33897
|
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
33512
33898
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
33513
33899
|
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
33514
|
-
* @param {boolean} [compareMode] Enable comparison mode
|
|
33900
|
+
* @param {boolean} [compareMode] Enable comparison mode (default: true, compares with previous week)
|
|
33515
33901
|
* @param {*} [options] Override http request option.
|
|
33516
33902
|
* @throws {RequiredError}
|
|
33517
33903
|
*/
|
|
@@ -33943,6 +34329,55 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
33943
34329
|
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: 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> {
|
|
33944
34330
|
return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, search, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
33945
34331
|
},
|
|
34332
|
+
/**
|
|
34333
|
+
* Retrieve most popular queries used for getting suggestions, ordered by request count
|
|
34334
|
+
* @summary Get Popular Suggestion Queries
|
|
34335
|
+
* @param {string} xStoreID Store ID
|
|
34336
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
34337
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
34338
|
+
* @param {number} [limit] Number of results to return
|
|
34339
|
+
* @param {*} [options] Override http request option.
|
|
34340
|
+
* @throws {RequiredError}
|
|
34341
|
+
*/
|
|
34342
|
+
adminAnalyticsStoreXStoreIDSuggestionsPopularGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDSuggestionsPopularGet200Response> {
|
|
34343
|
+
return localVarFp.adminAnalyticsStoreXStoreIDSuggestionsPopularGet(xStoreID, startTime, endTime, limit, options).then((request) => request(axios, basePath));
|
|
34344
|
+
},
|
|
34345
|
+
/**
|
|
34346
|
+
* Retrieve analytics for query suggestions including request counts, suggestions returned, processing time, and usage metrics. Supports filtering by query, analytics tags, and time range.
|
|
34347
|
+
* @summary Get Query Suggestions Analytics
|
|
34348
|
+
* @param {string} xStoreID Store ID
|
|
34349
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
34350
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
34351
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
34352
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
34353
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
34354
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
34355
|
+
* @param {number} [page] Page number for pagination
|
|
34356
|
+
* @param {number} [pageSize] Number of results per page
|
|
34357
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortByEnum} [sortBy] Field to sort by
|
|
34358
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortOrderEnum} [sortOrder] Sort direction
|
|
34359
|
+
* @param {*} [options] Override http request option.
|
|
34360
|
+
* @throws {RequiredError}
|
|
34361
|
+
*/
|
|
34362
|
+
adminAnalyticsStoreXStoreIDSuggestionsQueriesGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetTagsMatchModeEnum, tagsExclude?: string, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortOrderEnum, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDSuggestionsPopularGet200Response> {
|
|
34363
|
+
return localVarFp.adminAnalyticsStoreXStoreIDSuggestionsQueriesGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, page, pageSize, sortBy, sortOrder, options).then((request) => request(axios, basePath));
|
|
34364
|
+
},
|
|
34365
|
+
/**
|
|
34366
|
+
* Retrieve comprehensive insights for a specific query suggestion including metrics, performance data, and optional time series
|
|
34367
|
+
* @summary Get Query Suggestions Insights
|
|
34368
|
+
* @param {string} xStoreID Store ID
|
|
34369
|
+
* @param {string} query Query suggestion to analyze
|
|
34370
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
34371
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
34372
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetGranularityEnum} [granularity] Time granularity for time series
|
|
34373
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
34374
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
34375
|
+
* @param {*} [options] Override http request option.
|
|
34376
|
+
* @throws {RequiredError}
|
|
34377
|
+
*/
|
|
34378
|
+
adminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetTagsMatchModeEnum, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet200Response> {
|
|
34379
|
+
return localVarFp.adminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet(xStoreID, query, startTime, endTime, granularity, analyticsTags, tagsMatchMode, options).then((request) => request(axios, basePath));
|
|
34380
|
+
},
|
|
33946
34381
|
/**
|
|
33947
34382
|
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
33948
34383
|
* @summary Get Analytics Tags
|
|
@@ -34058,7 +34493,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
34058
34493
|
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
34059
34494
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
34060
34495
|
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
34061
|
-
* @param {boolean} [compareMode] Enable comparison mode
|
|
34496
|
+
* @param {boolean} [compareMode] Enable comparison mode (default: true, compares with previous week)
|
|
34062
34497
|
* @param {*} [options] Override http request option.
|
|
34063
34498
|
* @throws {RequiredError}
|
|
34064
34499
|
* @memberof AnalyticsApi
|
|
@@ -34528,6 +34963,61 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
34528
34963
|
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, search, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
34529
34964
|
}
|
|
34530
34965
|
|
|
34966
|
+
/**
|
|
34967
|
+
* Retrieve most popular queries used for getting suggestions, ordered by request count
|
|
34968
|
+
* @summary Get Popular Suggestion Queries
|
|
34969
|
+
* @param {string} xStoreID Store ID
|
|
34970
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
34971
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
34972
|
+
* @param {number} [limit] Number of results to return
|
|
34973
|
+
* @param {*} [options] Override http request option.
|
|
34974
|
+
* @throws {RequiredError}
|
|
34975
|
+
* @memberof AnalyticsApi
|
|
34976
|
+
*/
|
|
34977
|
+
public adminAnalyticsStoreXStoreIDSuggestionsPopularGet(xStoreID: string, startTime?: string, endTime?: string, limit?: number, options?: RawAxiosRequestConfig) {
|
|
34978
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDSuggestionsPopularGet(xStoreID, startTime, endTime, limit, options).then((request) => request(this.axios, this.basePath));
|
|
34979
|
+
}
|
|
34980
|
+
|
|
34981
|
+
/**
|
|
34982
|
+
* Retrieve analytics for query suggestions including request counts, suggestions returned, processing time, and usage metrics. Supports filtering by query, analytics tags, and time range.
|
|
34983
|
+
* @summary Get Query Suggestions Analytics
|
|
34984
|
+
* @param {string} xStoreID Store ID
|
|
34985
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
34986
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
34987
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
34988
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
34989
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
34990
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
34991
|
+
* @param {number} [page] Page number for pagination
|
|
34992
|
+
* @param {number} [pageSize] Number of results per page
|
|
34993
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortByEnum} [sortBy] Field to sort by
|
|
34994
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortOrderEnum} [sortOrder] Sort direction
|
|
34995
|
+
* @param {*} [options] Override http request option.
|
|
34996
|
+
* @throws {RequiredError}
|
|
34997
|
+
* @memberof AnalyticsApi
|
|
34998
|
+
*/
|
|
34999
|
+
public adminAnalyticsStoreXStoreIDSuggestionsQueriesGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetTagsMatchModeEnum, tagsExclude?: string, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortOrderEnum, options?: RawAxiosRequestConfig) {
|
|
35000
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDSuggestionsQueriesGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, page, pageSize, sortBy, sortOrder, options).then((request) => request(this.axios, this.basePath));
|
|
35001
|
+
}
|
|
35002
|
+
|
|
35003
|
+
/**
|
|
35004
|
+
* Retrieve comprehensive insights for a specific query suggestion including metrics, performance data, and optional time series
|
|
35005
|
+
* @summary Get Query Suggestions Insights
|
|
35006
|
+
* @param {string} xStoreID Store ID
|
|
35007
|
+
* @param {string} query Query suggestion to analyze
|
|
35008
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
35009
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
35010
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetGranularityEnum} [granularity] Time granularity for time series
|
|
35011
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
35012
|
+
* @param {AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
35013
|
+
* @param {*} [options] Override http request option.
|
|
35014
|
+
* @throws {RequiredError}
|
|
35015
|
+
* @memberof AnalyticsApi
|
|
35016
|
+
*/
|
|
35017
|
+
public adminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetTagsMatchModeEnum, options?: RawAxiosRequestConfig) {
|
|
35018
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGet(xStoreID, query, startTime, endTime, granularity, analyticsTags, tagsMatchMode, options).then((request) => request(this.axios, this.basePath));
|
|
35019
|
+
}
|
|
35020
|
+
|
|
34531
35021
|
/**
|
|
34532
35022
|
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
34533
35023
|
* @summary Get Analytics Tags
|
|
@@ -35000,6 +35490,52 @@ export const AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum = {
|
|
|
35000
35490
|
Desc: 'desc'
|
|
35001
35491
|
} as const;
|
|
35002
35492
|
export type AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum];
|
|
35493
|
+
/**
|
|
35494
|
+
* @export
|
|
35495
|
+
*/
|
|
35496
|
+
export const AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetTagsMatchModeEnum = {
|
|
35497
|
+
Any: 'any',
|
|
35498
|
+
All: 'all'
|
|
35499
|
+
} as const;
|
|
35500
|
+
export type AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetTagsMatchModeEnum];
|
|
35501
|
+
/**
|
|
35502
|
+
* @export
|
|
35503
|
+
*/
|
|
35504
|
+
export const AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortByEnum = {
|
|
35505
|
+
Requests: 'requests',
|
|
35506
|
+
TotalSuggestionsReturned: 'total_suggestions_returned',
|
|
35507
|
+
AvgSuggestionsPerRequest: 'avg_suggestions_per_request',
|
|
35508
|
+
AvgProcessingTimeMs: 'avg_processing_time_ms',
|
|
35509
|
+
UniqueUsers: 'unique_users'
|
|
35510
|
+
} as const;
|
|
35511
|
+
export type AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortByEnum = typeof AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortByEnum[keyof typeof AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortByEnum];
|
|
35512
|
+
/**
|
|
35513
|
+
* @export
|
|
35514
|
+
*/
|
|
35515
|
+
export const AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortOrderEnum = {
|
|
35516
|
+
Asc: 'asc',
|
|
35517
|
+
Desc: 'desc'
|
|
35518
|
+
} as const;
|
|
35519
|
+
export type AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDSuggestionsQueriesGetSortOrderEnum];
|
|
35520
|
+
/**
|
|
35521
|
+
* @export
|
|
35522
|
+
*/
|
|
35523
|
+
export const AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetGranularityEnum = {
|
|
35524
|
+
Minute: 'minute',
|
|
35525
|
+
_5minute: '5minute',
|
|
35526
|
+
_15minute: '15minute',
|
|
35527
|
+
Hour: 'hour',
|
|
35528
|
+
Day: 'day'
|
|
35529
|
+
} as const;
|
|
35530
|
+
export type AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetGranularityEnum = typeof AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetGranularityEnum[keyof typeof AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetGranularityEnum];
|
|
35531
|
+
/**
|
|
35532
|
+
* @export
|
|
35533
|
+
*/
|
|
35534
|
+
export const AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetTagsMatchModeEnum = {
|
|
35535
|
+
Any: 'any',
|
|
35536
|
+
All: 'all'
|
|
35537
|
+
} as const;
|
|
35538
|
+
export type AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDSuggestionsQueryInsightsGetTagsMatchModeEnum];
|
|
35003
35539
|
/**
|
|
35004
35540
|
* @export
|
|
35005
35541
|
*/
|
|
@@ -44894,324 +45430,6 @@ export class DocumentsApi extends BaseAPI {
|
|
|
44894
45430
|
|
|
44895
45431
|
|
|
44896
45432
|
|
|
44897
|
-
/**
|
|
44898
|
-
* DropdownRecommendationsApi - axios parameter creator
|
|
44899
|
-
* @export
|
|
44900
|
-
*/
|
|
44901
|
-
export const DropdownRecommendationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
44902
|
-
return {
|
|
44903
|
-
/**
|
|
44904
|
-
* Retrieve configuration settings for dropdown recommendations
|
|
44905
|
-
* @summary Get Dropdown Recommendations Configuration
|
|
44906
|
-
* @param {string} xStoreid Store ID
|
|
44907
|
-
* @param {string} xStoresecret Store Secret
|
|
44908
|
-
* @param {*} [options] Override http request option.
|
|
44909
|
-
* @throws {RequiredError}
|
|
44910
|
-
*/
|
|
44911
|
-
v1DropdownRecommendationsConfigGet: async (xStoreid: string, xStoresecret: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44912
|
-
// verify required parameter 'xStoreid' is not null or undefined
|
|
44913
|
-
assertParamExists('v1DropdownRecommendationsConfigGet', 'xStoreid', xStoreid)
|
|
44914
|
-
// verify required parameter 'xStoresecret' is not null or undefined
|
|
44915
|
-
assertParamExists('v1DropdownRecommendationsConfigGet', 'xStoresecret', xStoresecret)
|
|
44916
|
-
const localVarPath = `/v1/dropdown-recommendations/config`;
|
|
44917
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
44918
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
44919
|
-
let baseOptions;
|
|
44920
|
-
if (configuration) {
|
|
44921
|
-
baseOptions = configuration.baseOptions;
|
|
44922
|
-
}
|
|
44923
|
-
|
|
44924
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
44925
|
-
const localVarHeaderParameter = {} as any;
|
|
44926
|
-
const localVarQueryParameter = {} as any;
|
|
44927
|
-
|
|
44928
|
-
|
|
44929
|
-
|
|
44930
|
-
if (xStoreid != null) {
|
|
44931
|
-
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
44932
|
-
}
|
|
44933
|
-
if (xStoresecret != null) {
|
|
44934
|
-
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
44935
|
-
}
|
|
44936
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
44937
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
44938
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
44939
|
-
|
|
44940
|
-
return {
|
|
44941
|
-
url: toPathString(localVarUrlObj),
|
|
44942
|
-
options: localVarRequestOptions,
|
|
44943
|
-
};
|
|
44944
|
-
},
|
|
44945
|
-
/**
|
|
44946
|
-
* Update configuration settings for dropdown recommendations
|
|
44947
|
-
* @summary Update Dropdown Recommendations Configuration
|
|
44948
|
-
* @param {string} xStoreid Store ID
|
|
44949
|
-
* @param {string} xStoresecret Store Secret
|
|
44950
|
-
* @param {DropdownRecommendationsServiceUpdateDropdownConfigRequest} dropdownRecommendationsServiceUpdateDropdownConfigRequest Configuration to update
|
|
44951
|
-
* @param {*} [options] Override http request option.
|
|
44952
|
-
* @throws {RequiredError}
|
|
44953
|
-
*/
|
|
44954
|
-
v1DropdownRecommendationsConfigPut: async (xStoreid: string, xStoresecret: string, dropdownRecommendationsServiceUpdateDropdownConfigRequest: DropdownRecommendationsServiceUpdateDropdownConfigRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44955
|
-
// verify required parameter 'xStoreid' is not null or undefined
|
|
44956
|
-
assertParamExists('v1DropdownRecommendationsConfigPut', 'xStoreid', xStoreid)
|
|
44957
|
-
// verify required parameter 'xStoresecret' is not null or undefined
|
|
44958
|
-
assertParamExists('v1DropdownRecommendationsConfigPut', 'xStoresecret', xStoresecret)
|
|
44959
|
-
// verify required parameter 'dropdownRecommendationsServiceUpdateDropdownConfigRequest' is not null or undefined
|
|
44960
|
-
assertParamExists('v1DropdownRecommendationsConfigPut', 'dropdownRecommendationsServiceUpdateDropdownConfigRequest', dropdownRecommendationsServiceUpdateDropdownConfigRequest)
|
|
44961
|
-
const localVarPath = `/v1/dropdown-recommendations/config`;
|
|
44962
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
44963
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
44964
|
-
let baseOptions;
|
|
44965
|
-
if (configuration) {
|
|
44966
|
-
baseOptions = configuration.baseOptions;
|
|
44967
|
-
}
|
|
44968
|
-
|
|
44969
|
-
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
44970
|
-
const localVarHeaderParameter = {} as any;
|
|
44971
|
-
const localVarQueryParameter = {} as any;
|
|
44972
|
-
|
|
44973
|
-
|
|
44974
|
-
|
|
44975
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
44976
|
-
|
|
44977
|
-
if (xStoreid != null) {
|
|
44978
|
-
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
44979
|
-
}
|
|
44980
|
-
if (xStoresecret != null) {
|
|
44981
|
-
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
44982
|
-
}
|
|
44983
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
44984
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
44985
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
44986
|
-
localVarRequestOptions.data = serializeDataIfNeeded(dropdownRecommendationsServiceUpdateDropdownConfigRequest, localVarRequestOptions, configuration)
|
|
44987
|
-
|
|
44988
|
-
return {
|
|
44989
|
-
url: toPathString(localVarUrlObj),
|
|
44990
|
-
options: localVarRequestOptions,
|
|
44991
|
-
};
|
|
44992
|
-
},
|
|
44993
|
-
/**
|
|
44994
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
44995
|
-
* @summary Get Dropdown Recommendations
|
|
44996
|
-
* @param {string} xStoreid Store ID
|
|
44997
|
-
* @param {string} xStoresecret Store Secret
|
|
44998
|
-
* @param {string} [xUserId] User ID for personalization
|
|
44999
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
45000
|
-
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
45001
|
-
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
45002
|
-
* @param {*} [options] Override http request option.
|
|
45003
|
-
* @throws {RequiredError}
|
|
45004
|
-
*/
|
|
45005
|
-
v1DropdownRecommendationsGet: async (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, q?: string, query?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
45006
|
-
// verify required parameter 'xStoreid' is not null or undefined
|
|
45007
|
-
assertParamExists('v1DropdownRecommendationsGet', 'xStoreid', xStoreid)
|
|
45008
|
-
// verify required parameter 'xStoresecret' is not null or undefined
|
|
45009
|
-
assertParamExists('v1DropdownRecommendationsGet', 'xStoresecret', xStoresecret)
|
|
45010
|
-
const localVarPath = `/v1/dropdown-recommendations`;
|
|
45011
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
45012
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
45013
|
-
let baseOptions;
|
|
45014
|
-
if (configuration) {
|
|
45015
|
-
baseOptions = configuration.baseOptions;
|
|
45016
|
-
}
|
|
45017
|
-
|
|
45018
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
45019
|
-
const localVarHeaderParameter = {} as any;
|
|
45020
|
-
const localVarQueryParameter = {} as any;
|
|
45021
|
-
|
|
45022
|
-
if (q !== undefined) {
|
|
45023
|
-
localVarQueryParameter['q'] = q;
|
|
45024
|
-
}
|
|
45025
|
-
|
|
45026
|
-
if (query !== undefined) {
|
|
45027
|
-
localVarQueryParameter['query'] = query;
|
|
45028
|
-
}
|
|
45029
|
-
|
|
45030
|
-
|
|
45031
|
-
|
|
45032
|
-
if (xStoreid != null) {
|
|
45033
|
-
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
45034
|
-
}
|
|
45035
|
-
if (xStoresecret != null) {
|
|
45036
|
-
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
45037
|
-
}
|
|
45038
|
-
if (xUserId != null) {
|
|
45039
|
-
localVarHeaderParameter['x-user-id'] = String(xUserId);
|
|
45040
|
-
}
|
|
45041
|
-
if (xAnonId != null) {
|
|
45042
|
-
localVarHeaderParameter['x-anon-id'] = String(xAnonId);
|
|
45043
|
-
}
|
|
45044
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
45045
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
45046
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
45047
|
-
|
|
45048
|
-
return {
|
|
45049
|
-
url: toPathString(localVarUrlObj),
|
|
45050
|
-
options: localVarRequestOptions,
|
|
45051
|
-
};
|
|
45052
|
-
},
|
|
45053
|
-
}
|
|
45054
|
-
};
|
|
45055
|
-
|
|
45056
|
-
/**
|
|
45057
|
-
* DropdownRecommendationsApi - functional programming interface
|
|
45058
|
-
* @export
|
|
45059
|
-
*/
|
|
45060
|
-
export const DropdownRecommendationsApiFp = function(configuration?: Configuration) {
|
|
45061
|
-
const localVarAxiosParamCreator = DropdownRecommendationsApiAxiosParamCreator(configuration)
|
|
45062
|
-
return {
|
|
45063
|
-
/**
|
|
45064
|
-
* Retrieve configuration settings for dropdown recommendations
|
|
45065
|
-
* @summary Get Dropdown Recommendations Configuration
|
|
45066
|
-
* @param {string} xStoreid Store ID
|
|
45067
|
-
* @param {string} xStoresecret Store Secret
|
|
45068
|
-
* @param {*} [options] Override http request option.
|
|
45069
|
-
* @throws {RequiredError}
|
|
45070
|
-
*/
|
|
45071
|
-
async v1DropdownRecommendationsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DropdownRecommendationsServiceDropdownConfigResponse>> {
|
|
45072
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.v1DropdownRecommendationsConfigGet(xStoreid, xStoresecret, options);
|
|
45073
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
45074
|
-
const localVarOperationServerBasePath = operationServerMap['DropdownRecommendationsApi.v1DropdownRecommendationsConfigGet']?.[localVarOperationServerIndex]?.url;
|
|
45075
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
45076
|
-
},
|
|
45077
|
-
/**
|
|
45078
|
-
* Update configuration settings for dropdown recommendations
|
|
45079
|
-
* @summary Update Dropdown Recommendations Configuration
|
|
45080
|
-
* @param {string} xStoreid Store ID
|
|
45081
|
-
* @param {string} xStoresecret Store Secret
|
|
45082
|
-
* @param {DropdownRecommendationsServiceUpdateDropdownConfigRequest} dropdownRecommendationsServiceUpdateDropdownConfigRequest Configuration to update
|
|
45083
|
-
* @param {*} [options] Override http request option.
|
|
45084
|
-
* @throws {RequiredError}
|
|
45085
|
-
*/
|
|
45086
|
-
async v1DropdownRecommendationsConfigPut(xStoreid: string, xStoresecret: string, dropdownRecommendationsServiceUpdateDropdownConfigRequest: DropdownRecommendationsServiceUpdateDropdownConfigRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DropdownRecommendationsServiceDropdownConfigResponse>> {
|
|
45087
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.v1DropdownRecommendationsConfigPut(xStoreid, xStoresecret, dropdownRecommendationsServiceUpdateDropdownConfigRequest, options);
|
|
45088
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
45089
|
-
const localVarOperationServerBasePath = operationServerMap['DropdownRecommendationsApi.v1DropdownRecommendationsConfigPut']?.[localVarOperationServerIndex]?.url;
|
|
45090
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
45091
|
-
},
|
|
45092
|
-
/**
|
|
45093
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
45094
|
-
* @summary Get Dropdown Recommendations
|
|
45095
|
-
* @param {string} xStoreid Store ID
|
|
45096
|
-
* @param {string} xStoresecret Store Secret
|
|
45097
|
-
* @param {string} [xUserId] User ID for personalization
|
|
45098
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
45099
|
-
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
45100
|
-
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
45101
|
-
* @param {*} [options] Override http request option.
|
|
45102
|
-
* @throws {RequiredError}
|
|
45103
|
-
*/
|
|
45104
|
-
async v1DropdownRecommendationsGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, q?: string, query?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DropdownRecommendationsServiceDropdownRecommendationsAPIResponse>> {
|
|
45105
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.v1DropdownRecommendationsGet(xStoreid, xStoresecret, xUserId, xAnonId, q, query, options);
|
|
45106
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
45107
|
-
const localVarOperationServerBasePath = operationServerMap['DropdownRecommendationsApi.v1DropdownRecommendationsGet']?.[localVarOperationServerIndex]?.url;
|
|
45108
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
45109
|
-
},
|
|
45110
|
-
}
|
|
45111
|
-
};
|
|
45112
|
-
|
|
45113
|
-
/**
|
|
45114
|
-
* DropdownRecommendationsApi - factory interface
|
|
45115
|
-
* @export
|
|
45116
|
-
*/
|
|
45117
|
-
export const DropdownRecommendationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
45118
|
-
const localVarFp = DropdownRecommendationsApiFp(configuration)
|
|
45119
|
-
return {
|
|
45120
|
-
/**
|
|
45121
|
-
* Retrieve configuration settings for dropdown recommendations
|
|
45122
|
-
* @summary Get Dropdown Recommendations Configuration
|
|
45123
|
-
* @param {string} xStoreid Store ID
|
|
45124
|
-
* @param {string} xStoresecret Store Secret
|
|
45125
|
-
* @param {*} [options] Override http request option.
|
|
45126
|
-
* @throws {RequiredError}
|
|
45127
|
-
*/
|
|
45128
|
-
v1DropdownRecommendationsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DropdownRecommendationsServiceDropdownConfigResponse> {
|
|
45129
|
-
return localVarFp.v1DropdownRecommendationsConfigGet(xStoreid, xStoresecret, options).then((request) => request(axios, basePath));
|
|
45130
|
-
},
|
|
45131
|
-
/**
|
|
45132
|
-
* Update configuration settings for dropdown recommendations
|
|
45133
|
-
* @summary Update Dropdown Recommendations Configuration
|
|
45134
|
-
* @param {string} xStoreid Store ID
|
|
45135
|
-
* @param {string} xStoresecret Store Secret
|
|
45136
|
-
* @param {DropdownRecommendationsServiceUpdateDropdownConfigRequest} dropdownRecommendationsServiceUpdateDropdownConfigRequest Configuration to update
|
|
45137
|
-
* @param {*} [options] Override http request option.
|
|
45138
|
-
* @throws {RequiredError}
|
|
45139
|
-
*/
|
|
45140
|
-
v1DropdownRecommendationsConfigPut(xStoreid: string, xStoresecret: string, dropdownRecommendationsServiceUpdateDropdownConfigRequest: DropdownRecommendationsServiceUpdateDropdownConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<DropdownRecommendationsServiceDropdownConfigResponse> {
|
|
45141
|
-
return localVarFp.v1DropdownRecommendationsConfigPut(xStoreid, xStoresecret, dropdownRecommendationsServiceUpdateDropdownConfigRequest, options).then((request) => request(axios, basePath));
|
|
45142
|
-
},
|
|
45143
|
-
/**
|
|
45144
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
45145
|
-
* @summary Get Dropdown Recommendations
|
|
45146
|
-
* @param {string} xStoreid Store ID
|
|
45147
|
-
* @param {string} xStoresecret Store Secret
|
|
45148
|
-
* @param {string} [xUserId] User ID for personalization
|
|
45149
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
45150
|
-
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
45151
|
-
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
45152
|
-
* @param {*} [options] Override http request option.
|
|
45153
|
-
* @throws {RequiredError}
|
|
45154
|
-
*/
|
|
45155
|
-
v1DropdownRecommendationsGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, q?: string, query?: string, options?: RawAxiosRequestConfig): AxiosPromise<DropdownRecommendationsServiceDropdownRecommendationsAPIResponse> {
|
|
45156
|
-
return localVarFp.v1DropdownRecommendationsGet(xStoreid, xStoresecret, xUserId, xAnonId, q, query, options).then((request) => request(axios, basePath));
|
|
45157
|
-
},
|
|
45158
|
-
};
|
|
45159
|
-
};
|
|
45160
|
-
|
|
45161
|
-
/**
|
|
45162
|
-
* DropdownRecommendationsApi - object-oriented interface
|
|
45163
|
-
* @export
|
|
45164
|
-
* @class DropdownRecommendationsApi
|
|
45165
|
-
* @extends {BaseAPI}
|
|
45166
|
-
*/
|
|
45167
|
-
export class DropdownRecommendationsApi extends BaseAPI {
|
|
45168
|
-
/**
|
|
45169
|
-
* Retrieve configuration settings for dropdown recommendations
|
|
45170
|
-
* @summary Get Dropdown Recommendations Configuration
|
|
45171
|
-
* @param {string} xStoreid Store ID
|
|
45172
|
-
* @param {string} xStoresecret Store Secret
|
|
45173
|
-
* @param {*} [options] Override http request option.
|
|
45174
|
-
* @throws {RequiredError}
|
|
45175
|
-
* @memberof DropdownRecommendationsApi
|
|
45176
|
-
*/
|
|
45177
|
-
public v1DropdownRecommendationsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) {
|
|
45178
|
-
return DropdownRecommendationsApiFp(this.configuration).v1DropdownRecommendationsConfigGet(xStoreid, xStoresecret, options).then((request) => request(this.axios, this.basePath));
|
|
45179
|
-
}
|
|
45180
|
-
|
|
45181
|
-
/**
|
|
45182
|
-
* Update configuration settings for dropdown recommendations
|
|
45183
|
-
* @summary Update Dropdown Recommendations Configuration
|
|
45184
|
-
* @param {string} xStoreid Store ID
|
|
45185
|
-
* @param {string} xStoresecret Store Secret
|
|
45186
|
-
* @param {DropdownRecommendationsServiceUpdateDropdownConfigRequest} dropdownRecommendationsServiceUpdateDropdownConfigRequest Configuration to update
|
|
45187
|
-
* @param {*} [options] Override http request option.
|
|
45188
|
-
* @throws {RequiredError}
|
|
45189
|
-
* @memberof DropdownRecommendationsApi
|
|
45190
|
-
*/
|
|
45191
|
-
public v1DropdownRecommendationsConfigPut(xStoreid: string, xStoresecret: string, dropdownRecommendationsServiceUpdateDropdownConfigRequest: DropdownRecommendationsServiceUpdateDropdownConfigRequest, options?: RawAxiosRequestConfig) {
|
|
45192
|
-
return DropdownRecommendationsApiFp(this.configuration).v1DropdownRecommendationsConfigPut(xStoreid, xStoresecret, dropdownRecommendationsServiceUpdateDropdownConfigRequest, options).then((request) => request(this.axios, this.basePath));
|
|
45193
|
-
}
|
|
45194
|
-
|
|
45195
|
-
/**
|
|
45196
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
45197
|
-
* @summary Get Dropdown Recommendations
|
|
45198
|
-
* @param {string} xStoreid Store ID
|
|
45199
|
-
* @param {string} xStoresecret Store Secret
|
|
45200
|
-
* @param {string} [xUserId] User ID for personalization
|
|
45201
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
45202
|
-
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
45203
|
-
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
45204
|
-
* @param {*} [options] Override http request option.
|
|
45205
|
-
* @throws {RequiredError}
|
|
45206
|
-
* @memberof DropdownRecommendationsApi
|
|
45207
|
-
*/
|
|
45208
|
-
public v1DropdownRecommendationsGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, q?: string, query?: string, options?: RawAxiosRequestConfig) {
|
|
45209
|
-
return DropdownRecommendationsApiFp(this.configuration).v1DropdownRecommendationsGet(xStoreid, xStoresecret, xUserId, xAnonId, q, query, options).then((request) => request(this.axios, this.basePath));
|
|
45210
|
-
}
|
|
45211
|
-
}
|
|
45212
|
-
|
|
45213
|
-
|
|
45214
|
-
|
|
45215
45433
|
/**
|
|
45216
45434
|
* ExternalAPINotificationsApi - axios parameter creator
|
|
45217
45435
|
* @export
|
|
@@ -57535,6 +57753,43 @@ export const QuerySuggestionsManagementApiAxiosParamCreator = function (configur
|
|
|
57535
57753
|
|
|
57536
57754
|
|
|
57537
57755
|
|
|
57756
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
57757
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
57758
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
57759
|
+
|
|
57760
|
+
return {
|
|
57761
|
+
url: toPathString(localVarUrlObj),
|
|
57762
|
+
options: localVarRequestOptions,
|
|
57763
|
+
};
|
|
57764
|
+
},
|
|
57765
|
+
/**
|
|
57766
|
+
* Performs complete sync: refreshes auto-generated cache from analytics, promotes to management table, then syncs to Typesense. This is the recommended endpoint for periodic sync jobs.
|
|
57767
|
+
* @summary Complete Sync: Refresh + Promote + Sync to Typesense
|
|
57768
|
+
* @param {string} xStoreID Store ID
|
|
57769
|
+
* @param {*} [options] Override http request option.
|
|
57770
|
+
* @throws {RequiredError}
|
|
57771
|
+
*/
|
|
57772
|
+
adminV1QuerySuggestionsXStoreIDCompleteSyncPost: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57773
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
57774
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDCompleteSyncPost', 'xStoreID', xStoreID)
|
|
57775
|
+
const localVarPath = `/admin/v1/query-suggestions/{xStoreID}/complete-sync`
|
|
57776
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
57777
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
57778
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
57779
|
+
let baseOptions;
|
|
57780
|
+
if (configuration) {
|
|
57781
|
+
baseOptions = configuration.baseOptions;
|
|
57782
|
+
}
|
|
57783
|
+
|
|
57784
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
57785
|
+
const localVarHeaderParameter = {} as any;
|
|
57786
|
+
const localVarQueryParameter = {} as any;
|
|
57787
|
+
|
|
57788
|
+
// authentication BearerAuth required
|
|
57789
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
57790
|
+
|
|
57791
|
+
|
|
57792
|
+
|
|
57538
57793
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
57539
57794
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
57540
57795
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -58622,6 +58877,19 @@ export const QuerySuggestionsManagementApiFp = function(configuration?: Configur
|
|
|
58622
58877
|
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDCachedGet']?.[localVarOperationServerIndex]?.url;
|
|
58623
58878
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
58624
58879
|
},
|
|
58880
|
+
/**
|
|
58881
|
+
* Performs complete sync: refreshes auto-generated cache from analytics, promotes to management table, then syncs to Typesense. This is the recommended endpoint for periodic sync jobs.
|
|
58882
|
+
* @summary Complete Sync: Refresh + Promote + Sync to Typesense
|
|
58883
|
+
* @param {string} xStoreID Store ID
|
|
58884
|
+
* @param {*} [options] Override http request option.
|
|
58885
|
+
* @throws {RequiredError}
|
|
58886
|
+
*/
|
|
58887
|
+
async adminV1QuerySuggestionsXStoreIDCompleteSyncPost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>> {
|
|
58888
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDCompleteSyncPost(xStoreID, options);
|
|
58889
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
58890
|
+
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDCompleteSyncPost']?.[localVarOperationServerIndex]?.url;
|
|
58891
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
58892
|
+
},
|
|
58625
58893
|
/**
|
|
58626
58894
|
* Retrieve the current configuration for query suggestions for a store
|
|
58627
58895
|
* @summary Get Query Suggestions Configuration
|
|
@@ -59035,6 +59303,16 @@ export const QuerySuggestionsManagementApiFactory = function (configuration?: Co
|
|
|
59035
59303
|
adminV1QuerySuggestionsXStoreIDCachedGet(xStoreID: string, page?: number, pageSize?: number, minPopularity?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDCachedGet200Response> {
|
|
59036
59304
|
return localVarFp.adminV1QuerySuggestionsXStoreIDCachedGet(xStoreID, page, pageSize, minPopularity, options).then((request) => request(axios, basePath));
|
|
59037
59305
|
},
|
|
59306
|
+
/**
|
|
59307
|
+
* Performs complete sync: refreshes auto-generated cache from analytics, promotes to management table, then syncs to Typesense. This is the recommended endpoint for periodic sync jobs.
|
|
59308
|
+
* @summary Complete Sync: Refresh + Promote + Sync to Typesense
|
|
59309
|
+
* @param {string} xStoreID Store ID
|
|
59310
|
+
* @param {*} [options] Override http request option.
|
|
59311
|
+
* @throws {RequiredError}
|
|
59312
|
+
*/
|
|
59313
|
+
adminV1QuerySuggestionsXStoreIDCompleteSyncPost(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse> {
|
|
59314
|
+
return localVarFp.adminV1QuerySuggestionsXStoreIDCompleteSyncPost(xStoreID, options).then((request) => request(axios, basePath));
|
|
59315
|
+
},
|
|
59038
59316
|
/**
|
|
59039
59317
|
* Retrieve the current configuration for query suggestions for a store
|
|
59040
59318
|
* @summary Get Query Suggestions Configuration
|
|
@@ -59398,6 +59676,18 @@ export class QuerySuggestionsManagementApi extends BaseAPI {
|
|
|
59398
59676
|
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDCachedGet(xStoreID, page, pageSize, minPopularity, options).then((request) => request(this.axios, this.basePath));
|
|
59399
59677
|
}
|
|
59400
59678
|
|
|
59679
|
+
/**
|
|
59680
|
+
* Performs complete sync: refreshes auto-generated cache from analytics, promotes to management table, then syncs to Typesense. This is the recommended endpoint for periodic sync jobs.
|
|
59681
|
+
* @summary Complete Sync: Refresh + Promote + Sync to Typesense
|
|
59682
|
+
* @param {string} xStoreID Store ID
|
|
59683
|
+
* @param {*} [options] Override http request option.
|
|
59684
|
+
* @throws {RequiredError}
|
|
59685
|
+
* @memberof QuerySuggestionsManagementApi
|
|
59686
|
+
*/
|
|
59687
|
+
public adminV1QuerySuggestionsXStoreIDCompleteSyncPost(xStoreID: string, options?: RawAxiosRequestConfig) {
|
|
59688
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDCompleteSyncPost(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
59689
|
+
}
|
|
59690
|
+
|
|
59401
59691
|
/**
|
|
59402
59692
|
* Retrieve the current configuration for query suggestions for a store
|
|
59403
59693
|
* @summary Get Query Suggestions Configuration
|
|
@@ -65981,6 +66271,43 @@ export const StoresApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
65981
66271
|
|
|
65982
66272
|
|
|
65983
66273
|
|
|
66274
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66275
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
66276
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
66277
|
+
|
|
66278
|
+
return {
|
|
66279
|
+
url: toPathString(localVarUrlObj),
|
|
66280
|
+
options: localVarRequestOptions,
|
|
66281
|
+
};
|
|
66282
|
+
},
|
|
66283
|
+
/**
|
|
66284
|
+
* Ensures that Typesense analytics collections and rules exist for the store\'s collection. This is useful for retroactive fixes or ensuring analytics exist for existing stores.
|
|
66285
|
+
* @summary Ensure Analytics Collections and Rules for Store
|
|
66286
|
+
* @param {string} xStoreID Store ID
|
|
66287
|
+
* @param {*} [options] Override http request option.
|
|
66288
|
+
* @throws {RequiredError}
|
|
66289
|
+
*/
|
|
66290
|
+
adminStoresXStoreIDAnalyticsEnsurePost: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
66291
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
66292
|
+
assertParamExists('adminStoresXStoreIDAnalyticsEnsurePost', 'xStoreID', xStoreID)
|
|
66293
|
+
const localVarPath = `/admin/Stores/{xStoreID}/analytics/ensure`
|
|
66294
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
66295
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66296
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
66297
|
+
let baseOptions;
|
|
66298
|
+
if (configuration) {
|
|
66299
|
+
baseOptions = configuration.baseOptions;
|
|
66300
|
+
}
|
|
66301
|
+
|
|
66302
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
66303
|
+
const localVarHeaderParameter = {} as any;
|
|
66304
|
+
const localVarQueryParameter = {} as any;
|
|
66305
|
+
|
|
66306
|
+
// authentication BearerAuth required
|
|
66307
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
66308
|
+
|
|
66309
|
+
|
|
66310
|
+
|
|
65984
66311
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
65985
66312
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
65986
66313
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -66086,138 +66413,291 @@ export const StoresApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
66086
66413
|
};
|
|
66087
66414
|
},
|
|
66088
66415
|
/**
|
|
66089
|
-
* Retrieve API usage logs for a specific store from ClickHouse with filtering and pagination
|
|
66090
|
-
* @summary Get API Usage Logs for Store
|
|
66416
|
+
* Retrieve API usage logs for a specific store from ClickHouse with filtering and pagination
|
|
66417
|
+
* @summary Get API Usage Logs for Store
|
|
66418
|
+
* @param {string} xStoreID Store ID
|
|
66419
|
+
* @param {string} [startDate] Start date (ISO 8601 format)
|
|
66420
|
+
* @param {string} [endDate] End date (ISO 8601 format)
|
|
66421
|
+
* @param {string} [method] HTTP method filter
|
|
66422
|
+
* @param {string} [path] Path filter (partial match)
|
|
66423
|
+
* @param {string} [statusCode] Status code filter: \'2xx\', \'4xx\', \'5xx\', or specific code like \'200\', \'404\'
|
|
66424
|
+
* @param {string} [endpointType] Endpoint type filter: \'search\', \'stores\', \'analytics\', \'connectors\', \'credits\'
|
|
66425
|
+
* @param {string} [responseTime] Response time filter: \'fast\' (<100ms), \'medium\' (100-500ms), \'slow\' (>500ms)
|
|
66426
|
+
* @param {number} [page] Page number (default: 1)
|
|
66427
|
+
* @param {number} [perPage] Results per page (default: 50, max: 1000)
|
|
66428
|
+
* @param {*} [options] Override http request option.
|
|
66429
|
+
* @throws {RequiredError}
|
|
66430
|
+
*/
|
|
66431
|
+
adminStoresXStoreIDApiUsageGet: async (xStoreID: string, startDate?: string, endDate?: string, method?: string, path?: string, statusCode?: string, endpointType?: string, responseTime?: string, page?: number, perPage?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
66432
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
66433
|
+
assertParamExists('adminStoresXStoreIDApiUsageGet', 'xStoreID', xStoreID)
|
|
66434
|
+
const localVarPath = `/admin/Stores/{xStoreID}/api-usage`
|
|
66435
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
66436
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66437
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
66438
|
+
let baseOptions;
|
|
66439
|
+
if (configuration) {
|
|
66440
|
+
baseOptions = configuration.baseOptions;
|
|
66441
|
+
}
|
|
66442
|
+
|
|
66443
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
66444
|
+
const localVarHeaderParameter = {} as any;
|
|
66445
|
+
const localVarQueryParameter = {} as any;
|
|
66446
|
+
|
|
66447
|
+
// authentication BearerAuth required
|
|
66448
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
66449
|
+
|
|
66450
|
+
if (startDate !== undefined) {
|
|
66451
|
+
localVarQueryParameter['start_date'] = startDate;
|
|
66452
|
+
}
|
|
66453
|
+
|
|
66454
|
+
if (endDate !== undefined) {
|
|
66455
|
+
localVarQueryParameter['end_date'] = endDate;
|
|
66456
|
+
}
|
|
66457
|
+
|
|
66458
|
+
if (method !== undefined) {
|
|
66459
|
+
localVarQueryParameter['method'] = method;
|
|
66460
|
+
}
|
|
66461
|
+
|
|
66462
|
+
if (path !== undefined) {
|
|
66463
|
+
localVarQueryParameter['path'] = path;
|
|
66464
|
+
}
|
|
66465
|
+
|
|
66466
|
+
if (statusCode !== undefined) {
|
|
66467
|
+
localVarQueryParameter['status_code'] = statusCode;
|
|
66468
|
+
}
|
|
66469
|
+
|
|
66470
|
+
if (endpointType !== undefined) {
|
|
66471
|
+
localVarQueryParameter['endpoint_type'] = endpointType;
|
|
66472
|
+
}
|
|
66473
|
+
|
|
66474
|
+
if (responseTime !== undefined) {
|
|
66475
|
+
localVarQueryParameter['response_time'] = responseTime;
|
|
66476
|
+
}
|
|
66477
|
+
|
|
66478
|
+
if (page !== undefined) {
|
|
66479
|
+
localVarQueryParameter['page'] = page;
|
|
66480
|
+
}
|
|
66481
|
+
|
|
66482
|
+
if (perPage !== undefined) {
|
|
66483
|
+
localVarQueryParameter['per_page'] = perPage;
|
|
66484
|
+
}
|
|
66485
|
+
|
|
66486
|
+
|
|
66487
|
+
|
|
66488
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66489
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
66490
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
66491
|
+
|
|
66492
|
+
return {
|
|
66493
|
+
url: toPathString(localVarUrlObj),
|
|
66494
|
+
options: localVarRequestOptions,
|
|
66495
|
+
};
|
|
66496
|
+
},
|
|
66497
|
+
/**
|
|
66498
|
+
* Retrieves the store configuration using x-store ID, including onboarding status validation
|
|
66499
|
+
* @summary Get Store Config
|
|
66500
|
+
* @param {string} xStoreID X-Store ID
|
|
66501
|
+
* @param {*} [options] Override http request option.
|
|
66502
|
+
* @throws {RequiredError}
|
|
66503
|
+
*/
|
|
66504
|
+
adminStoresXStoreIDConfigGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
66505
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
66506
|
+
assertParamExists('adminStoresXStoreIDConfigGet', 'xStoreID', xStoreID)
|
|
66507
|
+
const localVarPath = `/admin/Stores/{xStoreID}/config`
|
|
66508
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
66509
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66510
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
66511
|
+
let baseOptions;
|
|
66512
|
+
if (configuration) {
|
|
66513
|
+
baseOptions = configuration.baseOptions;
|
|
66514
|
+
}
|
|
66515
|
+
|
|
66516
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
66517
|
+
const localVarHeaderParameter = {} as any;
|
|
66518
|
+
const localVarQueryParameter = {} as any;
|
|
66519
|
+
|
|
66520
|
+
// authentication BearerAuth required
|
|
66521
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
66522
|
+
|
|
66523
|
+
|
|
66524
|
+
|
|
66525
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66526
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
66527
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
66528
|
+
|
|
66529
|
+
return {
|
|
66530
|
+
url: toPathString(localVarUrlObj),
|
|
66531
|
+
options: localVarRequestOptions,
|
|
66532
|
+
};
|
|
66533
|
+
},
|
|
66534
|
+
/**
|
|
66535
|
+
*
|
|
66536
|
+
* @summary Update Store Config (Partial)
|
|
66537
|
+
* @param {string} xStoreID X-Store ID
|
|
66538
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Store configuration (partial updates supported)
|
|
66539
|
+
* @param {*} [options] Override http request option.
|
|
66540
|
+
* @throws {RequiredError}
|
|
66541
|
+
*/
|
|
66542
|
+
adminStoresXStoreIDConfigPut: async (xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
66543
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
66544
|
+
assertParamExists('adminStoresXStoreIDConfigPut', 'xStoreID', xStoreID)
|
|
66545
|
+
// verify required parameter 'dataTypesIndexConfig' is not null or undefined
|
|
66546
|
+
assertParamExists('adminStoresXStoreIDConfigPut', 'dataTypesIndexConfig', dataTypesIndexConfig)
|
|
66547
|
+
const localVarPath = `/admin/Stores/{xStoreID}/config`
|
|
66548
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
66549
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66550
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
66551
|
+
let baseOptions;
|
|
66552
|
+
if (configuration) {
|
|
66553
|
+
baseOptions = configuration.baseOptions;
|
|
66554
|
+
}
|
|
66555
|
+
|
|
66556
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
66557
|
+
const localVarHeaderParameter = {} as any;
|
|
66558
|
+
const localVarQueryParameter = {} as any;
|
|
66559
|
+
|
|
66560
|
+
// authentication BearerAuth required
|
|
66561
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
66562
|
+
|
|
66563
|
+
|
|
66564
|
+
|
|
66565
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
66566
|
+
|
|
66567
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66568
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
66569
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
66570
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesIndexConfig, localVarRequestOptions, configuration)
|
|
66571
|
+
|
|
66572
|
+
return {
|
|
66573
|
+
url: toPathString(localVarUrlObj),
|
|
66574
|
+
options: localVarRequestOptions,
|
|
66575
|
+
};
|
|
66576
|
+
},
|
|
66577
|
+
/**
|
|
66578
|
+
* Get metadata about all configurable fields for store configuration using x-store ID
|
|
66579
|
+
* @summary Get Store Config Schema
|
|
66580
|
+
* @param {string} xStoreID X-Store ID to get field options from
|
|
66581
|
+
* @param {*} [options] Override http request option.
|
|
66582
|
+
* @throws {RequiredError}
|
|
66583
|
+
*/
|
|
66584
|
+
adminStoresXStoreIDConfigSchemaGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
66585
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
66586
|
+
assertParamExists('adminStoresXStoreIDConfigSchemaGet', 'xStoreID', xStoreID)
|
|
66587
|
+
const localVarPath = `/admin/Stores/{xStoreID}/config-schema`
|
|
66588
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
66589
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66590
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
66591
|
+
let baseOptions;
|
|
66592
|
+
if (configuration) {
|
|
66593
|
+
baseOptions = configuration.baseOptions;
|
|
66594
|
+
}
|
|
66595
|
+
|
|
66596
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
66597
|
+
const localVarHeaderParameter = {} as any;
|
|
66598
|
+
const localVarQueryParameter = {} as any;
|
|
66599
|
+
|
|
66600
|
+
// authentication BearerAuth required
|
|
66601
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
66602
|
+
|
|
66603
|
+
|
|
66604
|
+
|
|
66605
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66606
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
66607
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
66608
|
+
|
|
66609
|
+
return {
|
|
66610
|
+
url: toPathString(localVarUrlObj),
|
|
66611
|
+
options: localVarRequestOptions,
|
|
66612
|
+
};
|
|
66613
|
+
},
|
|
66614
|
+
/**
|
|
66615
|
+
* Retrieves all store credentials (XStoreID, XStoreSecret, XStoreWriteSecret) for a given x-store ID
|
|
66616
|
+
* @summary Get store credentials
|
|
66617
|
+
* @param {string} xStoreID X-Store ID
|
|
66618
|
+
* @param {*} [options] Override http request option.
|
|
66619
|
+
* @throws {RequiredError}
|
|
66620
|
+
*/
|
|
66621
|
+
adminStoresXStoreIDCredentialsGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
66622
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
66623
|
+
assertParamExists('adminStoresXStoreIDCredentialsGet', 'xStoreID', xStoreID)
|
|
66624
|
+
const localVarPath = `/admin/Stores/{xStoreID}/credentials`
|
|
66625
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
66626
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66627
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
66628
|
+
let baseOptions;
|
|
66629
|
+
if (configuration) {
|
|
66630
|
+
baseOptions = configuration.baseOptions;
|
|
66631
|
+
}
|
|
66632
|
+
|
|
66633
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
66634
|
+
const localVarHeaderParameter = {} as any;
|
|
66635
|
+
const localVarQueryParameter = {} as any;
|
|
66636
|
+
|
|
66637
|
+
// authentication BearerAuth required
|
|
66638
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
66639
|
+
|
|
66640
|
+
|
|
66641
|
+
|
|
66642
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66643
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
66644
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
66645
|
+
|
|
66646
|
+
return {
|
|
66647
|
+
url: toPathString(localVarUrlObj),
|
|
66648
|
+
options: localVarRequestOptions,
|
|
66649
|
+
};
|
|
66650
|
+
},
|
|
66651
|
+
/**
|
|
66652
|
+
* Get default configuration values computed from the store\'s index schema using x-store ID
|
|
66653
|
+
* @summary Get Store Schema-Based Defaults
|
|
66654
|
+
* @param {string} xStoreID X-Store ID
|
|
66655
|
+
* @param {*} [options] Override http request option.
|
|
66656
|
+
* @throws {RequiredError}
|
|
66657
|
+
*/
|
|
66658
|
+
adminStoresXStoreIDDefaultsGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
66659
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
66660
|
+
assertParamExists('adminStoresXStoreIDDefaultsGet', 'xStoreID', xStoreID)
|
|
66661
|
+
const localVarPath = `/admin/Stores/{xStoreID}/defaults`
|
|
66662
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
66663
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66664
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
66665
|
+
let baseOptions;
|
|
66666
|
+
if (configuration) {
|
|
66667
|
+
baseOptions = configuration.baseOptions;
|
|
66668
|
+
}
|
|
66669
|
+
|
|
66670
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
66671
|
+
const localVarHeaderParameter = {} as any;
|
|
66672
|
+
const localVarQueryParameter = {} as any;
|
|
66673
|
+
|
|
66674
|
+
// authentication BearerAuth required
|
|
66675
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
66676
|
+
|
|
66677
|
+
|
|
66678
|
+
|
|
66679
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66680
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
66681
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
66682
|
+
|
|
66683
|
+
return {
|
|
66684
|
+
url: toPathString(localVarUrlObj),
|
|
66685
|
+
options: localVarRequestOptions,
|
|
66686
|
+
};
|
|
66687
|
+
},
|
|
66688
|
+
/**
|
|
66689
|
+
* Syncs popular items from ClickHouse to Typesense for real-time boosting in search results
|
|
66690
|
+
* @summary Sync Popular Items to Typesense
|
|
66091
66691
|
* @param {string} xStoreID Store ID
|
|
66092
|
-
* @param {
|
|
66093
|
-
* @param {
|
|
66094
|
-
* @param {string} [method] HTTP method filter
|
|
66095
|
-
* @param {string} [path] Path filter (partial match)
|
|
66096
|
-
* @param {string} [statusCode] Status code filter: \'2xx\', \'4xx\', \'5xx\', or specific code like \'200\', \'404\'
|
|
66097
|
-
* @param {string} [endpointType] Endpoint type filter: \'search\', \'stores\', \'analytics\', \'connectors\', \'credits\'
|
|
66098
|
-
* @param {string} [responseTime] Response time filter: \'fast\' (<100ms), \'medium\' (100-500ms), \'slow\' (>500ms)
|
|
66099
|
-
* @param {number} [page] Page number (default: 1)
|
|
66100
|
-
* @param {number} [perPage] Results per page (default: 50, max: 1000)
|
|
66101
|
-
* @param {*} [options] Override http request option.
|
|
66102
|
-
* @throws {RequiredError}
|
|
66103
|
-
*/
|
|
66104
|
-
adminStoresXStoreIDApiUsageGet: async (xStoreID: string, startDate?: string, endDate?: string, method?: string, path?: string, statusCode?: string, endpointType?: string, responseTime?: string, page?: number, perPage?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
66105
|
-
// verify required parameter 'xStoreID' is not null or undefined
|
|
66106
|
-
assertParamExists('adminStoresXStoreIDApiUsageGet', 'xStoreID', xStoreID)
|
|
66107
|
-
const localVarPath = `/admin/Stores/{xStoreID}/api-usage`
|
|
66108
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
66109
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66110
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
66111
|
-
let baseOptions;
|
|
66112
|
-
if (configuration) {
|
|
66113
|
-
baseOptions = configuration.baseOptions;
|
|
66114
|
-
}
|
|
66115
|
-
|
|
66116
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
66117
|
-
const localVarHeaderParameter = {} as any;
|
|
66118
|
-
const localVarQueryParameter = {} as any;
|
|
66119
|
-
|
|
66120
|
-
// authentication BearerAuth required
|
|
66121
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
66122
|
-
|
|
66123
|
-
if (startDate !== undefined) {
|
|
66124
|
-
localVarQueryParameter['start_date'] = startDate;
|
|
66125
|
-
}
|
|
66126
|
-
|
|
66127
|
-
if (endDate !== undefined) {
|
|
66128
|
-
localVarQueryParameter['end_date'] = endDate;
|
|
66129
|
-
}
|
|
66130
|
-
|
|
66131
|
-
if (method !== undefined) {
|
|
66132
|
-
localVarQueryParameter['method'] = method;
|
|
66133
|
-
}
|
|
66134
|
-
|
|
66135
|
-
if (path !== undefined) {
|
|
66136
|
-
localVarQueryParameter['path'] = path;
|
|
66137
|
-
}
|
|
66138
|
-
|
|
66139
|
-
if (statusCode !== undefined) {
|
|
66140
|
-
localVarQueryParameter['status_code'] = statusCode;
|
|
66141
|
-
}
|
|
66142
|
-
|
|
66143
|
-
if (endpointType !== undefined) {
|
|
66144
|
-
localVarQueryParameter['endpoint_type'] = endpointType;
|
|
66145
|
-
}
|
|
66146
|
-
|
|
66147
|
-
if (responseTime !== undefined) {
|
|
66148
|
-
localVarQueryParameter['response_time'] = responseTime;
|
|
66149
|
-
}
|
|
66150
|
-
|
|
66151
|
-
if (page !== undefined) {
|
|
66152
|
-
localVarQueryParameter['page'] = page;
|
|
66153
|
-
}
|
|
66154
|
-
|
|
66155
|
-
if (perPage !== undefined) {
|
|
66156
|
-
localVarQueryParameter['per_page'] = perPage;
|
|
66157
|
-
}
|
|
66158
|
-
|
|
66159
|
-
|
|
66160
|
-
|
|
66161
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66162
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
66163
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
66164
|
-
|
|
66165
|
-
return {
|
|
66166
|
-
url: toPathString(localVarUrlObj),
|
|
66167
|
-
options: localVarRequestOptions,
|
|
66168
|
-
};
|
|
66169
|
-
},
|
|
66170
|
-
/**
|
|
66171
|
-
* Retrieves the store configuration using x-store ID, including onboarding status validation
|
|
66172
|
-
* @summary Get Store Config
|
|
66173
|
-
* @param {string} xStoreID X-Store ID
|
|
66174
|
-
* @param {*} [options] Override http request option.
|
|
66175
|
-
* @throws {RequiredError}
|
|
66176
|
-
*/
|
|
66177
|
-
adminStoresXStoreIDConfigGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
66178
|
-
// verify required parameter 'xStoreID' is not null or undefined
|
|
66179
|
-
assertParamExists('adminStoresXStoreIDConfigGet', 'xStoreID', xStoreID)
|
|
66180
|
-
const localVarPath = `/admin/Stores/{xStoreID}/config`
|
|
66181
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
66182
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66183
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
66184
|
-
let baseOptions;
|
|
66185
|
-
if (configuration) {
|
|
66186
|
-
baseOptions = configuration.baseOptions;
|
|
66187
|
-
}
|
|
66188
|
-
|
|
66189
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
66190
|
-
const localVarHeaderParameter = {} as any;
|
|
66191
|
-
const localVarQueryParameter = {} as any;
|
|
66192
|
-
|
|
66193
|
-
// authentication BearerAuth required
|
|
66194
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
66195
|
-
|
|
66196
|
-
|
|
66197
|
-
|
|
66198
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66199
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
66200
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
66201
|
-
|
|
66202
|
-
return {
|
|
66203
|
-
url: toPathString(localVarUrlObj),
|
|
66204
|
-
options: localVarRequestOptions,
|
|
66205
|
-
};
|
|
66206
|
-
},
|
|
66207
|
-
/**
|
|
66208
|
-
*
|
|
66209
|
-
* @summary Update Store Config (Partial)
|
|
66210
|
-
* @param {string} xStoreID X-Store ID
|
|
66211
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig Store configuration (partial updates supported)
|
|
66692
|
+
* @param {number} [limit] Number of items to sync (default: 100)
|
|
66693
|
+
* @param {number} [daysBack] Number of days to look back (default: 30)
|
|
66212
66694
|
* @param {*} [options] Override http request option.
|
|
66213
66695
|
* @throws {RequiredError}
|
|
66214
66696
|
*/
|
|
66215
|
-
|
|
66697
|
+
adminStoresXStoreIDPopularItemsSyncPost: async (xStoreID: string, limit?: number, daysBack?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
66216
66698
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
66217
|
-
assertParamExists('
|
|
66218
|
-
|
|
66219
|
-
assertParamExists('adminStoresXStoreIDConfigPut', 'dataTypesIndexConfig', dataTypesIndexConfig)
|
|
66220
|
-
const localVarPath = `/admin/Stores/{xStoreID}/config`
|
|
66699
|
+
assertParamExists('adminStoresXStoreIDPopularItemsSyncPost', 'xStoreID', xStoreID)
|
|
66700
|
+
const localVarPath = `/admin/Stores/{xStoreID}/popular-items/sync`
|
|
66221
66701
|
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
66222
66702
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66223
66703
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -66226,127 +66706,21 @@ export const StoresApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
66226
66706
|
baseOptions = configuration.baseOptions;
|
|
66227
66707
|
}
|
|
66228
66708
|
|
|
66229
|
-
const localVarRequestOptions = { method: '
|
|
66230
|
-
const localVarHeaderParameter = {} as any;
|
|
66231
|
-
const localVarQueryParameter = {} as any;
|
|
66232
|
-
|
|
66233
|
-
// authentication BearerAuth required
|
|
66234
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
66235
|
-
|
|
66236
|
-
|
|
66237
|
-
|
|
66238
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
66239
|
-
|
|
66240
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66241
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
66242
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
66243
|
-
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesIndexConfig, localVarRequestOptions, configuration)
|
|
66244
|
-
|
|
66245
|
-
return {
|
|
66246
|
-
url: toPathString(localVarUrlObj),
|
|
66247
|
-
options: localVarRequestOptions,
|
|
66248
|
-
};
|
|
66249
|
-
},
|
|
66250
|
-
/**
|
|
66251
|
-
* Get metadata about all configurable fields for store configuration using x-store ID
|
|
66252
|
-
* @summary Get Store Config Schema
|
|
66253
|
-
* @param {string} xStoreID X-Store ID to get field options from
|
|
66254
|
-
* @param {*} [options] Override http request option.
|
|
66255
|
-
* @throws {RequiredError}
|
|
66256
|
-
*/
|
|
66257
|
-
adminStoresXStoreIDConfigSchemaGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
66258
|
-
// verify required parameter 'xStoreID' is not null or undefined
|
|
66259
|
-
assertParamExists('adminStoresXStoreIDConfigSchemaGet', 'xStoreID', xStoreID)
|
|
66260
|
-
const localVarPath = `/admin/Stores/{xStoreID}/config-schema`
|
|
66261
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
66262
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66263
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
66264
|
-
let baseOptions;
|
|
66265
|
-
if (configuration) {
|
|
66266
|
-
baseOptions = configuration.baseOptions;
|
|
66267
|
-
}
|
|
66268
|
-
|
|
66269
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
66709
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
66270
66710
|
const localVarHeaderParameter = {} as any;
|
|
66271
66711
|
const localVarQueryParameter = {} as any;
|
|
66272
66712
|
|
|
66273
66713
|
// authentication BearerAuth required
|
|
66274
66714
|
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
66275
66715
|
|
|
66276
|
-
|
|
66277
|
-
|
|
66278
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66279
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
66280
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
66281
|
-
|
|
66282
|
-
return {
|
|
66283
|
-
url: toPathString(localVarUrlObj),
|
|
66284
|
-
options: localVarRequestOptions,
|
|
66285
|
-
};
|
|
66286
|
-
},
|
|
66287
|
-
/**
|
|
66288
|
-
* Retrieves all store credentials (XStoreID, XStoreSecret, XStoreWriteSecret) for a given x-store ID
|
|
66289
|
-
* @summary Get store credentials
|
|
66290
|
-
* @param {string} xStoreID X-Store ID
|
|
66291
|
-
* @param {*} [options] Override http request option.
|
|
66292
|
-
* @throws {RequiredError}
|
|
66293
|
-
*/
|
|
66294
|
-
adminStoresXStoreIDCredentialsGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
66295
|
-
// verify required parameter 'xStoreID' is not null or undefined
|
|
66296
|
-
assertParamExists('adminStoresXStoreIDCredentialsGet', 'xStoreID', xStoreID)
|
|
66297
|
-
const localVarPath = `/admin/Stores/{xStoreID}/credentials`
|
|
66298
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
66299
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66300
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
66301
|
-
let baseOptions;
|
|
66302
|
-
if (configuration) {
|
|
66303
|
-
baseOptions = configuration.baseOptions;
|
|
66716
|
+
if (limit !== undefined) {
|
|
66717
|
+
localVarQueryParameter['limit'] = limit;
|
|
66304
66718
|
}
|
|
66305
66719
|
|
|
66306
|
-
|
|
66307
|
-
|
|
66308
|
-
const localVarQueryParameter = {} as any;
|
|
66309
|
-
|
|
66310
|
-
// authentication BearerAuth required
|
|
66311
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
66312
|
-
|
|
66313
|
-
|
|
66314
|
-
|
|
66315
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66316
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
66317
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
66318
|
-
|
|
66319
|
-
return {
|
|
66320
|
-
url: toPathString(localVarUrlObj),
|
|
66321
|
-
options: localVarRequestOptions,
|
|
66322
|
-
};
|
|
66323
|
-
},
|
|
66324
|
-
/**
|
|
66325
|
-
* Get default configuration values computed from the store\'s index schema using x-store ID
|
|
66326
|
-
* @summary Get Store Schema-Based Defaults
|
|
66327
|
-
* @param {string} xStoreID X-Store ID
|
|
66328
|
-
* @param {*} [options] Override http request option.
|
|
66329
|
-
* @throws {RequiredError}
|
|
66330
|
-
*/
|
|
66331
|
-
adminStoresXStoreIDDefaultsGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
66332
|
-
// verify required parameter 'xStoreID' is not null or undefined
|
|
66333
|
-
assertParamExists('adminStoresXStoreIDDefaultsGet', 'xStoreID', xStoreID)
|
|
66334
|
-
const localVarPath = `/admin/Stores/{xStoreID}/defaults`
|
|
66335
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
66336
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66337
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
66338
|
-
let baseOptions;
|
|
66339
|
-
if (configuration) {
|
|
66340
|
-
baseOptions = configuration.baseOptions;
|
|
66720
|
+
if (daysBack !== undefined) {
|
|
66721
|
+
localVarQueryParameter['days_back'] = daysBack;
|
|
66341
66722
|
}
|
|
66342
66723
|
|
|
66343
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
66344
|
-
const localVarHeaderParameter = {} as any;
|
|
66345
|
-
const localVarQueryParameter = {} as any;
|
|
66346
|
-
|
|
66347
|
-
// authentication BearerAuth required
|
|
66348
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
66349
|
-
|
|
66350
66724
|
|
|
66351
66725
|
|
|
66352
66726
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -66622,6 +66996,19 @@ export const StoresApiFp = function(configuration?: Configuration) {
|
|
|
66622
66996
|
const localVarOperationServerBasePath = operationServerMap['StoresApi.adminStoresXStoreIDAnalyticsDailyStatsGet']?.[localVarOperationServerIndex]?.url;
|
|
66623
66997
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
66624
66998
|
},
|
|
66999
|
+
/**
|
|
67000
|
+
* Ensures that Typesense analytics collections and rules exist for the store\'s collection. This is useful for retroactive fixes or ensuring analytics exist for existing stores.
|
|
67001
|
+
* @summary Ensure Analytics Collections and Rules for Store
|
|
67002
|
+
* @param {string} xStoreID Store ID
|
|
67003
|
+
* @param {*} [options] Override http request option.
|
|
67004
|
+
* @throws {RequiredError}
|
|
67005
|
+
*/
|
|
67006
|
+
async adminStoresXStoreIDAnalyticsEnsurePost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>> {
|
|
67007
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminStoresXStoreIDAnalyticsEnsurePost(xStoreID, options);
|
|
67008
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
67009
|
+
const localVarOperationServerBasePath = operationServerMap['StoresApi.adminStoresXStoreIDAnalyticsEnsurePost']?.[localVarOperationServerIndex]?.url;
|
|
67010
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
67011
|
+
},
|
|
66625
67012
|
/**
|
|
66626
67013
|
* Retrieves time series data for a specific metric (records, search_response_time, operations, or search_requests) with date filtering for graphing.
|
|
66627
67014
|
* @summary Get Time Series Data for Store Metrics
|
|
@@ -66740,6 +67127,21 @@ export const StoresApiFp = function(configuration?: Configuration) {
|
|
|
66740
67127
|
const localVarOperationServerBasePath = operationServerMap['StoresApi.adminStoresXStoreIDDefaultsGet']?.[localVarOperationServerIndex]?.url;
|
|
66741
67128
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
66742
67129
|
},
|
|
67130
|
+
/**
|
|
67131
|
+
* Syncs popular items from ClickHouse to Typesense for real-time boosting in search results
|
|
67132
|
+
* @summary Sync Popular Items to Typesense
|
|
67133
|
+
* @param {string} xStoreID Store ID
|
|
67134
|
+
* @param {number} [limit] Number of items to sync (default: 100)
|
|
67135
|
+
* @param {number} [daysBack] Number of days to look back (default: 30)
|
|
67136
|
+
* @param {*} [options] Override http request option.
|
|
67137
|
+
* @throws {RequiredError}
|
|
67138
|
+
*/
|
|
67139
|
+
async adminStoresXStoreIDPopularItemsSyncPost(xStoreID: string, limit?: number, daysBack?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>> {
|
|
67140
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminStoresXStoreIDPopularItemsSyncPost(xStoreID, limit, daysBack, options);
|
|
67141
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
67142
|
+
const localVarOperationServerBasePath = operationServerMap['StoresApi.adminStoresXStoreIDPopularItemsSyncPost']?.[localVarOperationServerIndex]?.url;
|
|
67143
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
67144
|
+
},
|
|
66743
67145
|
/**
|
|
66744
67146
|
* Get schema options for a specific store by xStoreID
|
|
66745
67147
|
* @summary Get store schema options
|
|
@@ -66870,6 +67272,16 @@ export const StoresApiFactory = function (configuration?: Configuration, basePat
|
|
|
66870
67272
|
adminStoresXStoreIDAnalyticsDailyStatsGet(xStoreID: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): AxiosPromise<StoreRouteDailyStatsResponse> {
|
|
66871
67273
|
return localVarFp.adminStoresXStoreIDAnalyticsDailyStatsGet(xStoreID, startDate, endDate, options).then((request) => request(axios, basePath));
|
|
66872
67274
|
},
|
|
67275
|
+
/**
|
|
67276
|
+
* Ensures that Typesense analytics collections and rules exist for the store\'s collection. This is useful for retroactive fixes or ensuring analytics exist for existing stores.
|
|
67277
|
+
* @summary Ensure Analytics Collections and Rules for Store
|
|
67278
|
+
* @param {string} xStoreID Store ID
|
|
67279
|
+
* @param {*} [options] Override http request option.
|
|
67280
|
+
* @throws {RequiredError}
|
|
67281
|
+
*/
|
|
67282
|
+
adminStoresXStoreIDAnalyticsEnsurePost(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse> {
|
|
67283
|
+
return localVarFp.adminStoresXStoreIDAnalyticsEnsurePost(xStoreID, options).then((request) => request(axios, basePath));
|
|
67284
|
+
},
|
|
66873
67285
|
/**
|
|
66874
67286
|
* Retrieves time series data for a specific metric (records, search_response_time, operations, or search_requests) with date filtering for graphing.
|
|
66875
67287
|
* @summary Get Time Series Data for Store Metrics
|
|
@@ -66964,6 +67376,18 @@ export const StoresApiFactory = function (configuration?: Configuration, basePat
|
|
|
66964
67376
|
adminStoresXStoreIDDefaultsGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper> {
|
|
66965
67377
|
return localVarFp.adminStoresXStoreIDDefaultsGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
66966
67378
|
},
|
|
67379
|
+
/**
|
|
67380
|
+
* Syncs popular items from ClickHouse to Typesense for real-time boosting in search results
|
|
67381
|
+
* @summary Sync Popular Items to Typesense
|
|
67382
|
+
* @param {string} xStoreID Store ID
|
|
67383
|
+
* @param {number} [limit] Number of items to sync (default: 100)
|
|
67384
|
+
* @param {number} [daysBack] Number of days to look back (default: 30)
|
|
67385
|
+
* @param {*} [options] Override http request option.
|
|
67386
|
+
* @throws {RequiredError}
|
|
67387
|
+
*/
|
|
67388
|
+
adminStoresXStoreIDPopularItemsSyncPost(xStoreID: string, limit?: number, daysBack?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse> {
|
|
67389
|
+
return localVarFp.adminStoresXStoreIDPopularItemsSyncPost(xStoreID, limit, daysBack, options).then((request) => request(axios, basePath));
|
|
67390
|
+
},
|
|
66967
67391
|
/**
|
|
66968
67392
|
* Get schema options for a specific store by xStoreID
|
|
66969
67393
|
* @summary Get store schema options
|
|
@@ -67094,6 +67518,18 @@ export class StoresApi extends BaseAPI {
|
|
|
67094
67518
|
return StoresApiFp(this.configuration).adminStoresXStoreIDAnalyticsDailyStatsGet(xStoreID, startDate, endDate, options).then((request) => request(this.axios, this.basePath));
|
|
67095
67519
|
}
|
|
67096
67520
|
|
|
67521
|
+
/**
|
|
67522
|
+
* Ensures that Typesense analytics collections and rules exist for the store\'s collection. This is useful for retroactive fixes or ensuring analytics exist for existing stores.
|
|
67523
|
+
* @summary Ensure Analytics Collections and Rules for Store
|
|
67524
|
+
* @param {string} xStoreID Store ID
|
|
67525
|
+
* @param {*} [options] Override http request option.
|
|
67526
|
+
* @throws {RequiredError}
|
|
67527
|
+
* @memberof StoresApi
|
|
67528
|
+
*/
|
|
67529
|
+
public adminStoresXStoreIDAnalyticsEnsurePost(xStoreID: string, options?: RawAxiosRequestConfig) {
|
|
67530
|
+
return StoresApiFp(this.configuration).adminStoresXStoreIDAnalyticsEnsurePost(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
67531
|
+
}
|
|
67532
|
+
|
|
67097
67533
|
/**
|
|
67098
67534
|
* Retrieves time series data for a specific metric (records, search_response_time, operations, or search_requests) with date filtering for graphing.
|
|
67099
67535
|
* @summary Get Time Series Data for Store Metrics
|
|
@@ -67204,6 +67640,20 @@ export class StoresApi extends BaseAPI {
|
|
|
67204
67640
|
return StoresApiFp(this.configuration).adminStoresXStoreIDDefaultsGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
67205
67641
|
}
|
|
67206
67642
|
|
|
67643
|
+
/**
|
|
67644
|
+
* Syncs popular items from ClickHouse to Typesense for real-time boosting in search results
|
|
67645
|
+
* @summary Sync Popular Items to Typesense
|
|
67646
|
+
* @param {string} xStoreID Store ID
|
|
67647
|
+
* @param {number} [limit] Number of items to sync (default: 100)
|
|
67648
|
+
* @param {number} [daysBack] Number of days to look back (default: 30)
|
|
67649
|
+
* @param {*} [options] Override http request option.
|
|
67650
|
+
* @throws {RequiredError}
|
|
67651
|
+
* @memberof StoresApi
|
|
67652
|
+
*/
|
|
67653
|
+
public adminStoresXStoreIDPopularItemsSyncPost(xStoreID: string, limit?: number, daysBack?: number, options?: RawAxiosRequestConfig) {
|
|
67654
|
+
return StoresApiFp(this.configuration).adminStoresXStoreIDPopularItemsSyncPost(xStoreID, limit, daysBack, options).then((request) => request(this.axios, this.basePath));
|
|
67655
|
+
}
|
|
67656
|
+
|
|
67207
67657
|
/**
|
|
67208
67658
|
* Get schema options for a specific store by xStoreID
|
|
67209
67659
|
* @summary Get store schema options
|