@seekora-ai/admin-api 1.0.44 → 1.0.46
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 +8 -5
- package/api.ts +883 -124
- package/dist/api.d.ts +681 -94
- package/dist/api.js +450 -114
- package/dist/esm/api.d.ts +681 -94
- package/dist/esm/api.js +446 -110
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.46.tgz +0 -0
- package/seekora-ai-admin-api-1.0.44.tgz +0 -0
package/dist/esm/api.js
CHANGED
|
@@ -1315,7 +1315,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1315
1315
|
};
|
|
1316
1316
|
}),
|
|
1317
1317
|
/**
|
|
1318
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
1318
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
1319
1319
|
* @summary Get Geographic Analytics
|
|
1320
1320
|
* @param {string} xStoreID Store ID
|
|
1321
1321
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -1326,6 +1326,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1326
1326
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1327
1327
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1328
1328
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1329
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1330
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1331
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1332
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1333
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1334
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1335
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1336
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1329
1337
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1330
1338
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1331
1339
|
* @param {number} [page] Page number for pagination
|
|
@@ -1336,7 +1344,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1336
1344
|
* @param {*} [options] Override http request option.
|
|
1337
1345
|
* @throws {RequiredError}
|
|
1338
1346
|
*/
|
|
1339
|
-
adminAnalyticsStoreXStoreIDGeoGet: (xStoreID_1, startTime_1, endTime_1, granularity_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, granularity_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options = {}) {
|
|
1347
|
+
adminAnalyticsStoreXStoreIDGeoGet: (xStoreID_1, startTime_1, endTime_1, granularity_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, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, granularity_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, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (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 = {}) {
|
|
1340
1348
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1341
1349
|
assertParamExists('adminAnalyticsStoreXStoreIDGeoGet', 'xStoreID', xStoreID);
|
|
1342
1350
|
const localVarPath = `/admin/analytics/store/{xStoreID}/geo`
|
|
@@ -1376,6 +1384,30 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1376
1384
|
if (tagValueFilter !== undefined) {
|
|
1377
1385
|
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1378
1386
|
}
|
|
1387
|
+
if (compareMode !== undefined) {
|
|
1388
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1389
|
+
}
|
|
1390
|
+
if (compareStartTime !== undefined) {
|
|
1391
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1392
|
+
}
|
|
1393
|
+
if (compareEndTime !== undefined) {
|
|
1394
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1395
|
+
}
|
|
1396
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1397
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1398
|
+
}
|
|
1399
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1400
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1401
|
+
}
|
|
1402
|
+
if (compareTagsExclude !== undefined) {
|
|
1403
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1404
|
+
}
|
|
1405
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1406
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1407
|
+
}
|
|
1408
|
+
if (compareTagValueFilter !== undefined) {
|
|
1409
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1410
|
+
}
|
|
1379
1411
|
if (limit !== undefined) {
|
|
1380
1412
|
localVarQueryParameter['limit'] = limit;
|
|
1381
1413
|
}
|
|
@@ -1437,7 +1469,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1437
1469
|
};
|
|
1438
1470
|
}),
|
|
1439
1471
|
/**
|
|
1440
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
1472
|
+
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators and comparison mode between different timelines and tag sets.
|
|
1441
1473
|
* @summary Get KPI Analytics
|
|
1442
1474
|
* @param {string} xStoreID Store ID
|
|
1443
1475
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -1448,6 +1480,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1448
1480
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1449
1481
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1450
1482
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1483
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1484
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1485
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1486
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1487
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1488
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1489
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1490
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1451
1491
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1452
1492
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1453
1493
|
* @param {number} [page] Page number for pagination
|
|
@@ -1455,7 +1495,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1455
1495
|
* @param {*} [options] Override http request option.
|
|
1456
1496
|
* @throws {RequiredError}
|
|
1457
1497
|
*/
|
|
1458
|
-
adminAnalyticsStoreXStoreIDKpiGet: (xStoreID_1, startTime_1, endTime_1, granularity_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, granularity_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options = {}) {
|
|
1498
|
+
adminAnalyticsStoreXStoreIDKpiGet: (xStoreID_1, startTime_1, endTime_1, granularity_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, limit_1, offset_1, page_1, pageSize_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, granularity_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, limit_1, offset_1, page_1, pageSize_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options = {}) {
|
|
1459
1499
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1460
1500
|
assertParamExists('adminAnalyticsStoreXStoreIDKpiGet', 'xStoreID', xStoreID);
|
|
1461
1501
|
const localVarPath = `/admin/analytics/store/{xStoreID}/kpi`
|
|
@@ -1495,6 +1535,30 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1495
1535
|
if (tagValueFilter !== undefined) {
|
|
1496
1536
|
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1497
1537
|
}
|
|
1538
|
+
if (compareMode !== undefined) {
|
|
1539
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1540
|
+
}
|
|
1541
|
+
if (compareStartTime !== undefined) {
|
|
1542
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1543
|
+
}
|
|
1544
|
+
if (compareEndTime !== undefined) {
|
|
1545
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1546
|
+
}
|
|
1547
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1548
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1549
|
+
}
|
|
1550
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1551
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1552
|
+
}
|
|
1553
|
+
if (compareTagsExclude !== undefined) {
|
|
1554
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1555
|
+
}
|
|
1556
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1557
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1558
|
+
}
|
|
1559
|
+
if (compareTagValueFilter !== undefined) {
|
|
1560
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1561
|
+
}
|
|
1498
1562
|
if (limit !== undefined) {
|
|
1499
1563
|
localVarQueryParameter['limit'] = limit;
|
|
1500
1564
|
}
|
|
@@ -1547,7 +1611,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1547
1611
|
};
|
|
1548
1612
|
}),
|
|
1549
1613
|
/**
|
|
1550
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
1614
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
1551
1615
|
* @summary Get Query Analytics
|
|
1552
1616
|
* @param {string} xStoreID Store ID
|
|
1553
1617
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -1559,6 +1623,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1559
1623
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1560
1624
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1561
1625
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1626
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1627
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1628
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1629
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1630
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1631
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1632
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1633
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1562
1634
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1563
1635
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1564
1636
|
* @param {number} [page] Page number for pagination
|
|
@@ -1570,7 +1642,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1570
1642
|
* @param {*} [options] Override http request option.
|
|
1571
1643
|
* @throws {RequiredError}
|
|
1572
1644
|
*/
|
|
1573
|
-
adminAnalyticsStoreXStoreIDQueriesGet: (xStoreID_1, startTime_1, endTime_1, granularity_1, search_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, orderBy_1, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, granularity_1, search_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, orderBy_1, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options = {}) {
|
|
1645
|
+
adminAnalyticsStoreXStoreIDQueriesGet: (xStoreID_1, startTime_1, endTime_1, granularity_1, search_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, limit_1, offset_1, page_1, pageSize_1, orderBy_1, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, granularity_1, search_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, limit_1, offset_1, page_1, pageSize_1, orderBy_1, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options = {}) {
|
|
1574
1646
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1575
1647
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesGet', 'xStoreID', xStoreID);
|
|
1576
1648
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries`
|
|
@@ -1613,6 +1685,30 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1613
1685
|
if (tagValueFilter !== undefined) {
|
|
1614
1686
|
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1615
1687
|
}
|
|
1688
|
+
if (compareMode !== undefined) {
|
|
1689
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1690
|
+
}
|
|
1691
|
+
if (compareStartTime !== undefined) {
|
|
1692
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1693
|
+
}
|
|
1694
|
+
if (compareEndTime !== undefined) {
|
|
1695
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1696
|
+
}
|
|
1697
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1698
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1699
|
+
}
|
|
1700
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1701
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1702
|
+
}
|
|
1703
|
+
if (compareTagsExclude !== undefined) {
|
|
1704
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1705
|
+
}
|
|
1706
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1707
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1708
|
+
}
|
|
1709
|
+
if (compareTagValueFilter !== undefined) {
|
|
1710
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1711
|
+
}
|
|
1616
1712
|
if (limit !== undefined) {
|
|
1617
1713
|
localVarQueryParameter['limit'] = limit;
|
|
1618
1714
|
}
|
|
@@ -1646,11 +1742,20 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1646
1742
|
};
|
|
1647
1743
|
}),
|
|
1648
1744
|
/**
|
|
1649
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
1745
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
1650
1746
|
* @summary Get No-Clicks Queries
|
|
1651
1747
|
* @param {string} xStoreID Store ID
|
|
1652
1748
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1653
1749
|
* @param {string} [endTime] End time in RFC3339 format
|
|
1750
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
1751
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1752
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1753
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1754
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1755
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1756
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1757
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1758
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1654
1759
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1655
1760
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1656
1761
|
* @param {number} [page] Page number for pagination
|
|
@@ -1661,7 +1766,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1661
1766
|
* @param {*} [options] Override http request option.
|
|
1662
1767
|
* @throws {RequiredError}
|
|
1663
1768
|
*/
|
|
1664
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet: (xStoreID_1, startTime_1, endTime_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options = {}) {
|
|
1769
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet: (xStoreID_1, startTime_1, endTime_1, search_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, search_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options = {}) {
|
|
1665
1770
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1666
1771
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoClicksGet', 'xStoreID', xStoreID);
|
|
1667
1772
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-clicks`
|
|
@@ -1683,6 +1788,33 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1683
1788
|
if (endTime !== undefined) {
|
|
1684
1789
|
localVarQueryParameter['end_time'] = endTime;
|
|
1685
1790
|
}
|
|
1791
|
+
if (search !== undefined) {
|
|
1792
|
+
localVarQueryParameter['search'] = search;
|
|
1793
|
+
}
|
|
1794
|
+
if (compareMode !== undefined) {
|
|
1795
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1796
|
+
}
|
|
1797
|
+
if (compareStartTime !== undefined) {
|
|
1798
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1799
|
+
}
|
|
1800
|
+
if (compareEndTime !== undefined) {
|
|
1801
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1802
|
+
}
|
|
1803
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1804
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1805
|
+
}
|
|
1806
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1807
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1808
|
+
}
|
|
1809
|
+
if (compareTagsExclude !== undefined) {
|
|
1810
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1811
|
+
}
|
|
1812
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1813
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1814
|
+
}
|
|
1815
|
+
if (compareTagValueFilter !== undefined) {
|
|
1816
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1817
|
+
}
|
|
1686
1818
|
if (limit !== undefined) {
|
|
1687
1819
|
localVarQueryParameter['limit'] = limit;
|
|
1688
1820
|
}
|
|
@@ -1713,11 +1845,20 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1713
1845
|
};
|
|
1714
1846
|
}),
|
|
1715
1847
|
/**
|
|
1716
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
1848
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
1717
1849
|
* @summary Get No-Results Queries
|
|
1718
1850
|
* @param {string} xStoreID Store ID
|
|
1719
1851
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1720
1852
|
* @param {string} [endTime] End time in RFC3339 format
|
|
1853
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
1854
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1855
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1856
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1857
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1858
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1859
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1860
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1861
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1721
1862
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1722
1863
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1723
1864
|
* @param {number} [page] Page number for pagination
|
|
@@ -1728,7 +1869,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1728
1869
|
* @param {*} [options] Override http request option.
|
|
1729
1870
|
* @throws {RequiredError}
|
|
1730
1871
|
*/
|
|
1731
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: (xStoreID_1, startTime_1, endTime_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options = {}) {
|
|
1872
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: (xStoreID_1, startTime_1, endTime_1, search_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, search_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options = {}) {
|
|
1732
1873
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1733
1874
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoResultsGet', 'xStoreID', xStoreID);
|
|
1734
1875
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-results`
|
|
@@ -1750,6 +1891,33 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1750
1891
|
if (endTime !== undefined) {
|
|
1751
1892
|
localVarQueryParameter['end_time'] = endTime;
|
|
1752
1893
|
}
|
|
1894
|
+
if (search !== undefined) {
|
|
1895
|
+
localVarQueryParameter['search'] = search;
|
|
1896
|
+
}
|
|
1897
|
+
if (compareMode !== undefined) {
|
|
1898
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1899
|
+
}
|
|
1900
|
+
if (compareStartTime !== undefined) {
|
|
1901
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1902
|
+
}
|
|
1903
|
+
if (compareEndTime !== undefined) {
|
|
1904
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1905
|
+
}
|
|
1906
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1907
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1908
|
+
}
|
|
1909
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1910
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1911
|
+
}
|
|
1912
|
+
if (compareTagsExclude !== undefined) {
|
|
1913
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1914
|
+
}
|
|
1915
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1916
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1917
|
+
}
|
|
1918
|
+
if (compareTagValueFilter !== undefined) {
|
|
1919
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1920
|
+
}
|
|
1753
1921
|
if (limit !== undefined) {
|
|
1754
1922
|
localVarQueryParameter['limit'] = limit;
|
|
1755
1923
|
}
|
|
@@ -1823,7 +1991,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1823
1991
|
};
|
|
1824
1992
|
}),
|
|
1825
1993
|
/**
|
|
1826
|
-
* Retrieve analytics for top performing search results with
|
|
1994
|
+
* 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.
|
|
1827
1995
|
* @summary Get Top Results Analytics
|
|
1828
1996
|
* @param {string} xStoreID Store ID
|
|
1829
1997
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -1833,7 +2001,8 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1833
2001
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
1834
2002
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
1835
2003
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
1836
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
2004
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
2005
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
1837
2006
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1838
2007
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1839
2008
|
* @param {number} [page] Page number for pagination
|
|
@@ -1841,7 +2010,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1841
2010
|
* @param {*} [options] Override http request option.
|
|
1842
2011
|
* @throws {RequiredError}
|
|
1843
2012
|
*/
|
|
1844
|
-
adminAnalyticsStoreXStoreIDResultsGet: (xStoreID_1, startTime_1, endTime_1, itemIds_1, minImpressions_1, sortBy_1, sortOrder_1, sort_1, includeDocuments_1, limit_1, offset_1, page_1, pageSize_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, itemIds_1, minImpressions_1, sortBy_1, sortOrder_1, sort_1, includeDocuments_1, limit_1, offset_1, page_1, pageSize_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options = {}) {
|
|
2013
|
+
adminAnalyticsStoreXStoreIDResultsGet: (xStoreID_1, startTime_1, endTime_1, itemIds_1, minImpressions_1, sortBy_1, sortOrder_1, sort_1, includeDocuments_1, includeWidget_1, limit_1, offset_1, page_1, pageSize_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, itemIds_1, minImpressions_1, sortBy_1, sortOrder_1, sort_1, includeDocuments_1, includeWidget_1, limit_1, offset_1, page_1, pageSize_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options = {}) {
|
|
1845
2014
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1846
2015
|
assertParamExists('adminAnalyticsStoreXStoreIDResultsGet', 'xStoreID', xStoreID);
|
|
1847
2016
|
const localVarPath = `/admin/analytics/store/{xStoreID}/results`
|
|
@@ -1881,6 +2050,9 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1881
2050
|
if (includeDocuments !== undefined) {
|
|
1882
2051
|
localVarQueryParameter['include_documents'] = includeDocuments;
|
|
1883
2052
|
}
|
|
2053
|
+
if (includeWidget !== undefined) {
|
|
2054
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
2055
|
+
}
|
|
1884
2056
|
if (limit !== undefined) {
|
|
1885
2057
|
localVarQueryParameter['limit'] = limit;
|
|
1886
2058
|
}
|
|
@@ -1915,16 +2087,16 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1915
2087
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1916
2088
|
* @param {number} [page] Page number for pagination
|
|
1917
2089
|
* @param {number} [pageSize] Number of results per page
|
|
1918
|
-
* @param {
|
|
1919
|
-
* @param {
|
|
2090
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsGetSortByEnum} [sortBy] Field to sort by
|
|
2091
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsGetSortOrderEnum} [sortOrder] Sort direction
|
|
1920
2092
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
1921
2093
|
* @param {*} [options] Override http request option.
|
|
1922
2094
|
* @throws {RequiredError}
|
|
1923
2095
|
*/
|
|
1924
|
-
|
|
2096
|
+
adminAnalyticsStoreXStoreIDTagsGet: (xStoreID_1, startTime_1, endTime_1, search_1, tagKey_1, tagValue_1, minUsage_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, search_1, tagKey_1, tagValue_1, minUsage_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, search, tagKey, tagValue, minUsage, limit, offset, page, pageSize, sortBy, sortOrder, sort, options = {}) {
|
|
1925
2097
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1926
|
-
assertParamExists('
|
|
1927
|
-
const localVarPath = `/
|
|
2098
|
+
assertParamExists('adminAnalyticsStoreXStoreIDTagsGet', 'xStoreID', xStoreID);
|
|
2099
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/tags`
|
|
1928
2100
|
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
1929
2101
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1930
2102
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1992,16 +2164,16 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1992
2164
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1993
2165
|
* @param {number} [page] Page number for pagination
|
|
1994
2166
|
* @param {number} [pageSize] Number of results per page
|
|
1995
|
-
* @param {
|
|
1996
|
-
* @param {
|
|
2167
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsSummaryGetSortByEnum} [sortBy] Field to sort by
|
|
2168
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsSummaryGetSortOrderEnum} [sortOrder] Sort direction
|
|
1997
2169
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
1998
2170
|
* @param {*} [options] Override http request option.
|
|
1999
2171
|
* @throws {RequiredError}
|
|
2000
2172
|
*/
|
|
2001
|
-
|
|
2173
|
+
adminAnalyticsStoreXStoreIDTagsSummaryGet: (xStoreID_1, startTime_1, endTime_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_1, limit_1, offset_1, page_1, pageSize_1, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options = {}) {
|
|
2002
2174
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2003
|
-
assertParamExists('
|
|
2004
|
-
const localVarPath = `/
|
|
2175
|
+
assertParamExists('adminAnalyticsStoreXStoreIDTagsSummaryGet', 'xStoreID', xStoreID);
|
|
2176
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/tags/summary`
|
|
2005
2177
|
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
2006
2178
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2007
2179
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -2198,7 +2370,7 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2198
2370
|
});
|
|
2199
2371
|
},
|
|
2200
2372
|
/**
|
|
2201
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
2373
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
2202
2374
|
* @summary Get Geographic Analytics
|
|
2203
2375
|
* @param {string} xStoreID Store ID
|
|
2204
2376
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2209,6 +2381,14 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2209
2381
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2210
2382
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2211
2383
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2384
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2385
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2386
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2387
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2388
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2389
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2390
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2391
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2212
2392
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2213
2393
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2214
2394
|
* @param {number} [page] Page number for pagination
|
|
@@ -2219,10 +2399,10 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2219
2399
|
* @param {*} [options] Override http request option.
|
|
2220
2400
|
* @throws {RequiredError}
|
|
2221
2401
|
*/
|
|
2222
|
-
adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2402
|
+
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) {
|
|
2223
2403
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2224
2404
|
var _a, _b, _c;
|
|
2225
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2405
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.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);
|
|
2226
2406
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2227
2407
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDGeoGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2228
2408
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2245,7 +2425,7 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2245
2425
|
});
|
|
2246
2426
|
},
|
|
2247
2427
|
/**
|
|
2248
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
2428
|
+
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators and comparison mode between different timelines and tag sets.
|
|
2249
2429
|
* @summary Get KPI Analytics
|
|
2250
2430
|
* @param {string} xStoreID Store ID
|
|
2251
2431
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2256,6 +2436,14 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2256
2436
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2257
2437
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2258
2438
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2439
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2440
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2441
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2442
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2443
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2444
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2445
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2446
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2259
2447
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2260
2448
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2261
2449
|
* @param {number} [page] Page number for pagination
|
|
@@ -2263,10 +2451,10 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2263
2451
|
* @param {*} [options] Override http request option.
|
|
2264
2452
|
* @throws {RequiredError}
|
|
2265
2453
|
*/
|
|
2266
|
-
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options) {
|
|
2454
|
+
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options) {
|
|
2267
2455
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2268
2456
|
var _a, _b, _c;
|
|
2269
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options);
|
|
2457
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options);
|
|
2270
2458
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2271
2459
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDKpiGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2272
2460
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2289,7 +2477,7 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2289
2477
|
});
|
|
2290
2478
|
},
|
|
2291
2479
|
/**
|
|
2292
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
2480
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
2293
2481
|
* @summary Get Query Analytics
|
|
2294
2482
|
* @param {string} xStoreID Store ID
|
|
2295
2483
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2301,6 +2489,14 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2301
2489
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2302
2490
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2303
2491
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2492
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2493
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2494
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2495
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2496
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2497
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2498
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2499
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2304
2500
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2305
2501
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2306
2502
|
* @param {number} [page] Page number for pagination
|
|
@@ -2312,21 +2508,30 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2312
2508
|
* @param {*} [options] Override http request option.
|
|
2313
2509
|
* @throws {RequiredError}
|
|
2314
2510
|
*/
|
|
2315
|
-
adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options) {
|
|
2511
|
+
adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options) {
|
|
2316
2512
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2317
2513
|
var _a, _b, _c;
|
|
2318
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options);
|
|
2514
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options);
|
|
2319
2515
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2320
2516
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2321
2517
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2322
2518
|
});
|
|
2323
2519
|
},
|
|
2324
2520
|
/**
|
|
2325
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
2521
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
2326
2522
|
* @summary Get No-Clicks Queries
|
|
2327
2523
|
* @param {string} xStoreID Store ID
|
|
2328
2524
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2329
2525
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2526
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2527
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2528
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2529
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2530
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2531
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2532
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2533
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2534
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2330
2535
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2331
2536
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2332
2537
|
* @param {number} [page] Page number for pagination
|
|
@@ -2337,21 +2542,30 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2337
2542
|
* @param {*} [options] Override http request option.
|
|
2338
2543
|
* @throws {RequiredError}
|
|
2339
2544
|
*/
|
|
2340
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2545
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2341
2546
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2342
2547
|
var _a, _b, _c;
|
|
2343
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2548
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2344
2549
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2345
2550
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoClicksGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2346
2551
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2347
2552
|
});
|
|
2348
2553
|
},
|
|
2349
2554
|
/**
|
|
2350
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
2555
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
2351
2556
|
* @summary Get No-Results Queries
|
|
2352
2557
|
* @param {string} xStoreID Store ID
|
|
2353
2558
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2354
2559
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2560
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2561
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2562
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2563
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2564
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2565
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2566
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2567
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2568
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2355
2569
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2356
2570
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2357
2571
|
* @param {number} [page] Page number for pagination
|
|
@@ -2362,10 +2576,10 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2362
2576
|
* @param {*} [options] Override http request option.
|
|
2363
2577
|
* @throws {RequiredError}
|
|
2364
2578
|
*/
|
|
2365
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2579
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2366
2580
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2367
2581
|
var _a, _b, _c;
|
|
2368
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2582
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2369
2583
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2370
2584
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoResultsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2371
2585
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2391,7 +2605,7 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2391
2605
|
});
|
|
2392
2606
|
},
|
|
2393
2607
|
/**
|
|
2394
|
-
* Retrieve analytics for top performing search results with
|
|
2608
|
+
* 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.
|
|
2395
2609
|
* @summary Get Top Results Analytics
|
|
2396
2610
|
* @param {string} xStoreID Store ID
|
|
2397
2611
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2401,7 +2615,8 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2401
2615
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
2402
2616
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
2403
2617
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
2404
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
2618
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
2619
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
2405
2620
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2406
2621
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2407
2622
|
* @param {number} [page] Page number for pagination
|
|
@@ -2409,10 +2624,10 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2409
2624
|
* @param {*} [options] Override http request option.
|
|
2410
2625
|
* @throws {RequiredError}
|
|
2411
2626
|
*/
|
|
2412
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options) {
|
|
2627
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
2413
2628
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2414
2629
|
var _a, _b, _c;
|
|
2415
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options);
|
|
2630
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options);
|
|
2416
2631
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2417
2632
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDResultsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2418
2633
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2432,18 +2647,18 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2432
2647
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2433
2648
|
* @param {number} [page] Page number for pagination
|
|
2434
2649
|
* @param {number} [pageSize] Number of results per page
|
|
2435
|
-
* @param {
|
|
2436
|
-
* @param {
|
|
2650
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsGetSortByEnum} [sortBy] Field to sort by
|
|
2651
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsGetSortOrderEnum} [sortOrder] Sort direction
|
|
2437
2652
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
2438
2653
|
* @param {*} [options] Override http request option.
|
|
2439
2654
|
* @throws {RequiredError}
|
|
2440
2655
|
*/
|
|
2441
|
-
|
|
2656
|
+
adminAnalyticsStoreXStoreIDTagsGet(xStoreID, startTime, endTime, search, tagKey, tagValue, minUsage, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2442
2657
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2443
2658
|
var _a, _b, _c;
|
|
2444
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
2659
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDTagsGet(xStoreID, startTime, endTime, search, tagKey, tagValue, minUsage, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2445
2660
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2446
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.
|
|
2661
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDTagsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2447
2662
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2448
2663
|
});
|
|
2449
2664
|
},
|
|
@@ -2457,18 +2672,18 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2457
2672
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2458
2673
|
* @param {number} [page] Page number for pagination
|
|
2459
2674
|
* @param {number} [pageSize] Number of results per page
|
|
2460
|
-
* @param {
|
|
2461
|
-
* @param {
|
|
2675
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsSummaryGetSortByEnum} [sortBy] Field to sort by
|
|
2676
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsSummaryGetSortOrderEnum} [sortOrder] Sort direction
|
|
2462
2677
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
2463
2678
|
* @param {*} [options] Override http request option.
|
|
2464
2679
|
* @throws {RequiredError}
|
|
2465
2680
|
*/
|
|
2466
|
-
|
|
2681
|
+
adminAnalyticsStoreXStoreIDTagsSummaryGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2467
2682
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2468
2683
|
var _a, _b, _c;
|
|
2469
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
2684
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDTagsSummaryGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2470
2685
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2471
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.
|
|
2686
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDTagsSummaryGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2472
2687
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2473
2688
|
});
|
|
2474
2689
|
},
|
|
@@ -2587,7 +2802,7 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2587
2802
|
return localVarFp.adminAnalyticsStoreXStoreIDFiltersTrendsGet(xStoreID, startTime, endTime, granularity, filterKey, topFilters, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2588
2803
|
},
|
|
2589
2804
|
/**
|
|
2590
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
2805
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
2591
2806
|
* @summary Get Geographic Analytics
|
|
2592
2807
|
* @param {string} xStoreID Store ID
|
|
2593
2808
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2598,6 +2813,14 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2598
2813
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2599
2814
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2600
2815
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2816
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2817
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2818
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2819
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2820
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2821
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2822
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2823
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2601
2824
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2602
2825
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2603
2826
|
* @param {number} [page] Page number for pagination
|
|
@@ -2608,8 +2831,8 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2608
2831
|
* @param {*} [options] Override http request option.
|
|
2609
2832
|
* @throws {RequiredError}
|
|
2610
2833
|
*/
|
|
2611
|
-
adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2612
|
-
return localVarFp.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2834
|
+
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) {
|
|
2835
|
+
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));
|
|
2613
2836
|
},
|
|
2614
2837
|
/**
|
|
2615
2838
|
* Check the health status of analytics service and ClickHouse connection
|
|
@@ -2622,7 +2845,7 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2622
2845
|
return localVarFp.adminAnalyticsStoreXStoreIDHealthGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
2623
2846
|
},
|
|
2624
2847
|
/**
|
|
2625
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
2848
|
+
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators and comparison mode between different timelines and tag sets.
|
|
2626
2849
|
* @summary Get KPI Analytics
|
|
2627
2850
|
* @param {string} xStoreID Store ID
|
|
2628
2851
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2633,6 +2856,14 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2633
2856
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2634
2857
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2635
2858
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2859
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2860
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2861
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2862
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2863
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2864
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2865
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2866
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2636
2867
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2637
2868
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2638
2869
|
* @param {number} [page] Page number for pagination
|
|
@@ -2640,8 +2871,8 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2640
2871
|
* @param {*} [options] Override http request option.
|
|
2641
2872
|
* @throws {RequiredError}
|
|
2642
2873
|
*/
|
|
2643
|
-
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options) {
|
|
2644
|
-
return localVarFp.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
2874
|
+
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options) {
|
|
2875
|
+
return localVarFp.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
2645
2876
|
},
|
|
2646
2877
|
/**
|
|
2647
2878
|
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
@@ -2654,7 +2885,7 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2654
2885
|
return localVarFp.adminAnalyticsStoreXStoreIDKpiRealtimeGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
2655
2886
|
},
|
|
2656
2887
|
/**
|
|
2657
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
2888
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
2658
2889
|
* @summary Get Query Analytics
|
|
2659
2890
|
* @param {string} xStoreID Store ID
|
|
2660
2891
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2666,6 +2897,14 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2666
2897
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2667
2898
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2668
2899
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2900
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2901
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2902
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2903
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2904
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2905
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2906
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2907
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2669
2908
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2670
2909
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2671
2910
|
* @param {number} [page] Page number for pagination
|
|
@@ -2677,15 +2916,24 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2677
2916
|
* @param {*} [options] Override http request option.
|
|
2678
2917
|
* @throws {RequiredError}
|
|
2679
2918
|
*/
|
|
2680
|
-
adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options) {
|
|
2681
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2919
|
+
adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options) {
|
|
2920
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2682
2921
|
},
|
|
2683
2922
|
/**
|
|
2684
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
2923
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
2685
2924
|
* @summary Get No-Clicks Queries
|
|
2686
2925
|
* @param {string} xStoreID Store ID
|
|
2687
2926
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2688
2927
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2928
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2929
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2930
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2931
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2932
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2933
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2934
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2935
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2936
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2689
2937
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2690
2938
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2691
2939
|
* @param {number} [page] Page number for pagination
|
|
@@ -2696,15 +2944,24 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2696
2944
|
* @param {*} [options] Override http request option.
|
|
2697
2945
|
* @throws {RequiredError}
|
|
2698
2946
|
*/
|
|
2699
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2700
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2947
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2948
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2701
2949
|
},
|
|
2702
2950
|
/**
|
|
2703
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
2951
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
2704
2952
|
* @summary Get No-Results Queries
|
|
2705
2953
|
* @param {string} xStoreID Store ID
|
|
2706
2954
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2707
2955
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2956
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2957
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2958
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2959
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2960
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2961
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2962
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2963
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2964
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2708
2965
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2709
2966
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2710
2967
|
* @param {number} [page] Page number for pagination
|
|
@@ -2715,8 +2972,8 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2715
2972
|
* @param {*} [options] Override http request option.
|
|
2716
2973
|
* @throws {RequiredError}
|
|
2717
2974
|
*/
|
|
2718
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2719
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2975
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2976
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2720
2977
|
},
|
|
2721
2978
|
/**
|
|
2722
2979
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
@@ -2732,7 +2989,7 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2732
2989
|
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
2733
2990
|
},
|
|
2734
2991
|
/**
|
|
2735
|
-
* Retrieve analytics for top performing search results with
|
|
2992
|
+
* 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.
|
|
2736
2993
|
* @summary Get Top Results Analytics
|
|
2737
2994
|
* @param {string} xStoreID Store ID
|
|
2738
2995
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2742,7 +2999,8 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2742
2999
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
2743
3000
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
2744
3001
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
2745
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
3002
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
3003
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
2746
3004
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2747
3005
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2748
3006
|
* @param {number} [page] Page number for pagination
|
|
@@ -2750,8 +3008,8 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2750
3008
|
* @param {*} [options] Override http request option.
|
|
2751
3009
|
* @throws {RequiredError}
|
|
2752
3010
|
*/
|
|
2753
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options) {
|
|
2754
|
-
return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
3011
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
3012
|
+
return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
2755
3013
|
},
|
|
2756
3014
|
/**
|
|
2757
3015
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -2767,14 +3025,14 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2767
3025
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2768
3026
|
* @param {number} [page] Page number for pagination
|
|
2769
3027
|
* @param {number} [pageSize] Number of results per page
|
|
2770
|
-
* @param {
|
|
2771
|
-
* @param {
|
|
3028
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsGetSortByEnum} [sortBy] Field to sort by
|
|
3029
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsGetSortOrderEnum} [sortOrder] Sort direction
|
|
2772
3030
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
2773
3031
|
* @param {*} [options] Override http request option.
|
|
2774
3032
|
* @throws {RequiredError}
|
|
2775
3033
|
*/
|
|
2776
|
-
|
|
2777
|
-
return localVarFp.
|
|
3034
|
+
adminAnalyticsStoreXStoreIDTagsGet(xStoreID, startTime, endTime, search, tagKey, tagValue, minUsage, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3035
|
+
return localVarFp.adminAnalyticsStoreXStoreIDTagsGet(xStoreID, startTime, endTime, search, tagKey, tagValue, minUsage, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2778
3036
|
},
|
|
2779
3037
|
/**
|
|
2780
3038
|
* Retrieve high-level summary of analytics tags usage and statistics
|
|
@@ -2786,14 +3044,14 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2786
3044
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2787
3045
|
* @param {number} [page] Page number for pagination
|
|
2788
3046
|
* @param {number} [pageSize] Number of results per page
|
|
2789
|
-
* @param {
|
|
2790
|
-
* @param {
|
|
3047
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsSummaryGetSortByEnum} [sortBy] Field to sort by
|
|
3048
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsSummaryGetSortOrderEnum} [sortOrder] Sort direction
|
|
2791
3049
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
2792
3050
|
* @param {*} [options] Override http request option.
|
|
2793
3051
|
* @throws {RequiredError}
|
|
2794
3052
|
*/
|
|
2795
|
-
|
|
2796
|
-
return localVarFp.
|
|
3053
|
+
adminAnalyticsStoreXStoreIDTagsSummaryGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3054
|
+
return localVarFp.adminAnalyticsStoreXStoreIDTagsSummaryGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2797
3055
|
},
|
|
2798
3056
|
};
|
|
2799
3057
|
};
|
|
@@ -2916,7 +3174,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2916
3174
|
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDFiltersTrendsGet(xStoreID, startTime, endTime, granularity, filterKey, topFilters, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
2917
3175
|
}
|
|
2918
3176
|
/**
|
|
2919
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
3177
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
2920
3178
|
* @summary Get Geographic Analytics
|
|
2921
3179
|
* @param {string} xStoreID Store ID
|
|
2922
3180
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2927,6 +3185,14 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2927
3185
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2928
3186
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2929
3187
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3188
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3189
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3190
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3191
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3192
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3193
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3194
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3195
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2930
3196
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2931
3197
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2932
3198
|
* @param {number} [page] Page number for pagination
|
|
@@ -2938,8 +3204,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2938
3204
|
* @throws {RequiredError}
|
|
2939
3205
|
* @memberof AnalyticsApi
|
|
2940
3206
|
*/
|
|
2941
|
-
adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2942
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3207
|
+
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) {
|
|
3208
|
+
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));
|
|
2943
3209
|
}
|
|
2944
3210
|
/**
|
|
2945
3211
|
* Check the health status of analytics service and ClickHouse connection
|
|
@@ -2953,7 +3219,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2953
3219
|
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDHealthGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
2954
3220
|
}
|
|
2955
3221
|
/**
|
|
2956
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
3222
|
+
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators and comparison mode between different timelines and tag sets.
|
|
2957
3223
|
* @summary Get KPI Analytics
|
|
2958
3224
|
* @param {string} xStoreID Store ID
|
|
2959
3225
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2964,6 +3230,14 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2964
3230
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2965
3231
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2966
3232
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3233
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3234
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3235
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3236
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3237
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3238
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3239
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3240
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2967
3241
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2968
3242
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2969
3243
|
* @param {number} [page] Page number for pagination
|
|
@@ -2972,8 +3246,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2972
3246
|
* @throws {RequiredError}
|
|
2973
3247
|
* @memberof AnalyticsApi
|
|
2974
3248
|
*/
|
|
2975
|
-
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options) {
|
|
2976
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
3249
|
+
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options) {
|
|
3250
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
2977
3251
|
}
|
|
2978
3252
|
/**
|
|
2979
3253
|
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
@@ -2987,7 +3261,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2987
3261
|
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDKpiRealtimeGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
2988
3262
|
}
|
|
2989
3263
|
/**
|
|
2990
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
3264
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
2991
3265
|
* @summary Get Query Analytics
|
|
2992
3266
|
* @param {string} xStoreID Store ID
|
|
2993
3267
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2999,6 +3273,14 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2999
3273
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3000
3274
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3001
3275
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3276
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3277
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3278
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3279
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3280
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3281
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3282
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3283
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3002
3284
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
3003
3285
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
3004
3286
|
* @param {number} [page] Page number for pagination
|
|
@@ -3011,15 +3293,24 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3011
3293
|
* @throws {RequiredError}
|
|
3012
3294
|
* @memberof AnalyticsApi
|
|
3013
3295
|
*/
|
|
3014
|
-
adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options) {
|
|
3015
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3296
|
+
adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options) {
|
|
3297
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3016
3298
|
}
|
|
3017
3299
|
/**
|
|
3018
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
3300
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
3019
3301
|
* @summary Get No-Clicks Queries
|
|
3020
3302
|
* @param {string} xStoreID Store ID
|
|
3021
3303
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3022
3304
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3305
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3306
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3307
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3308
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3309
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3310
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3311
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3312
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3313
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3023
3314
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
3024
3315
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
3025
3316
|
* @param {number} [page] Page number for pagination
|
|
@@ -3031,15 +3322,24 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3031
3322
|
* @throws {RequiredError}
|
|
3032
3323
|
* @memberof AnalyticsApi
|
|
3033
3324
|
*/
|
|
3034
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3035
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3325
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3326
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3036
3327
|
}
|
|
3037
3328
|
/**
|
|
3038
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
3329
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
3039
3330
|
* @summary Get No-Results Queries
|
|
3040
3331
|
* @param {string} xStoreID Store ID
|
|
3041
3332
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3042
3333
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3334
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3335
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3336
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3337
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3338
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3339
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3340
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3341
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3342
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3043
3343
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
3044
3344
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
3045
3345
|
* @param {number} [page] Page number for pagination
|
|
@@ -3051,8 +3351,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3051
3351
|
* @throws {RequiredError}
|
|
3052
3352
|
* @memberof AnalyticsApi
|
|
3053
3353
|
*/
|
|
3054
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3055
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3354
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3355
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3056
3356
|
}
|
|
3057
3357
|
/**
|
|
3058
3358
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
@@ -3069,7 +3369,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3069
3369
|
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
|
|
3070
3370
|
}
|
|
3071
3371
|
/**
|
|
3072
|
-
* Retrieve analytics for top performing search results with
|
|
3372
|
+
* 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.
|
|
3073
3373
|
* @summary Get Top Results Analytics
|
|
3074
3374
|
* @param {string} xStoreID Store ID
|
|
3075
3375
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -3079,7 +3379,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3079
3379
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
3080
3380
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
3081
3381
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
3082
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
3382
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
3383
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
3083
3384
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
3084
3385
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
3085
3386
|
* @param {number} [page] Page number for pagination
|
|
@@ -3088,8 +3389,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3088
3389
|
* @throws {RequiredError}
|
|
3089
3390
|
* @memberof AnalyticsApi
|
|
3090
3391
|
*/
|
|
3091
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options) {
|
|
3092
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
3392
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
3393
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
3093
3394
|
}
|
|
3094
3395
|
/**
|
|
3095
3396
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -3105,15 +3406,15 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3105
3406
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
3106
3407
|
* @param {number} [page] Page number for pagination
|
|
3107
3408
|
* @param {number} [pageSize] Number of results per page
|
|
3108
|
-
* @param {
|
|
3109
|
-
* @param {
|
|
3409
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsGetSortByEnum} [sortBy] Field to sort by
|
|
3410
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsGetSortOrderEnum} [sortOrder] Sort direction
|
|
3110
3411
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
3111
3412
|
* @param {*} [options] Override http request option.
|
|
3112
3413
|
* @throws {RequiredError}
|
|
3113
3414
|
* @memberof AnalyticsApi
|
|
3114
3415
|
*/
|
|
3115
|
-
|
|
3116
|
-
return AnalyticsApiFp(this.configuration).
|
|
3416
|
+
adminAnalyticsStoreXStoreIDTagsGet(xStoreID, startTime, endTime, search, tagKey, tagValue, minUsage, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3417
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDTagsGet(xStoreID, startTime, endTime, search, tagKey, tagValue, minUsage, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3117
3418
|
}
|
|
3118
3419
|
/**
|
|
3119
3420
|
* Retrieve high-level summary of analytics tags usage and statistics
|
|
@@ -3125,15 +3426,15 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3125
3426
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
3126
3427
|
* @param {number} [page] Page number for pagination
|
|
3127
3428
|
* @param {number} [pageSize] Number of results per page
|
|
3128
|
-
* @param {
|
|
3129
|
-
* @param {
|
|
3429
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsSummaryGetSortByEnum} [sortBy] Field to sort by
|
|
3430
|
+
* @param {AdminAnalyticsStoreXStoreIDTagsSummaryGetSortOrderEnum} [sortOrder] Sort direction
|
|
3130
3431
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
3131
3432
|
* @param {*} [options] Override http request option.
|
|
3132
3433
|
* @throws {RequiredError}
|
|
3133
3434
|
* @memberof AnalyticsApi
|
|
3134
3435
|
*/
|
|
3135
|
-
|
|
3136
|
-
return AnalyticsApiFp(this.configuration).
|
|
3436
|
+
adminAnalyticsStoreXStoreIDTagsSummaryGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3437
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDTagsSummaryGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3137
3438
|
}
|
|
3138
3439
|
}
|
|
3139
3440
|
/**
|
|
@@ -3241,6 +3542,13 @@ export const AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum = {
|
|
|
3241
3542
|
Any: 'any',
|
|
3242
3543
|
All: 'all'
|
|
3243
3544
|
};
|
|
3545
|
+
/**
|
|
3546
|
+
* @export
|
|
3547
|
+
*/
|
|
3548
|
+
export const AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum = {
|
|
3549
|
+
Any: 'any',
|
|
3550
|
+
All: 'all'
|
|
3551
|
+
};
|
|
3244
3552
|
/**
|
|
3245
3553
|
* @export
|
|
3246
3554
|
*/
|
|
@@ -3278,6 +3586,13 @@ export const AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum = {
|
|
|
3278
3586
|
Any: 'any',
|
|
3279
3587
|
All: 'all'
|
|
3280
3588
|
};
|
|
3589
|
+
/**
|
|
3590
|
+
* @export
|
|
3591
|
+
*/
|
|
3592
|
+
export const AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum = {
|
|
3593
|
+
Any: 'any',
|
|
3594
|
+
All: 'all'
|
|
3595
|
+
};
|
|
3281
3596
|
/**
|
|
3282
3597
|
* @export
|
|
3283
3598
|
*/
|
|
@@ -3297,6 +3612,13 @@ export const AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum = {
|
|
|
3297
3612
|
Any: 'any',
|
|
3298
3613
|
All: 'all'
|
|
3299
3614
|
};
|
|
3615
|
+
/**
|
|
3616
|
+
* @export
|
|
3617
|
+
*/
|
|
3618
|
+
export const AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum = {
|
|
3619
|
+
Any: 'any',
|
|
3620
|
+
All: 'all'
|
|
3621
|
+
};
|
|
3300
3622
|
/**
|
|
3301
3623
|
* @export
|
|
3302
3624
|
*/
|
|
@@ -3315,6 +3637,13 @@ export const AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = {
|
|
|
3315
3637
|
Asc: 'asc',
|
|
3316
3638
|
Desc: 'desc'
|
|
3317
3639
|
};
|
|
3640
|
+
/**
|
|
3641
|
+
* @export
|
|
3642
|
+
*/
|
|
3643
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum = {
|
|
3644
|
+
Any: 'any',
|
|
3645
|
+
All: 'all'
|
|
3646
|
+
};
|
|
3318
3647
|
/**
|
|
3319
3648
|
* @export
|
|
3320
3649
|
*/
|
|
@@ -3330,6 +3659,13 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = {
|
|
|
3330
3659
|
Asc: 'asc',
|
|
3331
3660
|
Desc: 'desc'
|
|
3332
3661
|
};
|
|
3662
|
+
/**
|
|
3663
|
+
* @export
|
|
3664
|
+
*/
|
|
3665
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum = {
|
|
3666
|
+
Any: 'any',
|
|
3667
|
+
All: 'all'
|
|
3668
|
+
};
|
|
3333
3669
|
/**
|
|
3334
3670
|
* @export
|
|
3335
3671
|
*/
|
|
@@ -3366,7 +3702,7 @@ export const AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum = {
|
|
|
3366
3702
|
/**
|
|
3367
3703
|
* @export
|
|
3368
3704
|
*/
|
|
3369
|
-
export const
|
|
3705
|
+
export const AdminAnalyticsStoreXStoreIDTagsGetSortByEnum = {
|
|
3370
3706
|
TagKey: 'tag_key',
|
|
3371
3707
|
TagValue: 'tag_value',
|
|
3372
3708
|
UsageCount: 'usage_count',
|
|
@@ -3375,14 +3711,14 @@ export const ApiAdminAnalyticsStoreXStoreIDTagsGetSortByEnum = {
|
|
|
3375
3711
|
/**
|
|
3376
3712
|
* @export
|
|
3377
3713
|
*/
|
|
3378
|
-
export const
|
|
3714
|
+
export const AdminAnalyticsStoreXStoreIDTagsGetSortOrderEnum = {
|
|
3379
3715
|
Asc: 'asc',
|
|
3380
3716
|
Desc: 'desc'
|
|
3381
3717
|
};
|
|
3382
3718
|
/**
|
|
3383
3719
|
* @export
|
|
3384
3720
|
*/
|
|
3385
|
-
export const
|
|
3721
|
+
export const AdminAnalyticsStoreXStoreIDTagsSummaryGetSortByEnum = {
|
|
3386
3722
|
EventCount: 'event_count',
|
|
3387
3723
|
UniqueTags: 'unique_tags',
|
|
3388
3724
|
AvgUsage: 'avg_usage',
|
|
@@ -3391,7 +3727,7 @@ export const ApiAdminAnalyticsStoreXStoreIDTagsSummaryGetSortByEnum = {
|
|
|
3391
3727
|
/**
|
|
3392
3728
|
* @export
|
|
3393
3729
|
*/
|
|
3394
|
-
export const
|
|
3730
|
+
export const AdminAnalyticsStoreXStoreIDTagsSummaryGetSortOrderEnum = {
|
|
3395
3731
|
Asc: 'asc',
|
|
3396
3732
|
Desc: 'desc'
|
|
3397
3733
|
};
|