@seekora-ai/admin-api 1.0.45 → 1.0.47
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 +20 -3
- package/api.ts +1915 -141
- package/dist/api.d.ts +1442 -133
- package/dist/api.js +971 -74
- package/dist/esm/api.d.ts +1442 -133
- package/dist/esm/api.js +963 -70
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.47.tgz +0 -0
- package/seekora-ai-admin-api-1.0.45.tgz +0 -0
package/dist/esm/api.js
CHANGED
|
@@ -30,6 +30,11 @@ export const DataTypesCreateCustomWordListRequestTypeEnum = {
|
|
|
30
30
|
Stopwords: 'stopwords',
|
|
31
31
|
Synonyms: 'synonyms'
|
|
32
32
|
};
|
|
33
|
+
export const DataTypesCreatePaymentOrderRequestPaymentTypeEnum = {
|
|
34
|
+
Generic: 'generic',
|
|
35
|
+
Subscription: 'subscription',
|
|
36
|
+
CreditTopup: 'credit_topup'
|
|
37
|
+
};
|
|
33
38
|
export const DataTypesCreatePluralDeclensionRequestTypeEnum = {
|
|
34
39
|
Custom: 'custom',
|
|
35
40
|
Default: 'default'
|
|
@@ -1315,7 +1320,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1315
1320
|
};
|
|
1316
1321
|
}),
|
|
1317
1322
|
/**
|
|
1318
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
1323
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
1319
1324
|
* @summary Get Geographic Analytics
|
|
1320
1325
|
* @param {string} xStoreID Store ID
|
|
1321
1326
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -1326,6 +1331,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1326
1331
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1327
1332
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1328
1333
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1334
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1335
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1336
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1337
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1338
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1339
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1340
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1341
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1329
1342
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1330
1343
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1331
1344
|
* @param {number} [page] Page number for pagination
|
|
@@ -1336,7 +1349,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1336
1349
|
* @param {*} [options] Override http request option.
|
|
1337
1350
|
* @throws {RequiredError}
|
|
1338
1351
|
*/
|
|
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 = {}) {
|
|
1352
|
+
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
1353
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1341
1354
|
assertParamExists('adminAnalyticsStoreXStoreIDGeoGet', 'xStoreID', xStoreID);
|
|
1342
1355
|
const localVarPath = `/admin/analytics/store/{xStoreID}/geo`
|
|
@@ -1376,6 +1389,30 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1376
1389
|
if (tagValueFilter !== undefined) {
|
|
1377
1390
|
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1378
1391
|
}
|
|
1392
|
+
if (compareMode !== undefined) {
|
|
1393
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1394
|
+
}
|
|
1395
|
+
if (compareStartTime !== undefined) {
|
|
1396
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1397
|
+
}
|
|
1398
|
+
if (compareEndTime !== undefined) {
|
|
1399
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1400
|
+
}
|
|
1401
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1402
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1403
|
+
}
|
|
1404
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1405
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1406
|
+
}
|
|
1407
|
+
if (compareTagsExclude !== undefined) {
|
|
1408
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1409
|
+
}
|
|
1410
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1411
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1412
|
+
}
|
|
1413
|
+
if (compareTagValueFilter !== undefined) {
|
|
1414
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1415
|
+
}
|
|
1379
1416
|
if (limit !== undefined) {
|
|
1380
1417
|
localVarQueryParameter['limit'] = limit;
|
|
1381
1418
|
}
|
|
@@ -1437,7 +1474,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1437
1474
|
};
|
|
1438
1475
|
}),
|
|
1439
1476
|
/**
|
|
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.
|
|
1477
|
+
* 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
1478
|
* @summary Get KPI Analytics
|
|
1442
1479
|
* @param {string} xStoreID Store ID
|
|
1443
1480
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -1448,6 +1485,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1448
1485
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1449
1486
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1450
1487
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1488
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1489
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1490
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1491
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1492
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1493
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1494
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1495
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1451
1496
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1452
1497
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1453
1498
|
* @param {number} [page] Page number for pagination
|
|
@@ -1455,7 +1500,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1455
1500
|
* @param {*} [options] Override http request option.
|
|
1456
1501
|
* @throws {RequiredError}
|
|
1457
1502
|
*/
|
|
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 = {}) {
|
|
1503
|
+
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
1504
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1460
1505
|
assertParamExists('adminAnalyticsStoreXStoreIDKpiGet', 'xStoreID', xStoreID);
|
|
1461
1506
|
const localVarPath = `/admin/analytics/store/{xStoreID}/kpi`
|
|
@@ -1495,6 +1540,30 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1495
1540
|
if (tagValueFilter !== undefined) {
|
|
1496
1541
|
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1497
1542
|
}
|
|
1543
|
+
if (compareMode !== undefined) {
|
|
1544
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1545
|
+
}
|
|
1546
|
+
if (compareStartTime !== undefined) {
|
|
1547
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1548
|
+
}
|
|
1549
|
+
if (compareEndTime !== undefined) {
|
|
1550
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1551
|
+
}
|
|
1552
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1553
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1554
|
+
}
|
|
1555
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1556
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1557
|
+
}
|
|
1558
|
+
if (compareTagsExclude !== undefined) {
|
|
1559
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1560
|
+
}
|
|
1561
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1562
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1563
|
+
}
|
|
1564
|
+
if (compareTagValueFilter !== undefined) {
|
|
1565
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1566
|
+
}
|
|
1498
1567
|
if (limit !== undefined) {
|
|
1499
1568
|
localVarQueryParameter['limit'] = limit;
|
|
1500
1569
|
}
|
|
@@ -1547,7 +1616,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1547
1616
|
};
|
|
1548
1617
|
}),
|
|
1549
1618
|
/**
|
|
1550
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
1619
|
+
* 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
1620
|
* @summary Get Query Analytics
|
|
1552
1621
|
* @param {string} xStoreID Store ID
|
|
1553
1622
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -1559,6 +1628,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1559
1628
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1560
1629
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1561
1630
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1631
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1632
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1633
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1634
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1635
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1636
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1637
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1638
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1562
1639
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1563
1640
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1564
1641
|
* @param {number} [page] Page number for pagination
|
|
@@ -1570,7 +1647,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1570
1647
|
* @param {*} [options] Override http request option.
|
|
1571
1648
|
* @throws {RequiredError}
|
|
1572
1649
|
*/
|
|
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 = {}) {
|
|
1650
|
+
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
1651
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1575
1652
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesGet', 'xStoreID', xStoreID);
|
|
1576
1653
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries`
|
|
@@ -1613,6 +1690,30 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1613
1690
|
if (tagValueFilter !== undefined) {
|
|
1614
1691
|
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1615
1692
|
}
|
|
1693
|
+
if (compareMode !== undefined) {
|
|
1694
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1695
|
+
}
|
|
1696
|
+
if (compareStartTime !== undefined) {
|
|
1697
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1698
|
+
}
|
|
1699
|
+
if (compareEndTime !== undefined) {
|
|
1700
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1701
|
+
}
|
|
1702
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1703
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1704
|
+
}
|
|
1705
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1706
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1707
|
+
}
|
|
1708
|
+
if (compareTagsExclude !== undefined) {
|
|
1709
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1710
|
+
}
|
|
1711
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1712
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1713
|
+
}
|
|
1714
|
+
if (compareTagValueFilter !== undefined) {
|
|
1715
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1716
|
+
}
|
|
1616
1717
|
if (limit !== undefined) {
|
|
1617
1718
|
localVarQueryParameter['limit'] = limit;
|
|
1618
1719
|
}
|
|
@@ -1646,11 +1747,25 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1646
1747
|
};
|
|
1647
1748
|
}),
|
|
1648
1749
|
/**
|
|
1649
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
1750
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
1650
1751
|
* @summary Get No-Clicks Queries
|
|
1651
1752
|
* @param {string} xStoreID Store ID
|
|
1652
1753
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1653
1754
|
* @param {string} [endTime] End time in RFC3339 format
|
|
1755
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
1756
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
1757
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
1758
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1759
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1760
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1761
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1762
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1763
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1764
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1765
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1766
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1767
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1768
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1654
1769
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1655
1770
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1656
1771
|
* @param {number} [page] Page number for pagination
|
|
@@ -1661,7 +1776,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1661
1776
|
* @param {*} [options] Override http request option.
|
|
1662
1777
|
* @throws {RequiredError}
|
|
1663
1778
|
*/
|
|
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 = {}) {
|
|
1779
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet: (xStoreID_1, startTime_1, endTime_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, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_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, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options = {}) {
|
|
1665
1780
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1666
1781
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoClicksGet', 'xStoreID', xStoreID);
|
|
1667
1782
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-clicks`
|
|
@@ -1683,6 +1798,48 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1683
1798
|
if (endTime !== undefined) {
|
|
1684
1799
|
localVarQueryParameter['end_time'] = endTime;
|
|
1685
1800
|
}
|
|
1801
|
+
if (search !== undefined) {
|
|
1802
|
+
localVarQueryParameter['search'] = search;
|
|
1803
|
+
}
|
|
1804
|
+
if (analyticsTags !== undefined) {
|
|
1805
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
1806
|
+
}
|
|
1807
|
+
if (tagsMatchMode !== undefined) {
|
|
1808
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
1809
|
+
}
|
|
1810
|
+
if (tagsExclude !== undefined) {
|
|
1811
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
1812
|
+
}
|
|
1813
|
+
if (tagKeyFilter !== undefined) {
|
|
1814
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
1815
|
+
}
|
|
1816
|
+
if (tagValueFilter !== undefined) {
|
|
1817
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1818
|
+
}
|
|
1819
|
+
if (compareMode !== undefined) {
|
|
1820
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1821
|
+
}
|
|
1822
|
+
if (compareStartTime !== undefined) {
|
|
1823
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1824
|
+
}
|
|
1825
|
+
if (compareEndTime !== undefined) {
|
|
1826
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1827
|
+
}
|
|
1828
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1829
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1830
|
+
}
|
|
1831
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1832
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1833
|
+
}
|
|
1834
|
+
if (compareTagsExclude !== undefined) {
|
|
1835
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1836
|
+
}
|
|
1837
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1838
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1839
|
+
}
|
|
1840
|
+
if (compareTagValueFilter !== undefined) {
|
|
1841
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1842
|
+
}
|
|
1686
1843
|
if (limit !== undefined) {
|
|
1687
1844
|
localVarQueryParameter['limit'] = limit;
|
|
1688
1845
|
}
|
|
@@ -1713,11 +1870,25 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1713
1870
|
};
|
|
1714
1871
|
}),
|
|
1715
1872
|
/**
|
|
1716
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
1873
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
1717
1874
|
* @summary Get No-Results Queries
|
|
1718
1875
|
* @param {string} xStoreID Store ID
|
|
1719
1876
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1720
1877
|
* @param {string} [endTime] End time in RFC3339 format
|
|
1878
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
1879
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
1880
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
1881
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1882
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1883
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1884
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1885
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1886
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1887
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1888
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1889
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1890
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1891
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1721
1892
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1722
1893
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1723
1894
|
* @param {number} [page] Page number for pagination
|
|
@@ -1728,7 +1899,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1728
1899
|
* @param {*} [options] Override http request option.
|
|
1729
1900
|
* @throws {RequiredError}
|
|
1730
1901
|
*/
|
|
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 = {}) {
|
|
1902
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: (xStoreID_1, startTime_1, endTime_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, sortBy_1, sortOrder_1, sort_1, ...args_1) => __awaiter(this, [xStoreID_1, startTime_1, endTime_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, sortBy_1, sortOrder_1, sort_1, ...args_1], void 0, function* (xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options = {}) {
|
|
1732
1903
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1733
1904
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoResultsGet', 'xStoreID', xStoreID);
|
|
1734
1905
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-results`
|
|
@@ -1750,6 +1921,48 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1750
1921
|
if (endTime !== undefined) {
|
|
1751
1922
|
localVarQueryParameter['end_time'] = endTime;
|
|
1752
1923
|
}
|
|
1924
|
+
if (search !== undefined) {
|
|
1925
|
+
localVarQueryParameter['search'] = search;
|
|
1926
|
+
}
|
|
1927
|
+
if (analyticsTags !== undefined) {
|
|
1928
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
1929
|
+
}
|
|
1930
|
+
if (tagsMatchMode !== undefined) {
|
|
1931
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
1932
|
+
}
|
|
1933
|
+
if (tagsExclude !== undefined) {
|
|
1934
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
1935
|
+
}
|
|
1936
|
+
if (tagKeyFilter !== undefined) {
|
|
1937
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
1938
|
+
}
|
|
1939
|
+
if (tagValueFilter !== undefined) {
|
|
1940
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1941
|
+
}
|
|
1942
|
+
if (compareMode !== undefined) {
|
|
1943
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1944
|
+
}
|
|
1945
|
+
if (compareStartTime !== undefined) {
|
|
1946
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1947
|
+
}
|
|
1948
|
+
if (compareEndTime !== undefined) {
|
|
1949
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1950
|
+
}
|
|
1951
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1952
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1953
|
+
}
|
|
1954
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1955
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1956
|
+
}
|
|
1957
|
+
if (compareTagsExclude !== undefined) {
|
|
1958
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1959
|
+
}
|
|
1960
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1961
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1962
|
+
}
|
|
1963
|
+
if (compareTagValueFilter !== undefined) {
|
|
1964
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1965
|
+
}
|
|
1753
1966
|
if (limit !== undefined) {
|
|
1754
1967
|
localVarQueryParameter['limit'] = limit;
|
|
1755
1968
|
}
|
|
@@ -1823,17 +2036,31 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1823
2036
|
};
|
|
1824
2037
|
}),
|
|
1825
2038
|
/**
|
|
1826
|
-
* Retrieve analytics for top performing search results with
|
|
2039
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
1827
2040
|
* @summary Get Top Results Analytics
|
|
1828
2041
|
* @param {string} xStoreID Store ID
|
|
1829
2042
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1830
2043
|
* @param {string} [endTime] End time in RFC3339 format
|
|
1831
2044
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
2045
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2046
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2047
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2048
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2049
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2050
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2051
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2052
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2053
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2054
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2055
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2056
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2057
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1832
2058
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
1833
2059
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
1834
2060
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
1835
2061
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
1836
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
2062
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
2063
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
1837
2064
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1838
2065
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1839
2066
|
* @param {number} [page] Page number for pagination
|
|
@@ -1841,7 +2068,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1841
2068
|
* @param {*} [options] Override http request option.
|
|
1842
2069
|
* @throws {RequiredError}
|
|
1843
2070
|
*/
|
|
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 = {}) {
|
|
2071
|
+
adminAnalyticsStoreXStoreIDResultsGet: (xStoreID_1, startTime_1, endTime_1, itemIds_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, 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, 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, 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, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options = {}) {
|
|
1845
2072
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1846
2073
|
assertParamExists('adminAnalyticsStoreXStoreIDResultsGet', 'xStoreID', xStoreID);
|
|
1847
2074
|
const localVarPath = `/admin/analytics/store/{xStoreID}/results`
|
|
@@ -1866,6 +2093,45 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1866
2093
|
if (itemIds !== undefined) {
|
|
1867
2094
|
localVarQueryParameter['item_ids'] = itemIds;
|
|
1868
2095
|
}
|
|
2096
|
+
if (analyticsTags !== undefined) {
|
|
2097
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
2098
|
+
}
|
|
2099
|
+
if (tagsMatchMode !== undefined) {
|
|
2100
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
2101
|
+
}
|
|
2102
|
+
if (tagsExclude !== undefined) {
|
|
2103
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
2104
|
+
}
|
|
2105
|
+
if (tagKeyFilter !== undefined) {
|
|
2106
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
2107
|
+
}
|
|
2108
|
+
if (tagValueFilter !== undefined) {
|
|
2109
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
2110
|
+
}
|
|
2111
|
+
if (compareMode !== undefined) {
|
|
2112
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
2113
|
+
}
|
|
2114
|
+
if (compareStartTime !== undefined) {
|
|
2115
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
2116
|
+
}
|
|
2117
|
+
if (compareEndTime !== undefined) {
|
|
2118
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
2119
|
+
}
|
|
2120
|
+
if (compareAnalyticsTags !== undefined) {
|
|
2121
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
2122
|
+
}
|
|
2123
|
+
if (compareTagsMatchMode !== undefined) {
|
|
2124
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
2125
|
+
}
|
|
2126
|
+
if (compareTagsExclude !== undefined) {
|
|
2127
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
2128
|
+
}
|
|
2129
|
+
if (compareTagKeyFilter !== undefined) {
|
|
2130
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
2131
|
+
}
|
|
2132
|
+
if (compareTagValueFilter !== undefined) {
|
|
2133
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
2134
|
+
}
|
|
1869
2135
|
if (minImpressions !== undefined) {
|
|
1870
2136
|
localVarQueryParameter['min_impressions'] = minImpressions;
|
|
1871
2137
|
}
|
|
@@ -1881,6 +2147,9 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1881
2147
|
if (includeDocuments !== undefined) {
|
|
1882
2148
|
localVarQueryParameter['include_documents'] = includeDocuments;
|
|
1883
2149
|
}
|
|
2150
|
+
if (includeWidget !== undefined) {
|
|
2151
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
2152
|
+
}
|
|
1884
2153
|
if (limit !== undefined) {
|
|
1885
2154
|
localVarQueryParameter['limit'] = limit;
|
|
1886
2155
|
}
|
|
@@ -2198,7 +2467,7 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2198
2467
|
});
|
|
2199
2468
|
},
|
|
2200
2469
|
/**
|
|
2201
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
2470
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
2202
2471
|
* @summary Get Geographic Analytics
|
|
2203
2472
|
* @param {string} xStoreID Store ID
|
|
2204
2473
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2209,6 +2478,14 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2209
2478
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2210
2479
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2211
2480
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2481
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2482
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2483
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2484
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2485
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2486
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2487
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2488
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2212
2489
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2213
2490
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2214
2491
|
* @param {number} [page] Page number for pagination
|
|
@@ -2219,10 +2496,10 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2219
2496
|
* @param {*} [options] Override http request option.
|
|
2220
2497
|
* @throws {RequiredError}
|
|
2221
2498
|
*/
|
|
2222
|
-
adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2499
|
+
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
2500
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2224
2501
|
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);
|
|
2502
|
+
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
2503
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2227
2504
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDGeoGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2228
2505
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2245,7 +2522,7 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2245
2522
|
});
|
|
2246
2523
|
},
|
|
2247
2524
|
/**
|
|
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.
|
|
2525
|
+
* 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
2526
|
* @summary Get KPI Analytics
|
|
2250
2527
|
* @param {string} xStoreID Store ID
|
|
2251
2528
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2256,6 +2533,14 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2256
2533
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2257
2534
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2258
2535
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2536
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2537
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2538
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2539
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2540
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2541
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2542
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2543
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2259
2544
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2260
2545
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2261
2546
|
* @param {number} [page] Page number for pagination
|
|
@@ -2263,10 +2548,10 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2263
2548
|
* @param {*} [options] Override http request option.
|
|
2264
2549
|
* @throws {RequiredError}
|
|
2265
2550
|
*/
|
|
2266
|
-
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options) {
|
|
2551
|
+
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options) {
|
|
2267
2552
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2268
2553
|
var _a, _b, _c;
|
|
2269
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options);
|
|
2554
|
+
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
2555
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2271
2556
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDKpiGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2272
2557
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2289,7 +2574,7 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2289
2574
|
});
|
|
2290
2575
|
},
|
|
2291
2576
|
/**
|
|
2292
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
2577
|
+
* 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
2578
|
* @summary Get Query Analytics
|
|
2294
2579
|
* @param {string} xStoreID Store ID
|
|
2295
2580
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2301,6 +2586,14 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2301
2586
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2302
2587
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2303
2588
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2589
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2590
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2591
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2592
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2593
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2594
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2595
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2596
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2304
2597
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2305
2598
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2306
2599
|
* @param {number} [page] Page number for pagination
|
|
@@ -2312,21 +2605,35 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2312
2605
|
* @param {*} [options] Override http request option.
|
|
2313
2606
|
* @throws {RequiredError}
|
|
2314
2607
|
*/
|
|
2315
|
-
adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options) {
|
|
2608
|
+
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
2609
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2317
2610
|
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);
|
|
2611
|
+
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
2612
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2320
2613
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2321
2614
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2322
2615
|
});
|
|
2323
2616
|
},
|
|
2324
2617
|
/**
|
|
2325
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
2618
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
2326
2619
|
* @summary Get No-Clicks Queries
|
|
2327
2620
|
* @param {string} xStoreID Store ID
|
|
2328
2621
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2329
2622
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2623
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2624
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2625
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2626
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2627
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2628
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2629
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2630
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2631
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2632
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2633
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2634
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2635
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2636
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2330
2637
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2331
2638
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2332
2639
|
* @param {number} [page] Page number for pagination
|
|
@@ -2337,21 +2644,35 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2337
2644
|
* @param {*} [options] Override http request option.
|
|
2338
2645
|
* @throws {RequiredError}
|
|
2339
2646
|
*/
|
|
2340
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2647
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2341
2648
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2342
2649
|
var _a, _b, _c;
|
|
2343
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2650
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2344
2651
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2345
2652
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoClicksGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2346
2653
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2347
2654
|
});
|
|
2348
2655
|
},
|
|
2349
2656
|
/**
|
|
2350
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
2657
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
2351
2658
|
* @summary Get No-Results Queries
|
|
2352
2659
|
* @param {string} xStoreID Store ID
|
|
2353
2660
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2354
2661
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2662
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2663
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2664
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2665
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2666
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2667
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2668
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2669
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2670
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2671
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2672
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2673
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2674
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2675
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2355
2676
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2356
2677
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2357
2678
|
* @param {number} [page] Page number for pagination
|
|
@@ -2362,10 +2683,10 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2362
2683
|
* @param {*} [options] Override http request option.
|
|
2363
2684
|
* @throws {RequiredError}
|
|
2364
2685
|
*/
|
|
2365
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2686
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2366
2687
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2367
2688
|
var _a, _b, _c;
|
|
2368
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2689
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2369
2690
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2370
2691
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoResultsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2371
2692
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2391,17 +2712,31 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2391
2712
|
});
|
|
2392
2713
|
},
|
|
2393
2714
|
/**
|
|
2394
|
-
* Retrieve analytics for top performing search results with
|
|
2715
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
2395
2716
|
* @summary Get Top Results Analytics
|
|
2396
2717
|
* @param {string} xStoreID Store ID
|
|
2397
2718
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2398
2719
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2399
2720
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
2721
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2722
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2723
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2724
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2725
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2726
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2727
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2728
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2729
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2730
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2731
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2732
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2733
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2400
2734
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
2401
2735
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
2402
2736
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
2403
2737
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
2404
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
2738
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
2739
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
2405
2740
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2406
2741
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2407
2742
|
* @param {number} [page] Page number for pagination
|
|
@@ -2409,10 +2744,10 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2409
2744
|
* @param {*} [options] Override http request option.
|
|
2410
2745
|
* @throws {RequiredError}
|
|
2411
2746
|
*/
|
|
2412
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options) {
|
|
2747
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
2413
2748
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2414
2749
|
var _a, _b, _c;
|
|
2415
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options);
|
|
2750
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options);
|
|
2416
2751
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2417
2752
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDResultsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2418
2753
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2587,7 +2922,7 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2587
2922
|
return localVarFp.adminAnalyticsStoreXStoreIDFiltersTrendsGet(xStoreID, startTime, endTime, granularity, filterKey, topFilters, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2588
2923
|
},
|
|
2589
2924
|
/**
|
|
2590
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
2925
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
2591
2926
|
* @summary Get Geographic Analytics
|
|
2592
2927
|
* @param {string} xStoreID Store ID
|
|
2593
2928
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2598,6 +2933,14 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2598
2933
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2599
2934
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2600
2935
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2936
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2937
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2938
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2939
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2940
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2941
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2942
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2943
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2601
2944
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2602
2945
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2603
2946
|
* @param {number} [page] Page number for pagination
|
|
@@ -2608,8 +2951,8 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2608
2951
|
* @param {*} [options] Override http request option.
|
|
2609
2952
|
* @throws {RequiredError}
|
|
2610
2953
|
*/
|
|
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));
|
|
2954
|
+
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) {
|
|
2955
|
+
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
2956
|
},
|
|
2614
2957
|
/**
|
|
2615
2958
|
* Check the health status of analytics service and ClickHouse connection
|
|
@@ -2622,7 +2965,7 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2622
2965
|
return localVarFp.adminAnalyticsStoreXStoreIDHealthGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
2623
2966
|
},
|
|
2624
2967
|
/**
|
|
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.
|
|
2968
|
+
* 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
2969
|
* @summary Get KPI Analytics
|
|
2627
2970
|
* @param {string} xStoreID Store ID
|
|
2628
2971
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2633,6 +2976,14 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2633
2976
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2634
2977
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2635
2978
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2979
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2980
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2981
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2982
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2983
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2984
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2985
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2986
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2636
2987
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2637
2988
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2638
2989
|
* @param {number} [page] Page number for pagination
|
|
@@ -2640,8 +2991,8 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2640
2991
|
* @param {*} [options] Override http request option.
|
|
2641
2992
|
* @throws {RequiredError}
|
|
2642
2993
|
*/
|
|
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));
|
|
2994
|
+
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options) {
|
|
2995
|
+
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
2996
|
},
|
|
2646
2997
|
/**
|
|
2647
2998
|
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
@@ -2654,7 +3005,7 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2654
3005
|
return localVarFp.adminAnalyticsStoreXStoreIDKpiRealtimeGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
2655
3006
|
},
|
|
2656
3007
|
/**
|
|
2657
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
3008
|
+
* 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
3009
|
* @summary Get Query Analytics
|
|
2659
3010
|
* @param {string} xStoreID Store ID
|
|
2660
3011
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2666,6 +3017,14 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2666
3017
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2667
3018
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2668
3019
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3020
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3021
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3022
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3023
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3024
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3025
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3026
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3027
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2669
3028
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2670
3029
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2671
3030
|
* @param {number} [page] Page number for pagination
|
|
@@ -2677,15 +3036,29 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2677
3036
|
* @param {*} [options] Override http request option.
|
|
2678
3037
|
* @throws {RequiredError}
|
|
2679
3038
|
*/
|
|
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));
|
|
3039
|
+
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) {
|
|
3040
|
+
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
3041
|
},
|
|
2683
3042
|
/**
|
|
2684
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
3043
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
2685
3044
|
* @summary Get No-Clicks Queries
|
|
2686
3045
|
* @param {string} xStoreID Store ID
|
|
2687
3046
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2688
3047
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3048
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3049
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3050
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3051
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3052
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3053
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3054
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3055
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3056
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3057
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3058
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3059
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3060
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3061
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2689
3062
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2690
3063
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2691
3064
|
* @param {number} [page] Page number for pagination
|
|
@@ -2696,15 +3069,29 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2696
3069
|
* @param {*} [options] Override http request option.
|
|
2697
3070
|
* @throws {RequiredError}
|
|
2698
3071
|
*/
|
|
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));
|
|
3072
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3073
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2701
3074
|
},
|
|
2702
3075
|
/**
|
|
2703
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
3076
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
2704
3077
|
* @summary Get No-Results Queries
|
|
2705
3078
|
* @param {string} xStoreID Store ID
|
|
2706
3079
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2707
3080
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3081
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3082
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3083
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3084
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3085
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3086
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3087
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3088
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3089
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3090
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3091
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3092
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3093
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3094
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2708
3095
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2709
3096
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2710
3097
|
* @param {number} [page] Page number for pagination
|
|
@@ -2715,8 +3102,8 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2715
3102
|
* @param {*} [options] Override http request option.
|
|
2716
3103
|
* @throws {RequiredError}
|
|
2717
3104
|
*/
|
|
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));
|
|
3105
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3106
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2720
3107
|
},
|
|
2721
3108
|
/**
|
|
2722
3109
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
@@ -2732,17 +3119,31 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2732
3119
|
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
2733
3120
|
},
|
|
2734
3121
|
/**
|
|
2735
|
-
* Retrieve analytics for top performing search results with
|
|
3122
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
2736
3123
|
* @summary Get Top Results Analytics
|
|
2737
3124
|
* @param {string} xStoreID Store ID
|
|
2738
3125
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2739
3126
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2740
3127
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
3128
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3129
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3130
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3131
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3132
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3133
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3134
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3135
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3136
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3137
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3138
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3139
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3140
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2741
3141
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
2742
3142
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
2743
3143
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
2744
3144
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
2745
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
3145
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
3146
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
2746
3147
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2747
3148
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2748
3149
|
* @param {number} [page] Page number for pagination
|
|
@@ -2750,8 +3151,8 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2750
3151
|
* @param {*} [options] Override http request option.
|
|
2751
3152
|
* @throws {RequiredError}
|
|
2752
3153
|
*/
|
|
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));
|
|
3154
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
3155
|
+
return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
2755
3156
|
},
|
|
2756
3157
|
/**
|
|
2757
3158
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -2916,7 +3317,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2916
3317
|
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
3318
|
}
|
|
2918
3319
|
/**
|
|
2919
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
3320
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
2920
3321
|
* @summary Get Geographic Analytics
|
|
2921
3322
|
* @param {string} xStoreID Store ID
|
|
2922
3323
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2927,6 +3328,14 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2927
3328
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2928
3329
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2929
3330
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3331
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3332
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3333
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3334
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3335
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3336
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3337
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3338
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2930
3339
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2931
3340
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2932
3341
|
* @param {number} [page] Page number for pagination
|
|
@@ -2938,8 +3347,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2938
3347
|
* @throws {RequiredError}
|
|
2939
3348
|
* @memberof AnalyticsApi
|
|
2940
3349
|
*/
|
|
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));
|
|
3350
|
+
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) {
|
|
3351
|
+
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
3352
|
}
|
|
2944
3353
|
/**
|
|
2945
3354
|
* Check the health status of analytics service and ClickHouse connection
|
|
@@ -2953,7 +3362,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2953
3362
|
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDHealthGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
2954
3363
|
}
|
|
2955
3364
|
/**
|
|
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.
|
|
3365
|
+
* 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
3366
|
* @summary Get KPI Analytics
|
|
2958
3367
|
* @param {string} xStoreID Store ID
|
|
2959
3368
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2964,6 +3373,14 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2964
3373
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2965
3374
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2966
3375
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3376
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3377
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3378
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3379
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3380
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3381
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3382
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3383
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2967
3384
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2968
3385
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2969
3386
|
* @param {number} [page] Page number for pagination
|
|
@@ -2972,8 +3389,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2972
3389
|
* @throws {RequiredError}
|
|
2973
3390
|
* @memberof AnalyticsApi
|
|
2974
3391
|
*/
|
|
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));
|
|
3392
|
+
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options) {
|
|
3393
|
+
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
3394
|
}
|
|
2978
3395
|
/**
|
|
2979
3396
|
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
@@ -2987,7 +3404,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2987
3404
|
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDKpiRealtimeGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
2988
3405
|
}
|
|
2989
3406
|
/**
|
|
2990
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
3407
|
+
* 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
3408
|
* @summary Get Query Analytics
|
|
2992
3409
|
* @param {string} xStoreID Store ID
|
|
2993
3410
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2999,6 +3416,14 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
2999
3416
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3000
3417
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3001
3418
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3419
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3420
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3421
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3422
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3423
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3424
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3425
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3426
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3002
3427
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
3003
3428
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
3004
3429
|
* @param {number} [page] Page number for pagination
|
|
@@ -3011,15 +3436,29 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3011
3436
|
* @throws {RequiredError}
|
|
3012
3437
|
* @memberof AnalyticsApi
|
|
3013
3438
|
*/
|
|
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));
|
|
3439
|
+
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) {
|
|
3440
|
+
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
3441
|
}
|
|
3017
3442
|
/**
|
|
3018
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
3443
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
3019
3444
|
* @summary Get No-Clicks Queries
|
|
3020
3445
|
* @param {string} xStoreID Store ID
|
|
3021
3446
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3022
3447
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3448
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3449
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3450
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3451
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3452
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3453
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3454
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3455
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3456
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3457
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3458
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3459
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3460
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3461
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3023
3462
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
3024
3463
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
3025
3464
|
* @param {number} [page] Page number for pagination
|
|
@@ -3031,15 +3470,29 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3031
3470
|
* @throws {RequiredError}
|
|
3032
3471
|
* @memberof AnalyticsApi
|
|
3033
3472
|
*/
|
|
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));
|
|
3473
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3474
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3036
3475
|
}
|
|
3037
3476
|
/**
|
|
3038
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
3477
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
3039
3478
|
* @summary Get No-Results Queries
|
|
3040
3479
|
* @param {string} xStoreID Store ID
|
|
3041
3480
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3042
3481
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3482
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3483
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3484
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3485
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3486
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3487
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3488
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3489
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3490
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3491
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3492
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3493
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3494
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3495
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3043
3496
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
3044
3497
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
3045
3498
|
* @param {number} [page] Page number for pagination
|
|
@@ -3051,8 +3504,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3051
3504
|
* @throws {RequiredError}
|
|
3052
3505
|
* @memberof AnalyticsApi
|
|
3053
3506
|
*/
|
|
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));
|
|
3507
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3508
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3056
3509
|
}
|
|
3057
3510
|
/**
|
|
3058
3511
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
@@ -3069,17 +3522,31 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3069
3522
|
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
|
|
3070
3523
|
}
|
|
3071
3524
|
/**
|
|
3072
|
-
* Retrieve analytics for top performing search results with
|
|
3525
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
3073
3526
|
* @summary Get Top Results Analytics
|
|
3074
3527
|
* @param {string} xStoreID Store ID
|
|
3075
3528
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3076
3529
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3077
3530
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
3531
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3532
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3533
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3534
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3535
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3536
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3537
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3538
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3539
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3540
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3541
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3542
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3543
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3078
3544
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
3079
3545
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
3080
3546
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
3081
3547
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
3082
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
3548
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
3549
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
3083
3550
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
3084
3551
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
3085
3552
|
* @param {number} [page] Page number for pagination
|
|
@@ -3088,8 +3555,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3088
3555
|
* @throws {RequiredError}
|
|
3089
3556
|
* @memberof AnalyticsApi
|
|
3090
3557
|
*/
|
|
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));
|
|
3558
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options) {
|
|
3559
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
3093
3560
|
}
|
|
3094
3561
|
/**
|
|
3095
3562
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -3241,6 +3708,13 @@ export const AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum = {
|
|
|
3241
3708
|
Any: 'any',
|
|
3242
3709
|
All: 'all'
|
|
3243
3710
|
};
|
|
3711
|
+
/**
|
|
3712
|
+
* @export
|
|
3713
|
+
*/
|
|
3714
|
+
export const AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum = {
|
|
3715
|
+
Any: 'any',
|
|
3716
|
+
All: 'all'
|
|
3717
|
+
};
|
|
3244
3718
|
/**
|
|
3245
3719
|
* @export
|
|
3246
3720
|
*/
|
|
@@ -3278,6 +3752,13 @@ export const AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum = {
|
|
|
3278
3752
|
Any: 'any',
|
|
3279
3753
|
All: 'all'
|
|
3280
3754
|
};
|
|
3755
|
+
/**
|
|
3756
|
+
* @export
|
|
3757
|
+
*/
|
|
3758
|
+
export const AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum = {
|
|
3759
|
+
Any: 'any',
|
|
3760
|
+
All: 'all'
|
|
3761
|
+
};
|
|
3281
3762
|
/**
|
|
3282
3763
|
* @export
|
|
3283
3764
|
*/
|
|
@@ -3297,6 +3778,13 @@ export const AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum = {
|
|
|
3297
3778
|
Any: 'any',
|
|
3298
3779
|
All: 'all'
|
|
3299
3780
|
};
|
|
3781
|
+
/**
|
|
3782
|
+
* @export
|
|
3783
|
+
*/
|
|
3784
|
+
export const AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum = {
|
|
3785
|
+
Any: 'any',
|
|
3786
|
+
All: 'all'
|
|
3787
|
+
};
|
|
3300
3788
|
/**
|
|
3301
3789
|
* @export
|
|
3302
3790
|
*/
|
|
@@ -3315,6 +3803,20 @@ export const AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = {
|
|
|
3315
3803
|
Asc: 'asc',
|
|
3316
3804
|
Desc: 'desc'
|
|
3317
3805
|
};
|
|
3806
|
+
/**
|
|
3807
|
+
* @export
|
|
3808
|
+
*/
|
|
3809
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = {
|
|
3810
|
+
Any: 'any',
|
|
3811
|
+
All: 'all'
|
|
3812
|
+
};
|
|
3813
|
+
/**
|
|
3814
|
+
* @export
|
|
3815
|
+
*/
|
|
3816
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum = {
|
|
3817
|
+
Any: 'any',
|
|
3818
|
+
All: 'all'
|
|
3819
|
+
};
|
|
3318
3820
|
/**
|
|
3319
3821
|
* @export
|
|
3320
3822
|
*/
|
|
@@ -3330,6 +3832,20 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = {
|
|
|
3330
3832
|
Asc: 'asc',
|
|
3331
3833
|
Desc: 'desc'
|
|
3332
3834
|
};
|
|
3835
|
+
/**
|
|
3836
|
+
* @export
|
|
3837
|
+
*/
|
|
3838
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = {
|
|
3839
|
+
Any: 'any',
|
|
3840
|
+
All: 'all'
|
|
3841
|
+
};
|
|
3842
|
+
/**
|
|
3843
|
+
* @export
|
|
3844
|
+
*/
|
|
3845
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum = {
|
|
3846
|
+
Any: 'any',
|
|
3847
|
+
All: 'all'
|
|
3848
|
+
};
|
|
3333
3849
|
/**
|
|
3334
3850
|
* @export
|
|
3335
3851
|
*/
|
|
@@ -3345,6 +3861,20 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
3345
3861
|
Asc: 'asc',
|
|
3346
3862
|
Desc: 'desc'
|
|
3347
3863
|
};
|
|
3864
|
+
/**
|
|
3865
|
+
* @export
|
|
3866
|
+
*/
|
|
3867
|
+
export const AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = {
|
|
3868
|
+
Any: 'any',
|
|
3869
|
+
All: 'all'
|
|
3870
|
+
};
|
|
3871
|
+
/**
|
|
3872
|
+
* @export
|
|
3873
|
+
*/
|
|
3874
|
+
export const AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = {
|
|
3875
|
+
Any: 'any',
|
|
3876
|
+
All: 'all'
|
|
3877
|
+
};
|
|
3348
3878
|
/**
|
|
3349
3879
|
* @export
|
|
3350
3880
|
*/
|
|
@@ -11612,6 +12142,369 @@ export class ParentMenusApi extends BaseAPI {
|
|
|
11612
12142
|
return ParentMenusApiFp(this.configuration).miscParentMenusPost(parentMenu, options).then((request) => request(this.axios, this.basePath));
|
|
11613
12143
|
}
|
|
11614
12144
|
}
|
|
12145
|
+
/**
|
|
12146
|
+
* PaymentGatewayApi - axios parameter creator
|
|
12147
|
+
* @export
|
|
12148
|
+
*/
|
|
12149
|
+
export const PaymentGatewayApiAxiosParamCreator = function (configuration) {
|
|
12150
|
+
return {
|
|
12151
|
+
/**
|
|
12152
|
+
* Creates a payment order using specified or default payment gateway
|
|
12153
|
+
* @summary Create a new payment order
|
|
12154
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12155
|
+
* @param {*} [options] Override http request option.
|
|
12156
|
+
* @throws {RequiredError}
|
|
12157
|
+
*/
|
|
12158
|
+
paymentGatewayCreateOrderPost: (order_1, ...args_1) => __awaiter(this, [order_1, ...args_1], void 0, function* (order, options = {}) {
|
|
12159
|
+
// verify required parameter 'order' is not null or undefined
|
|
12160
|
+
assertParamExists('paymentGatewayCreateOrderPost', 'order', order);
|
|
12161
|
+
const localVarPath = `/payment-gateway/create-order`;
|
|
12162
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12163
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12164
|
+
let baseOptions;
|
|
12165
|
+
if (configuration) {
|
|
12166
|
+
baseOptions = configuration.baseOptions;
|
|
12167
|
+
}
|
|
12168
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12169
|
+
const localVarHeaderParameter = {};
|
|
12170
|
+
const localVarQueryParameter = {};
|
|
12171
|
+
// authentication BearerAuth required
|
|
12172
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
12173
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12174
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12175
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12176
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12177
|
+
localVarRequestOptions.data = serializeDataIfNeeded(order, localVarRequestOptions, configuration);
|
|
12178
|
+
return {
|
|
12179
|
+
url: toPathString(localVarUrlObj),
|
|
12180
|
+
options: localVarRequestOptions,
|
|
12181
|
+
};
|
|
12182
|
+
}),
|
|
12183
|
+
/**
|
|
12184
|
+
* Returns list of all active credit plans for purchase
|
|
12185
|
+
* @summary Get available credit plans
|
|
12186
|
+
* @param {*} [options] Override http request option.
|
|
12187
|
+
* @throws {RequiredError}
|
|
12188
|
+
*/
|
|
12189
|
+
paymentGatewayCreditPlansGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
12190
|
+
const localVarPath = `/payment-gateway/credit-plans`;
|
|
12191
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12192
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12193
|
+
let baseOptions;
|
|
12194
|
+
if (configuration) {
|
|
12195
|
+
baseOptions = configuration.baseOptions;
|
|
12196
|
+
}
|
|
12197
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
12198
|
+
const localVarHeaderParameter = {};
|
|
12199
|
+
const localVarQueryParameter = {};
|
|
12200
|
+
// authentication BearerAuth required
|
|
12201
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
12202
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12203
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12204
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12205
|
+
return {
|
|
12206
|
+
url: toPathString(localVarUrlObj),
|
|
12207
|
+
options: localVarRequestOptions,
|
|
12208
|
+
};
|
|
12209
|
+
}),
|
|
12210
|
+
/**
|
|
12211
|
+
* Returns list of all available payment gateways
|
|
12212
|
+
* @summary Get available payment gateways
|
|
12213
|
+
* @param {*} [options] Override http request option.
|
|
12214
|
+
* @throws {RequiredError}
|
|
12215
|
+
*/
|
|
12216
|
+
paymentGatewayGatewaysGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
12217
|
+
const localVarPath = `/payment-gateway/gateways`;
|
|
12218
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12219
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12220
|
+
let baseOptions;
|
|
12221
|
+
if (configuration) {
|
|
12222
|
+
baseOptions = configuration.baseOptions;
|
|
12223
|
+
}
|
|
12224
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
12225
|
+
const localVarHeaderParameter = {};
|
|
12226
|
+
const localVarQueryParameter = {};
|
|
12227
|
+
// authentication BearerAuth required
|
|
12228
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
12229
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12230
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12231
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12232
|
+
return {
|
|
12233
|
+
url: toPathString(localVarUrlObj),
|
|
12234
|
+
options: localVarRequestOptions,
|
|
12235
|
+
};
|
|
12236
|
+
}),
|
|
12237
|
+
/**
|
|
12238
|
+
* Processes a refund for a completed payment
|
|
12239
|
+
* @summary Process payment refund
|
|
12240
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12241
|
+
* @param {*} [options] Override http request option.
|
|
12242
|
+
* @throws {RequiredError}
|
|
12243
|
+
*/
|
|
12244
|
+
paymentGatewayRefundPost: (refund_1, ...args_1) => __awaiter(this, [refund_1, ...args_1], void 0, function* (refund, options = {}) {
|
|
12245
|
+
// verify required parameter 'refund' is not null or undefined
|
|
12246
|
+
assertParamExists('paymentGatewayRefundPost', 'refund', refund);
|
|
12247
|
+
const localVarPath = `/payment-gateway/refund`;
|
|
12248
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12249
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12250
|
+
let baseOptions;
|
|
12251
|
+
if (configuration) {
|
|
12252
|
+
baseOptions = configuration.baseOptions;
|
|
12253
|
+
}
|
|
12254
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12255
|
+
const localVarHeaderParameter = {};
|
|
12256
|
+
const localVarQueryParameter = {};
|
|
12257
|
+
// authentication BearerAuth required
|
|
12258
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
12259
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12260
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12261
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12262
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12263
|
+
localVarRequestOptions.data = serializeDataIfNeeded(refund, localVarRequestOptions, configuration);
|
|
12264
|
+
return {
|
|
12265
|
+
url: toPathString(localVarUrlObj),
|
|
12266
|
+
options: localVarRequestOptions,
|
|
12267
|
+
};
|
|
12268
|
+
}),
|
|
12269
|
+
/**
|
|
12270
|
+
* Verifies the current status of a payment
|
|
12271
|
+
* @summary Verify payment status
|
|
12272
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12273
|
+
* @param {*} [options] Override http request option.
|
|
12274
|
+
* @throws {RequiredError}
|
|
12275
|
+
*/
|
|
12276
|
+
paymentGatewayVerifyPost: (verify_1, ...args_1) => __awaiter(this, [verify_1, ...args_1], void 0, function* (verify, options = {}) {
|
|
12277
|
+
// verify required parameter 'verify' is not null or undefined
|
|
12278
|
+
assertParamExists('paymentGatewayVerifyPost', 'verify', verify);
|
|
12279
|
+
const localVarPath = `/payment-gateway/verify`;
|
|
12280
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12281
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12282
|
+
let baseOptions;
|
|
12283
|
+
if (configuration) {
|
|
12284
|
+
baseOptions = configuration.baseOptions;
|
|
12285
|
+
}
|
|
12286
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12287
|
+
const localVarHeaderParameter = {};
|
|
12288
|
+
const localVarQueryParameter = {};
|
|
12289
|
+
// authentication BearerAuth required
|
|
12290
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
12291
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12292
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12293
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12294
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12295
|
+
localVarRequestOptions.data = serializeDataIfNeeded(verify, localVarRequestOptions, configuration);
|
|
12296
|
+
return {
|
|
12297
|
+
url: toPathString(localVarUrlObj),
|
|
12298
|
+
options: localVarRequestOptions,
|
|
12299
|
+
};
|
|
12300
|
+
}),
|
|
12301
|
+
};
|
|
12302
|
+
};
|
|
12303
|
+
/**
|
|
12304
|
+
* PaymentGatewayApi - functional programming interface
|
|
12305
|
+
* @export
|
|
12306
|
+
*/
|
|
12307
|
+
export const PaymentGatewayApiFp = function (configuration) {
|
|
12308
|
+
const localVarAxiosParamCreator = PaymentGatewayApiAxiosParamCreator(configuration);
|
|
12309
|
+
return {
|
|
12310
|
+
/**
|
|
12311
|
+
* Creates a payment order using specified or default payment gateway
|
|
12312
|
+
* @summary Create a new payment order
|
|
12313
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12314
|
+
* @param {*} [options] Override http request option.
|
|
12315
|
+
* @throws {RequiredError}
|
|
12316
|
+
*/
|
|
12317
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12318
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12319
|
+
var _a, _b, _c;
|
|
12320
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayCreateOrderPost(order, options);
|
|
12321
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12322
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentGatewayApi.paymentGatewayCreateOrderPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12323
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12324
|
+
});
|
|
12325
|
+
},
|
|
12326
|
+
/**
|
|
12327
|
+
* Returns list of all active credit plans for purchase
|
|
12328
|
+
* @summary Get available credit plans
|
|
12329
|
+
* @param {*} [options] Override http request option.
|
|
12330
|
+
* @throws {RequiredError}
|
|
12331
|
+
*/
|
|
12332
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12333
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12334
|
+
var _a, _b, _c;
|
|
12335
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayCreditPlansGet(options);
|
|
12336
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12337
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentGatewayApi.paymentGatewayCreditPlansGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12338
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12339
|
+
});
|
|
12340
|
+
},
|
|
12341
|
+
/**
|
|
12342
|
+
* Returns list of all available payment gateways
|
|
12343
|
+
* @summary Get available payment gateways
|
|
12344
|
+
* @param {*} [options] Override http request option.
|
|
12345
|
+
* @throws {RequiredError}
|
|
12346
|
+
*/
|
|
12347
|
+
paymentGatewayGatewaysGet(options) {
|
|
12348
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12349
|
+
var _a, _b, _c;
|
|
12350
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayGatewaysGet(options);
|
|
12351
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12352
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentGatewayApi.paymentGatewayGatewaysGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12353
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12354
|
+
});
|
|
12355
|
+
},
|
|
12356
|
+
/**
|
|
12357
|
+
* Processes a refund for a completed payment
|
|
12358
|
+
* @summary Process payment refund
|
|
12359
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12360
|
+
* @param {*} [options] Override http request option.
|
|
12361
|
+
* @throws {RequiredError}
|
|
12362
|
+
*/
|
|
12363
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12364
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12365
|
+
var _a, _b, _c;
|
|
12366
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayRefundPost(refund, options);
|
|
12367
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12368
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentGatewayApi.paymentGatewayRefundPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12369
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12370
|
+
});
|
|
12371
|
+
},
|
|
12372
|
+
/**
|
|
12373
|
+
* Verifies the current status of a payment
|
|
12374
|
+
* @summary Verify payment status
|
|
12375
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12376
|
+
* @param {*} [options] Override http request option.
|
|
12377
|
+
* @throws {RequiredError}
|
|
12378
|
+
*/
|
|
12379
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12380
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12381
|
+
var _a, _b, _c;
|
|
12382
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayVerifyPost(verify, options);
|
|
12383
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12384
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentGatewayApi.paymentGatewayVerifyPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12385
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12386
|
+
});
|
|
12387
|
+
},
|
|
12388
|
+
};
|
|
12389
|
+
};
|
|
12390
|
+
/**
|
|
12391
|
+
* PaymentGatewayApi - factory interface
|
|
12392
|
+
* @export
|
|
12393
|
+
*/
|
|
12394
|
+
export const PaymentGatewayApiFactory = function (configuration, basePath, axios) {
|
|
12395
|
+
const localVarFp = PaymentGatewayApiFp(configuration);
|
|
12396
|
+
return {
|
|
12397
|
+
/**
|
|
12398
|
+
* Creates a payment order using specified or default payment gateway
|
|
12399
|
+
* @summary Create a new payment order
|
|
12400
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12401
|
+
* @param {*} [options] Override http request option.
|
|
12402
|
+
* @throws {RequiredError}
|
|
12403
|
+
*/
|
|
12404
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12405
|
+
return localVarFp.paymentGatewayCreateOrderPost(order, options).then((request) => request(axios, basePath));
|
|
12406
|
+
},
|
|
12407
|
+
/**
|
|
12408
|
+
* Returns list of all active credit plans for purchase
|
|
12409
|
+
* @summary Get available credit plans
|
|
12410
|
+
* @param {*} [options] Override http request option.
|
|
12411
|
+
* @throws {RequiredError}
|
|
12412
|
+
*/
|
|
12413
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12414
|
+
return localVarFp.paymentGatewayCreditPlansGet(options).then((request) => request(axios, basePath));
|
|
12415
|
+
},
|
|
12416
|
+
/**
|
|
12417
|
+
* Returns list of all available payment gateways
|
|
12418
|
+
* @summary Get available payment gateways
|
|
12419
|
+
* @param {*} [options] Override http request option.
|
|
12420
|
+
* @throws {RequiredError}
|
|
12421
|
+
*/
|
|
12422
|
+
paymentGatewayGatewaysGet(options) {
|
|
12423
|
+
return localVarFp.paymentGatewayGatewaysGet(options).then((request) => request(axios, basePath));
|
|
12424
|
+
},
|
|
12425
|
+
/**
|
|
12426
|
+
* Processes a refund for a completed payment
|
|
12427
|
+
* @summary Process payment refund
|
|
12428
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12429
|
+
* @param {*} [options] Override http request option.
|
|
12430
|
+
* @throws {RequiredError}
|
|
12431
|
+
*/
|
|
12432
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12433
|
+
return localVarFp.paymentGatewayRefundPost(refund, options).then((request) => request(axios, basePath));
|
|
12434
|
+
},
|
|
12435
|
+
/**
|
|
12436
|
+
* Verifies the current status of a payment
|
|
12437
|
+
* @summary Verify payment status
|
|
12438
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12439
|
+
* @param {*} [options] Override http request option.
|
|
12440
|
+
* @throws {RequiredError}
|
|
12441
|
+
*/
|
|
12442
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12443
|
+
return localVarFp.paymentGatewayVerifyPost(verify, options).then((request) => request(axios, basePath));
|
|
12444
|
+
},
|
|
12445
|
+
};
|
|
12446
|
+
};
|
|
12447
|
+
/**
|
|
12448
|
+
* PaymentGatewayApi - object-oriented interface
|
|
12449
|
+
* @export
|
|
12450
|
+
* @class PaymentGatewayApi
|
|
12451
|
+
* @extends {BaseAPI}
|
|
12452
|
+
*/
|
|
12453
|
+
export class PaymentGatewayApi extends BaseAPI {
|
|
12454
|
+
/**
|
|
12455
|
+
* Creates a payment order using specified or default payment gateway
|
|
12456
|
+
* @summary Create a new payment order
|
|
12457
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12458
|
+
* @param {*} [options] Override http request option.
|
|
12459
|
+
* @throws {RequiredError}
|
|
12460
|
+
* @memberof PaymentGatewayApi
|
|
12461
|
+
*/
|
|
12462
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12463
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayCreateOrderPost(order, options).then((request) => request(this.axios, this.basePath));
|
|
12464
|
+
}
|
|
12465
|
+
/**
|
|
12466
|
+
* Returns list of all active credit plans for purchase
|
|
12467
|
+
* @summary Get available credit plans
|
|
12468
|
+
* @param {*} [options] Override http request option.
|
|
12469
|
+
* @throws {RequiredError}
|
|
12470
|
+
* @memberof PaymentGatewayApi
|
|
12471
|
+
*/
|
|
12472
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12473
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayCreditPlansGet(options).then((request) => request(this.axios, this.basePath));
|
|
12474
|
+
}
|
|
12475
|
+
/**
|
|
12476
|
+
* Returns list of all available payment gateways
|
|
12477
|
+
* @summary Get available payment gateways
|
|
12478
|
+
* @param {*} [options] Override http request option.
|
|
12479
|
+
* @throws {RequiredError}
|
|
12480
|
+
* @memberof PaymentGatewayApi
|
|
12481
|
+
*/
|
|
12482
|
+
paymentGatewayGatewaysGet(options) {
|
|
12483
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayGatewaysGet(options).then((request) => request(this.axios, this.basePath));
|
|
12484
|
+
}
|
|
12485
|
+
/**
|
|
12486
|
+
* Processes a refund for a completed payment
|
|
12487
|
+
* @summary Process payment refund
|
|
12488
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12489
|
+
* @param {*} [options] Override http request option.
|
|
12490
|
+
* @throws {RequiredError}
|
|
12491
|
+
* @memberof PaymentGatewayApi
|
|
12492
|
+
*/
|
|
12493
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12494
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayRefundPost(refund, options).then((request) => request(this.axios, this.basePath));
|
|
12495
|
+
}
|
|
12496
|
+
/**
|
|
12497
|
+
* Verifies the current status of a payment
|
|
12498
|
+
* @summary Verify payment status
|
|
12499
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12500
|
+
* @param {*} [options] Override http request option.
|
|
12501
|
+
* @throws {RequiredError}
|
|
12502
|
+
* @memberof PaymentGatewayApi
|
|
12503
|
+
*/
|
|
12504
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12505
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayVerifyPost(verify, options).then((request) => request(this.axios, this.basePath));
|
|
12506
|
+
}
|
|
12507
|
+
}
|
|
11615
12508
|
/**
|
|
11616
12509
|
* PaymentsApi - axios parameter creator
|
|
11617
12510
|
* @export
|