@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/esm/api.js
CHANGED
|
@@ -1993,7 +1993,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1993
1993
|
};
|
|
1994
1994
|
}),
|
|
1995
1995
|
/**
|
|
1996
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
1996
|
+
* 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
|
|
1997
1997
|
* @summary Get Query Insights
|
|
1998
1998
|
* @param {string} xStoreID Store ID
|
|
1999
1999
|
* @param {string} query Search query to analyze
|
|
@@ -2010,12 +2010,14 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2010
2010
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2011
2011
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2012
2012
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2013
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
2013
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
2014
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
2015
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
2014
2016
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
2015
2017
|
* @param {*} [options] Override http request option.
|
|
2016
2018
|
* @throws {RequiredError}
|
|
2017
2019
|
*/
|
|
2018
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1], void 0, function* (xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options = {}) {
|
|
2020
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, geoPage_1, geoPageSize_1, includeWidget_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, geoPage_1, geoPageSize_1, includeWidget_1, ...args_1], void 0, function* (xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options = {}) {
|
|
2019
2021
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2020
2022
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID);
|
|
2021
2023
|
// verify required parameter 'query' is not null or undefined
|
|
@@ -2076,6 +2078,12 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2076
2078
|
if (filtersPageSize !== undefined) {
|
|
2077
2079
|
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
2078
2080
|
}
|
|
2081
|
+
if (geoPage !== undefined) {
|
|
2082
|
+
localVarQueryParameter['geo_page'] = geoPage;
|
|
2083
|
+
}
|
|
2084
|
+
if (geoPageSize !== undefined) {
|
|
2085
|
+
localVarQueryParameter['geo_page_size'] = geoPageSize;
|
|
2086
|
+
}
|
|
2079
2087
|
if (includeWidget !== undefined) {
|
|
2080
2088
|
localVarQueryParameter['include_widget'] = includeWidget;
|
|
2081
2089
|
}
|
|
@@ -2745,7 +2753,7 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2745
2753
|
});
|
|
2746
2754
|
},
|
|
2747
2755
|
/**
|
|
2748
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
2756
|
+
* 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
|
|
2749
2757
|
* @summary Get Query Insights
|
|
2750
2758
|
* @param {string} xStoreID Store ID
|
|
2751
2759
|
* @param {string} query Search query to analyze
|
|
@@ -2762,15 +2770,17 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
2762
2770
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2763
2771
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2764
2772
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2765
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
2773
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
2774
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
2775
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
2766
2776
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
2767
2777
|
* @param {*} [options] Override http request option.
|
|
2768
2778
|
* @throws {RequiredError}
|
|
2769
2779
|
*/
|
|
2770
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
2780
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options) {
|
|
2771
2781
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2772
2782
|
var _a, _b, _c;
|
|
2773
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
|
|
2783
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options);
|
|
2774
2784
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2775
2785
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2776
2786
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3171,7 +3181,7 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3171
3181
|
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
3172
3182
|
},
|
|
3173
3183
|
/**
|
|
3174
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
3184
|
+
* 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
|
|
3175
3185
|
* @summary Get Query Insights
|
|
3176
3186
|
* @param {string} xStoreID Store ID
|
|
3177
3187
|
* @param {string} query Search query to analyze
|
|
@@ -3188,13 +3198,15 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3188
3198
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3189
3199
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3190
3200
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3191
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
3201
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3202
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
3203
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
3192
3204
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3193
3205
|
* @param {*} [options] Override http request option.
|
|
3194
3206
|
* @throws {RequiredError}
|
|
3195
3207
|
*/
|
|
3196
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3197
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(axios, basePath));
|
|
3208
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options) {
|
|
3209
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options).then((request) => request(axios, basePath));
|
|
3198
3210
|
},
|
|
3199
3211
|
/**
|
|
3200
3212
|
* 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.
|
|
@@ -3586,7 +3598,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3586
3598
|
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
3587
3599
|
}
|
|
3588
3600
|
/**
|
|
3589
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
3601
|
+
* 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
|
|
3590
3602
|
* @summary Get Query Insights
|
|
3591
3603
|
* @param {string} xStoreID Store ID
|
|
3592
3604
|
* @param {string} query Search query to analyze
|
|
@@ -3603,14 +3615,16 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
3603
3615
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3604
3616
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3605
3617
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3606
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
3618
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3619
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
3620
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
3607
3621
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3608
3622
|
* @param {*} [options] Override http request option.
|
|
3609
3623
|
* @throws {RequiredError}
|
|
3610
3624
|
* @memberof AnalyticsApi
|
|
3611
3625
|
*/
|
|
3612
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
|
|
3613
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
3626
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options) {
|
|
3627
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
3614
3628
|
}
|
|
3615
3629
|
/**
|
|
3616
3630
|
* 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.
|
|
@@ -7398,6 +7412,129 @@ export const ItemAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
7398
7412
|
options: localVarRequestOptions,
|
|
7399
7413
|
};
|
|
7400
7414
|
}),
|
|
7415
|
+
/**
|
|
7416
|
+
* 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
|
|
7417
|
+
* @summary Get Item Insights
|
|
7418
|
+
* @param {string} xStoreID Store ID
|
|
7419
|
+
* @param {string} itemId Item ID to analyze
|
|
7420
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
7421
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
7422
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
7423
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
7424
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
7425
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
7426
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
7427
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
7428
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
7429
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
7430
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
7431
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
7432
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
7433
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
7434
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
7435
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
7436
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
7437
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
7438
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
7439
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
7440
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
7441
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
7442
|
+
* @param {*} [options] Override http request option.
|
|
7443
|
+
* @throws {RequiredError}
|
|
7444
|
+
*/
|
|
7445
|
+
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 = {}) {
|
|
7446
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
7447
|
+
assertParamExists('adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet', 'xStoreID', xStoreID);
|
|
7448
|
+
// verify required parameter 'itemId' is not null or undefined
|
|
7449
|
+
assertParamExists('adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet', 'itemId', itemId);
|
|
7450
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/items/{itemId}/insights`
|
|
7451
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
7452
|
+
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
|
|
7453
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7454
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7455
|
+
let baseOptions;
|
|
7456
|
+
if (configuration) {
|
|
7457
|
+
baseOptions = configuration.baseOptions;
|
|
7458
|
+
}
|
|
7459
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
7460
|
+
const localVarHeaderParameter = {};
|
|
7461
|
+
const localVarQueryParameter = {};
|
|
7462
|
+
// authentication BearerAuth required
|
|
7463
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
7464
|
+
if (startTime !== undefined) {
|
|
7465
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
7466
|
+
}
|
|
7467
|
+
if (endTime !== undefined) {
|
|
7468
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
7469
|
+
}
|
|
7470
|
+
if (analyticsTags !== undefined) {
|
|
7471
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
7472
|
+
}
|
|
7473
|
+
if (tagsMatchMode !== undefined) {
|
|
7474
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
7475
|
+
}
|
|
7476
|
+
if (tagsExclude !== undefined) {
|
|
7477
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
7478
|
+
}
|
|
7479
|
+
if (tagKeyFilter !== undefined) {
|
|
7480
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
7481
|
+
}
|
|
7482
|
+
if (tagValueFilter !== undefined) {
|
|
7483
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
7484
|
+
}
|
|
7485
|
+
if (compareMode !== undefined) {
|
|
7486
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
7487
|
+
}
|
|
7488
|
+
if (compareStartTime !== undefined) {
|
|
7489
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
7490
|
+
}
|
|
7491
|
+
if (compareEndTime !== undefined) {
|
|
7492
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
7493
|
+
}
|
|
7494
|
+
if (compareAnalyticsTags !== undefined) {
|
|
7495
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
7496
|
+
}
|
|
7497
|
+
if (compareTagsMatchMode !== undefined) {
|
|
7498
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
7499
|
+
}
|
|
7500
|
+
if (compareTagsExclude !== undefined) {
|
|
7501
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
7502
|
+
}
|
|
7503
|
+
if (compareTagKeyFilter !== undefined) {
|
|
7504
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
7505
|
+
}
|
|
7506
|
+
if (compareTagValueFilter !== undefined) {
|
|
7507
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
7508
|
+
}
|
|
7509
|
+
if (resultsPage !== undefined) {
|
|
7510
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
7511
|
+
}
|
|
7512
|
+
if (resultsPageSize !== undefined) {
|
|
7513
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
7514
|
+
}
|
|
7515
|
+
if (filtersPage !== undefined) {
|
|
7516
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
7517
|
+
}
|
|
7518
|
+
if (filtersPageSize !== undefined) {
|
|
7519
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
7520
|
+
}
|
|
7521
|
+
if (geoPage !== undefined) {
|
|
7522
|
+
localVarQueryParameter['geo_page'] = geoPage;
|
|
7523
|
+
}
|
|
7524
|
+
if (geoPageSize !== undefined) {
|
|
7525
|
+
localVarQueryParameter['geo_page_size'] = geoPageSize;
|
|
7526
|
+
}
|
|
7527
|
+
if (groupBy !== undefined) {
|
|
7528
|
+
localVarQueryParameter['group_by'] = groupBy;
|
|
7529
|
+
}
|
|
7530
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7531
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7532
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
7533
|
+
return {
|
|
7534
|
+
url: toPathString(localVarUrlObj),
|
|
7535
|
+
options: localVarRequestOptions,
|
|
7536
|
+
};
|
|
7537
|
+
}),
|
|
7401
7538
|
/**
|
|
7402
7539
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
7403
7540
|
* @summary Get Item Performance Analytics
|
|
@@ -7748,6 +7885,45 @@ export const ItemAnalyticsApiFp = function (configuration) {
|
|
|
7748
7885
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7749
7886
|
});
|
|
7750
7887
|
},
|
|
7888
|
+
/**
|
|
7889
|
+
* 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
|
|
7890
|
+
* @summary Get Item Insights
|
|
7891
|
+
* @param {string} xStoreID Store ID
|
|
7892
|
+
* @param {string} itemId Item ID to analyze
|
|
7893
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
7894
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
7895
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
7896
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
7897
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
7898
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
7899
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
7900
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
7901
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
7902
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
7903
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
7904
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
7905
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
7906
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
7907
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
7908
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
7909
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
7910
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
7911
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
7912
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
7913
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
7914
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
7915
|
+
* @param {*} [options] Override http request option.
|
|
7916
|
+
* @throws {RequiredError}
|
|
7917
|
+
*/
|
|
7918
|
+
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) {
|
|
7919
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
7920
|
+
var _a, _b, _c;
|
|
7921
|
+
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);
|
|
7922
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
7923
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ItemAnalyticsApi.adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
7924
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7925
|
+
});
|
|
7926
|
+
},
|
|
7751
7927
|
/**
|
|
7752
7928
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
7753
7929
|
* @summary Get Item Performance Analytics
|
|
@@ -7915,6 +8091,39 @@ export const ItemAnalyticsApiFactory = function (configuration, basePath, axios)
|
|
|
7915
8091
|
adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options) {
|
|
7916
8092
|
return localVarFp.adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
7917
8093
|
},
|
|
8094
|
+
/**
|
|
8095
|
+
* 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
|
|
8096
|
+
* @summary Get Item Insights
|
|
8097
|
+
* @param {string} xStoreID Store ID
|
|
8098
|
+
* @param {string} itemId Item ID to analyze
|
|
8099
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
8100
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
8101
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
8102
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
8103
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
8104
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
8105
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
8106
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
8107
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
8108
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
8109
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
8110
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
8111
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
8112
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
8113
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
8114
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
8115
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
8116
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
8117
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
8118
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
8119
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
8120
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
8121
|
+
* @param {*} [options] Override http request option.
|
|
8122
|
+
* @throws {RequiredError}
|
|
8123
|
+
*/
|
|
8124
|
+
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) {
|
|
8125
|
+
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));
|
|
8126
|
+
},
|
|
7918
8127
|
/**
|
|
7919
8128
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
7920
8129
|
* @summary Get Item Performance Analytics
|
|
@@ -8068,6 +8277,40 @@ export class ItemAnalyticsApi extends BaseAPI {
|
|
|
8068
8277
|
adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options) {
|
|
8069
8278
|
return ItemAnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID, itemId, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
|
|
8070
8279
|
}
|
|
8280
|
+
/**
|
|
8281
|
+
* 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
|
|
8282
|
+
* @summary Get Item Insights
|
|
8283
|
+
* @param {string} xStoreID Store ID
|
|
8284
|
+
* @param {string} itemId Item ID to analyze
|
|
8285
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
8286
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
8287
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
8288
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
8289
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
8290
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
8291
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
8292
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
8293
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
8294
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
8295
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
8296
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
8297
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
8298
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
8299
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
8300
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
8301
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
8302
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
8303
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
8304
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
8305
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
8306
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
8307
|
+
* @param {*} [options] Override http request option.
|
|
8308
|
+
* @throws {RequiredError}
|
|
8309
|
+
* @memberof ItemAnalyticsApi
|
|
8310
|
+
*/
|
|
8311
|
+
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) {
|
|
8312
|
+
return ItemAnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID, itemId, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, geoPage, geoPageSize, groupBy, options).then((request) => request(this.axios, this.basePath));
|
|
8313
|
+
}
|
|
8071
8314
|
/**
|
|
8072
8315
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
8073
8316
|
* @summary Get Item Performance Analytics
|
|
@@ -8172,6 +8415,26 @@ export const AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum = {
|
|
|
8172
8415
|
Asc: 'asc',
|
|
8173
8416
|
Desc: 'desc'
|
|
8174
8417
|
};
|
|
8418
|
+
/**
|
|
8419
|
+
* @export
|
|
8420
|
+
*/
|
|
8421
|
+
export const AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum = {
|
|
8422
|
+
Any: 'any',
|
|
8423
|
+
All: 'all'
|
|
8424
|
+
};
|
|
8425
|
+
/**
|
|
8426
|
+
* @export
|
|
8427
|
+
*/
|
|
8428
|
+
export const AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum = {
|
|
8429
|
+
Any: 'any',
|
|
8430
|
+
All: 'all'
|
|
8431
|
+
};
|
|
8432
|
+
/**
|
|
8433
|
+
* @export
|
|
8434
|
+
*/
|
|
8435
|
+
export const AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum = {
|
|
8436
|
+
Date: 'date'
|
|
8437
|
+
};
|
|
8175
8438
|
/**
|
|
8176
8439
|
* @export
|
|
8177
8440
|
*/
|
package/package.json
CHANGED
|
Binary file
|
|
Binary file
|