@seekora-ai/admin-api 1.0.49 → 1.0.50
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 +17 -2
- package/api.ts +921 -19
- package/dist/api.d.ts +810 -46
- package/dist/api.js +281 -18
- package/dist/esm/api.d.ts +810 -46
- package/dist/esm/api.js +278 -15
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.50.tgz +0 -0
- package/seekora-ai-admin-api-1.0.49.tgz +0 -0
package/dist/api.js
CHANGED
|
@@ -23,9 +23,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
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.
|
|
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 = 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 = exports.PluralsDeclensionsApiFp = void 0;
|
|
26
|
+
exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum = 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.AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum = void 0;
|
|
27
|
+
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 = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum = 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 = exports.PluralsDeclensionsApiFp = exports.PluralsDeclensionsApiAxiosParamCreator = exports.PlansApi = exports.PlansApiFactory = void 0;
|
|
29
29
|
const axios_1 = require("axios");
|
|
30
30
|
// Some imports not used depending on template conditions
|
|
31
31
|
// @ts-ignore
|
|
@@ -2007,7 +2007,7 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2007
2007
|
};
|
|
2008
2008
|
}),
|
|
2009
2009
|
/**
|
|
2010
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
2010
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
2011
2011
|
* @summary Get Query Insights
|
|
2012
2012
|
* @param {string} xStoreID Store ID
|
|
2013
2013
|
* @param {string} query Search query to analyze
|
|
@@ -2024,12 +2024,14 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2024
2024
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2025
2025
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2026
2026
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2027
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
2027
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
2028
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
2029
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
2028
2030
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
2029
2031
|
* @param {*} [options] Override http request option.
|
|
2030
2032
|
* @throws {RequiredError}
|
|
2031
2033
|
*/
|
|
2032
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1], void 0, function* (xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options = {}) {
|
|
2034
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, geoPage_1, geoPageSize_1, includeWidget_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, geoPage_1, geoPageSize_1, includeWidget_1, ...args_1], void 0, function* (xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options = {}) {
|
|
2033
2035
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2034
2036
|
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID);
|
|
2035
2037
|
// verify required parameter 'query' is not null or undefined
|
|
@@ -2090,6 +2092,12 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2090
2092
|
if (filtersPageSize !== undefined) {
|
|
2091
2093
|
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
2092
2094
|
}
|
|
2095
|
+
if (geoPage !== undefined) {
|
|
2096
|
+
localVarQueryParameter['geo_page'] = geoPage;
|
|
2097
|
+
}
|
|
2098
|
+
if (geoPageSize !== undefined) {
|
|
2099
|
+
localVarQueryParameter['geo_page_size'] = geoPageSize;
|
|
2100
|
+
}
|
|
2093
2101
|
if (includeWidget !== undefined) {
|
|
2094
2102
|
localVarQueryParameter['include_widget'] = includeWidget;
|
|
2095
2103
|
}
|
|
@@ -2760,7 +2768,7 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2760
2768
|
});
|
|
2761
2769
|
},
|
|
2762
2770
|
/**
|
|
2763
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
2771
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
2764
2772
|
* @summary Get Query Insights
|
|
2765
2773
|
* @param {string} xStoreID Store ID
|
|
2766
2774
|
* @param {string} query Search query to analyze
|
|
@@ -2777,15 +2785,17 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
2777
2785
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2778
2786
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2779
2787
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2780
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
2788
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
2789
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
2790
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
2781
2791
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
2782
2792
|
* @param {*} [options] Override http request option.
|
|
2783
2793
|
* @throws {RequiredError}
|
|
2784
2794
|
*/
|
|
2785
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
2795
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options) {
|
|
2786
2796
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2787
2797
|
var _a, _b, _c;
|
|
2788
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
|
|
2798
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options);
|
|
2789
2799
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2790
2800
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2791
2801
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3187,7 +3197,7 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3187
3197
|
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));
|
|
3188
3198
|
},
|
|
3189
3199
|
/**
|
|
3190
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
3200
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
3191
3201
|
* @summary Get Query Insights
|
|
3192
3202
|
* @param {string} xStoreID Store ID
|
|
3193
3203
|
* @param {string} query Search query to analyze
|
|
@@ -3204,13 +3214,15 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3204
3214
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3205
3215
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3206
3216
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3207
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
3217
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3218
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
3219
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
3208
3220
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3209
3221
|
* @param {*} [options] Override http request option.
|
|
3210
3222
|
* @throws {RequiredError}
|
|
3211
3223
|
*/
|
|
3212
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3213
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(axios, basePath));
|
|
3224
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options) {
|
|
3225
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options).then((request) => request(axios, basePath));
|
|
3214
3226
|
},
|
|
3215
3227
|
/**
|
|
3216
3228
|
* 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.
|
|
@@ -3603,7 +3615,7 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3603
3615
|
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));
|
|
3604
3616
|
}
|
|
3605
3617
|
/**
|
|
3606
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
3618
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
3607
3619
|
* @summary Get Query Insights
|
|
3608
3620
|
* @param {string} xStoreID Store ID
|
|
3609
3621
|
* @param {string} query Search query to analyze
|
|
@@ -3620,14 +3632,16 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
3620
3632
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3621
3633
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3622
3634
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3623
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
3635
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3636
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
3637
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
3624
3638
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3625
3639
|
* @param {*} [options] Override http request option.
|
|
3626
3640
|
* @throws {RequiredError}
|
|
3627
3641
|
* @memberof AnalyticsApi
|
|
3628
3642
|
*/
|
|
3629
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3630
|
-
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
3643
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options) {
|
|
3644
|
+
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
3631
3645
|
}
|
|
3632
3646
|
/**
|
|
3633
3647
|
* 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.
|
|
@@ -7444,6 +7458,129 @@ const ItemAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
7444
7458
|
options: localVarRequestOptions,
|
|
7445
7459
|
};
|
|
7446
7460
|
}),
|
|
7461
|
+
/**
|
|
7462
|
+
* Retrieve comprehensive analytics insights for a specific item including popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
7463
|
+
* @summary Get Item Insights
|
|
7464
|
+
* @param {string} xStoreID Store ID
|
|
7465
|
+
* @param {string} itemId Item ID to analyze
|
|
7466
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
7467
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
7468
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
7469
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
7470
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
7471
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
7472
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
7473
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
7474
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
7475
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
7476
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
7477
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
7478
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
7479
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
7480
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
7481
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
7482
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
7483
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
7484
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
7485
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
7486
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
7487
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
7488
|
+
* @param {*} [options] Override http request option.
|
|
7489
|
+
* @throws {RequiredError}
|
|
7490
|
+
*/
|
|
7491
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet: (xStoreID_1, itemId_1, startTime_1, endTime_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, geoPage_1, geoPageSize_1, groupBy_1, ...args_1) => __awaiter(this, [xStoreID_1, itemId_1, startTime_1, endTime_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, geoPage_1, geoPageSize_1, groupBy_1, ...args_1], void 0, function* (xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options = {}) {
|
|
7492
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
7493
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet', 'xStoreID', xStoreID);
|
|
7494
|
+
// verify required parameter 'itemId' is not null or undefined
|
|
7495
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet', 'itemId', itemId);
|
|
7496
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/items/{itemId}/insights`
|
|
7497
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
7498
|
+
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
|
|
7499
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7500
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
7501
|
+
let baseOptions;
|
|
7502
|
+
if (configuration) {
|
|
7503
|
+
baseOptions = configuration.baseOptions;
|
|
7504
|
+
}
|
|
7505
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
7506
|
+
const localVarHeaderParameter = {};
|
|
7507
|
+
const localVarQueryParameter = {};
|
|
7508
|
+
// authentication BearerAuth required
|
|
7509
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
7510
|
+
if (startTime !== undefined) {
|
|
7511
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
7512
|
+
}
|
|
7513
|
+
if (endTime !== undefined) {
|
|
7514
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
7515
|
+
}
|
|
7516
|
+
if (analyticsTags !== undefined) {
|
|
7517
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
7518
|
+
}
|
|
7519
|
+
if (tagsMatchMode !== undefined) {
|
|
7520
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
7521
|
+
}
|
|
7522
|
+
if (tagsExclude !== undefined) {
|
|
7523
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
7524
|
+
}
|
|
7525
|
+
if (tagKeyFilter !== undefined) {
|
|
7526
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
7527
|
+
}
|
|
7528
|
+
if (tagValueFilter !== undefined) {
|
|
7529
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
7530
|
+
}
|
|
7531
|
+
if (compareMode !== undefined) {
|
|
7532
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
7533
|
+
}
|
|
7534
|
+
if (compareStartTime !== undefined) {
|
|
7535
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
7536
|
+
}
|
|
7537
|
+
if (compareEndTime !== undefined) {
|
|
7538
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
7539
|
+
}
|
|
7540
|
+
if (compareAnalyticsTags !== undefined) {
|
|
7541
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
7542
|
+
}
|
|
7543
|
+
if (compareTagsMatchMode !== undefined) {
|
|
7544
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
7545
|
+
}
|
|
7546
|
+
if (compareTagsExclude !== undefined) {
|
|
7547
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
7548
|
+
}
|
|
7549
|
+
if (compareTagKeyFilter !== undefined) {
|
|
7550
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
7551
|
+
}
|
|
7552
|
+
if (compareTagValueFilter !== undefined) {
|
|
7553
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
7554
|
+
}
|
|
7555
|
+
if (resultsPage !== undefined) {
|
|
7556
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
7557
|
+
}
|
|
7558
|
+
if (resultsPageSize !== undefined) {
|
|
7559
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
7560
|
+
}
|
|
7561
|
+
if (filtersPage !== undefined) {
|
|
7562
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
7563
|
+
}
|
|
7564
|
+
if (filtersPageSize !== undefined) {
|
|
7565
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
7566
|
+
}
|
|
7567
|
+
if (geoPage !== undefined) {
|
|
7568
|
+
localVarQueryParameter['geo_page'] = geoPage;
|
|
7569
|
+
}
|
|
7570
|
+
if (geoPageSize !== undefined) {
|
|
7571
|
+
localVarQueryParameter['geo_page_size'] = geoPageSize;
|
|
7572
|
+
}
|
|
7573
|
+
if (groupBy !== undefined) {
|
|
7574
|
+
localVarQueryParameter['group_by'] = groupBy;
|
|
7575
|
+
}
|
|
7576
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
7577
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7578
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
7579
|
+
return {
|
|
7580
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
7581
|
+
options: localVarRequestOptions,
|
|
7582
|
+
};
|
|
7583
|
+
}),
|
|
7447
7584
|
/**
|
|
7448
7585
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
7449
7586
|
* @summary Get Item Performance Analytics
|
|
@@ -7795,6 +7932,45 @@ const ItemAnalyticsApiFp = function (configuration) {
|
|
|
7795
7932
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7796
7933
|
});
|
|
7797
7934
|
},
|
|
7935
|
+
/**
|
|
7936
|
+
* Retrieve comprehensive analytics insights for a specific item including popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
7937
|
+
* @summary Get Item Insights
|
|
7938
|
+
* @param {string} xStoreID Store ID
|
|
7939
|
+
* @param {string} itemId Item ID to analyze
|
|
7940
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
7941
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
7942
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
7943
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
7944
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
7945
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
7946
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
7947
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
7948
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
7949
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
7950
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
7951
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
7952
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
7953
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
7954
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
7955
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
7956
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
7957
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
7958
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
7959
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
7960
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
7961
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
7962
|
+
* @param {*} [options] Override http request option.
|
|
7963
|
+
* @throws {RequiredError}
|
|
7964
|
+
*/
|
|
7965
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options) {
|
|
7966
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
7967
|
+
var _a, _b, _c;
|
|
7968
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options);
|
|
7969
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
7970
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ItemAnalyticsApi.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
7971
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7972
|
+
});
|
|
7973
|
+
},
|
|
7798
7974
|
/**
|
|
7799
7975
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
7800
7976
|
* @summary Get Item Performance Analytics
|
|
@@ -7963,6 +8139,39 @@ const ItemAnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
7963
8139
|
adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options) {
|
|
7964
8140
|
return localVarFp.adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
7965
8141
|
},
|
|
8142
|
+
/**
|
|
8143
|
+
* Retrieve comprehensive analytics insights for a specific item including popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
8144
|
+
* @summary Get Item Insights
|
|
8145
|
+
* @param {string} xStoreID Store ID
|
|
8146
|
+
* @param {string} itemId Item ID to analyze
|
|
8147
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
8148
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
8149
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
8150
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
8151
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
8152
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
8153
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
8154
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
8155
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
8156
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
8157
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
8158
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
8159
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
8160
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
8161
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
8162
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
8163
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
8164
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
8165
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
8166
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
8167
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
8168
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
8169
|
+
* @param {*} [options] Override http request option.
|
|
8170
|
+
* @throws {RequiredError}
|
|
8171
|
+
*/
|
|
8172
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options) {
|
|
8173
|
+
return localVarFp.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options).then((request) => request(axios, basePath));
|
|
8174
|
+
},
|
|
7966
8175
|
/**
|
|
7967
8176
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
7968
8177
|
* @summary Get Item Performance Analytics
|
|
@@ -8117,6 +8326,40 @@ class ItemAnalyticsApi extends base_1.BaseAPI {
|
|
|
8117
8326
|
adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options) {
|
|
8118
8327
|
return (0, exports.ItemAnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
|
|
8119
8328
|
}
|
|
8329
|
+
/**
|
|
8330
|
+
* Retrieve comprehensive analytics insights for a specific item including popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
8331
|
+
* @summary Get Item Insights
|
|
8332
|
+
* @param {string} xStoreID Store ID
|
|
8333
|
+
* @param {string} itemId Item ID to analyze
|
|
8334
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
8335
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
8336
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
8337
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
8338
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
8339
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
8340
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
8341
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
8342
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
8343
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
8344
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
8345
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
8346
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
8347
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
8348
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
8349
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
8350
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
8351
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
8352
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
8353
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
8354
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
8355
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
8356
|
+
* @param {*} [options] Override http request option.
|
|
8357
|
+
* @throws {RequiredError}
|
|
8358
|
+
* @memberof ItemAnalyticsApi
|
|
8359
|
+
*/
|
|
8360
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options) {
|
|
8361
|
+
return (0, exports.ItemAnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options).then((request) => request(this.axios, this.basePath));
|
|
8362
|
+
}
|
|
8120
8363
|
/**
|
|
8121
8364
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
8122
8365
|
* @summary Get Item Performance Analytics
|
|
@@ -8222,6 +8465,26 @@ exports.AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum = {
|
|
|
8222
8465
|
Asc: 'asc',
|
|
8223
8466
|
Desc: 'desc'
|
|
8224
8467
|
};
|
|
8468
|
+
/**
|
|
8469
|
+
* @export
|
|
8470
|
+
*/
|
|
8471
|
+
exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum = {
|
|
8472
|
+
Any: 'any',
|
|
8473
|
+
All: 'all'
|
|
8474
|
+
};
|
|
8475
|
+
/**
|
|
8476
|
+
* @export
|
|
8477
|
+
*/
|
|
8478
|
+
exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum = {
|
|
8479
|
+
Any: 'any',
|
|
8480
|
+
All: 'all'
|
|
8481
|
+
};
|
|
8482
|
+
/**
|
|
8483
|
+
* @export
|
|
8484
|
+
*/
|
|
8485
|
+
exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum = {
|
|
8486
|
+
Date: 'date'
|
|
8487
|
+
};
|
|
8225
8488
|
/**
|
|
8226
8489
|
* @export
|
|
8227
8490
|
*/
|