@seekora-ai/admin-api 1.0.49 → 1.0.51
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 +73 -2
- package/api.ts +17186 -12372
- package/dist/api.d.ts +7067 -3338
- package/dist/api.js +2057 -51
- package/dist/esm/api.d.ts +7067 -3338
- package/dist/esm/api.js +2044 -47
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.51.tgz +0 -0
- package/seekora-ai-admin-api-1.0.49.tgz +0 -0
package/dist/esm/api.js
CHANGED
|
@@ -26,6 +26,36 @@ import globalAxios from 'axios';
|
|
|
26
26
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
|
|
27
27
|
// @ts-ignore
|
|
28
28
|
import { BASE_PATH, BaseAPI, operationServerMap } from './base';
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @export
|
|
32
|
+
* @enum {string}
|
|
33
|
+
*/
|
|
34
|
+
export const AnalyticsBulkOperation = {
|
|
35
|
+
BulkEnable: 'enable',
|
|
36
|
+
BulkDisable: 'disable',
|
|
37
|
+
BulkDelete: 'delete',
|
|
38
|
+
BulkUpdatePriority: 'update_priority'
|
|
39
|
+
};
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @export
|
|
43
|
+
* @enum {string}
|
|
44
|
+
*/
|
|
45
|
+
export const AnalyticsQuerySuggestionSource = {
|
|
46
|
+
SourceAutoGenerated: 'auto_generated',
|
|
47
|
+
SourceManual: 'manual',
|
|
48
|
+
SourceImported: 'imported'
|
|
49
|
+
};
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
* @export
|
|
53
|
+
* @enum {string}
|
|
54
|
+
*/
|
|
55
|
+
export const AnalyticsQuerySuggestionStatus = {
|
|
56
|
+
StatusEnabled: 'enabled',
|
|
57
|
+
StatusDisabled: 'disabled'
|
|
58
|
+
};
|
|
29
59
|
export const DataTypesCreateCustomWordListRequestTypeEnum = {
|
|
30
60
|
Stopwords: 'stopwords',
|
|
31
61
|
Synonyms: 'synonyms'
|
|
@@ -1442,6 +1472,133 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1442
1472
|
options: localVarRequestOptions,
|
|
1443
1473
|
};
|
|
1444
1474
|
}),
|
|
1475
|
+
/**
|
|
1476
|
+
* Retrieve comprehensive analytics insights for a specific geographic location including all core metrics (Total Searches, Total Clicks, CTR, Conversions, CVR, Revenue), popular queries with performance metrics, top results by region with average rankings, popular filters used per region with performance impact, and totals & rates with optional comparison mode and internal pagination for each subsection
|
|
1477
|
+
* @summary Get Geographic Insights
|
|
1478
|
+
* @param {string} xStoreID Store ID
|
|
1479
|
+
* @param {string} [country] Country name to analyze
|
|
1480
|
+
* @param {string} [region] Region/state name to analyze
|
|
1481
|
+
* @param {string} [city] City name to analyze
|
|
1482
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
1483
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
1484
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
1485
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
1486
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1487
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1488
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1489
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1490
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1491
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1492
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1493
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1494
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1495
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1496
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1497
|
+
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
1498
|
+
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
1499
|
+
* @param {number} [resultsPage] Page number for top results pagination
|
|
1500
|
+
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
1501
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
1502
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
1503
|
+
* @param {*} [options] Override http request option.
|
|
1504
|
+
* @throws {RequiredError}
|
|
1505
|
+
*/
|
|
1506
|
+
adminAnalyticsStoreXStoreIDGeoInsightsGet: (xStoreID_1, country_1, region_1, city_1, startTime_1, endTime_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, queriesPage_1, queriesPageSize_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, ...args_1) => __awaiter(this, [xStoreID_1, country_1, region_1, city_1, startTime_1, endTime_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, queriesPage_1, queriesPageSize_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, ...args_1], void 0, function* (xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options = {}) {
|
|
1507
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
1508
|
+
assertParamExists('adminAnalyticsStoreXStoreIDGeoInsightsGet', 'xStoreID', xStoreID);
|
|
1509
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/geo/insights`
|
|
1510
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
1511
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1512
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1513
|
+
let baseOptions;
|
|
1514
|
+
if (configuration) {
|
|
1515
|
+
baseOptions = configuration.baseOptions;
|
|
1516
|
+
}
|
|
1517
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1518
|
+
const localVarHeaderParameter = {};
|
|
1519
|
+
const localVarQueryParameter = {};
|
|
1520
|
+
// authentication BearerAuth required
|
|
1521
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1522
|
+
if (country !== undefined) {
|
|
1523
|
+
localVarQueryParameter['country'] = country;
|
|
1524
|
+
}
|
|
1525
|
+
if (region !== undefined) {
|
|
1526
|
+
localVarQueryParameter['region'] = region;
|
|
1527
|
+
}
|
|
1528
|
+
if (city !== undefined) {
|
|
1529
|
+
localVarQueryParameter['city'] = city;
|
|
1530
|
+
}
|
|
1531
|
+
if (startTime !== undefined) {
|
|
1532
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
1533
|
+
}
|
|
1534
|
+
if (endTime !== undefined) {
|
|
1535
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
1536
|
+
}
|
|
1537
|
+
if (analyticsTags !== undefined) {
|
|
1538
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
1539
|
+
}
|
|
1540
|
+
if (tagsMatchMode !== undefined) {
|
|
1541
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
1542
|
+
}
|
|
1543
|
+
if (tagsExclude !== undefined) {
|
|
1544
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
1545
|
+
}
|
|
1546
|
+
if (tagKeyFilter !== undefined) {
|
|
1547
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
1548
|
+
}
|
|
1549
|
+
if (tagValueFilter !== undefined) {
|
|
1550
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1551
|
+
}
|
|
1552
|
+
if (compareMode !== undefined) {
|
|
1553
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1554
|
+
}
|
|
1555
|
+
if (compareStartTime !== undefined) {
|
|
1556
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1557
|
+
}
|
|
1558
|
+
if (compareEndTime !== undefined) {
|
|
1559
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1560
|
+
}
|
|
1561
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1562
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1563
|
+
}
|
|
1564
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1565
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1566
|
+
}
|
|
1567
|
+
if (compareTagsExclude !== undefined) {
|
|
1568
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1569
|
+
}
|
|
1570
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1571
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1572
|
+
}
|
|
1573
|
+
if (compareTagValueFilter !== undefined) {
|
|
1574
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1575
|
+
}
|
|
1576
|
+
if (queriesPage !== undefined) {
|
|
1577
|
+
localVarQueryParameter['queries_page'] = queriesPage;
|
|
1578
|
+
}
|
|
1579
|
+
if (queriesPageSize !== undefined) {
|
|
1580
|
+
localVarQueryParameter['queries_page_size'] = queriesPageSize;
|
|
1581
|
+
}
|
|
1582
|
+
if (resultsPage !== undefined) {
|
|
1583
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
1584
|
+
}
|
|
1585
|
+
if (resultsPageSize !== undefined) {
|
|
1586
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
1587
|
+
}
|
|
1588
|
+
if (filtersPage !== undefined) {
|
|
1589
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
1590
|
+
}
|
|
1591
|
+
if (filtersPageSize !== undefined) {
|
|
1592
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
1593
|
+
}
|
|
1594
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1595
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1596
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1597
|
+
return {
|
|
1598
|
+
url: toPathString(localVarUrlObj),
|
|
1599
|
+
options: localVarRequestOptions,
|
|
1600
|
+
};
|
|
1601
|
+
}),
|
|
1445
1602
|
/**
|
|
1446
1603
|
* Check the health status of analytics service and ClickHouse connection
|
|
1447
1604
|
* @summary Analytics Health Check
|
|
@@ -1993,7 +2150,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1993
2150
|
};
|
|
1994
2151
|
}),
|
|
1995
2152
|
/**
|
|
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
|
|
2153
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
1997
2154
|
* @summary Get Query Insights
|
|
1998
2155
|
* @param {string} xStoreID Store ID
|
|
1999
2156
|
* @param {string} query Search query to analyze
|
|
@@ -2010,12 +2167,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2010
2167
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2011
2168
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2012
2169
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2013
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
2170
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
2171
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
2172
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
2014
2173
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
2015
2174
|
* @param {*} [options] Override http request option.
|
|
2016
2175
|
* @throws {RequiredError}
|
|
2017
2176
|
*/
|
|
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 = {}) {
|
|
2177
|
+
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, geoPage_1, geoPageSize_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, geoPage_1, geoPageSize_1, includeWidget_1, ...args_1], void 0, function* (xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options = {}) {
|
|
2019
2178
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2020
2179
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID);
|
|
2021
2180
|
// verify required parameter 'query' is not null or undefined
|
|
@@ -2076,6 +2235,12 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2076
2235
|
if (filtersPageSize !== undefined) {
|
|
2077
2236
|
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
2078
2237
|
}
|
|
2238
|
+
if (geoPage !== undefined) {
|
|
2239
|
+
localVarQueryParameter['geo_page'] = geoPage;
|
|
2240
|
+
}
|
|
2241
|
+
if (geoPageSize !== undefined) {
|
|
2242
|
+
localVarQueryParameter['geo_page_size'] = geoPageSize;
|
|
2243
|
+
}
|
|
2079
2244
|
if (includeWidget !== undefined) {
|
|
2080
2245
|
localVarQueryParameter['include_widget'] = includeWidget;
|
|
2081
2246
|
}
|
|
@@ -2557,6 +2722,46 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2557
2722
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2558
2723
|
});
|
|
2559
2724
|
},
|
|
2725
|
+
/**
|
|
2726
|
+
* Retrieve comprehensive analytics insights for a specific geographic location including all core metrics (Total Searches, Total Clicks, CTR, Conversions, CVR, Revenue), popular queries with performance metrics, top results by region with average rankings, popular filters used per region with performance impact, and totals & rates with optional comparison mode and internal pagination for each subsection
|
|
2727
|
+
* @summary Get Geographic Insights
|
|
2728
|
+
* @param {string} xStoreID Store ID
|
|
2729
|
+
* @param {string} [country] Country name to analyze
|
|
2730
|
+
* @param {string} [region] Region/state name to analyze
|
|
2731
|
+
* @param {string} [city] City name to analyze
|
|
2732
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
2733
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
2734
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2735
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2736
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2737
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2738
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2739
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2740
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2741
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2742
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2743
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2744
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2745
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2746
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2747
|
+
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
2748
|
+
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
2749
|
+
* @param {number} [resultsPage] Page number for top results pagination
|
|
2750
|
+
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
2751
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2752
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
2753
|
+
* @param {*} [options] Override http request option.
|
|
2754
|
+
* @throws {RequiredError}
|
|
2755
|
+
*/
|
|
2756
|
+
adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options) {
|
|
2757
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2758
|
+
var _a, _b, _c;
|
|
2759
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options);
|
|
2760
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2761
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDGeoInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2762
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2763
|
+
});
|
|
2764
|
+
},
|
|
2560
2765
|
/**
|
|
2561
2766
|
* Check the health status of analytics service and ClickHouse connection
|
|
2562
2767
|
* @summary Analytics Health Check
|
|
@@ -2745,7 +2950,7 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2745
2950
|
});
|
|
2746
2951
|
},
|
|
2747
2952
|
/**
|
|
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
|
|
2953
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
2749
2954
|
* @summary Get Query Insights
|
|
2750
2955
|
* @param {string} xStoreID Store ID
|
|
2751
2956
|
* @param {string} query Search query to analyze
|
|
@@ -2762,15 +2967,17 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2762
2967
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2763
2968
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2764
2969
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2765
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
2970
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
2971
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
2972
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
2766
2973
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
2767
2974
|
* @param {*} [options] Override http request option.
|
|
2768
2975
|
* @throws {RequiredError}
|
|
2769
2976
|
*/
|
|
2770
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
2977
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options) {
|
|
2771
2978
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2772
2979
|
var _a, _b, _c;
|
|
2773
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
|
|
2980
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options);
|
|
2774
2981
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2775
2982
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2776
2983
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3019,6 +3226,40 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3019
3226
|
adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3020
3227
|
return localVarFp.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, 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));
|
|
3021
3228
|
},
|
|
3229
|
+
/**
|
|
3230
|
+
* Retrieve comprehensive analytics insights for a specific geographic location including all core metrics (Total Searches, Total Clicks, CTR, Conversions, CVR, Revenue), popular queries with performance metrics, top results by region with average rankings, popular filters used per region with performance impact, and totals & rates with optional comparison mode and internal pagination for each subsection
|
|
3231
|
+
* @summary Get Geographic Insights
|
|
3232
|
+
* @param {string} xStoreID Store ID
|
|
3233
|
+
* @param {string} [country] Country name to analyze
|
|
3234
|
+
* @param {string} [region] Region/state name to analyze
|
|
3235
|
+
* @param {string} [city] City name to analyze
|
|
3236
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
3237
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
3238
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3239
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3240
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3241
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3242
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3243
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3244
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3245
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3246
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3247
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3248
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3249
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3250
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3251
|
+
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
3252
|
+
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
3253
|
+
* @param {number} [resultsPage] Page number for top results pagination
|
|
3254
|
+
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
3255
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3256
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3257
|
+
* @param {*} [options] Override http request option.
|
|
3258
|
+
* @throws {RequiredError}
|
|
3259
|
+
*/
|
|
3260
|
+
adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options) {
|
|
3261
|
+
return localVarFp.adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options).then((request) => request(axios, basePath));
|
|
3262
|
+
},
|
|
3022
3263
|
/**
|
|
3023
3264
|
* Check the health status of analytics service and ClickHouse connection
|
|
3024
3265
|
* @summary Analytics Health Check
|
|
@@ -3171,7 +3412,7 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3171
3412
|
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));
|
|
3172
3413
|
},
|
|
3173
3414
|
/**
|
|
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
|
|
3415
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
3175
3416
|
* @summary Get Query Insights
|
|
3176
3417
|
* @param {string} xStoreID Store ID
|
|
3177
3418
|
* @param {string} query Search query to analyze
|
|
@@ -3188,13 +3429,15 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3188
3429
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3189
3430
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3190
3431
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3191
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
3432
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3433
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
3434
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
3192
3435
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3193
3436
|
* @param {*} [options] Override http request option.
|
|
3194
3437
|
* @throws {RequiredError}
|
|
3195
3438
|
*/
|
|
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));
|
|
3439
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options) {
|
|
3440
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options).then((request) => request(axios, basePath));
|
|
3198
3441
|
},
|
|
3199
3442
|
/**
|
|
3200
3443
|
* 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.
|
|
@@ -3428,6 +3671,41 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3428
3671
|
adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3429
3672
|
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, 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));
|
|
3430
3673
|
}
|
|
3674
|
+
/**
|
|
3675
|
+
* Retrieve comprehensive analytics insights for a specific geographic location including all core metrics (Total Searches, Total Clicks, CTR, Conversions, CVR, Revenue), popular queries with performance metrics, top results by region with average rankings, popular filters used per region with performance impact, and totals & rates with optional comparison mode and internal pagination for each subsection
|
|
3676
|
+
* @summary Get Geographic Insights
|
|
3677
|
+
* @param {string} xStoreID Store ID
|
|
3678
|
+
* @param {string} [country] Country name to analyze
|
|
3679
|
+
* @param {string} [region] Region/state name to analyze
|
|
3680
|
+
* @param {string} [city] City name to analyze
|
|
3681
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
3682
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
3683
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3684
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3685
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3686
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3687
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3688
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3689
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3690
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3691
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3692
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3693
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3694
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3695
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3696
|
+
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
3697
|
+
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
3698
|
+
* @param {number} [resultsPage] Page number for top results pagination
|
|
3699
|
+
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
3700
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3701
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3702
|
+
* @param {*} [options] Override http request option.
|
|
3703
|
+
* @throws {RequiredError}
|
|
3704
|
+
* @memberof AnalyticsApi
|
|
3705
|
+
*/
|
|
3706
|
+
adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options) {
|
|
3707
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID, country, region, city, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, queriesPage, queriesPageSize, resultsPage, resultsPageSize, filtersPage, filtersPageSize, options).then((request) => request(this.axios, this.basePath));
|
|
3708
|
+
}
|
|
3431
3709
|
/**
|
|
3432
3710
|
* Check the health status of analytics service and ClickHouse connection
|
|
3433
3711
|
* @summary Analytics Health Check
|
|
@@ -3586,7 +3864,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3586
3864
|
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));
|
|
3587
3865
|
}
|
|
3588
3866
|
/**
|
|
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
|
|
3867
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
3590
3868
|
* @summary Get Query Insights
|
|
3591
3869
|
* @param {string} xStoreID Store ID
|
|
3592
3870
|
* @param {string} query Search query to analyze
|
|
@@ -3603,14 +3881,16 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3603
3881
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3604
3882
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3605
3883
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3606
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
3884
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3885
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
3886
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
3607
3887
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3608
3888
|
* @param {*} [options] Override http request option.
|
|
3609
3889
|
* @throws {RequiredError}
|
|
3610
3890
|
* @memberof AnalyticsApi
|
|
3611
3891
|
*/
|
|
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));
|
|
3892
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options) {
|
|
3893
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
3614
3894
|
}
|
|
3615
3895
|
/**
|
|
3616
3896
|
* 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.
|
|
@@ -3824,6 +4104,20 @@ export const AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum = {
|
|
|
3824
4104
|
Asc: 'asc',
|
|
3825
4105
|
Desc: 'desc'
|
|
3826
4106
|
};
|
|
4107
|
+
/**
|
|
4108
|
+
* @export
|
|
4109
|
+
*/
|
|
4110
|
+
export const AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum = {
|
|
4111
|
+
Any: 'any',
|
|
4112
|
+
All: 'all'
|
|
4113
|
+
};
|
|
4114
|
+
/**
|
|
4115
|
+
* @export
|
|
4116
|
+
*/
|
|
4117
|
+
export const AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum = {
|
|
4118
|
+
Any: 'any',
|
|
4119
|
+
All: 'all'
|
|
4120
|
+
};
|
|
3827
4121
|
/**
|
|
3828
4122
|
* @export
|
|
3829
4123
|
*/
|
|
@@ -7399,30 +7693,43 @@ export const ItemAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
7399
7693
|
};
|
|
7400
7694
|
}),
|
|
7401
7695
|
/**
|
|
7402
|
-
* Retrieve
|
|
7403
|
-
* @summary Get Item
|
|
7696
|
+
* Retrieve comprehensive analytics insights for a specific item including all core metrics (Total Searches, Results Shown, Impressions, Clicks, Conversions, Revenue, CTR, CVR, Conversion Rate per Search, No-Click Rate, Avg Result Rank, Avg Click Position), popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
7697
|
+
* @summary Get Item Insights
|
|
7404
7698
|
* @param {string} xStoreID Store ID
|
|
7699
|
+
* @param {string} itemId Item ID to analyze
|
|
7405
7700
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
7406
7701
|
* @param {string} [endTime] End time in RFC3339 format
|
|
7407
|
-
* @param {string} [
|
|
7408
|
-
* @param {
|
|
7409
|
-
* @param {
|
|
7410
|
-
* @param {
|
|
7411
|
-
* @param {
|
|
7412
|
-
* @param {
|
|
7413
|
-
* @param {string} [
|
|
7414
|
-
* @param {
|
|
7415
|
-
* @param {
|
|
7416
|
-
* @param {
|
|
7417
|
-
* @param {
|
|
7702
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
7703
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
7704
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
7705
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
7706
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
7707
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
7708
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
7709
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
7710
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
7711
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
7712
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
7713
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
7714
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
7715
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
7716
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
7717
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
7718
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
7719
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
7720
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
7721
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
7418
7722
|
* @param {*} [options] Override http request option.
|
|
7419
7723
|
* @throws {RequiredError}
|
|
7420
7724
|
*/
|
|
7421
|
-
|
|
7725
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet: (xStoreID_1, itemId_1, startTime_1, endTime_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_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, geoPage_1, geoPageSize_1, groupBy_1, ...args_1) => __awaiter(this, [xStoreID_1, itemId_1, startTime_1, endTime_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_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, geoPage_1, geoPageSize_1, groupBy_1, ...args_1], void 0, function* (xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options = {}) {
|
|
7422
7726
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
7423
|
-
assertParamExists('
|
|
7424
|
-
|
|
7425
|
-
|
|
7727
|
+
assertParamExists('adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet', 'xStoreID', xStoreID);
|
|
7728
|
+
// verify required parameter 'itemId' is not null or undefined
|
|
7729
|
+
assertParamExists('adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet', 'itemId', itemId);
|
|
7730
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/items/{itemId}/insights`
|
|
7731
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
7732
|
+
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
|
|
7426
7733
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7427
7734
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7428
7735
|
let baseOptions;
|
|
@@ -7440,26 +7747,136 @@ export const ItemAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
7440
7747
|
if (endTime !== undefined) {
|
|
7441
7748
|
localVarQueryParameter['end_time'] = endTime;
|
|
7442
7749
|
}
|
|
7443
|
-
if (
|
|
7444
|
-
localVarQueryParameter['
|
|
7445
|
-
}
|
|
7446
|
-
if (itemLimit !== undefined) {
|
|
7447
|
-
localVarQueryParameter['item_limit'] = itemLimit;
|
|
7750
|
+
if (analyticsTags !== undefined) {
|
|
7751
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
7448
7752
|
}
|
|
7449
|
-
if (
|
|
7450
|
-
localVarQueryParameter['
|
|
7753
|
+
if (tagsMatchMode !== undefined) {
|
|
7754
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
7451
7755
|
}
|
|
7452
|
-
if (
|
|
7453
|
-
localVarQueryParameter['
|
|
7756
|
+
if (tagsExclude !== undefined) {
|
|
7757
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
7454
7758
|
}
|
|
7455
|
-
if (
|
|
7456
|
-
localVarQueryParameter['
|
|
7759
|
+
if (tagKeyFilter !== undefined) {
|
|
7760
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
7457
7761
|
}
|
|
7458
|
-
if (
|
|
7459
|
-
localVarQueryParameter['
|
|
7762
|
+
if (tagValueFilter !== undefined) {
|
|
7763
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
7460
7764
|
}
|
|
7461
|
-
if (
|
|
7462
|
-
localVarQueryParameter['
|
|
7765
|
+
if (compareMode !== undefined) {
|
|
7766
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
7767
|
+
}
|
|
7768
|
+
if (compareStartTime !== undefined) {
|
|
7769
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
7770
|
+
}
|
|
7771
|
+
if (compareEndTime !== undefined) {
|
|
7772
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
7773
|
+
}
|
|
7774
|
+
if (compareAnalyticsTags !== undefined) {
|
|
7775
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
7776
|
+
}
|
|
7777
|
+
if (compareTagsMatchMode !== undefined) {
|
|
7778
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
7779
|
+
}
|
|
7780
|
+
if (compareTagsExclude !== undefined) {
|
|
7781
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
7782
|
+
}
|
|
7783
|
+
if (compareTagKeyFilter !== undefined) {
|
|
7784
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
7785
|
+
}
|
|
7786
|
+
if (compareTagValueFilter !== undefined) {
|
|
7787
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
7788
|
+
}
|
|
7789
|
+
if (resultsPage !== undefined) {
|
|
7790
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
7791
|
+
}
|
|
7792
|
+
if (resultsPageSize !== undefined) {
|
|
7793
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
7794
|
+
}
|
|
7795
|
+
if (filtersPage !== undefined) {
|
|
7796
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
7797
|
+
}
|
|
7798
|
+
if (filtersPageSize !== undefined) {
|
|
7799
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
7800
|
+
}
|
|
7801
|
+
if (geoPage !== undefined) {
|
|
7802
|
+
localVarQueryParameter['geo_page'] = geoPage;
|
|
7803
|
+
}
|
|
7804
|
+
if (geoPageSize !== undefined) {
|
|
7805
|
+
localVarQueryParameter['geo_page_size'] = geoPageSize;
|
|
7806
|
+
}
|
|
7807
|
+
if (groupBy !== undefined) {
|
|
7808
|
+
localVarQueryParameter['group_by'] = groupBy;
|
|
7809
|
+
}
|
|
7810
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7811
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7812
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
7813
|
+
return {
|
|
7814
|
+
url: toPathString(localVarUrlObj),
|
|
7815
|
+
options: localVarRequestOptions,
|
|
7816
|
+
};
|
|
7817
|
+
}),
|
|
7818
|
+
/**
|
|
7819
|
+
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
7820
|
+
* @summary Get Item Performance Analytics
|
|
7821
|
+
* @param {string} xStoreID Store ID
|
|
7822
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
7823
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
7824
|
+
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
7825
|
+
* @param {number} [itemLimit] Maximum number of items to return
|
|
7826
|
+
* @param {number} [minImpressions] Minimum number of impressions required
|
|
7827
|
+
* @param {number} [maxPosition] Maximum position to include
|
|
7828
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortByEnum} [sortBy] Field to sort by
|
|
7829
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortOrderEnum} [sortOrder] Sort direction
|
|
7830
|
+
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
7831
|
+
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
7832
|
+
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
7833
|
+
* @param {number} [page] Page number for pagination
|
|
7834
|
+
* @param {number} [pageSize] Number of results per page
|
|
7835
|
+
* @param {*} [options] Override http request option.
|
|
7836
|
+
* @throws {RequiredError}
|
|
7837
|
+
*/
|
|
7838
|
+
adminAnalyticsStoreXStoreIDItemsPerformanceGet: (xStoreID_1, startTime_1, endTime_1, itemIds_1, itemLimit_1, minImpressions_1, maxPosition_1, sortBy_1, sortOrder_1, sort_1, limit_1, offset_1, page_1, pageSize_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, itemIds_1, itemLimit_1, minImpressions_1, maxPosition_1, sortBy_1, sortOrder_1, sort_1, limit_1, offset_1, page_1, pageSize_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, itemIds, itemLimit, minImpressions, maxPosition, sortBy, sortOrder, sort, limit, offset, page, pageSize, options = {}) {
|
|
7839
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
7840
|
+
assertParamExists('adminAnalyticsStoreXStoreIDItemsPerformanceGet', 'xStoreID', xStoreID);
|
|
7841
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/items/performance`
|
|
7842
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
7843
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7844
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7845
|
+
let baseOptions;
|
|
7846
|
+
if (configuration) {
|
|
7847
|
+
baseOptions = configuration.baseOptions;
|
|
7848
|
+
}
|
|
7849
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
7850
|
+
const localVarHeaderParameter = {};
|
|
7851
|
+
const localVarQueryParameter = {};
|
|
7852
|
+
// authentication BearerAuth required
|
|
7853
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
7854
|
+
if (startTime !== undefined) {
|
|
7855
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
7856
|
+
}
|
|
7857
|
+
if (endTime !== undefined) {
|
|
7858
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
7859
|
+
}
|
|
7860
|
+
if (itemIds !== undefined) {
|
|
7861
|
+
localVarQueryParameter['item_ids'] = itemIds;
|
|
7862
|
+
}
|
|
7863
|
+
if (itemLimit !== undefined) {
|
|
7864
|
+
localVarQueryParameter['item_limit'] = itemLimit;
|
|
7865
|
+
}
|
|
7866
|
+
if (minImpressions !== undefined) {
|
|
7867
|
+
localVarQueryParameter['min_impressions'] = minImpressions;
|
|
7868
|
+
}
|
|
7869
|
+
if (maxPosition !== undefined) {
|
|
7870
|
+
localVarQueryParameter['max_position'] = maxPosition;
|
|
7871
|
+
}
|
|
7872
|
+
if (sortBy !== undefined) {
|
|
7873
|
+
localVarQueryParameter['sort_by'] = sortBy;
|
|
7874
|
+
}
|
|
7875
|
+
if (sortOrder !== undefined) {
|
|
7876
|
+
localVarQueryParameter['sort_order'] = sortOrder;
|
|
7877
|
+
}
|
|
7878
|
+
if (sort !== undefined) {
|
|
7879
|
+
localVarQueryParameter['sort'] = sort;
|
|
7463
7880
|
}
|
|
7464
7881
|
if (limit !== undefined) {
|
|
7465
7882
|
localVarQueryParameter['limit'] = limit;
|
|
@@ -7748,6 +8165,45 @@ export const ItemAnalyticsApiFp = function (configuration) {
|
|
|
7748
8165
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7749
8166
|
});
|
|
7750
8167
|
},
|
|
8168
|
+
/**
|
|
8169
|
+
* Retrieve comprehensive analytics insights for a specific item including all core metrics (Total Searches, Results Shown, Impressions, Clicks, Conversions, Revenue, CTR, CVR, Conversion Rate per Search, No-Click Rate, Avg Result Rank, Avg Click Position), popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
8170
|
+
* @summary Get Item Insights
|
|
8171
|
+
* @param {string} xStoreID Store ID
|
|
8172
|
+
* @param {string} itemId Item ID to analyze
|
|
8173
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
8174
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
8175
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
8176
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
8177
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
8178
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
8179
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
8180
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
8181
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
8182
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
8183
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
8184
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
8185
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
8186
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
8187
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
8188
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
8189
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
8190
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
8191
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
8192
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
8193
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
8194
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
8195
|
+
* @param {*} [options] Override http request option.
|
|
8196
|
+
* @throws {RequiredError}
|
|
8197
|
+
*/
|
|
8198
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options) {
|
|
8199
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8200
|
+
var _a, _b, _c;
|
|
8201
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options);
|
|
8202
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8203
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ItemAnalyticsApi.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8204
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8205
|
+
});
|
|
8206
|
+
},
|
|
7751
8207
|
/**
|
|
7752
8208
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
7753
8209
|
* @summary Get Item Performance Analytics
|
|
@@ -7915,6 +8371,39 @@ export const ItemAnalyticsApiFactory = function (configuration, basePath, axios)
|
|
|
7915
8371
|
adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options) {
|
|
7916
8372
|
return localVarFp.adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
7917
8373
|
},
|
|
8374
|
+
/**
|
|
8375
|
+
* Retrieve comprehensive analytics insights for a specific item including all core metrics (Total Searches, Results Shown, Impressions, Clicks, Conversions, Revenue, CTR, CVR, Conversion Rate per Search, No-Click Rate, Avg Result Rank, Avg Click Position), popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
8376
|
+
* @summary Get Item Insights
|
|
8377
|
+
* @param {string} xStoreID Store ID
|
|
8378
|
+
* @param {string} itemId Item ID to analyze
|
|
8379
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
8380
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
8381
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
8382
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
8383
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
8384
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
8385
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
8386
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
8387
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
8388
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
8389
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
8390
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
8391
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
8392
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
8393
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
8394
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
8395
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
8396
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
8397
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
8398
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
8399
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
8400
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
8401
|
+
* @param {*} [options] Override http request option.
|
|
8402
|
+
* @throws {RequiredError}
|
|
8403
|
+
*/
|
|
8404
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options) {
|
|
8405
|
+
return localVarFp.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options).then((request) => request(axios, basePath));
|
|
8406
|
+
},
|
|
7918
8407
|
/**
|
|
7919
8408
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
7920
8409
|
* @summary Get Item Performance Analytics
|
|
@@ -8068,6 +8557,40 @@ export class ItemAnalyticsApi extends BaseAPI {
|
|
|
8068
8557
|
adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options) {
|
|
8069
8558
|
return ItemAnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
|
|
8070
8559
|
}
|
|
8560
|
+
/**
|
|
8561
|
+
* Retrieve comprehensive analytics insights for a specific item including all core metrics (Total Searches, Results Shown, Impressions, Clicks, Conversions, Revenue, CTR, CVR, Conversion Rate per Search, No-Click Rate, Avg Result Rank, Avg Click Position), popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
8562
|
+
* @summary Get Item Insights
|
|
8563
|
+
* @param {string} xStoreID Store ID
|
|
8564
|
+
* @param {string} itemId Item ID to analyze
|
|
8565
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
8566
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
8567
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
8568
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
8569
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
8570
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
8571
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
8572
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
8573
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
8574
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
8575
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
8576
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
8577
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
8578
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
8579
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
8580
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
8581
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
8582
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
8583
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
8584
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
8585
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
8586
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
8587
|
+
* @param {*} [options] Override http request option.
|
|
8588
|
+
* @throws {RequiredError}
|
|
8589
|
+
* @memberof ItemAnalyticsApi
|
|
8590
|
+
*/
|
|
8591
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options) {
|
|
8592
|
+
return ItemAnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options).then((request) => request(this.axios, this.basePath));
|
|
8593
|
+
}
|
|
8071
8594
|
/**
|
|
8072
8595
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
8073
8596
|
* @summary Get Item Performance Analytics
|
|
@@ -8172,6 +8695,26 @@ export const AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum = {
|
|
|
8172
8695
|
Asc: 'asc',
|
|
8173
8696
|
Desc: 'desc'
|
|
8174
8697
|
};
|
|
8698
|
+
/**
|
|
8699
|
+
* @export
|
|
8700
|
+
*/
|
|
8701
|
+
export const AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum = {
|
|
8702
|
+
Any: 'any',
|
|
8703
|
+
All: 'all'
|
|
8704
|
+
};
|
|
8705
|
+
/**
|
|
8706
|
+
* @export
|
|
8707
|
+
*/
|
|
8708
|
+
export const AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum = {
|
|
8709
|
+
Any: 'any',
|
|
8710
|
+
All: 'all'
|
|
8711
|
+
};
|
|
8712
|
+
/**
|
|
8713
|
+
* @export
|
|
8714
|
+
*/
|
|
8715
|
+
export const AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum = {
|
|
8716
|
+
Date: 'date'
|
|
8717
|
+
};
|
|
8175
8718
|
/**
|
|
8176
8719
|
* @export
|
|
8177
8720
|
*/
|
|
@@ -14345,6 +14888,1460 @@ export class PluralsDeclensionsApi extends BaseAPI {
|
|
|
14345
14888
|
return PluralsDeclensionsApiFp(this.configuration).adminStoresXStoreIDPluralsDeclensionsUploadJsonPost(xStoreID, file, options).then((request) => request(this.axios, this.basePath));
|
|
14346
14889
|
}
|
|
14347
14890
|
}
|
|
14891
|
+
/**
|
|
14892
|
+
* QuerySuggestionsApi - axios parameter creator
|
|
14893
|
+
* @export
|
|
14894
|
+
*/
|
|
14895
|
+
export const QuerySuggestionsApiAxiosParamCreator = function (configuration) {
|
|
14896
|
+
return {
|
|
14897
|
+
/**
|
|
14898
|
+
* Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
|
|
14899
|
+
* @summary Get Query Suggestions Configuration
|
|
14900
|
+
* @param {string} xStoreid Store ID
|
|
14901
|
+
* @param {string} xStoresecret Store Secret
|
|
14902
|
+
* @param {*} [options] Override http request option.
|
|
14903
|
+
* @throws {RequiredError}
|
|
14904
|
+
*/
|
|
14905
|
+
v1SuggestionsConfigGet: (xStoreid_1, xStoresecret_1, ...args_1) => __awaiter(this, [xStoreid_1, xStoresecret_1, ...args_1], void 0, function* (xStoreid, xStoresecret, options = {}) {
|
|
14906
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
14907
|
+
assertParamExists('v1SuggestionsConfigGet', 'xStoreid', xStoreid);
|
|
14908
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
14909
|
+
assertParamExists('v1SuggestionsConfigGet', 'xStoresecret', xStoresecret);
|
|
14910
|
+
const localVarPath = `/v1/suggestions/config`;
|
|
14911
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14912
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14913
|
+
let baseOptions;
|
|
14914
|
+
if (configuration) {
|
|
14915
|
+
baseOptions = configuration.baseOptions;
|
|
14916
|
+
}
|
|
14917
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
14918
|
+
const localVarHeaderParameter = {};
|
|
14919
|
+
const localVarQueryParameter = {};
|
|
14920
|
+
if (xStoreid != null) {
|
|
14921
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
14922
|
+
}
|
|
14923
|
+
if (xStoresecret != null) {
|
|
14924
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
14925
|
+
}
|
|
14926
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14927
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14928
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
14929
|
+
return {
|
|
14930
|
+
url: toPathString(localVarUrlObj),
|
|
14931
|
+
options: localVarRequestOptions,
|
|
14932
|
+
};
|
|
14933
|
+
}),
|
|
14934
|
+
/**
|
|
14935
|
+
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges.
|
|
14936
|
+
* @summary Get Query Suggestions
|
|
14937
|
+
* @param {string} xStoreid Store ID
|
|
14938
|
+
* @param {string} xStoresecret Store Secret
|
|
14939
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
14940
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
14941
|
+
* @param {number} [page] Page number for pagination
|
|
14942
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
14943
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
14944
|
+
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
14945
|
+
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
14946
|
+
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
14947
|
+
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
14948
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
14949
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
14950
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
14951
|
+
* @param {*} [options] Override http request option.
|
|
14952
|
+
* @throws {RequiredError}
|
|
14953
|
+
*/
|
|
14954
|
+
v1SuggestionsQueriesGet: (xStoreid_1, xStoresecret_1, query_1, hitsPerPage_1, page_1, analyticsTags_1, tagsMatchMode_1, includeCategories_1, includeFacets_1, maxCategories_1, maxFacets_1, minPopularity_1, timeRange_1, disableTypoTolerance_1, ...args_1) => __awaiter(this, [xStoreid_1, xStoresecret_1, query_1, hitsPerPage_1, page_1, analyticsTags_1, tagsMatchMode_1, includeCategories_1, includeFacets_1, maxCategories_1, maxFacets_1, minPopularity_1, timeRange_1, disableTypoTolerance_1, ...args_1], void 0, function* (xStoreid, xStoresecret, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options = {}) {
|
|
14955
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
14956
|
+
assertParamExists('v1SuggestionsQueriesGet', 'xStoreid', xStoreid);
|
|
14957
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
14958
|
+
assertParamExists('v1SuggestionsQueriesGet', 'xStoresecret', xStoresecret);
|
|
14959
|
+
const localVarPath = `/v1/suggestions/queries`;
|
|
14960
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14961
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14962
|
+
let baseOptions;
|
|
14963
|
+
if (configuration) {
|
|
14964
|
+
baseOptions = configuration.baseOptions;
|
|
14965
|
+
}
|
|
14966
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
14967
|
+
const localVarHeaderParameter = {};
|
|
14968
|
+
const localVarQueryParameter = {};
|
|
14969
|
+
if (query !== undefined) {
|
|
14970
|
+
localVarQueryParameter['query'] = query;
|
|
14971
|
+
}
|
|
14972
|
+
if (hitsPerPage !== undefined) {
|
|
14973
|
+
localVarQueryParameter['hitsPerPage'] = hitsPerPage;
|
|
14974
|
+
}
|
|
14975
|
+
if (page !== undefined) {
|
|
14976
|
+
localVarQueryParameter['page'] = page;
|
|
14977
|
+
}
|
|
14978
|
+
if (analyticsTags !== undefined) {
|
|
14979
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
14980
|
+
}
|
|
14981
|
+
if (tagsMatchMode !== undefined) {
|
|
14982
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
14983
|
+
}
|
|
14984
|
+
if (includeCategories !== undefined) {
|
|
14985
|
+
localVarQueryParameter['include_categories'] = includeCategories;
|
|
14986
|
+
}
|
|
14987
|
+
if (includeFacets !== undefined) {
|
|
14988
|
+
localVarQueryParameter['include_facets'] = includeFacets;
|
|
14989
|
+
}
|
|
14990
|
+
if (maxCategories !== undefined) {
|
|
14991
|
+
localVarQueryParameter['max_categories'] = maxCategories;
|
|
14992
|
+
}
|
|
14993
|
+
if (maxFacets !== undefined) {
|
|
14994
|
+
localVarQueryParameter['max_facets'] = maxFacets;
|
|
14995
|
+
}
|
|
14996
|
+
if (minPopularity !== undefined) {
|
|
14997
|
+
localVarQueryParameter['min_popularity'] = minPopularity;
|
|
14998
|
+
}
|
|
14999
|
+
if (timeRange !== undefined) {
|
|
15000
|
+
localVarQueryParameter['time_range'] = timeRange;
|
|
15001
|
+
}
|
|
15002
|
+
if (disableTypoTolerance !== undefined) {
|
|
15003
|
+
localVarQueryParameter['disable_typo_tolerance'] = disableTypoTolerance;
|
|
15004
|
+
}
|
|
15005
|
+
if (xStoreid != null) {
|
|
15006
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
15007
|
+
}
|
|
15008
|
+
if (xStoresecret != null) {
|
|
15009
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
15010
|
+
}
|
|
15011
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15012
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15013
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15014
|
+
return {
|
|
15015
|
+
url: toPathString(localVarUrlObj),
|
|
15016
|
+
options: localVarRequestOptions,
|
|
15017
|
+
};
|
|
15018
|
+
}),
|
|
15019
|
+
};
|
|
15020
|
+
};
|
|
15021
|
+
/**
|
|
15022
|
+
* QuerySuggestionsApi - functional programming interface
|
|
15023
|
+
* @export
|
|
15024
|
+
*/
|
|
15025
|
+
export const QuerySuggestionsApiFp = function (configuration) {
|
|
15026
|
+
const localVarAxiosParamCreator = QuerySuggestionsApiAxiosParamCreator(configuration);
|
|
15027
|
+
return {
|
|
15028
|
+
/**
|
|
15029
|
+
* Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
|
|
15030
|
+
* @summary Get Query Suggestions Configuration
|
|
15031
|
+
* @param {string} xStoreid Store ID
|
|
15032
|
+
* @param {string} xStoresecret Store Secret
|
|
15033
|
+
* @param {*} [options] Override http request option.
|
|
15034
|
+
* @throws {RequiredError}
|
|
15035
|
+
*/
|
|
15036
|
+
v1SuggestionsConfigGet(xStoreid, xStoresecret, options) {
|
|
15037
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15038
|
+
var _a, _b, _c;
|
|
15039
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1SuggestionsConfigGet(xStoreid, xStoresecret, options);
|
|
15040
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15041
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsApi.v1SuggestionsConfigGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15042
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15043
|
+
});
|
|
15044
|
+
},
|
|
15045
|
+
/**
|
|
15046
|
+
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges.
|
|
15047
|
+
* @summary Get Query Suggestions
|
|
15048
|
+
* @param {string} xStoreid Store ID
|
|
15049
|
+
* @param {string} xStoresecret Store Secret
|
|
15050
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
15051
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
15052
|
+
* @param {number} [page] Page number for pagination
|
|
15053
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
15054
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
15055
|
+
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
15056
|
+
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
15057
|
+
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
15058
|
+
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
15059
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15060
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
15061
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
15062
|
+
* @param {*} [options] Override http request option.
|
|
15063
|
+
* @throws {RequiredError}
|
|
15064
|
+
*/
|
|
15065
|
+
v1SuggestionsQueriesGet(xStoreid, xStoresecret, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options) {
|
|
15066
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15067
|
+
var _a, _b, _c;
|
|
15068
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1SuggestionsQueriesGet(xStoreid, xStoresecret, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options);
|
|
15069
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15070
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsApi.v1SuggestionsQueriesGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15071
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15072
|
+
});
|
|
15073
|
+
},
|
|
15074
|
+
};
|
|
15075
|
+
};
|
|
15076
|
+
/**
|
|
15077
|
+
* QuerySuggestionsApi - factory interface
|
|
15078
|
+
* @export
|
|
15079
|
+
*/
|
|
15080
|
+
export const QuerySuggestionsApiFactory = function (configuration, basePath, axios) {
|
|
15081
|
+
const localVarFp = QuerySuggestionsApiFp(configuration);
|
|
15082
|
+
return {
|
|
15083
|
+
/**
|
|
15084
|
+
* Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
|
|
15085
|
+
* @summary Get Query Suggestions Configuration
|
|
15086
|
+
* @param {string} xStoreid Store ID
|
|
15087
|
+
* @param {string} xStoresecret Store Secret
|
|
15088
|
+
* @param {*} [options] Override http request option.
|
|
15089
|
+
* @throws {RequiredError}
|
|
15090
|
+
*/
|
|
15091
|
+
v1SuggestionsConfigGet(xStoreid, xStoresecret, options) {
|
|
15092
|
+
return localVarFp.v1SuggestionsConfigGet(xStoreid, xStoresecret, options).then((request) => request(axios, basePath));
|
|
15093
|
+
},
|
|
15094
|
+
/**
|
|
15095
|
+
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges.
|
|
15096
|
+
* @summary Get Query Suggestions
|
|
15097
|
+
* @param {string} xStoreid Store ID
|
|
15098
|
+
* @param {string} xStoresecret Store Secret
|
|
15099
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
15100
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
15101
|
+
* @param {number} [page] Page number for pagination
|
|
15102
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
15103
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
15104
|
+
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
15105
|
+
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
15106
|
+
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
15107
|
+
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
15108
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15109
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
15110
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
15111
|
+
* @param {*} [options] Override http request option.
|
|
15112
|
+
* @throws {RequiredError}
|
|
15113
|
+
*/
|
|
15114
|
+
v1SuggestionsQueriesGet(xStoreid, xStoresecret, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options) {
|
|
15115
|
+
return localVarFp.v1SuggestionsQueriesGet(xStoreid, xStoresecret, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options).then((request) => request(axios, basePath));
|
|
15116
|
+
},
|
|
15117
|
+
};
|
|
15118
|
+
};
|
|
15119
|
+
/**
|
|
15120
|
+
* QuerySuggestionsApi - object-oriented interface
|
|
15121
|
+
* @export
|
|
15122
|
+
* @class QuerySuggestionsApi
|
|
15123
|
+
* @extends {BaseAPI}
|
|
15124
|
+
*/
|
|
15125
|
+
export class QuerySuggestionsApi extends BaseAPI {
|
|
15126
|
+
/**
|
|
15127
|
+
* Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
|
|
15128
|
+
* @summary Get Query Suggestions Configuration
|
|
15129
|
+
* @param {string} xStoreid Store ID
|
|
15130
|
+
* @param {string} xStoresecret Store Secret
|
|
15131
|
+
* @param {*} [options] Override http request option.
|
|
15132
|
+
* @throws {RequiredError}
|
|
15133
|
+
* @memberof QuerySuggestionsApi
|
|
15134
|
+
*/
|
|
15135
|
+
v1SuggestionsConfigGet(xStoreid, xStoresecret, options) {
|
|
15136
|
+
return QuerySuggestionsApiFp(this.configuration).v1SuggestionsConfigGet(xStoreid, xStoresecret, options).then((request) => request(this.axios, this.basePath));
|
|
15137
|
+
}
|
|
15138
|
+
/**
|
|
15139
|
+
* Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges.
|
|
15140
|
+
* @summary Get Query Suggestions
|
|
15141
|
+
* @param {string} xStoreid Store ID
|
|
15142
|
+
* @param {string} xStoresecret Store Secret
|
|
15143
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
15144
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
15145
|
+
* @param {number} [page] Page number for pagination
|
|
15146
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
|
|
15147
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
|
|
15148
|
+
* @param {boolean} [includeCategories] Include category information in suggestions
|
|
15149
|
+
* @param {boolean} [includeFacets] Include popular facets/filters information
|
|
15150
|
+
* @param {number} [maxCategories] Maximum categories per suggestion
|
|
15151
|
+
* @param {number} [maxFacets] Maximum facets per suggestion
|
|
15152
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15153
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
|
|
15154
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
|
|
15155
|
+
* @param {*} [options] Override http request option.
|
|
15156
|
+
* @throws {RequiredError}
|
|
15157
|
+
* @memberof QuerySuggestionsApi
|
|
15158
|
+
*/
|
|
15159
|
+
v1SuggestionsQueriesGet(xStoreid, xStoresecret, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options) {
|
|
15160
|
+
return QuerySuggestionsApiFp(this.configuration).v1SuggestionsQueriesGet(xStoreid, xStoresecret, query, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, options).then((request) => request(this.axios, this.basePath));
|
|
15161
|
+
}
|
|
15162
|
+
}
|
|
15163
|
+
/**
|
|
15164
|
+
* @export
|
|
15165
|
+
*/
|
|
15166
|
+
export const V1SuggestionsQueriesGetTagsMatchModeEnum = {
|
|
15167
|
+
Any: 'any',
|
|
15168
|
+
All: 'all'
|
|
15169
|
+
};
|
|
15170
|
+
/**
|
|
15171
|
+
* @export
|
|
15172
|
+
*/
|
|
15173
|
+
export const V1SuggestionsQueriesGetTimeRangeEnum = {
|
|
15174
|
+
_7d: '7d',
|
|
15175
|
+
_30d: '30d',
|
|
15176
|
+
_90d: '90d'
|
|
15177
|
+
};
|
|
15178
|
+
/**
|
|
15179
|
+
* QuerySuggestionsManagementApi - axios parameter creator
|
|
15180
|
+
* @export
|
|
15181
|
+
*/
|
|
15182
|
+
export const QuerySuggestionsManagementApiAxiosParamCreator = function (configuration) {
|
|
15183
|
+
return {
|
|
15184
|
+
/**
|
|
15185
|
+
* Migrate existing analytics data for all stores (admin only)
|
|
15186
|
+
* @summary Migrate All Stores Data
|
|
15187
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
15188
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15189
|
+
* @param {*} [options] Override http request option.
|
|
15190
|
+
* @throws {RequiredError}
|
|
15191
|
+
*/
|
|
15192
|
+
adminAnalyticsQuerySuggestionsMigrateAllPost: (daysBack_1, minPopularity_1, ...args_1) => __awaiter(this, [daysBack_1, minPopularity_1, ...args_1], void 0, function* (daysBack, minPopularity, options = {}) {
|
|
15193
|
+
const localVarPath = `/admin/analytics/query-suggestions/migrate-all`;
|
|
15194
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15195
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15196
|
+
let baseOptions;
|
|
15197
|
+
if (configuration) {
|
|
15198
|
+
baseOptions = configuration.baseOptions;
|
|
15199
|
+
}
|
|
15200
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15201
|
+
const localVarHeaderParameter = {};
|
|
15202
|
+
const localVarQueryParameter = {};
|
|
15203
|
+
// authentication BearerAuth required
|
|
15204
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
15205
|
+
if (daysBack !== undefined) {
|
|
15206
|
+
localVarQueryParameter['days_back'] = daysBack;
|
|
15207
|
+
}
|
|
15208
|
+
if (minPopularity !== undefined) {
|
|
15209
|
+
localVarQueryParameter['min_popularity'] = minPopularity;
|
|
15210
|
+
}
|
|
15211
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15212
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15213
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15214
|
+
return {
|
|
15215
|
+
url: toPathString(localVarUrlObj),
|
|
15216
|
+
options: localVarRequestOptions,
|
|
15217
|
+
};
|
|
15218
|
+
}),
|
|
15219
|
+
/**
|
|
15220
|
+
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
15221
|
+
* @summary Bulk Update Suggestions
|
|
15222
|
+
* @param {string} xStoreID Store ID
|
|
15223
|
+
* @param {AnalyticsBulkOperationRequest} body Bulk operation request
|
|
15224
|
+
* @param {*} [options] Override http request option.
|
|
15225
|
+
* @throws {RequiredError}
|
|
15226
|
+
*/
|
|
15227
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost: (xStoreID_1, body_1, ...args_1) => __awaiter(this, [xStoreID_1, body_1, ...args_1], void 0, function* (xStoreID, body, options = {}) {
|
|
15228
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15229
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost', 'xStoreID', xStoreID);
|
|
15230
|
+
// verify required parameter 'body' is not null or undefined
|
|
15231
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost', 'body', body);
|
|
15232
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/bulk`
|
|
15233
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15234
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15235
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15236
|
+
let baseOptions;
|
|
15237
|
+
if (configuration) {
|
|
15238
|
+
baseOptions = configuration.baseOptions;
|
|
15239
|
+
}
|
|
15240
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15241
|
+
const localVarHeaderParameter = {};
|
|
15242
|
+
const localVarQueryParameter = {};
|
|
15243
|
+
// authentication BearerAuth required
|
|
15244
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
15245
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
15246
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15247
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15248
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15249
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
15250
|
+
return {
|
|
15251
|
+
url: toPathString(localVarUrlObj),
|
|
15252
|
+
options: localVarRequestOptions,
|
|
15253
|
+
};
|
|
15254
|
+
}),
|
|
15255
|
+
/**
|
|
15256
|
+
* Retrieve auto-generated suggestions from cache for review before promoting to management table
|
|
15257
|
+
* @summary Get Cached Auto-Generated Suggestions
|
|
15258
|
+
* @param {string} xStoreID Store ID
|
|
15259
|
+
* @param {number} [page] Page number
|
|
15260
|
+
* @param {number} [pageSize] Items per page
|
|
15261
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15262
|
+
* @param {*} [options] Override http request option.
|
|
15263
|
+
* @throws {RequiredError}
|
|
15264
|
+
*/
|
|
15265
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet: (xStoreID_1, page_1, pageSize_1, minPopularity_1, ...args_1) => __awaiter(this, [xStoreID_1, page_1, pageSize_1, minPopularity_1, ...args_1], void 0, function* (xStoreID, page, pageSize, minPopularity, options = {}) {
|
|
15266
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15267
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet', 'xStoreID', xStoreID);
|
|
15268
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/cached`
|
|
15269
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15270
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15271
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15272
|
+
let baseOptions;
|
|
15273
|
+
if (configuration) {
|
|
15274
|
+
baseOptions = configuration.baseOptions;
|
|
15275
|
+
}
|
|
15276
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
15277
|
+
const localVarHeaderParameter = {};
|
|
15278
|
+
const localVarQueryParameter = {};
|
|
15279
|
+
// authentication BearerAuth required
|
|
15280
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
15281
|
+
if (page !== undefined) {
|
|
15282
|
+
localVarQueryParameter['page'] = page;
|
|
15283
|
+
}
|
|
15284
|
+
if (pageSize !== undefined) {
|
|
15285
|
+
localVarQueryParameter['page_size'] = pageSize;
|
|
15286
|
+
}
|
|
15287
|
+
if (minPopularity !== undefined) {
|
|
15288
|
+
localVarQueryParameter['min_popularity'] = minPopularity;
|
|
15289
|
+
}
|
|
15290
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15291
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15292
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15293
|
+
return {
|
|
15294
|
+
url: toPathString(localVarUrlObj),
|
|
15295
|
+
options: localVarRequestOptions,
|
|
15296
|
+
};
|
|
15297
|
+
}),
|
|
15298
|
+
/**
|
|
15299
|
+
* Retrieve query suggestions with filtering and pagination for management
|
|
15300
|
+
* @summary Get Query Suggestions
|
|
15301
|
+
* @param {string} xStoreID Store ID
|
|
15302
|
+
* @param {string} [source] Filter by source (auto_generated, manual, imported)
|
|
15303
|
+
* @param {string} [status] Filter by status (enabled, disabled)
|
|
15304
|
+
* @param {string} [query] Search within query text
|
|
15305
|
+
* @param {string} [category] Filter by category
|
|
15306
|
+
* @param {string} [tag] Filter by tag
|
|
15307
|
+
* @param {number} [page] Page number
|
|
15308
|
+
* @param {number} [pageSize] Number of items per page
|
|
15309
|
+
* @param {*} [options] Override http request option.
|
|
15310
|
+
* @throws {RequiredError}
|
|
15311
|
+
*/
|
|
15312
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsGet: (xStoreID_1, source_1, status_1, query_1, category_1, tag_1, page_1, pageSize_1, ...args_1) => __awaiter(this, [xStoreID_1, source_1, status_1, query_1, category_1, tag_1, page_1, pageSize_1, ...args_1], void 0, function* (xStoreID, source, status, query, category, tag, page, pageSize, options = {}) {
|
|
15313
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15314
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsGet', 'xStoreID', xStoreID);
|
|
15315
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions`
|
|
15316
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15317
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15318
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15319
|
+
let baseOptions;
|
|
15320
|
+
if (configuration) {
|
|
15321
|
+
baseOptions = configuration.baseOptions;
|
|
15322
|
+
}
|
|
15323
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
15324
|
+
const localVarHeaderParameter = {};
|
|
15325
|
+
const localVarQueryParameter = {};
|
|
15326
|
+
// authentication BearerAuth required
|
|
15327
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
15328
|
+
if (source !== undefined) {
|
|
15329
|
+
localVarQueryParameter['source'] = source;
|
|
15330
|
+
}
|
|
15331
|
+
if (status !== undefined) {
|
|
15332
|
+
localVarQueryParameter['status'] = status;
|
|
15333
|
+
}
|
|
15334
|
+
if (query !== undefined) {
|
|
15335
|
+
localVarQueryParameter['query'] = query;
|
|
15336
|
+
}
|
|
15337
|
+
if (category !== undefined) {
|
|
15338
|
+
localVarQueryParameter['category'] = category;
|
|
15339
|
+
}
|
|
15340
|
+
if (tag !== undefined) {
|
|
15341
|
+
localVarQueryParameter['tag'] = tag;
|
|
15342
|
+
}
|
|
15343
|
+
if (page !== undefined) {
|
|
15344
|
+
localVarQueryParameter['page'] = page;
|
|
15345
|
+
}
|
|
15346
|
+
if (pageSize !== undefined) {
|
|
15347
|
+
localVarQueryParameter['page_size'] = pageSize;
|
|
15348
|
+
}
|
|
15349
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15350
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15351
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15352
|
+
return {
|
|
15353
|
+
url: toPathString(localVarUrlObj),
|
|
15354
|
+
options: localVarRequestOptions,
|
|
15355
|
+
};
|
|
15356
|
+
}),
|
|
15357
|
+
/**
|
|
15358
|
+
* Import query suggestions from JSON data
|
|
15359
|
+
* @summary Import Query Suggestions
|
|
15360
|
+
* @param {string} xStoreID Store ID
|
|
15361
|
+
* @param {AnalyticsImportQuerySuggestionsRequest} body Import suggestions request
|
|
15362
|
+
* @param {*} [options] Override http request option.
|
|
15363
|
+
* @throws {RequiredError}
|
|
15364
|
+
*/
|
|
15365
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost: (xStoreID_1, body_1, ...args_1) => __awaiter(this, [xStoreID_1, body_1, ...args_1], void 0, function* (xStoreID, body, options = {}) {
|
|
15366
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15367
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost', 'xStoreID', xStoreID);
|
|
15368
|
+
// verify required parameter 'body' is not null or undefined
|
|
15369
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost', 'body', body);
|
|
15370
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/import`
|
|
15371
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15372
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15373
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15374
|
+
let baseOptions;
|
|
15375
|
+
if (configuration) {
|
|
15376
|
+
baseOptions = configuration.baseOptions;
|
|
15377
|
+
}
|
|
15378
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15379
|
+
const localVarHeaderParameter = {};
|
|
15380
|
+
const localVarQueryParameter = {};
|
|
15381
|
+
// authentication BearerAuth required
|
|
15382
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
15383
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
15384
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15385
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15386
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15387
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
15388
|
+
return {
|
|
15389
|
+
url: toPathString(localVarUrlObj),
|
|
15390
|
+
options: localVarRequestOptions,
|
|
15391
|
+
};
|
|
15392
|
+
}),
|
|
15393
|
+
/**
|
|
15394
|
+
* Add a manually created query suggestion for a store
|
|
15395
|
+
* @summary Add Manual Query Suggestion
|
|
15396
|
+
* @param {string} xStoreID Store ID
|
|
15397
|
+
* @param {AnalyticsManualQuerySuggestionRequest} body Manual suggestion request
|
|
15398
|
+
* @param {*} [options] Override http request option.
|
|
15399
|
+
* @throws {RequiredError}
|
|
15400
|
+
*/
|
|
15401
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost: (xStoreID_1, body_1, ...args_1) => __awaiter(this, [xStoreID_1, body_1, ...args_1], void 0, function* (xStoreID, body, options = {}) {
|
|
15402
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15403
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost', 'xStoreID', xStoreID);
|
|
15404
|
+
// verify required parameter 'body' is not null or undefined
|
|
15405
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost', 'body', body);
|
|
15406
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/manual`
|
|
15407
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15408
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15409
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15410
|
+
let baseOptions;
|
|
15411
|
+
if (configuration) {
|
|
15412
|
+
baseOptions = configuration.baseOptions;
|
|
15413
|
+
}
|
|
15414
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15415
|
+
const localVarHeaderParameter = {};
|
|
15416
|
+
const localVarQueryParameter = {};
|
|
15417
|
+
// authentication BearerAuth required
|
|
15418
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
15419
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
15420
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15421
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15422
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15423
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
15424
|
+
return {
|
|
15425
|
+
url: toPathString(localVarUrlObj),
|
|
15426
|
+
options: localVarRequestOptions,
|
|
15427
|
+
};
|
|
15428
|
+
}),
|
|
15429
|
+
/**
|
|
15430
|
+
* Migrate existing search analytics data to the new query suggestions management system
|
|
15431
|
+
* @summary Migrate Existing Analytics Data
|
|
15432
|
+
* @param {string} xStoreID Store ID
|
|
15433
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
15434
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15435
|
+
* @param {*} [options] Override http request option.
|
|
15436
|
+
* @throws {RequiredError}
|
|
15437
|
+
*/
|
|
15438
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost: (xStoreID_1, daysBack_1, minPopularity_1, ...args_1) => __awaiter(this, [xStoreID_1, daysBack_1, minPopularity_1, ...args_1], void 0, function* (xStoreID, daysBack, minPopularity, options = {}) {
|
|
15439
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15440
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost', 'xStoreID', xStoreID);
|
|
15441
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/migrate`
|
|
15442
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15443
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15444
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15445
|
+
let baseOptions;
|
|
15446
|
+
if (configuration) {
|
|
15447
|
+
baseOptions = configuration.baseOptions;
|
|
15448
|
+
}
|
|
15449
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15450
|
+
const localVarHeaderParameter = {};
|
|
15451
|
+
const localVarQueryParameter = {};
|
|
15452
|
+
// authentication BearerAuth required
|
|
15453
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
15454
|
+
if (daysBack !== undefined) {
|
|
15455
|
+
localVarQueryParameter['days_back'] = daysBack;
|
|
15456
|
+
}
|
|
15457
|
+
if (minPopularity !== undefined) {
|
|
15458
|
+
localVarQueryParameter['min_popularity'] = minPopularity;
|
|
15459
|
+
}
|
|
15460
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15461
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15462
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15463
|
+
return {
|
|
15464
|
+
url: toPathString(localVarUrlObj),
|
|
15465
|
+
options: localVarRequestOptions,
|
|
15466
|
+
};
|
|
15467
|
+
}),
|
|
15468
|
+
/**
|
|
15469
|
+
* Move ALL auto-generated suggestions from cache to the management table that meet minimum popularity criteria
|
|
15470
|
+
* @summary Promote ALL Cached Suggestions to Management Table
|
|
15471
|
+
* @param {string} xStoreID Store ID
|
|
15472
|
+
* @param {number} [minPopularity] Minimum popularity threshold (default: 5)
|
|
15473
|
+
* @param {*} [options] Override http request option.
|
|
15474
|
+
* @throws {RequiredError}
|
|
15475
|
+
*/
|
|
15476
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost: (xStoreID_1, minPopularity_1, ...args_1) => __awaiter(this, [xStoreID_1, minPopularity_1, ...args_1], void 0, function* (xStoreID, minPopularity, options = {}) {
|
|
15477
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15478
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost', 'xStoreID', xStoreID);
|
|
15479
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/promote-all`
|
|
15480
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15481
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15482
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15483
|
+
let baseOptions;
|
|
15484
|
+
if (configuration) {
|
|
15485
|
+
baseOptions = configuration.baseOptions;
|
|
15486
|
+
}
|
|
15487
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15488
|
+
const localVarHeaderParameter = {};
|
|
15489
|
+
const localVarQueryParameter = {};
|
|
15490
|
+
// authentication BearerAuth required
|
|
15491
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
15492
|
+
if (minPopularity !== undefined) {
|
|
15493
|
+
localVarQueryParameter['min_popularity'] = minPopularity;
|
|
15494
|
+
}
|
|
15495
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15496
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15497
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15498
|
+
return {
|
|
15499
|
+
url: toPathString(localVarUrlObj),
|
|
15500
|
+
options: localVarRequestOptions,
|
|
15501
|
+
};
|
|
15502
|
+
}),
|
|
15503
|
+
/**
|
|
15504
|
+
* Move selected auto-generated suggestions from cache to the management table
|
|
15505
|
+
* @summary Promote Cached Suggestions to Management Table
|
|
15506
|
+
* @param {string} xStoreID Store ID
|
|
15507
|
+
* @param {AnalyticsPromoteSuggestionsRequest} body Promotion request
|
|
15508
|
+
* @param {*} [options] Override http request option.
|
|
15509
|
+
* @throws {RequiredError}
|
|
15510
|
+
*/
|
|
15511
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost: (xStoreID_1, body_1, ...args_1) => __awaiter(this, [xStoreID_1, body_1, ...args_1], void 0, function* (xStoreID, body, options = {}) {
|
|
15512
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15513
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost', 'xStoreID', xStoreID);
|
|
15514
|
+
// verify required parameter 'body' is not null or undefined
|
|
15515
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost', 'body', body);
|
|
15516
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/promote`
|
|
15517
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15518
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15519
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15520
|
+
let baseOptions;
|
|
15521
|
+
if (configuration) {
|
|
15522
|
+
baseOptions = configuration.baseOptions;
|
|
15523
|
+
}
|
|
15524
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15525
|
+
const localVarHeaderParameter = {};
|
|
15526
|
+
const localVarQueryParameter = {};
|
|
15527
|
+
// authentication BearerAuth required
|
|
15528
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
15529
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
15530
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15531
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15532
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15533
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
15534
|
+
return {
|
|
15535
|
+
url: toPathString(localVarUrlObj),
|
|
15536
|
+
options: localVarRequestOptions,
|
|
15537
|
+
};
|
|
15538
|
+
}),
|
|
15539
|
+
/**
|
|
15540
|
+
* Refresh auto-generated suggestions from search analytics data
|
|
15541
|
+
* @summary Refresh Auto-Generated Suggestions
|
|
15542
|
+
* @param {string} xStoreID Store ID
|
|
15543
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15544
|
+
* @param {number} [days] Number of days to analyze
|
|
15545
|
+
* @param {*} [options] Override http request option.
|
|
15546
|
+
* @throws {RequiredError}
|
|
15547
|
+
*/
|
|
15548
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost: (xStoreID_1, minPopularity_1, days_1, ...args_1) => __awaiter(this, [xStoreID_1, minPopularity_1, days_1, ...args_1], void 0, function* (xStoreID, minPopularity, days, options = {}) {
|
|
15549
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15550
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost', 'xStoreID', xStoreID);
|
|
15551
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/refresh`
|
|
15552
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15553
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15554
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15555
|
+
let baseOptions;
|
|
15556
|
+
if (configuration) {
|
|
15557
|
+
baseOptions = configuration.baseOptions;
|
|
15558
|
+
}
|
|
15559
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15560
|
+
const localVarHeaderParameter = {};
|
|
15561
|
+
const localVarQueryParameter = {};
|
|
15562
|
+
// authentication BearerAuth required
|
|
15563
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
15564
|
+
if (minPopularity !== undefined) {
|
|
15565
|
+
localVarQueryParameter['min_popularity'] = minPopularity;
|
|
15566
|
+
}
|
|
15567
|
+
if (days !== undefined) {
|
|
15568
|
+
localVarQueryParameter['days'] = days;
|
|
15569
|
+
}
|
|
15570
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15571
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15572
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15573
|
+
return {
|
|
15574
|
+
url: toPathString(localVarUrlObj),
|
|
15575
|
+
options: localVarRequestOptions,
|
|
15576
|
+
};
|
|
15577
|
+
}),
|
|
15578
|
+
/**
|
|
15579
|
+
* Get statistics about query suggestions for a store
|
|
15580
|
+
* @summary Get Suggestion Statistics
|
|
15581
|
+
* @param {string} xStoreID Store ID
|
|
15582
|
+
* @param {*} [options] Override http request option.
|
|
15583
|
+
* @throws {RequiredError}
|
|
15584
|
+
*/
|
|
15585
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet: (xStoreID_1, ...args_1) => __awaiter(this, [xStoreID_1, ...args_1], void 0, function* (xStoreID, options = {}) {
|
|
15586
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15587
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet', 'xStoreID', xStoreID);
|
|
15588
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/stats`
|
|
15589
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15590
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15591
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15592
|
+
let baseOptions;
|
|
15593
|
+
if (configuration) {
|
|
15594
|
+
baseOptions = configuration.baseOptions;
|
|
15595
|
+
}
|
|
15596
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
15597
|
+
const localVarHeaderParameter = {};
|
|
15598
|
+
const localVarQueryParameter = {};
|
|
15599
|
+
// authentication BearerAuth required
|
|
15600
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
15601
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15602
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15603
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15604
|
+
return {
|
|
15605
|
+
url: toPathString(localVarUrlObj),
|
|
15606
|
+
options: localVarRequestOptions,
|
|
15607
|
+
};
|
|
15608
|
+
}),
|
|
15609
|
+
/**
|
|
15610
|
+
* Update the status (enabled/disabled) of a query suggestion
|
|
15611
|
+
* @summary Update Suggestion Status
|
|
15612
|
+
* @param {string} xStoreID Store ID
|
|
15613
|
+
* @param {string} suggestionID Suggestion ID
|
|
15614
|
+
* @param {string} status New status (enabled, disabled)
|
|
15615
|
+
* @param {*} [options] Override http request option.
|
|
15616
|
+
* @throws {RequiredError}
|
|
15617
|
+
*/
|
|
15618
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut: (xStoreID_1, suggestionID_1, status_1, ...args_1) => __awaiter(this, [xStoreID_1, suggestionID_1, status_1, ...args_1], void 0, function* (xStoreID, suggestionID, status, options = {}) {
|
|
15619
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15620
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut', 'xStoreID', xStoreID);
|
|
15621
|
+
// verify required parameter 'suggestionID' is not null or undefined
|
|
15622
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut', 'suggestionID', suggestionID);
|
|
15623
|
+
// verify required parameter 'status' is not null or undefined
|
|
15624
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut', 'status', status);
|
|
15625
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/{suggestionID}/status`
|
|
15626
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
15627
|
+
.replace(`{${"suggestionID"}}`, encodeURIComponent(String(suggestionID)));
|
|
15628
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15629
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15630
|
+
let baseOptions;
|
|
15631
|
+
if (configuration) {
|
|
15632
|
+
baseOptions = configuration.baseOptions;
|
|
15633
|
+
}
|
|
15634
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
15635
|
+
const localVarHeaderParameter = {};
|
|
15636
|
+
const localVarQueryParameter = {};
|
|
15637
|
+
// authentication BearerAuth required
|
|
15638
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
15639
|
+
if (status !== undefined) {
|
|
15640
|
+
localVarQueryParameter['status'] = status;
|
|
15641
|
+
}
|
|
15642
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15643
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15644
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15645
|
+
return {
|
|
15646
|
+
url: toPathString(localVarUrlObj),
|
|
15647
|
+
options: localVarRequestOptions,
|
|
15648
|
+
};
|
|
15649
|
+
}),
|
|
15650
|
+
/**
|
|
15651
|
+
* Sync enabled query suggestions to Typesense collection for public API usage
|
|
15652
|
+
* @summary Sync Suggestions to Typesense
|
|
15653
|
+
* @param {string} xStoreID Store ID
|
|
15654
|
+
* @param {*} [options] Override http request option.
|
|
15655
|
+
* @throws {RequiredError}
|
|
15656
|
+
*/
|
|
15657
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost: (xStoreID_1, ...args_1) => __awaiter(this, [xStoreID_1, ...args_1], void 0, function* (xStoreID, options = {}) {
|
|
15658
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15659
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost', 'xStoreID', xStoreID);
|
|
15660
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/sync`
|
|
15661
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15662
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15663
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15664
|
+
let baseOptions;
|
|
15665
|
+
if (configuration) {
|
|
15666
|
+
baseOptions = configuration.baseOptions;
|
|
15667
|
+
}
|
|
15668
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15669
|
+
const localVarHeaderParameter = {};
|
|
15670
|
+
const localVarQueryParameter = {};
|
|
15671
|
+
// authentication BearerAuth required
|
|
15672
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
15673
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15674
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15675
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15676
|
+
return {
|
|
15677
|
+
url: toPathString(localVarUrlObj),
|
|
15678
|
+
options: localVarRequestOptions,
|
|
15679
|
+
};
|
|
15680
|
+
}),
|
|
15681
|
+
/**
|
|
15682
|
+
* Retrieve query suggestions directly from Typesense collection for admin dashboard testing/viewing
|
|
15683
|
+
* @summary Get Query Suggestions from Typesense (Admin)
|
|
15684
|
+
* @param {string} xStoreID Store ID
|
|
15685
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
15686
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
15687
|
+
* @param {number} [page] Page number for pagination
|
|
15688
|
+
* @param {*} [options] Override http request option.
|
|
15689
|
+
* @throws {RequiredError}
|
|
15690
|
+
*/
|
|
15691
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet: (xStoreID_1, query_1, hitsPerPage_1, page_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, hitsPerPage_1, page_1, ...args_1], void 0, function* (xStoreID, query, hitsPerPage, page, options = {}) {
|
|
15692
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
15693
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet', 'xStoreID', xStoreID);
|
|
15694
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/query-suggestions/typesense`
|
|
15695
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
15696
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15697
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15698
|
+
let baseOptions;
|
|
15699
|
+
if (configuration) {
|
|
15700
|
+
baseOptions = configuration.baseOptions;
|
|
15701
|
+
}
|
|
15702
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
15703
|
+
const localVarHeaderParameter = {};
|
|
15704
|
+
const localVarQueryParameter = {};
|
|
15705
|
+
// authentication BearerAuth required
|
|
15706
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
15707
|
+
if (query !== undefined) {
|
|
15708
|
+
localVarQueryParameter['query'] = query;
|
|
15709
|
+
}
|
|
15710
|
+
if (hitsPerPage !== undefined) {
|
|
15711
|
+
localVarQueryParameter['hitsPerPage'] = hitsPerPage;
|
|
15712
|
+
}
|
|
15713
|
+
if (page !== undefined) {
|
|
15714
|
+
localVarQueryParameter['page'] = page;
|
|
15715
|
+
}
|
|
15716
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15717
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15718
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15719
|
+
return {
|
|
15720
|
+
url: toPathString(localVarUrlObj),
|
|
15721
|
+
options: localVarRequestOptions,
|
|
15722
|
+
};
|
|
15723
|
+
}),
|
|
15724
|
+
};
|
|
15725
|
+
};
|
|
15726
|
+
/**
|
|
15727
|
+
* QuerySuggestionsManagementApi - functional programming interface
|
|
15728
|
+
* @export
|
|
15729
|
+
*/
|
|
15730
|
+
export const QuerySuggestionsManagementApiFp = function (configuration) {
|
|
15731
|
+
const localVarAxiosParamCreator = QuerySuggestionsManagementApiAxiosParamCreator(configuration);
|
|
15732
|
+
return {
|
|
15733
|
+
/**
|
|
15734
|
+
* Migrate existing analytics data for all stores (admin only)
|
|
15735
|
+
* @summary Migrate All Stores Data
|
|
15736
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
15737
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15738
|
+
* @param {*} [options] Override http request option.
|
|
15739
|
+
* @throws {RequiredError}
|
|
15740
|
+
*/
|
|
15741
|
+
adminAnalyticsQuerySuggestionsMigrateAllPost(daysBack, minPopularity, options) {
|
|
15742
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15743
|
+
var _a, _b, _c;
|
|
15744
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsQuerySuggestionsMigrateAllPost(daysBack, minPopularity, options);
|
|
15745
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15746
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsQuerySuggestionsMigrateAllPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15747
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15748
|
+
});
|
|
15749
|
+
},
|
|
15750
|
+
/**
|
|
15751
|
+
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
15752
|
+
* @summary Bulk Update Suggestions
|
|
15753
|
+
* @param {string} xStoreID Store ID
|
|
15754
|
+
* @param {AnalyticsBulkOperationRequest} body Bulk operation request
|
|
15755
|
+
* @param {*} [options] Override http request option.
|
|
15756
|
+
* @throws {RequiredError}
|
|
15757
|
+
*/
|
|
15758
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost(xStoreID, body, options) {
|
|
15759
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15760
|
+
var _a, _b, _c;
|
|
15761
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost(xStoreID, body, options);
|
|
15762
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15763
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15764
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15765
|
+
});
|
|
15766
|
+
},
|
|
15767
|
+
/**
|
|
15768
|
+
* Retrieve auto-generated suggestions from cache for review before promoting to management table
|
|
15769
|
+
* @summary Get Cached Auto-Generated Suggestions
|
|
15770
|
+
* @param {string} xStoreID Store ID
|
|
15771
|
+
* @param {number} [page] Page number
|
|
15772
|
+
* @param {number} [pageSize] Items per page
|
|
15773
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15774
|
+
* @param {*} [options] Override http request option.
|
|
15775
|
+
* @throws {RequiredError}
|
|
15776
|
+
*/
|
|
15777
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet(xStoreID, page, pageSize, minPopularity, options) {
|
|
15778
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15779
|
+
var _a, _b, _c;
|
|
15780
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet(xStoreID, page, pageSize, minPopularity, options);
|
|
15781
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15782
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15783
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15784
|
+
});
|
|
15785
|
+
},
|
|
15786
|
+
/**
|
|
15787
|
+
* Retrieve query suggestions with filtering and pagination for management
|
|
15788
|
+
* @summary Get Query Suggestions
|
|
15789
|
+
* @param {string} xStoreID Store ID
|
|
15790
|
+
* @param {string} [source] Filter by source (auto_generated, manual, imported)
|
|
15791
|
+
* @param {string} [status] Filter by status (enabled, disabled)
|
|
15792
|
+
* @param {string} [query] Search within query text
|
|
15793
|
+
* @param {string} [category] Filter by category
|
|
15794
|
+
* @param {string} [tag] Filter by tag
|
|
15795
|
+
* @param {number} [page] Page number
|
|
15796
|
+
* @param {number} [pageSize] Number of items per page
|
|
15797
|
+
* @param {*} [options] Override http request option.
|
|
15798
|
+
* @throws {RequiredError}
|
|
15799
|
+
*/
|
|
15800
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsGet(xStoreID, source, status, query, category, tag, page, pageSize, options) {
|
|
15801
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15802
|
+
var _a, _b, _c;
|
|
15803
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsGet(xStoreID, source, status, query, category, tag, page, pageSize, options);
|
|
15804
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15805
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15806
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15807
|
+
});
|
|
15808
|
+
},
|
|
15809
|
+
/**
|
|
15810
|
+
* Import query suggestions from JSON data
|
|
15811
|
+
* @summary Import Query Suggestions
|
|
15812
|
+
* @param {string} xStoreID Store ID
|
|
15813
|
+
* @param {AnalyticsImportQuerySuggestionsRequest} body Import suggestions request
|
|
15814
|
+
* @param {*} [options] Override http request option.
|
|
15815
|
+
* @throws {RequiredError}
|
|
15816
|
+
*/
|
|
15817
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost(xStoreID, body, options) {
|
|
15818
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15819
|
+
var _a, _b, _c;
|
|
15820
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost(xStoreID, body, options);
|
|
15821
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15822
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15823
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15824
|
+
});
|
|
15825
|
+
},
|
|
15826
|
+
/**
|
|
15827
|
+
* Add a manually created query suggestion for a store
|
|
15828
|
+
* @summary Add Manual Query Suggestion
|
|
15829
|
+
* @param {string} xStoreID Store ID
|
|
15830
|
+
* @param {AnalyticsManualQuerySuggestionRequest} body Manual suggestion request
|
|
15831
|
+
* @param {*} [options] Override http request option.
|
|
15832
|
+
* @throws {RequiredError}
|
|
15833
|
+
*/
|
|
15834
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost(xStoreID, body, options) {
|
|
15835
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15836
|
+
var _a, _b, _c;
|
|
15837
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost(xStoreID, body, options);
|
|
15838
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15839
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15840
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15841
|
+
});
|
|
15842
|
+
},
|
|
15843
|
+
/**
|
|
15844
|
+
* Migrate existing search analytics data to the new query suggestions management system
|
|
15845
|
+
* @summary Migrate Existing Analytics Data
|
|
15846
|
+
* @param {string} xStoreID Store ID
|
|
15847
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
15848
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15849
|
+
* @param {*} [options] Override http request option.
|
|
15850
|
+
* @throws {RequiredError}
|
|
15851
|
+
*/
|
|
15852
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost(xStoreID, daysBack, minPopularity, options) {
|
|
15853
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15854
|
+
var _a, _b, _c;
|
|
15855
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost(xStoreID, daysBack, minPopularity, options);
|
|
15856
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15857
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15858
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15859
|
+
});
|
|
15860
|
+
},
|
|
15861
|
+
/**
|
|
15862
|
+
* Move ALL auto-generated suggestions from cache to the management table that meet minimum popularity criteria
|
|
15863
|
+
* @summary Promote ALL Cached Suggestions to Management Table
|
|
15864
|
+
* @param {string} xStoreID Store ID
|
|
15865
|
+
* @param {number} [minPopularity] Minimum popularity threshold (default: 5)
|
|
15866
|
+
* @param {*} [options] Override http request option.
|
|
15867
|
+
* @throws {RequiredError}
|
|
15868
|
+
*/
|
|
15869
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost(xStoreID, minPopularity, options) {
|
|
15870
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15871
|
+
var _a, _b, _c;
|
|
15872
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost(xStoreID, minPopularity, options);
|
|
15873
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15874
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15875
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15876
|
+
});
|
|
15877
|
+
},
|
|
15878
|
+
/**
|
|
15879
|
+
* Move selected auto-generated suggestions from cache to the management table
|
|
15880
|
+
* @summary Promote Cached Suggestions to Management Table
|
|
15881
|
+
* @param {string} xStoreID Store ID
|
|
15882
|
+
* @param {AnalyticsPromoteSuggestionsRequest} body Promotion request
|
|
15883
|
+
* @param {*} [options] Override http request option.
|
|
15884
|
+
* @throws {RequiredError}
|
|
15885
|
+
*/
|
|
15886
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost(xStoreID, body, options) {
|
|
15887
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15888
|
+
var _a, _b, _c;
|
|
15889
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost(xStoreID, body, options);
|
|
15890
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15891
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15892
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15893
|
+
});
|
|
15894
|
+
},
|
|
15895
|
+
/**
|
|
15896
|
+
* Refresh auto-generated suggestions from search analytics data
|
|
15897
|
+
* @summary Refresh Auto-Generated Suggestions
|
|
15898
|
+
* @param {string} xStoreID Store ID
|
|
15899
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15900
|
+
* @param {number} [days] Number of days to analyze
|
|
15901
|
+
* @param {*} [options] Override http request option.
|
|
15902
|
+
* @throws {RequiredError}
|
|
15903
|
+
*/
|
|
15904
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost(xStoreID, minPopularity, days, options) {
|
|
15905
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15906
|
+
var _a, _b, _c;
|
|
15907
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost(xStoreID, minPopularity, days, options);
|
|
15908
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15909
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15910
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15911
|
+
});
|
|
15912
|
+
},
|
|
15913
|
+
/**
|
|
15914
|
+
* Get statistics about query suggestions for a store
|
|
15915
|
+
* @summary Get Suggestion Statistics
|
|
15916
|
+
* @param {string} xStoreID Store ID
|
|
15917
|
+
* @param {*} [options] Override http request option.
|
|
15918
|
+
* @throws {RequiredError}
|
|
15919
|
+
*/
|
|
15920
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet(xStoreID, options) {
|
|
15921
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15922
|
+
var _a, _b, _c;
|
|
15923
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet(xStoreID, options);
|
|
15924
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15925
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15926
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15927
|
+
});
|
|
15928
|
+
},
|
|
15929
|
+
/**
|
|
15930
|
+
* Update the status (enabled/disabled) of a query suggestion
|
|
15931
|
+
* @summary Update Suggestion Status
|
|
15932
|
+
* @param {string} xStoreID Store ID
|
|
15933
|
+
* @param {string} suggestionID Suggestion ID
|
|
15934
|
+
* @param {string} status New status (enabled, disabled)
|
|
15935
|
+
* @param {*} [options] Override http request option.
|
|
15936
|
+
* @throws {RequiredError}
|
|
15937
|
+
*/
|
|
15938
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut(xStoreID, suggestionID, status, options) {
|
|
15939
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15940
|
+
var _a, _b, _c;
|
|
15941
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut(xStoreID, suggestionID, status, options);
|
|
15942
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15943
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15944
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15945
|
+
});
|
|
15946
|
+
},
|
|
15947
|
+
/**
|
|
15948
|
+
* Sync enabled query suggestions to Typesense collection for public API usage
|
|
15949
|
+
* @summary Sync Suggestions to Typesense
|
|
15950
|
+
* @param {string} xStoreID Store ID
|
|
15951
|
+
* @param {*} [options] Override http request option.
|
|
15952
|
+
* @throws {RequiredError}
|
|
15953
|
+
*/
|
|
15954
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost(xStoreID, options) {
|
|
15955
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15956
|
+
var _a, _b, _c;
|
|
15957
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost(xStoreID, options);
|
|
15958
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15959
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15960
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15961
|
+
});
|
|
15962
|
+
},
|
|
15963
|
+
/**
|
|
15964
|
+
* Retrieve query suggestions directly from Typesense collection for admin dashboard testing/viewing
|
|
15965
|
+
* @summary Get Query Suggestions from Typesense (Admin)
|
|
15966
|
+
* @param {string} xStoreID Store ID
|
|
15967
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
15968
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
15969
|
+
* @param {number} [page] Page number for pagination
|
|
15970
|
+
* @param {*} [options] Override http request option.
|
|
15971
|
+
* @throws {RequiredError}
|
|
15972
|
+
*/
|
|
15973
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet(xStoreID, query, hitsPerPage, page, options) {
|
|
15974
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15975
|
+
var _a, _b, _c;
|
|
15976
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet(xStoreID, query, hitsPerPage, page, options);
|
|
15977
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15978
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['QuerySuggestionsManagementApi.adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15979
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15980
|
+
});
|
|
15981
|
+
},
|
|
15982
|
+
};
|
|
15983
|
+
};
|
|
15984
|
+
/**
|
|
15985
|
+
* QuerySuggestionsManagementApi - factory interface
|
|
15986
|
+
* @export
|
|
15987
|
+
*/
|
|
15988
|
+
export const QuerySuggestionsManagementApiFactory = function (configuration, basePath, axios) {
|
|
15989
|
+
const localVarFp = QuerySuggestionsManagementApiFp(configuration);
|
|
15990
|
+
return {
|
|
15991
|
+
/**
|
|
15992
|
+
* Migrate existing analytics data for all stores (admin only)
|
|
15993
|
+
* @summary Migrate All Stores Data
|
|
15994
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
15995
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
15996
|
+
* @param {*} [options] Override http request option.
|
|
15997
|
+
* @throws {RequiredError}
|
|
15998
|
+
*/
|
|
15999
|
+
adminAnalyticsQuerySuggestionsMigrateAllPost(daysBack, minPopularity, options) {
|
|
16000
|
+
return localVarFp.adminAnalyticsQuerySuggestionsMigrateAllPost(daysBack, minPopularity, options).then((request) => request(axios, basePath));
|
|
16001
|
+
},
|
|
16002
|
+
/**
|
|
16003
|
+
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
16004
|
+
* @summary Bulk Update Suggestions
|
|
16005
|
+
* @param {string} xStoreID Store ID
|
|
16006
|
+
* @param {AnalyticsBulkOperationRequest} body Bulk operation request
|
|
16007
|
+
* @param {*} [options] Override http request option.
|
|
16008
|
+
* @throws {RequiredError}
|
|
16009
|
+
*/
|
|
16010
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost(xStoreID, body, options) {
|
|
16011
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost(xStoreID, body, options).then((request) => request(axios, basePath));
|
|
16012
|
+
},
|
|
16013
|
+
/**
|
|
16014
|
+
* Retrieve auto-generated suggestions from cache for review before promoting to management table
|
|
16015
|
+
* @summary Get Cached Auto-Generated Suggestions
|
|
16016
|
+
* @param {string} xStoreID Store ID
|
|
16017
|
+
* @param {number} [page] Page number
|
|
16018
|
+
* @param {number} [pageSize] Items per page
|
|
16019
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16020
|
+
* @param {*} [options] Override http request option.
|
|
16021
|
+
* @throws {RequiredError}
|
|
16022
|
+
*/
|
|
16023
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet(xStoreID, page, pageSize, minPopularity, options) {
|
|
16024
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet(xStoreID, page, pageSize, minPopularity, options).then((request) => request(axios, basePath));
|
|
16025
|
+
},
|
|
16026
|
+
/**
|
|
16027
|
+
* Retrieve query suggestions with filtering and pagination for management
|
|
16028
|
+
* @summary Get Query Suggestions
|
|
16029
|
+
* @param {string} xStoreID Store ID
|
|
16030
|
+
* @param {string} [source] Filter by source (auto_generated, manual, imported)
|
|
16031
|
+
* @param {string} [status] Filter by status (enabled, disabled)
|
|
16032
|
+
* @param {string} [query] Search within query text
|
|
16033
|
+
* @param {string} [category] Filter by category
|
|
16034
|
+
* @param {string} [tag] Filter by tag
|
|
16035
|
+
* @param {number} [page] Page number
|
|
16036
|
+
* @param {number} [pageSize] Number of items per page
|
|
16037
|
+
* @param {*} [options] Override http request option.
|
|
16038
|
+
* @throws {RequiredError}
|
|
16039
|
+
*/
|
|
16040
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsGet(xStoreID, source, status, query, category, tag, page, pageSize, options) {
|
|
16041
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsGet(xStoreID, source, status, query, category, tag, page, pageSize, options).then((request) => request(axios, basePath));
|
|
16042
|
+
},
|
|
16043
|
+
/**
|
|
16044
|
+
* Import query suggestions from JSON data
|
|
16045
|
+
* @summary Import Query Suggestions
|
|
16046
|
+
* @param {string} xStoreID Store ID
|
|
16047
|
+
* @param {AnalyticsImportQuerySuggestionsRequest} body Import suggestions request
|
|
16048
|
+
* @param {*} [options] Override http request option.
|
|
16049
|
+
* @throws {RequiredError}
|
|
16050
|
+
*/
|
|
16051
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost(xStoreID, body, options) {
|
|
16052
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost(xStoreID, body, options).then((request) => request(axios, basePath));
|
|
16053
|
+
},
|
|
16054
|
+
/**
|
|
16055
|
+
* Add a manually created query suggestion for a store
|
|
16056
|
+
* @summary Add Manual Query Suggestion
|
|
16057
|
+
* @param {string} xStoreID Store ID
|
|
16058
|
+
* @param {AnalyticsManualQuerySuggestionRequest} body Manual suggestion request
|
|
16059
|
+
* @param {*} [options] Override http request option.
|
|
16060
|
+
* @throws {RequiredError}
|
|
16061
|
+
*/
|
|
16062
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost(xStoreID, body, options) {
|
|
16063
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost(xStoreID, body, options).then((request) => request(axios, basePath));
|
|
16064
|
+
},
|
|
16065
|
+
/**
|
|
16066
|
+
* Migrate existing search analytics data to the new query suggestions management system
|
|
16067
|
+
* @summary Migrate Existing Analytics Data
|
|
16068
|
+
* @param {string} xStoreID Store ID
|
|
16069
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
16070
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16071
|
+
* @param {*} [options] Override http request option.
|
|
16072
|
+
* @throws {RequiredError}
|
|
16073
|
+
*/
|
|
16074
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost(xStoreID, daysBack, minPopularity, options) {
|
|
16075
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost(xStoreID, daysBack, minPopularity, options).then((request) => request(axios, basePath));
|
|
16076
|
+
},
|
|
16077
|
+
/**
|
|
16078
|
+
* Move ALL auto-generated suggestions from cache to the management table that meet minimum popularity criteria
|
|
16079
|
+
* @summary Promote ALL Cached Suggestions to Management Table
|
|
16080
|
+
* @param {string} xStoreID Store ID
|
|
16081
|
+
* @param {number} [minPopularity] Minimum popularity threshold (default: 5)
|
|
16082
|
+
* @param {*} [options] Override http request option.
|
|
16083
|
+
* @throws {RequiredError}
|
|
16084
|
+
*/
|
|
16085
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost(xStoreID, minPopularity, options) {
|
|
16086
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost(xStoreID, minPopularity, options).then((request) => request(axios, basePath));
|
|
16087
|
+
},
|
|
16088
|
+
/**
|
|
16089
|
+
* Move selected auto-generated suggestions from cache to the management table
|
|
16090
|
+
* @summary Promote Cached Suggestions to Management Table
|
|
16091
|
+
* @param {string} xStoreID Store ID
|
|
16092
|
+
* @param {AnalyticsPromoteSuggestionsRequest} body Promotion request
|
|
16093
|
+
* @param {*} [options] Override http request option.
|
|
16094
|
+
* @throws {RequiredError}
|
|
16095
|
+
*/
|
|
16096
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost(xStoreID, body, options) {
|
|
16097
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost(xStoreID, body, options).then((request) => request(axios, basePath));
|
|
16098
|
+
},
|
|
16099
|
+
/**
|
|
16100
|
+
* Refresh auto-generated suggestions from search analytics data
|
|
16101
|
+
* @summary Refresh Auto-Generated Suggestions
|
|
16102
|
+
* @param {string} xStoreID Store ID
|
|
16103
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16104
|
+
* @param {number} [days] Number of days to analyze
|
|
16105
|
+
* @param {*} [options] Override http request option.
|
|
16106
|
+
* @throws {RequiredError}
|
|
16107
|
+
*/
|
|
16108
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost(xStoreID, minPopularity, days, options) {
|
|
16109
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost(xStoreID, minPopularity, days, options).then((request) => request(axios, basePath));
|
|
16110
|
+
},
|
|
16111
|
+
/**
|
|
16112
|
+
* Get statistics about query suggestions for a store
|
|
16113
|
+
* @summary Get Suggestion Statistics
|
|
16114
|
+
* @param {string} xStoreID Store ID
|
|
16115
|
+
* @param {*} [options] Override http request option.
|
|
16116
|
+
* @throws {RequiredError}
|
|
16117
|
+
*/
|
|
16118
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet(xStoreID, options) {
|
|
16119
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
16120
|
+
},
|
|
16121
|
+
/**
|
|
16122
|
+
* Update the status (enabled/disabled) of a query suggestion
|
|
16123
|
+
* @summary Update Suggestion Status
|
|
16124
|
+
* @param {string} xStoreID Store ID
|
|
16125
|
+
* @param {string} suggestionID Suggestion ID
|
|
16126
|
+
* @param {string} status New status (enabled, disabled)
|
|
16127
|
+
* @param {*} [options] Override http request option.
|
|
16128
|
+
* @throws {RequiredError}
|
|
16129
|
+
*/
|
|
16130
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut(xStoreID, suggestionID, status, options) {
|
|
16131
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut(xStoreID, suggestionID, status, options).then((request) => request(axios, basePath));
|
|
16132
|
+
},
|
|
16133
|
+
/**
|
|
16134
|
+
* Sync enabled query suggestions to Typesense collection for public API usage
|
|
16135
|
+
* @summary Sync Suggestions to Typesense
|
|
16136
|
+
* @param {string} xStoreID Store ID
|
|
16137
|
+
* @param {*} [options] Override http request option.
|
|
16138
|
+
* @throws {RequiredError}
|
|
16139
|
+
*/
|
|
16140
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost(xStoreID, options) {
|
|
16141
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost(xStoreID, options).then((request) => request(axios, basePath));
|
|
16142
|
+
},
|
|
16143
|
+
/**
|
|
16144
|
+
* Retrieve query suggestions directly from Typesense collection for admin dashboard testing/viewing
|
|
16145
|
+
* @summary Get Query Suggestions from Typesense (Admin)
|
|
16146
|
+
* @param {string} xStoreID Store ID
|
|
16147
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
16148
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
16149
|
+
* @param {number} [page] Page number for pagination
|
|
16150
|
+
* @param {*} [options] Override http request option.
|
|
16151
|
+
* @throws {RequiredError}
|
|
16152
|
+
*/
|
|
16153
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet(xStoreID, query, hitsPerPage, page, options) {
|
|
16154
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet(xStoreID, query, hitsPerPage, page, options).then((request) => request(axios, basePath));
|
|
16155
|
+
},
|
|
16156
|
+
};
|
|
16157
|
+
};
|
|
16158
|
+
/**
|
|
16159
|
+
* QuerySuggestionsManagementApi - object-oriented interface
|
|
16160
|
+
* @export
|
|
16161
|
+
* @class QuerySuggestionsManagementApi
|
|
16162
|
+
* @extends {BaseAPI}
|
|
16163
|
+
*/
|
|
16164
|
+
export class QuerySuggestionsManagementApi extends BaseAPI {
|
|
16165
|
+
/**
|
|
16166
|
+
* Migrate existing analytics data for all stores (admin only)
|
|
16167
|
+
* @summary Migrate All Stores Data
|
|
16168
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
16169
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16170
|
+
* @param {*} [options] Override http request option.
|
|
16171
|
+
* @throws {RequiredError}
|
|
16172
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16173
|
+
*/
|
|
16174
|
+
adminAnalyticsQuerySuggestionsMigrateAllPost(daysBack, minPopularity, options) {
|
|
16175
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminAnalyticsQuerySuggestionsMigrateAllPost(daysBack, minPopularity, options).then((request) => request(this.axios, this.basePath));
|
|
16176
|
+
}
|
|
16177
|
+
/**
|
|
16178
|
+
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
16179
|
+
* @summary Bulk Update Suggestions
|
|
16180
|
+
* @param {string} xStoreID Store ID
|
|
16181
|
+
* @param {AnalyticsBulkOperationRequest} body Bulk operation request
|
|
16182
|
+
* @param {*} [options] Override http request option.
|
|
16183
|
+
* @throws {RequiredError}
|
|
16184
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16185
|
+
*/
|
|
16186
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost(xStoreID, body, options) {
|
|
16187
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsBulkPost(xStoreID, body, options).then((request) => request(this.axios, this.basePath));
|
|
16188
|
+
}
|
|
16189
|
+
/**
|
|
16190
|
+
* Retrieve auto-generated suggestions from cache for review before promoting to management table
|
|
16191
|
+
* @summary Get Cached Auto-Generated Suggestions
|
|
16192
|
+
* @param {string} xStoreID Store ID
|
|
16193
|
+
* @param {number} [page] Page number
|
|
16194
|
+
* @param {number} [pageSize] Items per page
|
|
16195
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16196
|
+
* @param {*} [options] Override http request option.
|
|
16197
|
+
* @throws {RequiredError}
|
|
16198
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16199
|
+
*/
|
|
16200
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet(xStoreID, page, pageSize, minPopularity, options) {
|
|
16201
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsCachedGet(xStoreID, page, pageSize, minPopularity, options).then((request) => request(this.axios, this.basePath));
|
|
16202
|
+
}
|
|
16203
|
+
/**
|
|
16204
|
+
* Retrieve query suggestions with filtering and pagination for management
|
|
16205
|
+
* @summary Get Query Suggestions
|
|
16206
|
+
* @param {string} xStoreID Store ID
|
|
16207
|
+
* @param {string} [source] Filter by source (auto_generated, manual, imported)
|
|
16208
|
+
* @param {string} [status] Filter by status (enabled, disabled)
|
|
16209
|
+
* @param {string} [query] Search within query text
|
|
16210
|
+
* @param {string} [category] Filter by category
|
|
16211
|
+
* @param {string} [tag] Filter by tag
|
|
16212
|
+
* @param {number} [page] Page number
|
|
16213
|
+
* @param {number} [pageSize] Number of items per page
|
|
16214
|
+
* @param {*} [options] Override http request option.
|
|
16215
|
+
* @throws {RequiredError}
|
|
16216
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16217
|
+
*/
|
|
16218
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsGet(xStoreID, source, status, query, category, tag, page, pageSize, options) {
|
|
16219
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsGet(xStoreID, source, status, query, category, tag, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
16220
|
+
}
|
|
16221
|
+
/**
|
|
16222
|
+
* Import query suggestions from JSON data
|
|
16223
|
+
* @summary Import Query Suggestions
|
|
16224
|
+
* @param {string} xStoreID Store ID
|
|
16225
|
+
* @param {AnalyticsImportQuerySuggestionsRequest} body Import suggestions request
|
|
16226
|
+
* @param {*} [options] Override http request option.
|
|
16227
|
+
* @throws {RequiredError}
|
|
16228
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16229
|
+
*/
|
|
16230
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost(xStoreID, body, options) {
|
|
16231
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsImportPost(xStoreID, body, options).then((request) => request(this.axios, this.basePath));
|
|
16232
|
+
}
|
|
16233
|
+
/**
|
|
16234
|
+
* Add a manually created query suggestion for a store
|
|
16235
|
+
* @summary Add Manual Query Suggestion
|
|
16236
|
+
* @param {string} xStoreID Store ID
|
|
16237
|
+
* @param {AnalyticsManualQuerySuggestionRequest} body Manual suggestion request
|
|
16238
|
+
* @param {*} [options] Override http request option.
|
|
16239
|
+
* @throws {RequiredError}
|
|
16240
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16241
|
+
*/
|
|
16242
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost(xStoreID, body, options) {
|
|
16243
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsManualPost(xStoreID, body, options).then((request) => request(this.axios, this.basePath));
|
|
16244
|
+
}
|
|
16245
|
+
/**
|
|
16246
|
+
* Migrate existing search analytics data to the new query suggestions management system
|
|
16247
|
+
* @summary Migrate Existing Analytics Data
|
|
16248
|
+
* @param {string} xStoreID Store ID
|
|
16249
|
+
* @param {number} [daysBack] Number of days back to migrate data
|
|
16250
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16251
|
+
* @param {*} [options] Override http request option.
|
|
16252
|
+
* @throws {RequiredError}
|
|
16253
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16254
|
+
*/
|
|
16255
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost(xStoreID, daysBack, minPopularity, options) {
|
|
16256
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsMigratePost(xStoreID, daysBack, minPopularity, options).then((request) => request(this.axios, this.basePath));
|
|
16257
|
+
}
|
|
16258
|
+
/**
|
|
16259
|
+
* Move ALL auto-generated suggestions from cache to the management table that meet minimum popularity criteria
|
|
16260
|
+
* @summary Promote ALL Cached Suggestions to Management Table
|
|
16261
|
+
* @param {string} xStoreID Store ID
|
|
16262
|
+
* @param {number} [minPopularity] Minimum popularity threshold (default: 5)
|
|
16263
|
+
* @param {*} [options] Override http request option.
|
|
16264
|
+
* @throws {RequiredError}
|
|
16265
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16266
|
+
*/
|
|
16267
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost(xStoreID, minPopularity, options) {
|
|
16268
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsPromoteAllPost(xStoreID, minPopularity, options).then((request) => request(this.axios, this.basePath));
|
|
16269
|
+
}
|
|
16270
|
+
/**
|
|
16271
|
+
* Move selected auto-generated suggestions from cache to the management table
|
|
16272
|
+
* @summary Promote Cached Suggestions to Management Table
|
|
16273
|
+
* @param {string} xStoreID Store ID
|
|
16274
|
+
* @param {AnalyticsPromoteSuggestionsRequest} body Promotion request
|
|
16275
|
+
* @param {*} [options] Override http request option.
|
|
16276
|
+
* @throws {RequiredError}
|
|
16277
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16278
|
+
*/
|
|
16279
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost(xStoreID, body, options) {
|
|
16280
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsPromotePost(xStoreID, body, options).then((request) => request(this.axios, this.basePath));
|
|
16281
|
+
}
|
|
16282
|
+
/**
|
|
16283
|
+
* Refresh auto-generated suggestions from search analytics data
|
|
16284
|
+
* @summary Refresh Auto-Generated Suggestions
|
|
16285
|
+
* @param {string} xStoreID Store ID
|
|
16286
|
+
* @param {number} [minPopularity] Minimum popularity threshold
|
|
16287
|
+
* @param {number} [days] Number of days to analyze
|
|
16288
|
+
* @param {*} [options] Override http request option.
|
|
16289
|
+
* @throws {RequiredError}
|
|
16290
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16291
|
+
*/
|
|
16292
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost(xStoreID, minPopularity, days, options) {
|
|
16293
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsRefreshPost(xStoreID, minPopularity, days, options).then((request) => request(this.axios, this.basePath));
|
|
16294
|
+
}
|
|
16295
|
+
/**
|
|
16296
|
+
* Get statistics about query suggestions for a store
|
|
16297
|
+
* @summary Get Suggestion Statistics
|
|
16298
|
+
* @param {string} xStoreID Store ID
|
|
16299
|
+
* @param {*} [options] Override http request option.
|
|
16300
|
+
* @throws {RequiredError}
|
|
16301
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16302
|
+
*/
|
|
16303
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet(xStoreID, options) {
|
|
16304
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsStatsGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
16305
|
+
}
|
|
16306
|
+
/**
|
|
16307
|
+
* Update the status (enabled/disabled) of a query suggestion
|
|
16308
|
+
* @summary Update Suggestion Status
|
|
16309
|
+
* @param {string} xStoreID Store ID
|
|
16310
|
+
* @param {string} suggestionID Suggestion ID
|
|
16311
|
+
* @param {string} status New status (enabled, disabled)
|
|
16312
|
+
* @param {*} [options] Override http request option.
|
|
16313
|
+
* @throws {RequiredError}
|
|
16314
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16315
|
+
*/
|
|
16316
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut(xStoreID, suggestionID, status, options) {
|
|
16317
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsSuggestionIDStatusPut(xStoreID, suggestionID, status, options).then((request) => request(this.axios, this.basePath));
|
|
16318
|
+
}
|
|
16319
|
+
/**
|
|
16320
|
+
* Sync enabled query suggestions to Typesense collection for public API usage
|
|
16321
|
+
* @summary Sync Suggestions to Typesense
|
|
16322
|
+
* @param {string} xStoreID Store ID
|
|
16323
|
+
* @param {*} [options] Override http request option.
|
|
16324
|
+
* @throws {RequiredError}
|
|
16325
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16326
|
+
*/
|
|
16327
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost(xStoreID, options) {
|
|
16328
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsSyncPost(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
16329
|
+
}
|
|
16330
|
+
/**
|
|
16331
|
+
* Retrieve query suggestions directly from Typesense collection for admin dashboard testing/viewing
|
|
16332
|
+
* @summary Get Query Suggestions from Typesense (Admin)
|
|
16333
|
+
* @param {string} xStoreID Store ID
|
|
16334
|
+
* @param {string} [query] Partial query to get suggestions for
|
|
16335
|
+
* @param {number} [hitsPerPage] Number of suggestions to return
|
|
16336
|
+
* @param {number} [page] Page number for pagination
|
|
16337
|
+
* @param {*} [options] Override http request option.
|
|
16338
|
+
* @throws {RequiredError}
|
|
16339
|
+
* @memberof QuerySuggestionsManagementApi
|
|
16340
|
+
*/
|
|
16341
|
+
adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet(xStoreID, query, hitsPerPage, page, options) {
|
|
16342
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminAnalyticsStoreXStoreIDQuerySuggestionsTypesenseGet(xStoreID, query, hitsPerPage, page, options).then((request) => request(this.axios, this.basePath));
|
|
16343
|
+
}
|
|
16344
|
+
}
|
|
14348
16345
|
/**
|
|
14349
16346
|
* RegisterApi - axios parameter creator
|
|
14350
16347
|
* @export
|