@seekora-ai/admin-api 1.0.47 → 1.0.49
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 +6 -3
- package/api.ts +303 -38
- package/dist/api.d.ts +467 -254
- package/dist/api.js +112 -14
- package/dist/esm/api.d.ts +467 -254
- package/dist/esm/api.js +109 -11
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.49.tgz +0 -0
- package/seekora-ai-admin-api-1.0.47.tgz +0 -0
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @seekora-ai/admin-api@1.0.
|
|
1
|
+
## @seekora-ai/admin-api@1.0.49
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @seekora-ai/admin-api@1.0.
|
|
39
|
+
npm install @seekora-ai/admin-api@1.0.49 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -325,6 +325,7 @@ Class | Method | HTTP request | Description
|
|
|
325
325
|
- [AnalyticsItemTrendData](docs/AnalyticsItemTrendData.md)
|
|
326
326
|
- [AnalyticsKPIMetrics](docs/AnalyticsKPIMetrics.md)
|
|
327
327
|
- [AnalyticsKPIPointExtended](docs/AnalyticsKPIPointExtended.md)
|
|
328
|
+
- [AnalyticsPaginationMeta](docs/AnalyticsPaginationMeta.md)
|
|
328
329
|
- [AnalyticsQueryAnalytic](docs/AnalyticsQueryAnalytic.md)
|
|
329
330
|
- [AnalyticsQueryFilterAnalytics](docs/AnalyticsQueryFilterAnalytics.md)
|
|
330
331
|
- [AnalyticsQueryFilterCombination](docs/AnalyticsQueryFilterCombination.md)
|
|
@@ -334,7 +335,9 @@ Class | Method | HTTP request | Description
|
|
|
334
335
|
- [AnalyticsQueryInsights](docs/AnalyticsQueryInsights.md)
|
|
335
336
|
- [AnalyticsQueryPerformanceAnalytics](docs/AnalyticsQueryPerformanceAnalytics.md)
|
|
336
337
|
- [AnalyticsQueryPopularFilter](docs/AnalyticsQueryPopularFilter.md)
|
|
337
|
-
- [
|
|
338
|
+
- [AnalyticsQueryPopularFiltersSection](docs/AnalyticsQueryPopularFiltersSection.md)
|
|
339
|
+
- [AnalyticsQueryPopularResultWithWidget](docs/AnalyticsQueryPopularResultWithWidget.md)
|
|
340
|
+
- [AnalyticsQueryPopularResultsSection](docs/AnalyticsQueryPopularResultsSection.md)
|
|
338
341
|
- [AnalyticsQueryResponse](docs/AnalyticsQueryResponse.md)
|
|
339
342
|
- [AnalyticsTimeSeriesPoint](docs/AnalyticsTimeSeriesPoint.md)
|
|
340
343
|
- [AnalyticsWidgetData](docs/AnalyticsWidgetData.md)
|
package/api.ts
CHANGED
|
@@ -1068,11 +1068,11 @@ export interface AnalyticsExtendedKPIResponse {
|
|
|
1068
1068
|
*/
|
|
1069
1069
|
'compare_summary'?: AnalyticsKPIMetrics;
|
|
1070
1070
|
/**
|
|
1071
|
-
*
|
|
1072
|
-
* @type {
|
|
1071
|
+
* Can be []KPIPointExtended or []ComparisonMetrics
|
|
1072
|
+
* @type {object}
|
|
1073
1073
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1074
1074
|
*/
|
|
1075
|
-
'data'?:
|
|
1075
|
+
'data'?: object;
|
|
1076
1076
|
/**
|
|
1077
1077
|
*
|
|
1078
1078
|
* @type {string}
|
|
@@ -1140,12 +1140,24 @@ export interface AnalyticsFilterAnalyticsResponse {
|
|
|
1140
1140
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1141
1141
|
*/
|
|
1142
1142
|
'filter_key'?: string;
|
|
1143
|
+
/**
|
|
1144
|
+
*
|
|
1145
|
+
* @type {number}
|
|
1146
|
+
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1147
|
+
*/
|
|
1148
|
+
'limit'?: number;
|
|
1143
1149
|
/**
|
|
1144
1150
|
*
|
|
1145
1151
|
* @type {string}
|
|
1146
1152
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1147
1153
|
*/
|
|
1148
1154
|
'org_id'?: string;
|
|
1155
|
+
/**
|
|
1156
|
+
*
|
|
1157
|
+
* @type {number}
|
|
1158
|
+
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1159
|
+
*/
|
|
1160
|
+
'page'?: number;
|
|
1149
1161
|
/**
|
|
1150
1162
|
*
|
|
1151
1163
|
* @type {string}
|
|
@@ -1176,6 +1188,12 @@ export interface AnalyticsFilterAnalyticsResponse {
|
|
|
1176
1188
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1177
1189
|
*/
|
|
1178
1190
|
'store_id'?: string;
|
|
1191
|
+
/**
|
|
1192
|
+
*
|
|
1193
|
+
* @type {number}
|
|
1194
|
+
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1195
|
+
*/
|
|
1196
|
+
'total'?: number;
|
|
1179
1197
|
}
|
|
1180
1198
|
/**
|
|
1181
1199
|
*
|
|
@@ -1411,12 +1429,24 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
1411
1429
|
* @memberof AnalyticsFilterTrendsResponse
|
|
1412
1430
|
*/
|
|
1413
1431
|
'granularity'?: string;
|
|
1432
|
+
/**
|
|
1433
|
+
*
|
|
1434
|
+
* @type {number}
|
|
1435
|
+
* @memberof AnalyticsFilterTrendsResponse
|
|
1436
|
+
*/
|
|
1437
|
+
'limit'?: number;
|
|
1414
1438
|
/**
|
|
1415
1439
|
*
|
|
1416
1440
|
* @type {string}
|
|
1417
1441
|
* @memberof AnalyticsFilterTrendsResponse
|
|
1418
1442
|
*/
|
|
1419
1443
|
'org_id'?: string;
|
|
1444
|
+
/**
|
|
1445
|
+
*
|
|
1446
|
+
* @type {number}
|
|
1447
|
+
* @memberof AnalyticsFilterTrendsResponse
|
|
1448
|
+
*/
|
|
1449
|
+
'page'?: number;
|
|
1420
1450
|
/**
|
|
1421
1451
|
*
|
|
1422
1452
|
* @type {string}
|
|
@@ -1447,6 +1477,12 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
1447
1477
|
* @memberof AnalyticsFilterTrendsResponse
|
|
1448
1478
|
*/
|
|
1449
1479
|
'top_filters'?: number;
|
|
1480
|
+
/**
|
|
1481
|
+
*
|
|
1482
|
+
* @type {number}
|
|
1483
|
+
* @memberof AnalyticsFilterTrendsResponse
|
|
1484
|
+
*/
|
|
1485
|
+
'total'?: number;
|
|
1450
1486
|
/**
|
|
1451
1487
|
*
|
|
1452
1488
|
* @type {{ [key: string]: Array<AnalyticsTimeSeriesPoint>; }}
|
|
@@ -2485,6 +2521,49 @@ export interface AnalyticsKPIPointExtended {
|
|
|
2485
2521
|
*/
|
|
2486
2522
|
'unique_users'?: number;
|
|
2487
2523
|
}
|
|
2524
|
+
/**
|
|
2525
|
+
*
|
|
2526
|
+
* @export
|
|
2527
|
+
* @interface AnalyticsPaginationMeta
|
|
2528
|
+
*/
|
|
2529
|
+
export interface AnalyticsPaginationMeta {
|
|
2530
|
+
/**
|
|
2531
|
+
*
|
|
2532
|
+
* @type {boolean}
|
|
2533
|
+
* @memberof AnalyticsPaginationMeta
|
|
2534
|
+
*/
|
|
2535
|
+
'has_next'?: boolean;
|
|
2536
|
+
/**
|
|
2537
|
+
*
|
|
2538
|
+
* @type {boolean}
|
|
2539
|
+
* @memberof AnalyticsPaginationMeta
|
|
2540
|
+
*/
|
|
2541
|
+
'has_previous'?: boolean;
|
|
2542
|
+
/**
|
|
2543
|
+
*
|
|
2544
|
+
* @type {number}
|
|
2545
|
+
* @memberof AnalyticsPaginationMeta
|
|
2546
|
+
*/
|
|
2547
|
+
'page'?: number;
|
|
2548
|
+
/**
|
|
2549
|
+
*
|
|
2550
|
+
* @type {number}
|
|
2551
|
+
* @memberof AnalyticsPaginationMeta
|
|
2552
|
+
*/
|
|
2553
|
+
'page_size'?: number;
|
|
2554
|
+
/**
|
|
2555
|
+
*
|
|
2556
|
+
* @type {number}
|
|
2557
|
+
* @memberof AnalyticsPaginationMeta
|
|
2558
|
+
*/
|
|
2559
|
+
'total_items'?: number;
|
|
2560
|
+
/**
|
|
2561
|
+
*
|
|
2562
|
+
* @type {number}
|
|
2563
|
+
* @memberof AnalyticsPaginationMeta
|
|
2564
|
+
*/
|
|
2565
|
+
'total_pages'?: number;
|
|
2566
|
+
}
|
|
2488
2567
|
/**
|
|
2489
2568
|
*
|
|
2490
2569
|
* @export
|
|
@@ -2805,16 +2884,16 @@ export interface AnalyticsQueryInsights {
|
|
|
2805
2884
|
'no_results_rate'?: number;
|
|
2806
2885
|
/**
|
|
2807
2886
|
*
|
|
2808
|
-
* @type {
|
|
2887
|
+
* @type {AnalyticsQueryPopularFiltersSection}
|
|
2809
2888
|
* @memberof AnalyticsQueryInsights
|
|
2810
2889
|
*/
|
|
2811
|
-
'popular_filters'?:
|
|
2890
|
+
'popular_filters'?: AnalyticsQueryPopularFiltersSection;
|
|
2812
2891
|
/**
|
|
2813
2892
|
*
|
|
2814
|
-
* @type {
|
|
2893
|
+
* @type {AnalyticsQueryPopularResultsSection}
|
|
2815
2894
|
* @memberof AnalyticsQueryInsights
|
|
2816
2895
|
*/
|
|
2817
|
-
'popular_results'?:
|
|
2896
|
+
'popular_results'?: AnalyticsQueryPopularResultsSection;
|
|
2818
2897
|
/**
|
|
2819
2898
|
*
|
|
2820
2899
|
* @type {string}
|
|
@@ -2965,51 +3044,95 @@ export interface AnalyticsQueryPopularFilter {
|
|
|
2965
3044
|
/**
|
|
2966
3045
|
*
|
|
2967
3046
|
* @export
|
|
2968
|
-
* @interface
|
|
3047
|
+
* @interface AnalyticsQueryPopularFiltersSection
|
|
3048
|
+
*/
|
|
3049
|
+
export interface AnalyticsQueryPopularFiltersSection {
|
|
3050
|
+
/**
|
|
3051
|
+
*
|
|
3052
|
+
* @type {Array<AnalyticsQueryPopularFilter>}
|
|
3053
|
+
* @memberof AnalyticsQueryPopularFiltersSection
|
|
3054
|
+
*/
|
|
3055
|
+
'items'?: Array<AnalyticsQueryPopularFilter>;
|
|
3056
|
+
/**
|
|
3057
|
+
*
|
|
3058
|
+
* @type {AnalyticsPaginationMeta}
|
|
3059
|
+
* @memberof AnalyticsQueryPopularFiltersSection
|
|
3060
|
+
*/
|
|
3061
|
+
'meta'?: AnalyticsPaginationMeta;
|
|
3062
|
+
}
|
|
3063
|
+
/**
|
|
3064
|
+
*
|
|
3065
|
+
* @export
|
|
3066
|
+
* @interface AnalyticsQueryPopularResultWithWidget
|
|
2969
3067
|
*/
|
|
2970
|
-
export interface
|
|
3068
|
+
export interface AnalyticsQueryPopularResultWithWidget {
|
|
2971
3069
|
/**
|
|
2972
3070
|
*
|
|
2973
3071
|
* @type {number}
|
|
2974
|
-
* @memberof
|
|
3072
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
2975
3073
|
*/
|
|
2976
3074
|
'avg_position'?: number;
|
|
2977
3075
|
/**
|
|
2978
3076
|
*
|
|
2979
3077
|
* @type {number}
|
|
2980
|
-
* @memberof
|
|
3078
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
2981
3079
|
*/
|
|
2982
3080
|
'click_through_rate'?: number;
|
|
2983
3081
|
/**
|
|
2984
3082
|
*
|
|
2985
3083
|
* @type {number}
|
|
2986
|
-
* @memberof
|
|
3084
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
2987
3085
|
*/
|
|
2988
3086
|
'clicks'?: number;
|
|
2989
3087
|
/**
|
|
2990
3088
|
*
|
|
2991
3089
|
* @type {number}
|
|
2992
|
-
* @memberof
|
|
3090
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
2993
3091
|
*/
|
|
2994
3092
|
'impressions'?: number;
|
|
2995
3093
|
/**
|
|
2996
3094
|
*
|
|
2997
3095
|
* @type {string}
|
|
2998
|
-
* @memberof
|
|
3096
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
2999
3097
|
*/
|
|
3000
3098
|
'item_id'?: string;
|
|
3001
3099
|
/**
|
|
3002
3100
|
*
|
|
3003
3101
|
* @type {string}
|
|
3004
|
-
* @memberof
|
|
3102
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
3005
3103
|
*/
|
|
3006
3104
|
'item_name'?: string;
|
|
3007
3105
|
/**
|
|
3008
3106
|
* percentage of total impressions for this query
|
|
3009
3107
|
* @type {number}
|
|
3010
|
-
* @memberof
|
|
3108
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
3011
3109
|
*/
|
|
3012
3110
|
'share'?: number;
|
|
3111
|
+
/**
|
|
3112
|
+
* Widget display fields
|
|
3113
|
+
* @type {AnalyticsWidgetData}
|
|
3114
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
3115
|
+
*/
|
|
3116
|
+
'widget'?: AnalyticsWidgetData;
|
|
3117
|
+
}
|
|
3118
|
+
/**
|
|
3119
|
+
*
|
|
3120
|
+
* @export
|
|
3121
|
+
* @interface AnalyticsQueryPopularResultsSection
|
|
3122
|
+
*/
|
|
3123
|
+
export interface AnalyticsQueryPopularResultsSection {
|
|
3124
|
+
/**
|
|
3125
|
+
*
|
|
3126
|
+
* @type {Array<AnalyticsQueryPopularResultWithWidget>}
|
|
3127
|
+
* @memberof AnalyticsQueryPopularResultsSection
|
|
3128
|
+
*/
|
|
3129
|
+
'items'?: Array<AnalyticsQueryPopularResultWithWidget>;
|
|
3130
|
+
/**
|
|
3131
|
+
*
|
|
3132
|
+
* @type {AnalyticsPaginationMeta}
|
|
3133
|
+
* @memberof AnalyticsQueryPopularResultsSection
|
|
3134
|
+
*/
|
|
3135
|
+
'meta'?: AnalyticsPaginationMeta;
|
|
3013
3136
|
}
|
|
3014
3137
|
/**
|
|
3015
3138
|
*
|
|
@@ -5915,11 +6038,17 @@ export interface DataTypesErrorMetaResponse {
|
|
|
5915
6038
|
*/
|
|
5916
6039
|
export interface DataTypesEventPayload {
|
|
5917
6040
|
/**
|
|
5918
|
-
*
|
|
6041
|
+
* Journey Tracking & Analytics
|
|
5919
6042
|
* @type {Array<string>}
|
|
5920
6043
|
* @memberof DataTypesEventPayload
|
|
5921
6044
|
*/
|
|
5922
6045
|
'analytics_tags'?: Array<string>;
|
|
6046
|
+
/**
|
|
6047
|
+
* Anonymous user identifier
|
|
6048
|
+
* @type {string}
|
|
6049
|
+
* @memberof DataTypesEventPayload
|
|
6050
|
+
*/
|
|
6051
|
+
'anon_id'?: string;
|
|
5923
6052
|
/**
|
|
5924
6053
|
*
|
|
5925
6054
|
* @type {string}
|
|
@@ -5927,13 +6056,13 @@ export interface DataTypesEventPayload {
|
|
|
5927
6056
|
*/
|
|
5928
6057
|
'city'?: string;
|
|
5929
6058
|
/**
|
|
5930
|
-
*
|
|
6059
|
+
* Click/Interaction Event Fields
|
|
5931
6060
|
* @type {string}
|
|
5932
6061
|
* @memberof DataTypesEventPayload
|
|
5933
6062
|
*/
|
|
5934
6063
|
'clicked_product_id'?: string;
|
|
5935
6064
|
/**
|
|
5936
|
-
* Geo data fields for direct submission
|
|
6065
|
+
* Enhanced Geo data fields for direct submission
|
|
5937
6066
|
* @type {string}
|
|
5938
6067
|
* @memberof DataTypesEventPayload
|
|
5939
6068
|
*/
|
|
@@ -5944,6 +6073,12 @@ export interface DataTypesEventPayload {
|
|
|
5944
6073
|
* @memberof DataTypesEventPayload
|
|
5945
6074
|
*/
|
|
5946
6075
|
'country_code'?: string;
|
|
6076
|
+
/**
|
|
6077
|
+
* Currency for value
|
|
6078
|
+
* @type {string}
|
|
6079
|
+
* @memberof DataTypesEventPayload
|
|
6080
|
+
*/
|
|
6081
|
+
'currency'?: string;
|
|
5947
6082
|
/**
|
|
5948
6083
|
*
|
|
5949
6084
|
* @type {string}
|
|
@@ -5951,7 +6086,7 @@ export interface DataTypesEventPayload {
|
|
|
5951
6086
|
*/
|
|
5952
6087
|
'device_type'?: string;
|
|
5953
6088
|
/**
|
|
5954
|
-
*
|
|
6089
|
+
* Core Event Information
|
|
5955
6090
|
* @type {string}
|
|
5956
6091
|
* @memberof DataTypesEventPayload
|
|
5957
6092
|
*/
|
|
@@ -5963,25 +6098,25 @@ export interface DataTypesEventPayload {
|
|
|
5963
6098
|
*/
|
|
5964
6099
|
'event_name'?: string;
|
|
5965
6100
|
/**
|
|
5966
|
-
*
|
|
6101
|
+
* Device & Location Context
|
|
5967
6102
|
* @type {string}
|
|
5968
6103
|
* @memberof DataTypesEventPayload
|
|
5969
6104
|
*/
|
|
5970
6105
|
'ip'?: string;
|
|
5971
6106
|
/**
|
|
5972
|
-
*
|
|
6107
|
+
* Performance
|
|
5973
6108
|
* @type {number}
|
|
5974
6109
|
* @memberof DataTypesEventPayload
|
|
5975
6110
|
*/
|
|
5976
6111
|
'latency_ms'?: number;
|
|
5977
6112
|
/**
|
|
5978
|
-
*
|
|
6113
|
+
* Legacy field
|
|
5979
6114
|
* @type {string}
|
|
5980
6115
|
* @memberof DataTypesEventPayload
|
|
5981
6116
|
*/
|
|
5982
6117
|
'location'?: string;
|
|
5983
6118
|
/**
|
|
5984
|
-
*
|
|
6119
|
+
* Flexible metadata including search_id, position, etc.
|
|
5985
6120
|
* @type {{ [key: string]: any; }}
|
|
5986
6121
|
* @memberof DataTypesEventPayload
|
|
5987
6122
|
*/
|
|
@@ -5993,7 +6128,13 @@ export interface DataTypesEventPayload {
|
|
|
5993
6128
|
*/
|
|
5994
6129
|
'org_id'?: string;
|
|
5995
6130
|
/**
|
|
5996
|
-
*
|
|
6131
|
+
* web, ios, android
|
|
6132
|
+
* @type {string}
|
|
6133
|
+
* @memberof DataTypesEventPayload
|
|
6134
|
+
*/
|
|
6135
|
+
'platform'?: string;
|
|
6136
|
+
/**
|
|
6137
|
+
* Search Event Fields
|
|
5997
6138
|
* @type {string}
|
|
5998
6139
|
* @memberof DataTypesEventPayload
|
|
5999
6140
|
*/
|
|
@@ -6011,7 +6152,13 @@ export interface DataTypesEventPayload {
|
|
|
6011
6152
|
*/
|
|
6012
6153
|
'results_count'?: number;
|
|
6013
6154
|
/**
|
|
6014
|
-
*
|
|
6155
|
+
* Session identifier for journey tracking
|
|
6156
|
+
* @type {string}
|
|
6157
|
+
* @memberof DataTypesEventPayload
|
|
6158
|
+
*/
|
|
6159
|
+
'session_id'?: string;
|
|
6160
|
+
/**
|
|
6161
|
+
* Organization Context
|
|
6015
6162
|
* @type {string}
|
|
6016
6163
|
* @memberof DataTypesEventPayload
|
|
6017
6164
|
*/
|
|
@@ -6023,11 +6170,17 @@ export interface DataTypesEventPayload {
|
|
|
6023
6170
|
*/
|
|
6024
6171
|
'timestamp'?: string;
|
|
6025
6172
|
/**
|
|
6026
|
-
*
|
|
6173
|
+
* User Context
|
|
6027
6174
|
* @type {string}
|
|
6028
6175
|
* @memberof DataTypesEventPayload
|
|
6029
6176
|
*/
|
|
6030
6177
|
'user_id'?: string;
|
|
6178
|
+
/**
|
|
6179
|
+
* Business Context
|
|
6180
|
+
* @type {number}
|
|
6181
|
+
* @memberof DataTypesEventPayload
|
|
6182
|
+
*/
|
|
6183
|
+
'value'?: number;
|
|
6031
6184
|
}
|
|
6032
6185
|
/**
|
|
6033
6186
|
*
|
|
@@ -14593,16 +14746,29 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14593
14746
|
};
|
|
14594
14747
|
},
|
|
14595
14748
|
/**
|
|
14596
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
14749
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
14597
14750
|
* @summary Get Query Insights
|
|
14598
14751
|
* @param {string} xStoreID Store ID
|
|
14599
14752
|
* @param {string} query Search query to analyze
|
|
14600
14753
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14601
14754
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14755
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14756
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14757
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14758
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14759
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14760
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14761
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14762
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14763
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
14764
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
14765
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
14766
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
14767
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
14602
14768
|
* @param {*} [options] Override http request option.
|
|
14603
14769
|
* @throws {RequiredError}
|
|
14604
14770
|
*/
|
|
14605
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14771
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14606
14772
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
14607
14773
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID)
|
|
14608
14774
|
// verify required parameter 'query' is not null or undefined
|
|
@@ -14632,6 +14798,58 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14632
14798
|
localVarQueryParameter['end_time'] = endTime;
|
|
14633
14799
|
}
|
|
14634
14800
|
|
|
14801
|
+
if (compareMode !== undefined) {
|
|
14802
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
14803
|
+
}
|
|
14804
|
+
|
|
14805
|
+
if (compareStartTime !== undefined) {
|
|
14806
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
14807
|
+
}
|
|
14808
|
+
|
|
14809
|
+
if (compareEndTime !== undefined) {
|
|
14810
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
14811
|
+
}
|
|
14812
|
+
|
|
14813
|
+
if (compareAnalyticsTags !== undefined) {
|
|
14814
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
14815
|
+
}
|
|
14816
|
+
|
|
14817
|
+
if (compareTagsMatchMode !== undefined) {
|
|
14818
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
14819
|
+
}
|
|
14820
|
+
|
|
14821
|
+
if (compareTagsExclude !== undefined) {
|
|
14822
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
14823
|
+
}
|
|
14824
|
+
|
|
14825
|
+
if (compareTagKeyFilter !== undefined) {
|
|
14826
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
14827
|
+
}
|
|
14828
|
+
|
|
14829
|
+
if (compareTagValueFilter !== undefined) {
|
|
14830
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
14831
|
+
}
|
|
14832
|
+
|
|
14833
|
+
if (resultsPage !== undefined) {
|
|
14834
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
14835
|
+
}
|
|
14836
|
+
|
|
14837
|
+
if (resultsPageSize !== undefined) {
|
|
14838
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
14839
|
+
}
|
|
14840
|
+
|
|
14841
|
+
if (filtersPage !== undefined) {
|
|
14842
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
14843
|
+
}
|
|
14844
|
+
|
|
14845
|
+
if (filtersPageSize !== undefined) {
|
|
14846
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
14847
|
+
}
|
|
14848
|
+
|
|
14849
|
+
if (includeWidget !== undefined) {
|
|
14850
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
14851
|
+
}
|
|
14852
|
+
|
|
14635
14853
|
|
|
14636
14854
|
|
|
14637
14855
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -15327,17 +15545,30 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
15327
15545
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15328
15546
|
},
|
|
15329
15547
|
/**
|
|
15330
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
15548
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
15331
15549
|
* @summary Get Query Insights
|
|
15332
15550
|
* @param {string} xStoreID Store ID
|
|
15333
15551
|
* @param {string} query Search query to analyze
|
|
15334
15552
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15335
15553
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15554
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15555
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15556
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15557
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15558
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15559
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15560
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15561
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
15562
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
15563
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
15564
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
15565
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
15566
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
15336
15567
|
* @param {*} [options] Override http request option.
|
|
15337
15568
|
* @throws {RequiredError}
|
|
15338
15569
|
*/
|
|
15339
|
-
async adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>> {
|
|
15340
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options);
|
|
15570
|
+
async adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>> {
|
|
15571
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
|
|
15341
15572
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
15342
15573
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']?.[localVarOperationServerIndex]?.url;
|
|
15343
15574
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -15729,17 +15960,30 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
15729
15960
|
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
15730
15961
|
},
|
|
15731
15962
|
/**
|
|
15732
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
15963
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
15733
15964
|
* @summary Get Query Insights
|
|
15734
15965
|
* @param {string} xStoreID Store ID
|
|
15735
15966
|
* @param {string} query Search query to analyze
|
|
15736
15967
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15737
15968
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15969
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15970
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15971
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15972
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15973
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15974
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15975
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15976
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
15977
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
15978
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
15979
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
15980
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
15981
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
15738
15982
|
* @param {*} [options] Override http request option.
|
|
15739
15983
|
* @throws {RequiredError}
|
|
15740
15984
|
*/
|
|
15741
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response> {
|
|
15742
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
15985
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response> {
|
|
15986
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(axios, basePath));
|
|
15743
15987
|
},
|
|
15744
15988
|
/**
|
|
15745
15989
|
* 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.
|
|
@@ -16145,18 +16389,31 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
16145
16389
|
}
|
|
16146
16390
|
|
|
16147
16391
|
/**
|
|
16148
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
16392
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
16149
16393
|
* @summary Get Query Insights
|
|
16150
16394
|
* @param {string} xStoreID Store ID
|
|
16151
16395
|
* @param {string} query Search query to analyze
|
|
16152
16396
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
16153
16397
|
* @param {string} [endTime] End time in RFC3339 format
|
|
16398
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
16399
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
16400
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
16401
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
16402
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
16403
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
16404
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
16405
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
16406
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
16407
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
16408
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
16409
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
16410
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
16154
16411
|
* @param {*} [options] Override http request option.
|
|
16155
16412
|
* @throws {RequiredError}
|
|
16156
16413
|
* @memberof AnalyticsApi
|
|
16157
16414
|
*/
|
|
16158
|
-
public adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig) {
|
|
16159
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
|
|
16415
|
+
public adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig) {
|
|
16416
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
16160
16417
|
}
|
|
16161
16418
|
|
|
16162
16419
|
/**
|
|
@@ -16533,6 +16790,14 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
16533
16790
|
Desc: 'desc'
|
|
16534
16791
|
} as const;
|
|
16535
16792
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
16793
|
+
/**
|
|
16794
|
+
* @export
|
|
16795
|
+
*/
|
|
16796
|
+
export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = {
|
|
16797
|
+
Any: 'any',
|
|
16798
|
+
All: 'all'
|
|
16799
|
+
} as const;
|
|
16800
|
+
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum];
|
|
16536
16801
|
/**
|
|
16537
16802
|
* @export
|
|
16538
16803
|
*/
|