@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/dist/esm/api.js
CHANGED
|
@@ -1993,16 +1993,29 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1993
1993
|
};
|
|
1994
1994
|
}),
|
|
1995
1995
|
/**
|
|
1996
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
1996
|
+
* 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
|
|
1997
1997
|
* @summary Get Query Insights
|
|
1998
1998
|
* @param {string} xStoreID Store ID
|
|
1999
1999
|
* @param {string} query Search query to analyze
|
|
2000
2000
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2001
2001
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2002
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2003
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2004
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2005
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2006
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2007
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2008
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2009
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2010
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2011
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2012
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2013
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
2014
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
2002
2015
|
* @param {*} [options] Override http request option.
|
|
2003
2016
|
* @throws {RequiredError}
|
|
2004
2017
|
*/
|
|
2005
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID_1, query_1, startTime_1, endTime_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, startTime_1, endTime_1, ...args_1], void 0, function* (xStoreID, query, startTime, endTime, options = {}) {
|
|
2018
|
+
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 = {}) {
|
|
2006
2019
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2007
2020
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID);
|
|
2008
2021
|
// verify required parameter 'query' is not null or undefined
|
|
@@ -2027,6 +2040,45 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2027
2040
|
if (endTime !== undefined) {
|
|
2028
2041
|
localVarQueryParameter['end_time'] = endTime;
|
|
2029
2042
|
}
|
|
2043
|
+
if (compareMode !== undefined) {
|
|
2044
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
2045
|
+
}
|
|
2046
|
+
if (compareStartTime !== undefined) {
|
|
2047
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
2048
|
+
}
|
|
2049
|
+
if (compareEndTime !== undefined) {
|
|
2050
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
2051
|
+
}
|
|
2052
|
+
if (compareAnalyticsTags !== undefined) {
|
|
2053
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
2054
|
+
}
|
|
2055
|
+
if (compareTagsMatchMode !== undefined) {
|
|
2056
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
2057
|
+
}
|
|
2058
|
+
if (compareTagsExclude !== undefined) {
|
|
2059
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
2060
|
+
}
|
|
2061
|
+
if (compareTagKeyFilter !== undefined) {
|
|
2062
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
2063
|
+
}
|
|
2064
|
+
if (compareTagValueFilter !== undefined) {
|
|
2065
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
2066
|
+
}
|
|
2067
|
+
if (resultsPage !== undefined) {
|
|
2068
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
2069
|
+
}
|
|
2070
|
+
if (resultsPageSize !== undefined) {
|
|
2071
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
2072
|
+
}
|
|
2073
|
+
if (filtersPage !== undefined) {
|
|
2074
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
2075
|
+
}
|
|
2076
|
+
if (filtersPageSize !== undefined) {
|
|
2077
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
2078
|
+
}
|
|
2079
|
+
if (includeWidget !== undefined) {
|
|
2080
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
2081
|
+
}
|
|
2030
2082
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2031
2083
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2032
2084
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -2693,19 +2745,32 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2693
2745
|
});
|
|
2694
2746
|
},
|
|
2695
2747
|
/**
|
|
2696
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
2748
|
+
* 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
|
|
2697
2749
|
* @summary Get Query Insights
|
|
2698
2750
|
* @param {string} xStoreID Store ID
|
|
2699
2751
|
* @param {string} query Search query to analyze
|
|
2700
2752
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2701
2753
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2754
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2755
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2756
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2757
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2758
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2759
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2760
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2761
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2762
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2763
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2764
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2765
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
2766
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
2702
2767
|
* @param {*} [options] Override http request option.
|
|
2703
2768
|
* @throws {RequiredError}
|
|
2704
2769
|
*/
|
|
2705
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options) {
|
|
2770
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
2706
2771
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2707
2772
|
var _a, _b, _c;
|
|
2708
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options);
|
|
2773
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
|
|
2709
2774
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2710
2775
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2711
2776
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3106,17 +3171,30 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3106
3171
|
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));
|
|
3107
3172
|
},
|
|
3108
3173
|
/**
|
|
3109
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
3174
|
+
* 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
|
|
3110
3175
|
* @summary Get Query Insights
|
|
3111
3176
|
* @param {string} xStoreID Store ID
|
|
3112
3177
|
* @param {string} query Search query to analyze
|
|
3113
3178
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3114
3179
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3180
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3181
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3182
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3183
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3184
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3185
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3186
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3187
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3188
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3189
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3190
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3191
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
3192
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3115
3193
|
* @param {*} [options] Override http request option.
|
|
3116
3194
|
* @throws {RequiredError}
|
|
3117
3195
|
*/
|
|
3118
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options) {
|
|
3119
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
3196
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3197
|
+
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));
|
|
3120
3198
|
},
|
|
3121
3199
|
/**
|
|
3122
3200
|
* 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.
|
|
@@ -3508,18 +3586,31 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3508
3586
|
return 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));
|
|
3509
3587
|
}
|
|
3510
3588
|
/**
|
|
3511
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
3589
|
+
* 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
|
|
3512
3590
|
* @summary Get Query Insights
|
|
3513
3591
|
* @param {string} xStoreID Store ID
|
|
3514
3592
|
* @param {string} query Search query to analyze
|
|
3515
3593
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3516
3594
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3595
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3596
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3597
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3598
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3599
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3600
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3601
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3602
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3603
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3604
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3605
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3606
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
3607
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3517
3608
|
* @param {*} [options] Override http request option.
|
|
3518
3609
|
* @throws {RequiredError}
|
|
3519
3610
|
* @memberof AnalyticsApi
|
|
3520
3611
|
*/
|
|
3521
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options) {
|
|
3522
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
|
|
3612
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3613
|
+
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));
|
|
3523
3614
|
}
|
|
3524
3615
|
/**
|
|
3525
3616
|
* 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.
|
|
@@ -3861,6 +3952,13 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
3861
3952
|
Asc: 'asc',
|
|
3862
3953
|
Desc: 'desc'
|
|
3863
3954
|
};
|
|
3955
|
+
/**
|
|
3956
|
+
* @export
|
|
3957
|
+
*/
|
|
3958
|
+
export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = {
|
|
3959
|
+
Any: 'any',
|
|
3960
|
+
All: 'all'
|
|
3961
|
+
};
|
|
3864
3962
|
/**
|
|
3865
3963
|
* @export
|
|
3866
3964
|
*/
|
package/package.json
CHANGED
|
Binary file
|
|
Binary file
|