@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/api.js
CHANGED
|
@@ -22,10 +22,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.
|
|
26
|
-
exports.
|
|
27
|
-
exports.
|
|
28
|
-
exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.SubscriptionsApi = exports.SubscriptionsApiFactory = exports.SubscriptionsApiFp = exports.SubscriptionsApiAxiosParamCreator = exports.StoresApi = exports.StoresApiFactory = exports.StoresApiFp = exports.StoresApiAxiosParamCreator = exports.StoreDocumentsApi = exports.StoreDocumentsApiFactory = exports.StoreDocumentsApiFp = exports.StoreDocumentsApiAxiosParamCreator = exports.StopwordsApi = exports.StopwordsApiFactory = exports.StopwordsApiFp = exports.StopwordsApiAxiosParamCreator = exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = void 0;
|
|
25
|
+
exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortByEnum = exports.AnalyticsApi = exports.AnalyticsApiFactory = exports.AnalyticsApiFp = exports.AnalyticsApiAxiosParamCreator = exports.AccountSettingsApi = exports.AccountSettingsApiFactory = exports.AccountSettingsApiFp = exports.AccountSettingsApiAxiosParamCreator = exports.APICallsApi = exports.APICallsApiFactory = exports.APICallsApiFp = exports.APICallsApiAxiosParamCreator = exports.DataTypesUpdateWordStatusRequestWordTypeEnum = exports.DataTypesUpdatePluralDeclensionRequestTypeEnum = exports.DataTypesCreditTransactionTransactionTypeEnum = exports.DataTypesCreateTaskRequestTypeEnum = exports.DataTypesCreateTaskRequestIndexingStrategyEnum = exports.DataTypesCreateTaskRequestFrequencyEnum = exports.DataTypesCreatePluralDeclensionRequestTypeEnum = exports.DataTypesCreatePaymentOrderRequestPaymentTypeEnum = exports.DataTypesCreateCustomWordListRequestTypeEnum = void 0;
|
|
26
|
+
exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortByEnum = exports.ItemAnalyticsApi = exports.ItemAnalyticsApiFactory = exports.ItemAnalyticsApiFp = exports.ItemAnalyticsApiAxiosParamCreator = exports.DocumentsApi = exports.DocumentsApiFactory = exports.DocumentsApiFp = exports.DocumentsApiAxiosParamCreator = exports.CustomStopwordsApi = exports.CustomStopwordsApiFactory = exports.CustomStopwordsApiFp = exports.CustomStopwordsApiAxiosParamCreator = exports.ApiCreditsTransactionsGetTypeEnum = exports.CreditsApi = exports.CreditsApiFactory = exports.CreditsApiFp = exports.CreditsApiAxiosParamCreator = exports.ConnectorsApi = exports.ConnectorsApiFactory = exports.ConnectorsApiFp = exports.ConnectorsApiAxiosParamCreator = exports.AuthApi = exports.AuthApiFactory = exports.AuthApiFp = exports.AuthApiAxiosParamCreator = exports.ArticlesApi = exports.ArticlesApiFactory = exports.ArticlesApiFp = exports.ArticlesApiAxiosParamCreator = exports.AnalyticsEventsApi = exports.AnalyticsEventsApiFactory = exports.AnalyticsEventsApiFp = exports.AnalyticsEventsApiAxiosParamCreator = exports.AdminAnalyticsStoreXStoreIDTagsSummaryGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDTagsSummaryGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDTagsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDTagsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum = void 0;
|
|
27
|
+
exports.PluralsDeclensionsApiFp = exports.PluralsDeclensionsApiAxiosParamCreator = exports.PlansApi = exports.PlansApiFactory = exports.PlansApiFp = exports.PlansApiAxiosParamCreator = exports.PaymentsApi = exports.PaymentsApiFactory = exports.PaymentsApiFp = exports.PaymentsApiAxiosParamCreator = exports.PaymentGatewayApi = exports.PaymentGatewayApiFactory = exports.PaymentGatewayApiFp = exports.PaymentGatewayApiAxiosParamCreator = exports.ParentMenusApi = exports.ParentMenusApiFactory = exports.ParentMenusApiFp = exports.ParentMenusApiAxiosParamCreator = exports.OrganizationsApi = exports.OrganizationsApiFactory = exports.OrganizationsApiFp = exports.OrganizationsApiAxiosParamCreator = exports.OnboardingApi = exports.OnboardingApiFactory = exports.OnboardingApiFp = exports.OnboardingApiAxiosParamCreator = exports.NewsLettersApi = exports.NewsLettersApiFactory = exports.NewsLettersApiFp = exports.NewsLettersApiAxiosParamCreator = exports.MongoDbApi = exports.MongoDbApiFactory = exports.MongoDbApiFp = exports.MongoDbApiAxiosParamCreator = exports.ModulesApi = exports.ModulesApiFactory = exports.ModulesApiFp = exports.ModulesApiAxiosParamCreator = exports.MenusApi = exports.MenusApiFactory = exports.MenusApiFp = exports.MenusApiAxiosParamCreator = exports.LimitsApi = exports.LimitsApiFactory = exports.LimitsApiFp = exports.LimitsApiAxiosParamCreator = exports.AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetSortByEnum = void 0;
|
|
28
|
+
exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.SubscriptionsApi = exports.SubscriptionsApiFactory = exports.SubscriptionsApiFp = exports.SubscriptionsApiAxiosParamCreator = exports.StoresApi = exports.StoresApiFactory = exports.StoresApiFp = exports.StoresApiAxiosParamCreator = exports.StoreDocumentsApi = exports.StoreDocumentsApiFactory = exports.StoreDocumentsApiFp = exports.StoreDocumentsApiAxiosParamCreator = exports.StopwordsApi = exports.StopwordsApiFactory = exports.StopwordsApiFp = exports.StopwordsApiAxiosParamCreator = exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = exports.RoleRightsApi = exports.RoleRightsApiFactory = exports.RoleRightsApiFp = exports.RoleRightsApiAxiosParamCreator = exports.RequestsApi = exports.RequestsApiFactory = exports.RequestsApiFp = exports.RequestsApiAxiosParamCreator = exports.RegisterApi = exports.RegisterApiFactory = exports.RegisterApiFp = exports.RegisterApiAxiosParamCreator = exports.PluralsDeclensionsApi = exports.PluralsDeclensionsApiFactory = void 0;
|
|
29
29
|
const axios_1 = require("axios");
|
|
30
30
|
// Some imports not used depending on template conditions
|
|
31
31
|
// @ts-ignore
|
|
@@ -36,6 +36,11 @@ exports.DataTypesCreateCustomWordListRequestTypeEnum = {
|
|
|
36
36
|
Stopwords: 'stopwords',
|
|
37
37
|
Synonyms: 'synonyms'
|
|
38
38
|
};
|
|
39
|
+
exports.DataTypesCreatePaymentOrderRequestPaymentTypeEnum = {
|
|
40
|
+
Generic: 'generic',
|
|
41
|
+
Subscription: 'subscription',
|
|
42
|
+
CreditTopup: 'credit_topup'
|
|
43
|
+
};
|
|
39
44
|
exports.DataTypesCreatePluralDeclensionRequestTypeEnum = {
|
|
40
45
|
Custom: 'custom',
|
|
41
46
|
Default: 'default'
|
|
@@ -1329,7 +1334,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1329
1334
|
};
|
|
1330
1335
|
}),
|
|
1331
1336
|
/**
|
|
1332
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
1337
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
1333
1338
|
* @summary Get Geographic Analytics
|
|
1334
1339
|
* @param {string} xStoreID Store ID
|
|
1335
1340
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -1340,6 +1345,14 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1340
1345
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1341
1346
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1342
1347
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1348
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1349
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1350
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1351
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1352
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1353
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1354
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1355
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1343
1356
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1344
1357
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1345
1358
|
* @param {number} [page] Page number for pagination
|
|
@@ -1350,7 +1363,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1350
1363
|
* @param {*} [options] Override http request option.
|
|
1351
1364
|
* @throws {RequiredError}
|
|
1352
1365
|
*/
|
|
1353
|
-
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 = {}) {
|
|
1366
|
+
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 = {}) {
|
|
1354
1367
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1355
1368
|
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDGeoGet', 'xStoreID', xStoreID);
|
|
1356
1369
|
const localVarPath = `/admin/analytics/store/{xStoreID}/geo`
|
|
@@ -1390,6 +1403,30 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1390
1403
|
if (tagValueFilter !== undefined) {
|
|
1391
1404
|
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1392
1405
|
}
|
|
1406
|
+
if (compareMode !== undefined) {
|
|
1407
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1408
|
+
}
|
|
1409
|
+
if (compareStartTime !== undefined) {
|
|
1410
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1411
|
+
}
|
|
1412
|
+
if (compareEndTime !== undefined) {
|
|
1413
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1414
|
+
}
|
|
1415
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1416
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1417
|
+
}
|
|
1418
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1419
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1420
|
+
}
|
|
1421
|
+
if (compareTagsExclude !== undefined) {
|
|
1422
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1423
|
+
}
|
|
1424
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1425
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1426
|
+
}
|
|
1427
|
+
if (compareTagValueFilter !== undefined) {
|
|
1428
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1429
|
+
}
|
|
1393
1430
|
if (limit !== undefined) {
|
|
1394
1431
|
localVarQueryParameter['limit'] = limit;
|
|
1395
1432
|
}
|
|
@@ -1451,7 +1488,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1451
1488
|
};
|
|
1452
1489
|
}),
|
|
1453
1490
|
/**
|
|
1454
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
1491
|
+
* 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.
|
|
1455
1492
|
* @summary Get KPI Analytics
|
|
1456
1493
|
* @param {string} xStoreID Store ID
|
|
1457
1494
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -1462,6 +1499,14 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1462
1499
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1463
1500
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1464
1501
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1502
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1503
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1504
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1505
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1506
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1507
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1508
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1509
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1465
1510
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1466
1511
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1467
1512
|
* @param {number} [page] Page number for pagination
|
|
@@ -1469,7 +1514,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1469
1514
|
* @param {*} [options] Override http request option.
|
|
1470
1515
|
* @throws {RequiredError}
|
|
1471
1516
|
*/
|
|
1472
|
-
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 = {}) {
|
|
1517
|
+
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 = {}) {
|
|
1473
1518
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1474
1519
|
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDKpiGet', 'xStoreID', xStoreID);
|
|
1475
1520
|
const localVarPath = `/admin/analytics/store/{xStoreID}/kpi`
|
|
@@ -1509,6 +1554,30 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1509
1554
|
if (tagValueFilter !== undefined) {
|
|
1510
1555
|
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1511
1556
|
}
|
|
1557
|
+
if (compareMode !== undefined) {
|
|
1558
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1559
|
+
}
|
|
1560
|
+
if (compareStartTime !== undefined) {
|
|
1561
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1562
|
+
}
|
|
1563
|
+
if (compareEndTime !== undefined) {
|
|
1564
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1565
|
+
}
|
|
1566
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1567
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1568
|
+
}
|
|
1569
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1570
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1571
|
+
}
|
|
1572
|
+
if (compareTagsExclude !== undefined) {
|
|
1573
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1574
|
+
}
|
|
1575
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1576
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1577
|
+
}
|
|
1578
|
+
if (compareTagValueFilter !== undefined) {
|
|
1579
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1580
|
+
}
|
|
1512
1581
|
if (limit !== undefined) {
|
|
1513
1582
|
localVarQueryParameter['limit'] = limit;
|
|
1514
1583
|
}
|
|
@@ -1561,7 +1630,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1561
1630
|
};
|
|
1562
1631
|
}),
|
|
1563
1632
|
/**
|
|
1564
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
1633
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
1565
1634
|
* @summary Get Query Analytics
|
|
1566
1635
|
* @param {string} xStoreID Store ID
|
|
1567
1636
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -1573,6 +1642,14 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1573
1642
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1574
1643
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1575
1644
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1645
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1646
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1647
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1648
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1649
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1650
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1651
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1652
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1576
1653
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1577
1654
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1578
1655
|
* @param {number} [page] Page number for pagination
|
|
@@ -1584,7 +1661,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1584
1661
|
* @param {*} [options] Override http request option.
|
|
1585
1662
|
* @throws {RequiredError}
|
|
1586
1663
|
*/
|
|
1587
|
-
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 = {}) {
|
|
1664
|
+
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 = {}) {
|
|
1588
1665
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1589
1666
|
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQueriesGet', 'xStoreID', xStoreID);
|
|
1590
1667
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries`
|
|
@@ -1627,6 +1704,30 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1627
1704
|
if (tagValueFilter !== undefined) {
|
|
1628
1705
|
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1629
1706
|
}
|
|
1707
|
+
if (compareMode !== undefined) {
|
|
1708
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1709
|
+
}
|
|
1710
|
+
if (compareStartTime !== undefined) {
|
|
1711
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1712
|
+
}
|
|
1713
|
+
if (compareEndTime !== undefined) {
|
|
1714
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1715
|
+
}
|
|
1716
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1717
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1718
|
+
}
|
|
1719
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1720
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1721
|
+
}
|
|
1722
|
+
if (compareTagsExclude !== undefined) {
|
|
1723
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1724
|
+
}
|
|
1725
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1726
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1727
|
+
}
|
|
1728
|
+
if (compareTagValueFilter !== undefined) {
|
|
1729
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1730
|
+
}
|
|
1630
1731
|
if (limit !== undefined) {
|
|
1631
1732
|
localVarQueryParameter['limit'] = limit;
|
|
1632
1733
|
}
|
|
@@ -1660,11 +1761,25 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1660
1761
|
};
|
|
1661
1762
|
}),
|
|
1662
1763
|
/**
|
|
1663
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
1764
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
1664
1765
|
* @summary Get No-Clicks Queries
|
|
1665
1766
|
* @param {string} xStoreID Store ID
|
|
1666
1767
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1667
1768
|
* @param {string} [endTime] End time in RFC3339 format
|
|
1769
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
1770
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
1771
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
1772
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1773
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1774
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1775
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1776
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1777
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1778
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1779
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1780
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1781
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1782
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1668
1783
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1669
1784
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1670
1785
|
* @param {number} [page] Page number for pagination
|
|
@@ -1675,7 +1790,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1675
1790
|
* @param {*} [options] Override http request option.
|
|
1676
1791
|
* @throws {RequiredError}
|
|
1677
1792
|
*/
|
|
1678
|
-
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 = {}) {
|
|
1793
|
+
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 = {}) {
|
|
1679
1794
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1680
1795
|
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQueriesNoClicksGet', 'xStoreID', xStoreID);
|
|
1681
1796
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-clicks`
|
|
@@ -1697,6 +1812,48 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1697
1812
|
if (endTime !== undefined) {
|
|
1698
1813
|
localVarQueryParameter['end_time'] = endTime;
|
|
1699
1814
|
}
|
|
1815
|
+
if (search !== undefined) {
|
|
1816
|
+
localVarQueryParameter['search'] = search;
|
|
1817
|
+
}
|
|
1818
|
+
if (analyticsTags !== undefined) {
|
|
1819
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
1820
|
+
}
|
|
1821
|
+
if (tagsMatchMode !== undefined) {
|
|
1822
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
1823
|
+
}
|
|
1824
|
+
if (tagsExclude !== undefined) {
|
|
1825
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
1826
|
+
}
|
|
1827
|
+
if (tagKeyFilter !== undefined) {
|
|
1828
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
1829
|
+
}
|
|
1830
|
+
if (tagValueFilter !== undefined) {
|
|
1831
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1832
|
+
}
|
|
1833
|
+
if (compareMode !== undefined) {
|
|
1834
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1835
|
+
}
|
|
1836
|
+
if (compareStartTime !== undefined) {
|
|
1837
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1838
|
+
}
|
|
1839
|
+
if (compareEndTime !== undefined) {
|
|
1840
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1841
|
+
}
|
|
1842
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1843
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1844
|
+
}
|
|
1845
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1846
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1847
|
+
}
|
|
1848
|
+
if (compareTagsExclude !== undefined) {
|
|
1849
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1850
|
+
}
|
|
1851
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1852
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1853
|
+
}
|
|
1854
|
+
if (compareTagValueFilter !== undefined) {
|
|
1855
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1856
|
+
}
|
|
1700
1857
|
if (limit !== undefined) {
|
|
1701
1858
|
localVarQueryParameter['limit'] = limit;
|
|
1702
1859
|
}
|
|
@@ -1727,11 +1884,25 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1727
1884
|
};
|
|
1728
1885
|
}),
|
|
1729
1886
|
/**
|
|
1730
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
1887
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
1731
1888
|
* @summary Get No-Results Queries
|
|
1732
1889
|
* @param {string} xStoreID Store ID
|
|
1733
1890
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1734
1891
|
* @param {string} [endTime] End time in RFC3339 format
|
|
1892
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
1893
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
1894
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
1895
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
1896
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
1897
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
1898
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
1899
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
1900
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
1901
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
1902
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
1903
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
1904
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
1905
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1735
1906
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1736
1907
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1737
1908
|
* @param {number} [page] Page number for pagination
|
|
@@ -1742,7 +1913,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1742
1913
|
* @param {*} [options] Override http request option.
|
|
1743
1914
|
* @throws {RequiredError}
|
|
1744
1915
|
*/
|
|
1745
|
-
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 = {}) {
|
|
1916
|
+
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 = {}) {
|
|
1746
1917
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1747
1918
|
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQueriesNoResultsGet', 'xStoreID', xStoreID);
|
|
1748
1919
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-results`
|
|
@@ -1764,6 +1935,48 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1764
1935
|
if (endTime !== undefined) {
|
|
1765
1936
|
localVarQueryParameter['end_time'] = endTime;
|
|
1766
1937
|
}
|
|
1938
|
+
if (search !== undefined) {
|
|
1939
|
+
localVarQueryParameter['search'] = search;
|
|
1940
|
+
}
|
|
1941
|
+
if (analyticsTags !== undefined) {
|
|
1942
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
1943
|
+
}
|
|
1944
|
+
if (tagsMatchMode !== undefined) {
|
|
1945
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
1946
|
+
}
|
|
1947
|
+
if (tagsExclude !== undefined) {
|
|
1948
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
1949
|
+
}
|
|
1950
|
+
if (tagKeyFilter !== undefined) {
|
|
1951
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
1952
|
+
}
|
|
1953
|
+
if (tagValueFilter !== undefined) {
|
|
1954
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
1955
|
+
}
|
|
1956
|
+
if (compareMode !== undefined) {
|
|
1957
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
1958
|
+
}
|
|
1959
|
+
if (compareStartTime !== undefined) {
|
|
1960
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
1961
|
+
}
|
|
1962
|
+
if (compareEndTime !== undefined) {
|
|
1963
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
1964
|
+
}
|
|
1965
|
+
if (compareAnalyticsTags !== undefined) {
|
|
1966
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
1967
|
+
}
|
|
1968
|
+
if (compareTagsMatchMode !== undefined) {
|
|
1969
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
1970
|
+
}
|
|
1971
|
+
if (compareTagsExclude !== undefined) {
|
|
1972
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
1973
|
+
}
|
|
1974
|
+
if (compareTagKeyFilter !== undefined) {
|
|
1975
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
1976
|
+
}
|
|
1977
|
+
if (compareTagValueFilter !== undefined) {
|
|
1978
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
1979
|
+
}
|
|
1767
1980
|
if (limit !== undefined) {
|
|
1768
1981
|
localVarQueryParameter['limit'] = limit;
|
|
1769
1982
|
}
|
|
@@ -1837,17 +2050,31 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1837
2050
|
};
|
|
1838
2051
|
}),
|
|
1839
2052
|
/**
|
|
1840
|
-
* Retrieve analytics for top performing search results with
|
|
2053
|
+
* 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.
|
|
1841
2054
|
* @summary Get Top Results Analytics
|
|
1842
2055
|
* @param {string} xStoreID Store ID
|
|
1843
2056
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
1844
2057
|
* @param {string} [endTime] End time in RFC3339 format
|
|
1845
2058
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
2059
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2060
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2061
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2062
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2063
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2064
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2065
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2066
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2067
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2068
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2069
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2070
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2071
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
1846
2072
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
1847
2073
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
1848
2074
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
1849
2075
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
1850
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
2076
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
2077
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
1851
2078
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
1852
2079
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
1853
2080
|
* @param {number} [page] Page number for pagination
|
|
@@ -1855,7 +2082,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1855
2082
|
* @param {*} [options] Override http request option.
|
|
1856
2083
|
* @throws {RequiredError}
|
|
1857
2084
|
*/
|
|
1858
|
-
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 = {}) {
|
|
2085
|
+
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 = {}) {
|
|
1859
2086
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
1860
2087
|
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDResultsGet', 'xStoreID', xStoreID);
|
|
1861
2088
|
const localVarPath = `/admin/analytics/store/{xStoreID}/results`
|
|
@@ -1880,6 +2107,45 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1880
2107
|
if (itemIds !== undefined) {
|
|
1881
2108
|
localVarQueryParameter['item_ids'] = itemIds;
|
|
1882
2109
|
}
|
|
2110
|
+
if (analyticsTags !== undefined) {
|
|
2111
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
2112
|
+
}
|
|
2113
|
+
if (tagsMatchMode !== undefined) {
|
|
2114
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
2115
|
+
}
|
|
2116
|
+
if (tagsExclude !== undefined) {
|
|
2117
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
2118
|
+
}
|
|
2119
|
+
if (tagKeyFilter !== undefined) {
|
|
2120
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
2121
|
+
}
|
|
2122
|
+
if (tagValueFilter !== undefined) {
|
|
2123
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
2124
|
+
}
|
|
2125
|
+
if (compareMode !== undefined) {
|
|
2126
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
2127
|
+
}
|
|
2128
|
+
if (compareStartTime !== undefined) {
|
|
2129
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
2130
|
+
}
|
|
2131
|
+
if (compareEndTime !== undefined) {
|
|
2132
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
2133
|
+
}
|
|
2134
|
+
if (compareAnalyticsTags !== undefined) {
|
|
2135
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
2136
|
+
}
|
|
2137
|
+
if (compareTagsMatchMode !== undefined) {
|
|
2138
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
2139
|
+
}
|
|
2140
|
+
if (compareTagsExclude !== undefined) {
|
|
2141
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
2142
|
+
}
|
|
2143
|
+
if (compareTagKeyFilter !== undefined) {
|
|
2144
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
2145
|
+
}
|
|
2146
|
+
if (compareTagValueFilter !== undefined) {
|
|
2147
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
2148
|
+
}
|
|
1883
2149
|
if (minImpressions !== undefined) {
|
|
1884
2150
|
localVarQueryParameter['min_impressions'] = minImpressions;
|
|
1885
2151
|
}
|
|
@@ -1895,6 +2161,9 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1895
2161
|
if (includeDocuments !== undefined) {
|
|
1896
2162
|
localVarQueryParameter['include_documents'] = includeDocuments;
|
|
1897
2163
|
}
|
|
2164
|
+
if (includeWidget !== undefined) {
|
|
2165
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
2166
|
+
}
|
|
1898
2167
|
if (limit !== undefined) {
|
|
1899
2168
|
localVarQueryParameter['limit'] = limit;
|
|
1900
2169
|
}
|
|
@@ -2213,7 +2482,7 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2213
2482
|
});
|
|
2214
2483
|
},
|
|
2215
2484
|
/**
|
|
2216
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
2485
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
2217
2486
|
* @summary Get Geographic Analytics
|
|
2218
2487
|
* @param {string} xStoreID Store ID
|
|
2219
2488
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2224,6 +2493,14 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2224
2493
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2225
2494
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2226
2495
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2496
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2497
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2498
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2499
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2500
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2501
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2502
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2503
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2227
2504
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2228
2505
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2229
2506
|
* @param {number} [page] Page number for pagination
|
|
@@ -2234,10 +2511,10 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2234
2511
|
* @param {*} [options] Override http request option.
|
|
2235
2512
|
* @throws {RequiredError}
|
|
2236
2513
|
*/
|
|
2237
|
-
adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2514
|
+
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) {
|
|
2238
2515
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2239
2516
|
var _a, _b, _c;
|
|
2240
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2517
|
+
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);
|
|
2241
2518
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2242
2519
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDGeoGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2243
2520
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2260,7 +2537,7 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2260
2537
|
});
|
|
2261
2538
|
},
|
|
2262
2539
|
/**
|
|
2263
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
2540
|
+
* 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.
|
|
2264
2541
|
* @summary Get KPI Analytics
|
|
2265
2542
|
* @param {string} xStoreID Store ID
|
|
2266
2543
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2271,6 +2548,14 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2271
2548
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2272
2549
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2273
2550
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2551
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2552
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2553
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2554
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2555
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2556
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2557
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2558
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2274
2559
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2275
2560
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2276
2561
|
* @param {number} [page] Page number for pagination
|
|
@@ -2278,10 +2563,10 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2278
2563
|
* @param {*} [options] Override http request option.
|
|
2279
2564
|
* @throws {RequiredError}
|
|
2280
2565
|
*/
|
|
2281
|
-
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options) {
|
|
2566
|
+
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options) {
|
|
2282
2567
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2283
2568
|
var _a, _b, _c;
|
|
2284
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options);
|
|
2569
|
+
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);
|
|
2285
2570
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2286
2571
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDKpiGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2287
2572
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2304,7 +2589,7 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2304
2589
|
});
|
|
2305
2590
|
},
|
|
2306
2591
|
/**
|
|
2307
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
2592
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
2308
2593
|
* @summary Get Query Analytics
|
|
2309
2594
|
* @param {string} xStoreID Store ID
|
|
2310
2595
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2316,6 +2601,14 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2316
2601
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2317
2602
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2318
2603
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2604
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2605
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2606
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2607
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2608
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2609
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2610
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2611
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2319
2612
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2320
2613
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2321
2614
|
* @param {number} [page] Page number for pagination
|
|
@@ -2327,21 +2620,35 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2327
2620
|
* @param {*} [options] Override http request option.
|
|
2328
2621
|
* @throws {RequiredError}
|
|
2329
2622
|
*/
|
|
2330
|
-
adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options) {
|
|
2623
|
+
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) {
|
|
2331
2624
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2332
2625
|
var _a, _b, _c;
|
|
2333
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options);
|
|
2626
|
+
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);
|
|
2334
2627
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2335
2628
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2336
2629
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2337
2630
|
});
|
|
2338
2631
|
},
|
|
2339
2632
|
/**
|
|
2340
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
2633
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
2341
2634
|
* @summary Get No-Clicks Queries
|
|
2342
2635
|
* @param {string} xStoreID Store ID
|
|
2343
2636
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2344
2637
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2638
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2639
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2640
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2641
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2642
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2643
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2644
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2645
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2646
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2647
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2648
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2649
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2650
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2651
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2345
2652
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2346
2653
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2347
2654
|
* @param {number} [page] Page number for pagination
|
|
@@ -2352,21 +2659,35 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2352
2659
|
* @param {*} [options] Override http request option.
|
|
2353
2660
|
* @throws {RequiredError}
|
|
2354
2661
|
*/
|
|
2355
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2662
|
+
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) {
|
|
2356
2663
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2357
2664
|
var _a, _b, _c;
|
|
2358
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2665
|
+
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);
|
|
2359
2666
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2360
2667
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoClicksGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2361
2668
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2362
2669
|
});
|
|
2363
2670
|
},
|
|
2364
2671
|
/**
|
|
2365
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
2672
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
2366
2673
|
* @summary Get No-Results Queries
|
|
2367
2674
|
* @param {string} xStoreID Store ID
|
|
2368
2675
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2369
2676
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2677
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
2678
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2679
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2680
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2681
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2682
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2683
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2684
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2685
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2686
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2687
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2688
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2689
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2690
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2370
2691
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2371
2692
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2372
2693
|
* @param {number} [page] Page number for pagination
|
|
@@ -2377,10 +2698,10 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2377
2698
|
* @param {*} [options] Override http request option.
|
|
2378
2699
|
* @throws {RequiredError}
|
|
2379
2700
|
*/
|
|
2380
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2701
|
+
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) {
|
|
2381
2702
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2382
2703
|
var _a, _b, _c;
|
|
2383
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
2704
|
+
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);
|
|
2384
2705
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2385
2706
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoResultsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2386
2707
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2406,17 +2727,31 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2406
2727
|
});
|
|
2407
2728
|
},
|
|
2408
2729
|
/**
|
|
2409
|
-
* Retrieve analytics for top performing search results with
|
|
2730
|
+
* 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.
|
|
2410
2731
|
* @summary Get Top Results Analytics
|
|
2411
2732
|
* @param {string} xStoreID Store ID
|
|
2412
2733
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2413
2734
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2414
2735
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
2736
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2737
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2738
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2739
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2740
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2741
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2742
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2743
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2744
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2745
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2746
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2747
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2748
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2415
2749
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
2416
2750
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
2417
2751
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
2418
2752
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
2419
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
2753
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
2754
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
2420
2755
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2421
2756
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2422
2757
|
* @param {number} [page] Page number for pagination
|
|
@@ -2424,10 +2759,10 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2424
2759
|
* @param {*} [options] Override http request option.
|
|
2425
2760
|
* @throws {RequiredError}
|
|
2426
2761
|
*/
|
|
2427
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options) {
|
|
2762
|
+
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) {
|
|
2428
2763
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2429
2764
|
var _a, _b, _c;
|
|
2430
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options);
|
|
2765
|
+
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);
|
|
2431
2766
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2432
2767
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDResultsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2433
2768
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2603,7 +2938,7 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2603
2938
|
return localVarFp.adminAnalyticsStoreXStoreIDFiltersTrendsGet(xStoreID, startTime, endTime, granularity, filterKey, topFilters, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
2604
2939
|
},
|
|
2605
2940
|
/**
|
|
2606
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
2941
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
2607
2942
|
* @summary Get Geographic Analytics
|
|
2608
2943
|
* @param {string} xStoreID Store ID
|
|
2609
2944
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2614,6 +2949,14 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2614
2949
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2615
2950
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2616
2951
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2952
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2953
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2954
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2955
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2956
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2957
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2958
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2959
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2617
2960
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2618
2961
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2619
2962
|
* @param {number} [page] Page number for pagination
|
|
@@ -2624,8 +2967,8 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2624
2967
|
* @param {*} [options] Override http request option.
|
|
2625
2968
|
* @throws {RequiredError}
|
|
2626
2969
|
*/
|
|
2627
|
-
adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2628
|
-
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));
|
|
2970
|
+
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) {
|
|
2971
|
+
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));
|
|
2629
2972
|
},
|
|
2630
2973
|
/**
|
|
2631
2974
|
* Check the health status of analytics service and ClickHouse connection
|
|
@@ -2638,7 +2981,7 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2638
2981
|
return localVarFp.adminAnalyticsStoreXStoreIDHealthGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
2639
2982
|
},
|
|
2640
2983
|
/**
|
|
2641
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
2984
|
+
* 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.
|
|
2642
2985
|
* @summary Get KPI Analytics
|
|
2643
2986
|
* @param {string} xStoreID Store ID
|
|
2644
2987
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2649,6 +2992,14 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2649
2992
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2650
2993
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2651
2994
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2995
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2996
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2997
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2998
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2999
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3000
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3001
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3002
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2652
3003
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2653
3004
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2654
3005
|
* @param {number} [page] Page number for pagination
|
|
@@ -2656,8 +3007,8 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2656
3007
|
* @param {*} [options] Override http request option.
|
|
2657
3008
|
* @throws {RequiredError}
|
|
2658
3009
|
*/
|
|
2659
|
-
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options) {
|
|
2660
|
-
return localVarFp.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
3010
|
+
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options) {
|
|
3011
|
+
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));
|
|
2661
3012
|
},
|
|
2662
3013
|
/**
|
|
2663
3014
|
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
@@ -2670,7 +3021,7 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2670
3021
|
return localVarFp.adminAnalyticsStoreXStoreIDKpiRealtimeGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
2671
3022
|
},
|
|
2672
3023
|
/**
|
|
2673
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
3024
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
2674
3025
|
* @summary Get Query Analytics
|
|
2675
3026
|
* @param {string} xStoreID Store ID
|
|
2676
3027
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2682,6 +3033,14 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2682
3033
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2683
3034
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2684
3035
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3036
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3037
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3038
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3039
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3040
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3041
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3042
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3043
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2685
3044
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2686
3045
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2687
3046
|
* @param {number} [page] Page number for pagination
|
|
@@ -2693,15 +3052,29 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2693
3052
|
* @param {*} [options] Override http request option.
|
|
2694
3053
|
* @throws {RequiredError}
|
|
2695
3054
|
*/
|
|
2696
|
-
adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options) {
|
|
2697
|
-
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));
|
|
3055
|
+
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) {
|
|
3056
|
+
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));
|
|
2698
3057
|
},
|
|
2699
3058
|
/**
|
|
2700
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
3059
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
2701
3060
|
* @summary Get No-Clicks Queries
|
|
2702
3061
|
* @param {string} xStoreID Store ID
|
|
2703
3062
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2704
3063
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3064
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3065
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3066
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3067
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3068
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3069
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3070
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3071
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3072
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3073
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3074
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3075
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3076
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3077
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2705
3078
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2706
3079
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2707
3080
|
* @param {number} [page] Page number for pagination
|
|
@@ -2712,15 +3085,29 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2712
3085
|
* @param {*} [options] Override http request option.
|
|
2713
3086
|
* @throws {RequiredError}
|
|
2714
3087
|
*/
|
|
2715
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2716
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
3088
|
+
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) {
|
|
3089
|
+
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));
|
|
2717
3090
|
},
|
|
2718
3091
|
/**
|
|
2719
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
3092
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
2720
3093
|
* @summary Get No-Results Queries
|
|
2721
3094
|
* @param {string} xStoreID Store ID
|
|
2722
3095
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2723
3096
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3097
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3098
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3099
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3100
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3101
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3102
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3103
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3104
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3105
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3106
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3107
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3108
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3109
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3110
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2724
3111
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2725
3112
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2726
3113
|
* @param {number} [page] Page number for pagination
|
|
@@ -2731,8 +3118,8 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2731
3118
|
* @param {*} [options] Override http request option.
|
|
2732
3119
|
* @throws {RequiredError}
|
|
2733
3120
|
*/
|
|
2734
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2735
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
3121
|
+
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) {
|
|
3122
|
+
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));
|
|
2736
3123
|
},
|
|
2737
3124
|
/**
|
|
2738
3125
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
@@ -2748,17 +3135,31 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2748
3135
|
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
2749
3136
|
},
|
|
2750
3137
|
/**
|
|
2751
|
-
* Retrieve analytics for top performing search results with
|
|
3138
|
+
* 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.
|
|
2752
3139
|
* @summary Get Top Results Analytics
|
|
2753
3140
|
* @param {string} xStoreID Store ID
|
|
2754
3141
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
2755
3142
|
* @param {string} [endTime] End time in RFC3339 format
|
|
2756
3143
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
3144
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3145
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3146
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3147
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3148
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3149
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3150
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3151
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3152
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3153
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3154
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3155
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3156
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2757
3157
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
2758
3158
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
2759
3159
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
2760
3160
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
2761
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
3161
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
3162
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
2762
3163
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2763
3164
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2764
3165
|
* @param {number} [page] Page number for pagination
|
|
@@ -2766,8 +3167,8 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2766
3167
|
* @param {*} [options] Override http request option.
|
|
2767
3168
|
* @throws {RequiredError}
|
|
2768
3169
|
*/
|
|
2769
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options) {
|
|
2770
|
-
return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
3170
|
+
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) {
|
|
3171
|
+
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));
|
|
2771
3172
|
},
|
|
2772
3173
|
/**
|
|
2773
3174
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -2933,7 +3334,7 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
2933
3334
|
return (0, exports.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));
|
|
2934
3335
|
}
|
|
2935
3336
|
/**
|
|
2936
|
-
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support
|
|
3337
|
+
* Retrieve geographic analytics data showing search behavior by country, region, and city with analytics tags filtering support and comparison mode
|
|
2937
3338
|
* @summary Get Geographic Analytics
|
|
2938
3339
|
* @param {string} xStoreID Store ID
|
|
2939
3340
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2944,6 +3345,14 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
2944
3345
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2945
3346
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2946
3347
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3348
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3349
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3350
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3351
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3352
|
+
* @param {AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3353
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3354
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3355
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2947
3356
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2948
3357
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2949
3358
|
* @param {number} [page] Page number for pagination
|
|
@@ -2955,8 +3364,8 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
2955
3364
|
* @throws {RequiredError}
|
|
2956
3365
|
* @memberof AnalyticsApi
|
|
2957
3366
|
*/
|
|
2958
|
-
adminAnalyticsStoreXStoreIDGeoGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
2959
|
-
return (0, exports.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));
|
|
3367
|
+
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) {
|
|
3368
|
+
return (0, exports.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));
|
|
2960
3369
|
}
|
|
2961
3370
|
/**
|
|
2962
3371
|
* Check the health status of analytics service and ClickHouse connection
|
|
@@ -2970,7 +3379,7 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
2970
3379
|
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDHealthGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
2971
3380
|
}
|
|
2972
3381
|
/**
|
|
2973
|
-
* Retrieve comprehensive KPI metrics including searches, clicks, conversions, and revenue data with time series and summary. Supports analytics tags filtering with AND/OR operators.
|
|
3382
|
+
* 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.
|
|
2974
3383
|
* @summary Get KPI Analytics
|
|
2975
3384
|
* @param {string} xStoreID Store ID
|
|
2976
3385
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -2981,6 +3390,14 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
2981
3390
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2982
3391
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2983
3392
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3393
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3394
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3395
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3396
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3397
|
+
* @param {AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3398
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3399
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3400
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2984
3401
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
2985
3402
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
2986
3403
|
* @param {number} [page] Page number for pagination
|
|
@@ -2989,8 +3406,8 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
2989
3406
|
* @throws {RequiredError}
|
|
2990
3407
|
* @memberof AnalyticsApi
|
|
2991
3408
|
*/
|
|
2992
|
-
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, options) {
|
|
2993
|
-
return (0, exports.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));
|
|
3409
|
+
adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options) {
|
|
3410
|
+
return (0, exports.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));
|
|
2994
3411
|
}
|
|
2995
3412
|
/**
|
|
2996
3413
|
* Retrieve real-time KPI metrics for the last hour with minute-level granularity
|
|
@@ -3004,7 +3421,7 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3004
3421
|
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDKpiRealtimeGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
3005
3422
|
}
|
|
3006
3423
|
/**
|
|
3007
|
-
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering
|
|
3424
|
+
* Retrieve detailed analytics for search queries including performance metrics, click-through rates, and conversion data with advanced analytics tags filtering and comparison mode support
|
|
3008
3425
|
* @summary Get Query Analytics
|
|
3009
3426
|
* @param {string} xStoreID Store ID
|
|
3010
3427
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
@@ -3016,6 +3433,14 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3016
3433
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3017
3434
|
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3018
3435
|
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3436
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3437
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3438
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3439
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3440
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3441
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3442
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3443
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3019
3444
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
3020
3445
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
3021
3446
|
* @param {number} [page] Page number for pagination
|
|
@@ -3028,15 +3453,29 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3028
3453
|
* @throws {RequiredError}
|
|
3029
3454
|
* @memberof AnalyticsApi
|
|
3030
3455
|
*/
|
|
3031
|
-
adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options) {
|
|
3032
|
-
return (0, exports.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));
|
|
3456
|
+
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) {
|
|
3457
|
+
return (0, exports.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));
|
|
3033
3458
|
}
|
|
3034
3459
|
/**
|
|
3035
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance
|
|
3460
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
3036
3461
|
* @summary Get No-Clicks Queries
|
|
3037
3462
|
* @param {string} xStoreID Store ID
|
|
3038
3463
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3039
3464
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3465
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3466
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3467
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3468
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3469
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3470
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3471
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3472
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3473
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3474
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3475
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3476
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3477
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3478
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3040
3479
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
3041
3480
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
3042
3481
|
* @param {number} [page] Page number for pagination
|
|
@@ -3048,15 +3487,29 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3048
3487
|
* @throws {RequiredError}
|
|
3049
3488
|
* @memberof AnalyticsApi
|
|
3050
3489
|
*/
|
|
3051
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3052
|
-
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3490
|
+
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) {
|
|
3491
|
+
return (0, exports.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));
|
|
3053
3492
|
}
|
|
3054
3493
|
/**
|
|
3055
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps
|
|
3494
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
3056
3495
|
* @summary Get No-Results Queries
|
|
3057
3496
|
* @param {string} xStoreID Store ID
|
|
3058
3497
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3059
3498
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3499
|
+
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
3500
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3501
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3502
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3503
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3504
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3505
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3506
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3507
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3508
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3509
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3510
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3511
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3512
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3060
3513
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
3061
3514
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
3062
3515
|
* @param {number} [page] Page number for pagination
|
|
@@ -3068,8 +3521,8 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3068
3521
|
* @throws {RequiredError}
|
|
3069
3522
|
* @memberof AnalyticsApi
|
|
3070
3523
|
*/
|
|
3071
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options) {
|
|
3072
|
-
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3524
|
+
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) {
|
|
3525
|
+
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3073
3526
|
}
|
|
3074
3527
|
/**
|
|
3075
3528
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
@@ -3086,17 +3539,31 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3086
3539
|
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
|
|
3087
3540
|
}
|
|
3088
3541
|
/**
|
|
3089
|
-
* Retrieve analytics for top performing search results with
|
|
3542
|
+
* 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.
|
|
3090
3543
|
* @summary Get Top Results Analytics
|
|
3091
3544
|
* @param {string} xStoreID Store ID
|
|
3092
3545
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
3093
3546
|
* @param {string} [endTime] End time in RFC3339 format
|
|
3094
3547
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
3548
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3549
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3550
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3551
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3552
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3553
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3554
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3555
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3556
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3557
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3558
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3559
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3560
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3095
3561
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
3096
3562
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
3097
3563
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
3098
3564
|
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
3099
|
-
* @param {boolean} [includeDocuments] Whether to include document data from search index
|
|
3565
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
3566
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
3100
3567
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
3101
3568
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
3102
3569
|
* @param {number} [page] Page number for pagination
|
|
@@ -3105,8 +3572,8 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3105
3572
|
* @throws {RequiredError}
|
|
3106
3573
|
* @memberof AnalyticsApi
|
|
3107
3574
|
*/
|
|
3108
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, limit, offset, page, pageSize, options) {
|
|
3109
|
-
return (0, exports.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));
|
|
3575
|
+
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) {
|
|
3576
|
+
return (0, exports.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));
|
|
3110
3577
|
}
|
|
3111
3578
|
/**
|
|
3112
3579
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -3259,6 +3726,13 @@ exports.AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum = {
|
|
|
3259
3726
|
Any: 'any',
|
|
3260
3727
|
All: 'all'
|
|
3261
3728
|
};
|
|
3729
|
+
/**
|
|
3730
|
+
* @export
|
|
3731
|
+
*/
|
|
3732
|
+
exports.AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum = {
|
|
3733
|
+
Any: 'any',
|
|
3734
|
+
All: 'all'
|
|
3735
|
+
};
|
|
3262
3736
|
/**
|
|
3263
3737
|
* @export
|
|
3264
3738
|
*/
|
|
@@ -3296,6 +3770,13 @@ exports.AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum = {
|
|
|
3296
3770
|
Any: 'any',
|
|
3297
3771
|
All: 'all'
|
|
3298
3772
|
};
|
|
3773
|
+
/**
|
|
3774
|
+
* @export
|
|
3775
|
+
*/
|
|
3776
|
+
exports.AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum = {
|
|
3777
|
+
Any: 'any',
|
|
3778
|
+
All: 'all'
|
|
3779
|
+
};
|
|
3299
3780
|
/**
|
|
3300
3781
|
* @export
|
|
3301
3782
|
*/
|
|
@@ -3315,6 +3796,13 @@ exports.AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum = {
|
|
|
3315
3796
|
Any: 'any',
|
|
3316
3797
|
All: 'all'
|
|
3317
3798
|
};
|
|
3799
|
+
/**
|
|
3800
|
+
* @export
|
|
3801
|
+
*/
|
|
3802
|
+
exports.AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum = {
|
|
3803
|
+
Any: 'any',
|
|
3804
|
+
All: 'all'
|
|
3805
|
+
};
|
|
3318
3806
|
/**
|
|
3319
3807
|
* @export
|
|
3320
3808
|
*/
|
|
@@ -3333,6 +3821,20 @@ exports.AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = {
|
|
|
3333
3821
|
Asc: 'asc',
|
|
3334
3822
|
Desc: 'desc'
|
|
3335
3823
|
};
|
|
3824
|
+
/**
|
|
3825
|
+
* @export
|
|
3826
|
+
*/
|
|
3827
|
+
exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = {
|
|
3828
|
+
Any: 'any',
|
|
3829
|
+
All: 'all'
|
|
3830
|
+
};
|
|
3831
|
+
/**
|
|
3832
|
+
* @export
|
|
3833
|
+
*/
|
|
3834
|
+
exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum = {
|
|
3835
|
+
Any: 'any',
|
|
3836
|
+
All: 'all'
|
|
3837
|
+
};
|
|
3336
3838
|
/**
|
|
3337
3839
|
* @export
|
|
3338
3840
|
*/
|
|
@@ -3348,6 +3850,20 @@ exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = {
|
|
|
3348
3850
|
Asc: 'asc',
|
|
3349
3851
|
Desc: 'desc'
|
|
3350
3852
|
};
|
|
3853
|
+
/**
|
|
3854
|
+
* @export
|
|
3855
|
+
*/
|
|
3856
|
+
exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = {
|
|
3857
|
+
Any: 'any',
|
|
3858
|
+
All: 'all'
|
|
3859
|
+
};
|
|
3860
|
+
/**
|
|
3861
|
+
* @export
|
|
3862
|
+
*/
|
|
3863
|
+
exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum = {
|
|
3864
|
+
Any: 'any',
|
|
3865
|
+
All: 'all'
|
|
3866
|
+
};
|
|
3351
3867
|
/**
|
|
3352
3868
|
* @export
|
|
3353
3869
|
*/
|
|
@@ -3363,6 +3879,20 @@ exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
3363
3879
|
Asc: 'asc',
|
|
3364
3880
|
Desc: 'desc'
|
|
3365
3881
|
};
|
|
3882
|
+
/**
|
|
3883
|
+
* @export
|
|
3884
|
+
*/
|
|
3885
|
+
exports.AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = {
|
|
3886
|
+
Any: 'any',
|
|
3887
|
+
All: 'all'
|
|
3888
|
+
};
|
|
3889
|
+
/**
|
|
3890
|
+
* @export
|
|
3891
|
+
*/
|
|
3892
|
+
exports.AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = {
|
|
3893
|
+
Any: 'any',
|
|
3894
|
+
All: 'all'
|
|
3895
|
+
};
|
|
3366
3896
|
/**
|
|
3367
3897
|
* @export
|
|
3368
3898
|
*/
|
|
@@ -11694,6 +12224,373 @@ class ParentMenusApi extends base_1.BaseAPI {
|
|
|
11694
12224
|
}
|
|
11695
12225
|
}
|
|
11696
12226
|
exports.ParentMenusApi = ParentMenusApi;
|
|
12227
|
+
/**
|
|
12228
|
+
* PaymentGatewayApi - axios parameter creator
|
|
12229
|
+
* @export
|
|
12230
|
+
*/
|
|
12231
|
+
const PaymentGatewayApiAxiosParamCreator = function (configuration) {
|
|
12232
|
+
return {
|
|
12233
|
+
/**
|
|
12234
|
+
* Creates a payment order using specified or default payment gateway
|
|
12235
|
+
* @summary Create a new payment order
|
|
12236
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12237
|
+
* @param {*} [options] Override http request option.
|
|
12238
|
+
* @throws {RequiredError}
|
|
12239
|
+
*/
|
|
12240
|
+
paymentGatewayCreateOrderPost: (order_1, ...args_1) => __awaiter(this, [order_1, ...args_1], void 0, function* (order, options = {}) {
|
|
12241
|
+
// verify required parameter 'order' is not null or undefined
|
|
12242
|
+
(0, common_1.assertParamExists)('paymentGatewayCreateOrderPost', 'order', order);
|
|
12243
|
+
const localVarPath = `/payment-gateway/create-order`;
|
|
12244
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12245
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
12246
|
+
let baseOptions;
|
|
12247
|
+
if (configuration) {
|
|
12248
|
+
baseOptions = configuration.baseOptions;
|
|
12249
|
+
}
|
|
12250
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12251
|
+
const localVarHeaderParameter = {};
|
|
12252
|
+
const localVarQueryParameter = {};
|
|
12253
|
+
// authentication BearerAuth required
|
|
12254
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
12255
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12256
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12257
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12258
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12259
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(order, localVarRequestOptions, configuration);
|
|
12260
|
+
return {
|
|
12261
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12262
|
+
options: localVarRequestOptions,
|
|
12263
|
+
};
|
|
12264
|
+
}),
|
|
12265
|
+
/**
|
|
12266
|
+
* Returns list of all active credit plans for purchase
|
|
12267
|
+
* @summary Get available credit plans
|
|
12268
|
+
* @param {*} [options] Override http request option.
|
|
12269
|
+
* @throws {RequiredError}
|
|
12270
|
+
*/
|
|
12271
|
+
paymentGatewayCreditPlansGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
12272
|
+
const localVarPath = `/payment-gateway/credit-plans`;
|
|
12273
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12274
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
12275
|
+
let baseOptions;
|
|
12276
|
+
if (configuration) {
|
|
12277
|
+
baseOptions = configuration.baseOptions;
|
|
12278
|
+
}
|
|
12279
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
12280
|
+
const localVarHeaderParameter = {};
|
|
12281
|
+
const localVarQueryParameter = {};
|
|
12282
|
+
// authentication BearerAuth required
|
|
12283
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
12284
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12285
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12286
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12287
|
+
return {
|
|
12288
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12289
|
+
options: localVarRequestOptions,
|
|
12290
|
+
};
|
|
12291
|
+
}),
|
|
12292
|
+
/**
|
|
12293
|
+
* Returns list of all available payment gateways
|
|
12294
|
+
* @summary Get available payment gateways
|
|
12295
|
+
* @param {*} [options] Override http request option.
|
|
12296
|
+
* @throws {RequiredError}
|
|
12297
|
+
*/
|
|
12298
|
+
paymentGatewayGatewaysGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
12299
|
+
const localVarPath = `/payment-gateway/gateways`;
|
|
12300
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12301
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
12302
|
+
let baseOptions;
|
|
12303
|
+
if (configuration) {
|
|
12304
|
+
baseOptions = configuration.baseOptions;
|
|
12305
|
+
}
|
|
12306
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
12307
|
+
const localVarHeaderParameter = {};
|
|
12308
|
+
const localVarQueryParameter = {};
|
|
12309
|
+
// authentication BearerAuth required
|
|
12310
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
12311
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12312
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12313
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12314
|
+
return {
|
|
12315
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12316
|
+
options: localVarRequestOptions,
|
|
12317
|
+
};
|
|
12318
|
+
}),
|
|
12319
|
+
/**
|
|
12320
|
+
* Processes a refund for a completed payment
|
|
12321
|
+
* @summary Process payment refund
|
|
12322
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12323
|
+
* @param {*} [options] Override http request option.
|
|
12324
|
+
* @throws {RequiredError}
|
|
12325
|
+
*/
|
|
12326
|
+
paymentGatewayRefundPost: (refund_1, ...args_1) => __awaiter(this, [refund_1, ...args_1], void 0, function* (refund, options = {}) {
|
|
12327
|
+
// verify required parameter 'refund' is not null or undefined
|
|
12328
|
+
(0, common_1.assertParamExists)('paymentGatewayRefundPost', 'refund', refund);
|
|
12329
|
+
const localVarPath = `/payment-gateway/refund`;
|
|
12330
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12331
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
12332
|
+
let baseOptions;
|
|
12333
|
+
if (configuration) {
|
|
12334
|
+
baseOptions = configuration.baseOptions;
|
|
12335
|
+
}
|
|
12336
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12337
|
+
const localVarHeaderParameter = {};
|
|
12338
|
+
const localVarQueryParameter = {};
|
|
12339
|
+
// authentication BearerAuth required
|
|
12340
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
12341
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12342
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12343
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12344
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12345
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(refund, localVarRequestOptions, configuration);
|
|
12346
|
+
return {
|
|
12347
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12348
|
+
options: localVarRequestOptions,
|
|
12349
|
+
};
|
|
12350
|
+
}),
|
|
12351
|
+
/**
|
|
12352
|
+
* Verifies the current status of a payment
|
|
12353
|
+
* @summary Verify payment status
|
|
12354
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12355
|
+
* @param {*} [options] Override http request option.
|
|
12356
|
+
* @throws {RequiredError}
|
|
12357
|
+
*/
|
|
12358
|
+
paymentGatewayVerifyPost: (verify_1, ...args_1) => __awaiter(this, [verify_1, ...args_1], void 0, function* (verify, options = {}) {
|
|
12359
|
+
// verify required parameter 'verify' is not null or undefined
|
|
12360
|
+
(0, common_1.assertParamExists)('paymentGatewayVerifyPost', 'verify', verify);
|
|
12361
|
+
const localVarPath = `/payment-gateway/verify`;
|
|
12362
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12363
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
12364
|
+
let baseOptions;
|
|
12365
|
+
if (configuration) {
|
|
12366
|
+
baseOptions = configuration.baseOptions;
|
|
12367
|
+
}
|
|
12368
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
12369
|
+
const localVarHeaderParameter = {};
|
|
12370
|
+
const localVarQueryParameter = {};
|
|
12371
|
+
// authentication BearerAuth required
|
|
12372
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
12373
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12374
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12375
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12376
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12377
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(verify, localVarRequestOptions, configuration);
|
|
12378
|
+
return {
|
|
12379
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12380
|
+
options: localVarRequestOptions,
|
|
12381
|
+
};
|
|
12382
|
+
}),
|
|
12383
|
+
};
|
|
12384
|
+
};
|
|
12385
|
+
exports.PaymentGatewayApiAxiosParamCreator = PaymentGatewayApiAxiosParamCreator;
|
|
12386
|
+
/**
|
|
12387
|
+
* PaymentGatewayApi - functional programming interface
|
|
12388
|
+
* @export
|
|
12389
|
+
*/
|
|
12390
|
+
const PaymentGatewayApiFp = function (configuration) {
|
|
12391
|
+
const localVarAxiosParamCreator = (0, exports.PaymentGatewayApiAxiosParamCreator)(configuration);
|
|
12392
|
+
return {
|
|
12393
|
+
/**
|
|
12394
|
+
* Creates a payment order using specified or default payment gateway
|
|
12395
|
+
* @summary Create a new payment order
|
|
12396
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12397
|
+
* @param {*} [options] Override http request option.
|
|
12398
|
+
* @throws {RequiredError}
|
|
12399
|
+
*/
|
|
12400
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12401
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12402
|
+
var _a, _b, _c;
|
|
12403
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayCreateOrderPost(order, options);
|
|
12404
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12405
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PaymentGatewayApi.paymentGatewayCreateOrderPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12406
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12407
|
+
});
|
|
12408
|
+
},
|
|
12409
|
+
/**
|
|
12410
|
+
* Returns list of all active credit plans for purchase
|
|
12411
|
+
* @summary Get available credit plans
|
|
12412
|
+
* @param {*} [options] Override http request option.
|
|
12413
|
+
* @throws {RequiredError}
|
|
12414
|
+
*/
|
|
12415
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12416
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12417
|
+
var _a, _b, _c;
|
|
12418
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayCreditPlansGet(options);
|
|
12419
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12420
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PaymentGatewayApi.paymentGatewayCreditPlansGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12421
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12422
|
+
});
|
|
12423
|
+
},
|
|
12424
|
+
/**
|
|
12425
|
+
* Returns list of all available payment gateways
|
|
12426
|
+
* @summary Get available payment gateways
|
|
12427
|
+
* @param {*} [options] Override http request option.
|
|
12428
|
+
* @throws {RequiredError}
|
|
12429
|
+
*/
|
|
12430
|
+
paymentGatewayGatewaysGet(options) {
|
|
12431
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12432
|
+
var _a, _b, _c;
|
|
12433
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayGatewaysGet(options);
|
|
12434
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12435
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PaymentGatewayApi.paymentGatewayGatewaysGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12436
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12437
|
+
});
|
|
12438
|
+
},
|
|
12439
|
+
/**
|
|
12440
|
+
* Processes a refund for a completed payment
|
|
12441
|
+
* @summary Process payment refund
|
|
12442
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12443
|
+
* @param {*} [options] Override http request option.
|
|
12444
|
+
* @throws {RequiredError}
|
|
12445
|
+
*/
|
|
12446
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12447
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12448
|
+
var _a, _b, _c;
|
|
12449
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayRefundPost(refund, options);
|
|
12450
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12451
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PaymentGatewayApi.paymentGatewayRefundPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12452
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12453
|
+
});
|
|
12454
|
+
},
|
|
12455
|
+
/**
|
|
12456
|
+
* Verifies the current status of a payment
|
|
12457
|
+
* @summary Verify payment status
|
|
12458
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12459
|
+
* @param {*} [options] Override http request option.
|
|
12460
|
+
* @throws {RequiredError}
|
|
12461
|
+
*/
|
|
12462
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12463
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
12464
|
+
var _a, _b, _c;
|
|
12465
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.paymentGatewayVerifyPost(verify, options);
|
|
12466
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12467
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PaymentGatewayApi.paymentGatewayVerifyPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12468
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12469
|
+
});
|
|
12470
|
+
},
|
|
12471
|
+
};
|
|
12472
|
+
};
|
|
12473
|
+
exports.PaymentGatewayApiFp = PaymentGatewayApiFp;
|
|
12474
|
+
/**
|
|
12475
|
+
* PaymentGatewayApi - factory interface
|
|
12476
|
+
* @export
|
|
12477
|
+
*/
|
|
12478
|
+
const PaymentGatewayApiFactory = function (configuration, basePath, axios) {
|
|
12479
|
+
const localVarFp = (0, exports.PaymentGatewayApiFp)(configuration);
|
|
12480
|
+
return {
|
|
12481
|
+
/**
|
|
12482
|
+
* Creates a payment order using specified or default payment gateway
|
|
12483
|
+
* @summary Create a new payment order
|
|
12484
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12485
|
+
* @param {*} [options] Override http request option.
|
|
12486
|
+
* @throws {RequiredError}
|
|
12487
|
+
*/
|
|
12488
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12489
|
+
return localVarFp.paymentGatewayCreateOrderPost(order, options).then((request) => request(axios, basePath));
|
|
12490
|
+
},
|
|
12491
|
+
/**
|
|
12492
|
+
* Returns list of all active credit plans for purchase
|
|
12493
|
+
* @summary Get available credit plans
|
|
12494
|
+
* @param {*} [options] Override http request option.
|
|
12495
|
+
* @throws {RequiredError}
|
|
12496
|
+
*/
|
|
12497
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12498
|
+
return localVarFp.paymentGatewayCreditPlansGet(options).then((request) => request(axios, basePath));
|
|
12499
|
+
},
|
|
12500
|
+
/**
|
|
12501
|
+
* Returns list of all available payment gateways
|
|
12502
|
+
* @summary Get available payment gateways
|
|
12503
|
+
* @param {*} [options] Override http request option.
|
|
12504
|
+
* @throws {RequiredError}
|
|
12505
|
+
*/
|
|
12506
|
+
paymentGatewayGatewaysGet(options) {
|
|
12507
|
+
return localVarFp.paymentGatewayGatewaysGet(options).then((request) => request(axios, basePath));
|
|
12508
|
+
},
|
|
12509
|
+
/**
|
|
12510
|
+
* Processes a refund for a completed payment
|
|
12511
|
+
* @summary Process payment refund
|
|
12512
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12513
|
+
* @param {*} [options] Override http request option.
|
|
12514
|
+
* @throws {RequiredError}
|
|
12515
|
+
*/
|
|
12516
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12517
|
+
return localVarFp.paymentGatewayRefundPost(refund, options).then((request) => request(axios, basePath));
|
|
12518
|
+
},
|
|
12519
|
+
/**
|
|
12520
|
+
* Verifies the current status of a payment
|
|
12521
|
+
* @summary Verify payment status
|
|
12522
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12523
|
+
* @param {*} [options] Override http request option.
|
|
12524
|
+
* @throws {RequiredError}
|
|
12525
|
+
*/
|
|
12526
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12527
|
+
return localVarFp.paymentGatewayVerifyPost(verify, options).then((request) => request(axios, basePath));
|
|
12528
|
+
},
|
|
12529
|
+
};
|
|
12530
|
+
};
|
|
12531
|
+
exports.PaymentGatewayApiFactory = PaymentGatewayApiFactory;
|
|
12532
|
+
/**
|
|
12533
|
+
* PaymentGatewayApi - object-oriented interface
|
|
12534
|
+
* @export
|
|
12535
|
+
* @class PaymentGatewayApi
|
|
12536
|
+
* @extends {BaseAPI}
|
|
12537
|
+
*/
|
|
12538
|
+
class PaymentGatewayApi extends base_1.BaseAPI {
|
|
12539
|
+
/**
|
|
12540
|
+
* Creates a payment order using specified or default payment gateway
|
|
12541
|
+
* @summary Create a new payment order
|
|
12542
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
12543
|
+
* @param {*} [options] Override http request option.
|
|
12544
|
+
* @throws {RequiredError}
|
|
12545
|
+
* @memberof PaymentGatewayApi
|
|
12546
|
+
*/
|
|
12547
|
+
paymentGatewayCreateOrderPost(order, options) {
|
|
12548
|
+
return (0, exports.PaymentGatewayApiFp)(this.configuration).paymentGatewayCreateOrderPost(order, options).then((request) => request(this.axios, this.basePath));
|
|
12549
|
+
}
|
|
12550
|
+
/**
|
|
12551
|
+
* Returns list of all active credit plans for purchase
|
|
12552
|
+
* @summary Get available credit plans
|
|
12553
|
+
* @param {*} [options] Override http request option.
|
|
12554
|
+
* @throws {RequiredError}
|
|
12555
|
+
* @memberof PaymentGatewayApi
|
|
12556
|
+
*/
|
|
12557
|
+
paymentGatewayCreditPlansGet(options) {
|
|
12558
|
+
return (0, exports.PaymentGatewayApiFp)(this.configuration).paymentGatewayCreditPlansGet(options).then((request) => request(this.axios, this.basePath));
|
|
12559
|
+
}
|
|
12560
|
+
/**
|
|
12561
|
+
* Returns list of all available payment gateways
|
|
12562
|
+
* @summary Get available payment gateways
|
|
12563
|
+
* @param {*} [options] Override http request option.
|
|
12564
|
+
* @throws {RequiredError}
|
|
12565
|
+
* @memberof PaymentGatewayApi
|
|
12566
|
+
*/
|
|
12567
|
+
paymentGatewayGatewaysGet(options) {
|
|
12568
|
+
return (0, exports.PaymentGatewayApiFp)(this.configuration).paymentGatewayGatewaysGet(options).then((request) => request(this.axios, this.basePath));
|
|
12569
|
+
}
|
|
12570
|
+
/**
|
|
12571
|
+
* Processes a refund for a completed payment
|
|
12572
|
+
* @summary Process payment refund
|
|
12573
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
12574
|
+
* @param {*} [options] Override http request option.
|
|
12575
|
+
* @throws {RequiredError}
|
|
12576
|
+
* @memberof PaymentGatewayApi
|
|
12577
|
+
*/
|
|
12578
|
+
paymentGatewayRefundPost(refund, options) {
|
|
12579
|
+
return (0, exports.PaymentGatewayApiFp)(this.configuration).paymentGatewayRefundPost(refund, options).then((request) => request(this.axios, this.basePath));
|
|
12580
|
+
}
|
|
12581
|
+
/**
|
|
12582
|
+
* Verifies the current status of a payment
|
|
12583
|
+
* @summary Verify payment status
|
|
12584
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
12585
|
+
* @param {*} [options] Override http request option.
|
|
12586
|
+
* @throws {RequiredError}
|
|
12587
|
+
* @memberof PaymentGatewayApi
|
|
12588
|
+
*/
|
|
12589
|
+
paymentGatewayVerifyPost(verify, options) {
|
|
12590
|
+
return (0, exports.PaymentGatewayApiFp)(this.configuration).paymentGatewayVerifyPost(verify, options).then((request) => request(this.axios, this.basePath));
|
|
12591
|
+
}
|
|
12592
|
+
}
|
|
12593
|
+
exports.PaymentGatewayApi = PaymentGatewayApi;
|
|
11697
12594
|
/**
|
|
11698
12595
|
* PaymentsApi - axios parameter creator
|
|
11699
12596
|
* @export
|