@seekora-ai/admin-api 1.0.48 → 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 +2 -2
- package/api.ts +163 -25
- package/dist/api.d.ts +128 -22
- package/dist/api.js +77 -14
- package/dist/esm/api.d.ts +128 -22
- package/dist/esm/api.js +74 -11
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.49.tgz +0 -0
- package/seekora-ai-admin-api-1.0.48.tgz +0 -0
package/dist/api.d.ts
CHANGED
|
@@ -1066,11 +1066,11 @@ export interface AnalyticsExtendedKPIResponse {
|
|
|
1066
1066
|
*/
|
|
1067
1067
|
'compare_summary'?: AnalyticsKPIMetrics;
|
|
1068
1068
|
/**
|
|
1069
|
-
*
|
|
1070
|
-
* @type {
|
|
1069
|
+
* Can be []KPIPointExtended or []ComparisonMetrics
|
|
1070
|
+
* @type {object}
|
|
1071
1071
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1072
1072
|
*/
|
|
1073
|
-
'data'?:
|
|
1073
|
+
'data'?: object;
|
|
1074
1074
|
/**
|
|
1075
1075
|
*
|
|
1076
1076
|
* @type {string}
|
|
@@ -1138,12 +1138,24 @@ export interface AnalyticsFilterAnalyticsResponse {
|
|
|
1138
1138
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1139
1139
|
*/
|
|
1140
1140
|
'filter_key'?: string;
|
|
1141
|
+
/**
|
|
1142
|
+
*
|
|
1143
|
+
* @type {number}
|
|
1144
|
+
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1145
|
+
*/
|
|
1146
|
+
'limit'?: number;
|
|
1141
1147
|
/**
|
|
1142
1148
|
*
|
|
1143
1149
|
* @type {string}
|
|
1144
1150
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1145
1151
|
*/
|
|
1146
1152
|
'org_id'?: string;
|
|
1153
|
+
/**
|
|
1154
|
+
*
|
|
1155
|
+
* @type {number}
|
|
1156
|
+
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1157
|
+
*/
|
|
1158
|
+
'page'?: number;
|
|
1147
1159
|
/**
|
|
1148
1160
|
*
|
|
1149
1161
|
* @type {string}
|
|
@@ -1174,6 +1186,12 @@ export interface AnalyticsFilterAnalyticsResponse {
|
|
|
1174
1186
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1175
1187
|
*/
|
|
1176
1188
|
'store_id'?: string;
|
|
1189
|
+
/**
|
|
1190
|
+
*
|
|
1191
|
+
* @type {number}
|
|
1192
|
+
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1193
|
+
*/
|
|
1194
|
+
'total'?: number;
|
|
1177
1195
|
}
|
|
1178
1196
|
/**
|
|
1179
1197
|
*
|
|
@@ -1409,12 +1427,24 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
1409
1427
|
* @memberof AnalyticsFilterTrendsResponse
|
|
1410
1428
|
*/
|
|
1411
1429
|
'granularity'?: string;
|
|
1430
|
+
/**
|
|
1431
|
+
*
|
|
1432
|
+
* @type {number}
|
|
1433
|
+
* @memberof AnalyticsFilterTrendsResponse
|
|
1434
|
+
*/
|
|
1435
|
+
'limit'?: number;
|
|
1412
1436
|
/**
|
|
1413
1437
|
*
|
|
1414
1438
|
* @type {string}
|
|
1415
1439
|
* @memberof AnalyticsFilterTrendsResponse
|
|
1416
1440
|
*/
|
|
1417
1441
|
'org_id'?: string;
|
|
1442
|
+
/**
|
|
1443
|
+
*
|
|
1444
|
+
* @type {number}
|
|
1445
|
+
* @memberof AnalyticsFilterTrendsResponse
|
|
1446
|
+
*/
|
|
1447
|
+
'page'?: number;
|
|
1418
1448
|
/**
|
|
1419
1449
|
*
|
|
1420
1450
|
* @type {string}
|
|
@@ -1445,6 +1475,12 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
1445
1475
|
* @memberof AnalyticsFilterTrendsResponse
|
|
1446
1476
|
*/
|
|
1447
1477
|
'top_filters'?: number;
|
|
1478
|
+
/**
|
|
1479
|
+
*
|
|
1480
|
+
* @type {number}
|
|
1481
|
+
* @memberof AnalyticsFilterTrendsResponse
|
|
1482
|
+
*/
|
|
1483
|
+
'total'?: number;
|
|
1448
1484
|
/**
|
|
1449
1485
|
*
|
|
1450
1486
|
* @type {{ [key: string]: Array<AnalyticsTimeSeriesPoint>; }}
|
|
@@ -6015,11 +6051,17 @@ export interface DataTypesErrorMetaResponse {
|
|
|
6015
6051
|
*/
|
|
6016
6052
|
export interface DataTypesEventPayload {
|
|
6017
6053
|
/**
|
|
6018
|
-
*
|
|
6054
|
+
* Journey Tracking & Analytics
|
|
6019
6055
|
* @type {Array<string>}
|
|
6020
6056
|
* @memberof DataTypesEventPayload
|
|
6021
6057
|
*/
|
|
6022
6058
|
'analytics_tags'?: Array<string>;
|
|
6059
|
+
/**
|
|
6060
|
+
* Anonymous user identifier
|
|
6061
|
+
* @type {string}
|
|
6062
|
+
* @memberof DataTypesEventPayload
|
|
6063
|
+
*/
|
|
6064
|
+
'anon_id'?: string;
|
|
6023
6065
|
/**
|
|
6024
6066
|
*
|
|
6025
6067
|
* @type {string}
|
|
@@ -6027,13 +6069,13 @@ export interface DataTypesEventPayload {
|
|
|
6027
6069
|
*/
|
|
6028
6070
|
'city'?: string;
|
|
6029
6071
|
/**
|
|
6030
|
-
*
|
|
6072
|
+
* Click/Interaction Event Fields
|
|
6031
6073
|
* @type {string}
|
|
6032
6074
|
* @memberof DataTypesEventPayload
|
|
6033
6075
|
*/
|
|
6034
6076
|
'clicked_product_id'?: string;
|
|
6035
6077
|
/**
|
|
6036
|
-
* Geo data fields for direct submission
|
|
6078
|
+
* Enhanced Geo data fields for direct submission
|
|
6037
6079
|
* @type {string}
|
|
6038
6080
|
* @memberof DataTypesEventPayload
|
|
6039
6081
|
*/
|
|
@@ -6044,6 +6086,12 @@ export interface DataTypesEventPayload {
|
|
|
6044
6086
|
* @memberof DataTypesEventPayload
|
|
6045
6087
|
*/
|
|
6046
6088
|
'country_code'?: string;
|
|
6089
|
+
/**
|
|
6090
|
+
* Currency for value
|
|
6091
|
+
* @type {string}
|
|
6092
|
+
* @memberof DataTypesEventPayload
|
|
6093
|
+
*/
|
|
6094
|
+
'currency'?: string;
|
|
6047
6095
|
/**
|
|
6048
6096
|
*
|
|
6049
6097
|
* @type {string}
|
|
@@ -6051,7 +6099,7 @@ export interface DataTypesEventPayload {
|
|
|
6051
6099
|
*/
|
|
6052
6100
|
'device_type'?: string;
|
|
6053
6101
|
/**
|
|
6054
|
-
*
|
|
6102
|
+
* Core Event Information
|
|
6055
6103
|
* @type {string}
|
|
6056
6104
|
* @memberof DataTypesEventPayload
|
|
6057
6105
|
*/
|
|
@@ -6063,25 +6111,25 @@ export interface DataTypesEventPayload {
|
|
|
6063
6111
|
*/
|
|
6064
6112
|
'event_name'?: string;
|
|
6065
6113
|
/**
|
|
6066
|
-
*
|
|
6114
|
+
* Device & Location Context
|
|
6067
6115
|
* @type {string}
|
|
6068
6116
|
* @memberof DataTypesEventPayload
|
|
6069
6117
|
*/
|
|
6070
6118
|
'ip'?: string;
|
|
6071
6119
|
/**
|
|
6072
|
-
*
|
|
6120
|
+
* Performance
|
|
6073
6121
|
* @type {number}
|
|
6074
6122
|
* @memberof DataTypesEventPayload
|
|
6075
6123
|
*/
|
|
6076
6124
|
'latency_ms'?: number;
|
|
6077
6125
|
/**
|
|
6078
|
-
*
|
|
6126
|
+
* Legacy field
|
|
6079
6127
|
* @type {string}
|
|
6080
6128
|
* @memberof DataTypesEventPayload
|
|
6081
6129
|
*/
|
|
6082
6130
|
'location'?: string;
|
|
6083
6131
|
/**
|
|
6084
|
-
*
|
|
6132
|
+
* Flexible metadata including search_id, position, etc.
|
|
6085
6133
|
* @type {{ [key: string]: any; }}
|
|
6086
6134
|
* @memberof DataTypesEventPayload
|
|
6087
6135
|
*/
|
|
@@ -6095,7 +6143,13 @@ export interface DataTypesEventPayload {
|
|
|
6095
6143
|
*/
|
|
6096
6144
|
'org_id'?: string;
|
|
6097
6145
|
/**
|
|
6098
|
-
*
|
|
6146
|
+
* web, ios, android
|
|
6147
|
+
* @type {string}
|
|
6148
|
+
* @memberof DataTypesEventPayload
|
|
6149
|
+
*/
|
|
6150
|
+
'platform'?: string;
|
|
6151
|
+
/**
|
|
6152
|
+
* Search Event Fields
|
|
6099
6153
|
* @type {string}
|
|
6100
6154
|
* @memberof DataTypesEventPayload
|
|
6101
6155
|
*/
|
|
@@ -6113,7 +6167,13 @@ export interface DataTypesEventPayload {
|
|
|
6113
6167
|
*/
|
|
6114
6168
|
'results_count'?: number;
|
|
6115
6169
|
/**
|
|
6116
|
-
*
|
|
6170
|
+
* Session identifier for journey tracking
|
|
6171
|
+
* @type {string}
|
|
6172
|
+
* @memberof DataTypesEventPayload
|
|
6173
|
+
*/
|
|
6174
|
+
'session_id'?: string;
|
|
6175
|
+
/**
|
|
6176
|
+
* Organization Context
|
|
6117
6177
|
* @type {string}
|
|
6118
6178
|
* @memberof DataTypesEventPayload
|
|
6119
6179
|
*/
|
|
@@ -6125,11 +6185,17 @@ export interface DataTypesEventPayload {
|
|
|
6125
6185
|
*/
|
|
6126
6186
|
'timestamp'?: string;
|
|
6127
6187
|
/**
|
|
6128
|
-
*
|
|
6188
|
+
* User Context
|
|
6129
6189
|
* @type {string}
|
|
6130
6190
|
* @memberof DataTypesEventPayload
|
|
6131
6191
|
*/
|
|
6132
6192
|
'user_id'?: string;
|
|
6193
|
+
/**
|
|
6194
|
+
* Business Context
|
|
6195
|
+
* @type {number}
|
|
6196
|
+
* @memberof DataTypesEventPayload
|
|
6197
|
+
*/
|
|
6198
|
+
'value'?: number;
|
|
6133
6199
|
}
|
|
6134
6200
|
/**
|
|
6135
6201
|
*
|
|
@@ -13191,12 +13257,20 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
13191
13257
|
*/
|
|
13192
13258
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: (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>;
|
|
13193
13259
|
/**
|
|
13194
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
13260
|
+
* 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
|
|
13195
13261
|
* @summary Get Query Insights
|
|
13196
13262
|
* @param {string} xStoreID Store ID
|
|
13197
13263
|
* @param {string} query Search query to analyze
|
|
13198
13264
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13199
13265
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13266
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13267
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13268
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13269
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13270
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13271
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13272
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13273
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13200
13274
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
13201
13275
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
13202
13276
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
@@ -13205,7 +13279,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
13205
13279
|
* @param {*} [options] Override http request option.
|
|
13206
13280
|
* @throws {RequiredError}
|
|
13207
13281
|
*/
|
|
13208
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13282
|
+
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<RequestArgs>;
|
|
13209
13283
|
/**
|
|
13210
13284
|
* 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.
|
|
13211
13285
|
* @summary Get Top Results Analytics
|
|
@@ -13548,12 +13622,20 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
13548
13622
|
*/
|
|
13549
13623
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(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<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>>;
|
|
13550
13624
|
/**
|
|
13551
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
13625
|
+
* 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
|
|
13552
13626
|
* @summary Get Query Insights
|
|
13553
13627
|
* @param {string} xStoreID Store ID
|
|
13554
13628
|
* @param {string} query Search query to analyze
|
|
13555
13629
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13556
13630
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13631
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13632
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13633
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13634
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13635
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13636
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13637
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13638
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13557
13639
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
13558
13640
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
13559
13641
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
@@ -13562,7 +13644,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
13562
13644
|
* @param {*} [options] Override http request option.
|
|
13563
13645
|
* @throws {RequiredError}
|
|
13564
13646
|
*/
|
|
13565
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>>;
|
|
13647
|
+
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>>;
|
|
13566
13648
|
/**
|
|
13567
13649
|
* 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.
|
|
13568
13650
|
* @summary Get Top Results Analytics
|
|
@@ -13905,12 +13987,20 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
13905
13987
|
*/
|
|
13906
13988
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(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): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>;
|
|
13907
13989
|
/**
|
|
13908
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
13990
|
+
* 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
|
|
13909
13991
|
* @summary Get Query Insights
|
|
13910
13992
|
* @param {string} xStoreID Store ID
|
|
13911
13993
|
* @param {string} query Search query to analyze
|
|
13912
13994
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13913
13995
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13996
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13997
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13998
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13999
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14000
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14001
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14002
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14003
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13914
14004
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
13915
14005
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
13916
14006
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
@@ -13919,7 +14009,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
13919
14009
|
* @param {*} [options] Override http request option.
|
|
13920
14010
|
* @throws {RequiredError}
|
|
13921
14011
|
*/
|
|
13922
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>;
|
|
14012
|
+
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>;
|
|
13923
14013
|
/**
|
|
13924
14014
|
* 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.
|
|
13925
14015
|
* @summary Get Top Results Analytics
|
|
@@ -14277,12 +14367,20 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
14277
14367
|
*/
|
|
14278
14368
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response, any, {}>>;
|
|
14279
14369
|
/**
|
|
14280
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
14370
|
+
* 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
|
|
14281
14371
|
* @summary Get Query Insights
|
|
14282
14372
|
* @param {string} xStoreID Store ID
|
|
14283
14373
|
* @param {string} query Search query to analyze
|
|
14284
14374
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14285
14375
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14376
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14377
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14378
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14379
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14380
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14381
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14382
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14383
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14286
14384
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
14287
14385
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
14288
14386
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
@@ -14292,7 +14390,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
14292
14390
|
* @throws {RequiredError}
|
|
14293
14391
|
* @memberof AnalyticsApi
|
|
14294
14392
|
*/
|
|
14295
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any, {}>>;
|
|
14393
|
+
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any, {}>>;
|
|
14296
14394
|
/**
|
|
14297
14395
|
* 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.
|
|
14298
14396
|
* @summary Get Top Results Analytics
|
|
@@ -14658,6 +14756,14 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum
|
|
|
14658
14756
|
readonly Desc: "desc";
|
|
14659
14757
|
};
|
|
14660
14758
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
14759
|
+
/**
|
|
14760
|
+
* @export
|
|
14761
|
+
*/
|
|
14762
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum: {
|
|
14763
|
+
readonly Any: "any";
|
|
14764
|
+
readonly All: "all";
|
|
14765
|
+
};
|
|
14766
|
+
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum];
|
|
14661
14767
|
/**
|
|
14662
14768
|
* @export
|
|
14663
14769
|
*/
|
package/dist/api.js
CHANGED
|
@@ -23,9 +23,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
25
|
exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortByEnum = exports.AnalyticsApi = exports.AnalyticsApiFactory = exports.AnalyticsApiFp = exports.AnalyticsApiAxiosParamCreator = exports.AccountSettingsApi = exports.AccountSettingsApiFactory = exports.AccountSettingsApiFp = exports.AccountSettingsApiAxiosParamCreator = exports.APICallsApi = exports.APICallsApiFactory = exports.APICallsApiFp = exports.APICallsApiAxiosParamCreator = exports.DataTypesUpdateWordStatusRequestWordTypeEnum = exports.DataTypesUpdatePluralDeclensionRequestTypeEnum = exports.DataTypesCreditTransactionTransactionTypeEnum = exports.DataTypesCreateTaskRequestTypeEnum = exports.DataTypesCreateTaskRequestIndexingStrategyEnum = exports.DataTypesCreateTaskRequestFrequencyEnum = exports.DataTypesCreatePluralDeclensionRequestTypeEnum = exports.DataTypesCreatePaymentOrderRequestPaymentTypeEnum = exports.DataTypesCreateCustomWordListRequestTypeEnum = void 0;
|
|
26
|
-
exports.
|
|
27
|
-
exports.
|
|
28
|
-
exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.SubscriptionsApi = exports.SubscriptionsApiFactory = exports.SubscriptionsApiFp = exports.SubscriptionsApiAxiosParamCreator = exports.StoresApi = exports.StoresApiFactory = exports.StoresApiFp = exports.StoresApiAxiosParamCreator = exports.StoreDocumentsApi = exports.StoreDocumentsApiFactory = exports.StoreDocumentsApiFp = exports.StoreDocumentsApiAxiosParamCreator = exports.StopwordsApi = exports.StopwordsApiFactory = exports.StopwordsApiFp = exports.StopwordsApiAxiosParamCreator = exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = exports.RoleRightsApi = exports.RoleRightsApiFactory = exports.RoleRightsApiFp = exports.RoleRightsApiAxiosParamCreator = exports.RequestsApi = exports.RequestsApiFactory = exports.RequestsApiFp = exports.RequestsApiAxiosParamCreator = exports.RegisterApi = exports.RegisterApiFactory = exports.RegisterApiFp = exports.RegisterApiAxiosParamCreator = exports.PluralsDeclensionsApi = exports.PluralsDeclensionsApiFactory = void 0;
|
|
26
|
+
exports.AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortByEnum = exports.ItemAnalyticsApi = exports.ItemAnalyticsApiFactory = exports.ItemAnalyticsApiFp = exports.ItemAnalyticsApiAxiosParamCreator = exports.DocumentsApi = exports.DocumentsApiFactory = exports.DocumentsApiFp = exports.DocumentsApiAxiosParamCreator = exports.CustomStopwordsApi = exports.CustomStopwordsApiFactory = exports.CustomStopwordsApiFp = exports.CustomStopwordsApiAxiosParamCreator = exports.ApiCreditsTransactionsGetTypeEnum = exports.CreditsApi = exports.CreditsApiFactory = exports.CreditsApiFp = exports.CreditsApiAxiosParamCreator = exports.ConnectorsApi = exports.ConnectorsApiFactory = exports.ConnectorsApiFp = exports.ConnectorsApiAxiosParamCreator = exports.AuthApi = exports.AuthApiFactory = exports.AuthApiFp = exports.AuthApiAxiosParamCreator = exports.ArticlesApi = exports.ArticlesApiFactory = exports.ArticlesApiFp = exports.ArticlesApiAxiosParamCreator = exports.AnalyticsEventsApi = exports.AnalyticsEventsApiFactory = exports.AnalyticsEventsApiFp = exports.AnalyticsEventsApiAxiosParamCreator = exports.AdminAnalyticsStoreXStoreIDTagsSummaryGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDTagsSummaryGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDTagsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDTagsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum = void 0;
|
|
27
|
+
exports.PluralsDeclensionsApiAxiosParamCreator = exports.PlansApi = exports.PlansApiFactory = exports.PlansApiFp = exports.PlansApiAxiosParamCreator = exports.PaymentsApi = exports.PaymentsApiFactory = exports.PaymentsApiFp = exports.PaymentsApiAxiosParamCreator = exports.PaymentGatewayApi = exports.PaymentGatewayApiFactory = exports.PaymentGatewayApiFp = exports.PaymentGatewayApiAxiosParamCreator = exports.ParentMenusApi = exports.ParentMenusApiFactory = exports.ParentMenusApiFp = exports.ParentMenusApiAxiosParamCreator = exports.OrganizationsApi = exports.OrganizationsApiFactory = exports.OrganizationsApiFp = exports.OrganizationsApiAxiosParamCreator = exports.OnboardingApi = exports.OnboardingApiFactory = exports.OnboardingApiFp = exports.OnboardingApiAxiosParamCreator = exports.NewsLettersApi = exports.NewsLettersApiFactory = exports.NewsLettersApiFp = exports.NewsLettersApiAxiosParamCreator = exports.MongoDbApi = exports.MongoDbApiFactory = exports.MongoDbApiFp = exports.MongoDbApiAxiosParamCreator = exports.ModulesApi = exports.ModulesApiFactory = exports.ModulesApiFp = exports.ModulesApiAxiosParamCreator = exports.MenusApi = exports.MenusApiFactory = exports.MenusApiFp = exports.MenusApiAxiosParamCreator = exports.LimitsApi = exports.LimitsApiFactory = exports.LimitsApiFp = exports.LimitsApiAxiosParamCreator = exports.AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetGranularityEnum = void 0;
|
|
28
|
+
exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.SubscriptionsApi = exports.SubscriptionsApiFactory = exports.SubscriptionsApiFp = exports.SubscriptionsApiAxiosParamCreator = exports.StoresApi = exports.StoresApiFactory = exports.StoresApiFp = exports.StoresApiAxiosParamCreator = exports.StoreDocumentsApi = exports.StoreDocumentsApiFactory = exports.StoreDocumentsApiFp = exports.StoreDocumentsApiAxiosParamCreator = exports.StopwordsApi = exports.StopwordsApiFactory = exports.StopwordsApiFp = exports.StopwordsApiAxiosParamCreator = exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = exports.RoleRightsApi = exports.RoleRightsApiFactory = exports.RoleRightsApiFp = exports.RoleRightsApiAxiosParamCreator = exports.RequestsApi = exports.RequestsApiFactory = exports.RequestsApiFp = exports.RequestsApiAxiosParamCreator = exports.RegisterApi = exports.RegisterApiFactory = exports.RegisterApiFp = exports.RegisterApiAxiosParamCreator = exports.PluralsDeclensionsApi = exports.PluralsDeclensionsApiFactory = exports.PluralsDeclensionsApiFp = void 0;
|
|
29
29
|
const axios_1 = require("axios");
|
|
30
30
|
// Some imports not used depending on template conditions
|
|
31
31
|
// @ts-ignore
|
|
@@ -2007,12 +2007,20 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2007
2007
|
};
|
|
2008
2008
|
}),
|
|
2009
2009
|
/**
|
|
2010
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
2010
|
+
* 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
|
|
2011
2011
|
* @summary Get Query Insights
|
|
2012
2012
|
* @param {string} xStoreID Store ID
|
|
2013
2013
|
* @param {string} query Search query to analyze
|
|
2014
2014
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2015
2015
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2016
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2017
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2018
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2019
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2020
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2021
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2022
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2023
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2016
2024
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2017
2025
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2018
2026
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
@@ -2021,7 +2029,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2021
2029
|
* @param {*} [options] Override http request option.
|
|
2022
2030
|
* @throws {RequiredError}
|
|
2023
2031
|
*/
|
|
2024
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID_1, query_1, startTime_1, endTime_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, startTime_1, endTime_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1], void 0, function* (xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options = {}) {
|
|
2032
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1], void 0, function* (xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options = {}) {
|
|
2025
2033
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2026
2034
|
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID);
|
|
2027
2035
|
// verify required parameter 'query' is not null or undefined
|
|
@@ -2046,6 +2054,30 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2046
2054
|
if (endTime !== undefined) {
|
|
2047
2055
|
localVarQueryParameter['end_time'] = endTime;
|
|
2048
2056
|
}
|
|
2057
|
+
if (compareMode !== undefined) {
|
|
2058
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
2059
|
+
}
|
|
2060
|
+
if (compareStartTime !== undefined) {
|
|
2061
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
2062
|
+
}
|
|
2063
|
+
if (compareEndTime !== undefined) {
|
|
2064
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
2065
|
+
}
|
|
2066
|
+
if (compareAnalyticsTags !== undefined) {
|
|
2067
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
2068
|
+
}
|
|
2069
|
+
if (compareTagsMatchMode !== undefined) {
|
|
2070
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
2071
|
+
}
|
|
2072
|
+
if (compareTagsExclude !== undefined) {
|
|
2073
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
2074
|
+
}
|
|
2075
|
+
if (compareTagKeyFilter !== undefined) {
|
|
2076
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
2077
|
+
}
|
|
2078
|
+
if (compareTagValueFilter !== undefined) {
|
|
2079
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
2080
|
+
}
|
|
2049
2081
|
if (resultsPage !== undefined) {
|
|
2050
2082
|
localVarQueryParameter['results_page'] = resultsPage;
|
|
2051
2083
|
}
|
|
@@ -2728,12 +2760,20 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2728
2760
|
});
|
|
2729
2761
|
},
|
|
2730
2762
|
/**
|
|
2731
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
2763
|
+
* 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
|
|
2732
2764
|
* @summary Get Query Insights
|
|
2733
2765
|
* @param {string} xStoreID Store ID
|
|
2734
2766
|
* @param {string} query Search query to analyze
|
|
2735
2767
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2736
2768
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2769
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2770
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2771
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2772
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2773
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2774
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2775
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2776
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2737
2777
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2738
2778
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2739
2779
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
@@ -2742,10 +2782,10 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2742
2782
|
* @param {*} [options] Override http request option.
|
|
2743
2783
|
* @throws {RequiredError}
|
|
2744
2784
|
*/
|
|
2745
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
2785
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
2746
2786
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2747
2787
|
var _a, _b, _c;
|
|
2748
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
|
|
2788
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
|
|
2749
2789
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2750
2790
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2751
2791
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3147,12 +3187,20 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3147
3187
|
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));
|
|
3148
3188
|
},
|
|
3149
3189
|
/**
|
|
3150
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
3190
|
+
* 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
|
|
3151
3191
|
* @summary Get Query Insights
|
|
3152
3192
|
* @param {string} xStoreID Store ID
|
|
3153
3193
|
* @param {string} query Search query to analyze
|
|
3154
3194
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3155
3195
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3196
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3197
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3198
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3199
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3200
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3201
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3202
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3203
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3156
3204
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3157
3205
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3158
3206
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
@@ -3161,8 +3209,8 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3161
3209
|
* @param {*} [options] Override http request option.
|
|
3162
3210
|
* @throws {RequiredError}
|
|
3163
3211
|
*/
|
|
3164
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3165
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(axios, basePath));
|
|
3212
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3213
|
+
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));
|
|
3166
3214
|
},
|
|
3167
3215
|
/**
|
|
3168
3216
|
* 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.
|
|
@@ -3555,12 +3603,20 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3555
3603
|
return (0, exports.AnalyticsApiFp)(this.configuration).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(this.axios, this.basePath));
|
|
3556
3604
|
}
|
|
3557
3605
|
/**
|
|
3558
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
3606
|
+
* 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
|
|
3559
3607
|
* @summary Get Query Insights
|
|
3560
3608
|
* @param {string} xStoreID Store ID
|
|
3561
3609
|
* @param {string} query Search query to analyze
|
|
3562
3610
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3563
3611
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3612
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3613
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3614
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3615
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3616
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3617
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3618
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3619
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3564
3620
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3565
3621
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3566
3622
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
@@ -3570,8 +3626,8 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3570
3626
|
* @throws {RequiredError}
|
|
3571
3627
|
* @memberof AnalyticsApi
|
|
3572
3628
|
*/
|
|
3573
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3574
|
-
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
3629
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3630
|
+
return (0, exports.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));
|
|
3575
3631
|
}
|
|
3576
3632
|
/**
|
|
3577
3633
|
* 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.
|
|
@@ -3914,6 +3970,13 @@ exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
3914
3970
|
Asc: 'asc',
|
|
3915
3971
|
Desc: 'desc'
|
|
3916
3972
|
};
|
|
3973
|
+
/**
|
|
3974
|
+
* @export
|
|
3975
|
+
*/
|
|
3976
|
+
exports.AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = {
|
|
3977
|
+
Any: 'any',
|
|
3978
|
+
All: 'all'
|
|
3979
|
+
};
|
|
3917
3980
|
/**
|
|
3918
3981
|
* @export
|
|
3919
3982
|
*/
|