@seekora-ai/admin-api 1.1.15 → 1.1.17
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 +26 -2
- package/api.ts +1578 -113
- package/dist/api.d.ts +1332 -52
- package/dist/api.js +344 -5
- package/dist/esm/api.d.ts +1332 -52
- package/dist/esm/api.js +339 -0
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.17.tgz +0 -0
- package/seekora-ai-admin-api-1.1.15.tgz +0 -0
package/dist/esm/api.js
CHANGED
|
@@ -2308,6 +2308,145 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2308
2308
|
options: localVarRequestOptions,
|
|
2309
2309
|
};
|
|
2310
2310
|
}),
|
|
2311
|
+
/**
|
|
2312
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
2313
|
+
* @summary Get Query Insights
|
|
2314
|
+
* @param {string} xStoreID Store ID
|
|
2315
|
+
* @param {string} query Search query to analyze
|
|
2316
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
2317
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
2318
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2319
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2320
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2321
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2322
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2323
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
2324
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2325
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2326
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2327
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2328
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2329
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2330
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2331
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2332
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2333
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2334
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
2335
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2336
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
2337
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
2338
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
2339
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
2340
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
2341
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
2342
|
+
* @param {*} [options] Override http request option.
|
|
2343
|
+
* @throws {RequiredError}
|
|
2344
|
+
*/
|
|
2345
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID_1, query_1, startTime_1, endTime_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, search_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, resultsSearch_1, filtersPage_1, filtersPageSize_1, filtersSearch_1, geoPage_1, geoPageSize_1, geoSearch_1, includeWidget_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, startTime_1, endTime_1, analyticsTags_1, tagsMatchMode_1, tagsExclude_1, tagKeyFilter_1, tagValueFilter_1, search_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, resultsSearch_1, filtersPage_1, filtersPageSize_1, filtersSearch_1, geoPage_1, geoPageSize_1, geoSearch_1, includeWidget_1, ...args_1], void 0, function* (xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options = {}) {
|
|
2346
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
2347
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID);
|
|
2348
|
+
// verify required parameter 'query' is not null or undefined
|
|
2349
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'query', query);
|
|
2350
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/{query}/insights`
|
|
2351
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
2352
|
+
.replace(`{${"query"}}`, encodeURIComponent(String(query)));
|
|
2353
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2354
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2355
|
+
let baseOptions;
|
|
2356
|
+
if (configuration) {
|
|
2357
|
+
baseOptions = configuration.baseOptions;
|
|
2358
|
+
}
|
|
2359
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2360
|
+
const localVarHeaderParameter = {};
|
|
2361
|
+
const localVarQueryParameter = {};
|
|
2362
|
+
// authentication BearerAuth required
|
|
2363
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
2364
|
+
if (startTime !== undefined) {
|
|
2365
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
2366
|
+
}
|
|
2367
|
+
if (endTime !== undefined) {
|
|
2368
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
2369
|
+
}
|
|
2370
|
+
if (analyticsTags !== undefined) {
|
|
2371
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
2372
|
+
}
|
|
2373
|
+
if (tagsMatchMode !== undefined) {
|
|
2374
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
2375
|
+
}
|
|
2376
|
+
if (tagsExclude !== undefined) {
|
|
2377
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
2378
|
+
}
|
|
2379
|
+
if (tagKeyFilter !== undefined) {
|
|
2380
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
2381
|
+
}
|
|
2382
|
+
if (tagValueFilter !== undefined) {
|
|
2383
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
2384
|
+
}
|
|
2385
|
+
if (search !== undefined) {
|
|
2386
|
+
localVarQueryParameter['search'] = search;
|
|
2387
|
+
}
|
|
2388
|
+
if (compareMode !== undefined) {
|
|
2389
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
2390
|
+
}
|
|
2391
|
+
if (compareStartTime !== undefined) {
|
|
2392
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
2393
|
+
}
|
|
2394
|
+
if (compareEndTime !== undefined) {
|
|
2395
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
2396
|
+
}
|
|
2397
|
+
if (compareAnalyticsTags !== undefined) {
|
|
2398
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
2399
|
+
}
|
|
2400
|
+
if (compareTagsMatchMode !== undefined) {
|
|
2401
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
2402
|
+
}
|
|
2403
|
+
if (compareTagsExclude !== undefined) {
|
|
2404
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
2405
|
+
}
|
|
2406
|
+
if (compareTagKeyFilter !== undefined) {
|
|
2407
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
2408
|
+
}
|
|
2409
|
+
if (compareTagValueFilter !== undefined) {
|
|
2410
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
2411
|
+
}
|
|
2412
|
+
if (resultsPage !== undefined) {
|
|
2413
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
2414
|
+
}
|
|
2415
|
+
if (resultsPageSize !== undefined) {
|
|
2416
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
2417
|
+
}
|
|
2418
|
+
if (resultsSearch !== undefined) {
|
|
2419
|
+
localVarQueryParameter['results_search'] = resultsSearch;
|
|
2420
|
+
}
|
|
2421
|
+
if (filtersPage !== undefined) {
|
|
2422
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
2423
|
+
}
|
|
2424
|
+
if (filtersPageSize !== undefined) {
|
|
2425
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
2426
|
+
}
|
|
2427
|
+
if (filtersSearch !== undefined) {
|
|
2428
|
+
localVarQueryParameter['filters_search'] = filtersSearch;
|
|
2429
|
+
}
|
|
2430
|
+
if (geoPage !== undefined) {
|
|
2431
|
+
localVarQueryParameter['geo_page'] = geoPage;
|
|
2432
|
+
}
|
|
2433
|
+
if (geoPageSize !== undefined) {
|
|
2434
|
+
localVarQueryParameter['geo_page_size'] = geoPageSize;
|
|
2435
|
+
}
|
|
2436
|
+
if (geoSearch !== undefined) {
|
|
2437
|
+
localVarQueryParameter['geo_search'] = geoSearch;
|
|
2438
|
+
}
|
|
2439
|
+
if (includeWidget !== undefined) {
|
|
2440
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
2441
|
+
}
|
|
2442
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2443
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2444
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2445
|
+
return {
|
|
2446
|
+
url: toPathString(localVarUrlObj),
|
|
2447
|
+
options: localVarRequestOptions,
|
|
2448
|
+
};
|
|
2449
|
+
}),
|
|
2311
2450
|
/**
|
|
2312
2451
|
* 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.
|
|
2313
2452
|
* @summary Get Top Results Analytics
|
|
@@ -2699,6 +2838,37 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2699
2838
|
options: localVarRequestOptions,
|
|
2700
2839
|
};
|
|
2701
2840
|
}),
|
|
2841
|
+
/**
|
|
2842
|
+
* Retrieves and returns the number of search events per day for the past 7 days from ClickHouse.
|
|
2843
|
+
* @summary Get daily search counts for the last 7 days
|
|
2844
|
+
* @param {string} xStoreID Unique store identifier
|
|
2845
|
+
* @param {*} [options] Override http request option.
|
|
2846
|
+
* @throws {RequiredError}
|
|
2847
|
+
*/
|
|
2848
|
+
apiAdminAnalyticsStoreXStoreIDSearchcountGet: (xStoreID_1, ...args_1) => __awaiter(this, [xStoreID_1, ...args_1], void 0, function* (xStoreID, options = {}) {
|
|
2849
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
2850
|
+
assertParamExists('apiAdminAnalyticsStoreXStoreIDSearchcountGet', 'xStoreID', xStoreID);
|
|
2851
|
+
const localVarPath = `/api/admin/analytics/store/{xStoreID}/searchcount`
|
|
2852
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
2853
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2854
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2855
|
+
let baseOptions;
|
|
2856
|
+
if (configuration) {
|
|
2857
|
+
baseOptions = configuration.baseOptions;
|
|
2858
|
+
}
|
|
2859
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2860
|
+
const localVarHeaderParameter = {};
|
|
2861
|
+
const localVarQueryParameter = {};
|
|
2862
|
+
// authentication BearerAuth required
|
|
2863
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
2864
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2865
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2866
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2867
|
+
return {
|
|
2868
|
+
url: toPathString(localVarUrlObj),
|
|
2869
|
+
options: localVarRequestOptions,
|
|
2870
|
+
};
|
|
2871
|
+
}),
|
|
2702
2872
|
};
|
|
2703
2873
|
};
|
|
2704
2874
|
/**
|
|
@@ -3119,6 +3289,49 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
3119
3289
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3120
3290
|
});
|
|
3121
3291
|
},
|
|
3292
|
+
/**
|
|
3293
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
3294
|
+
* @summary Get Query Insights
|
|
3295
|
+
* @param {string} xStoreID Store ID
|
|
3296
|
+
* @param {string} query Search query to analyze
|
|
3297
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
3298
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
3299
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3300
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3301
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3302
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3303
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3304
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
3305
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3306
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3307
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3308
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3309
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3310
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3311
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3312
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3313
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3314
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3315
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
3316
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3317
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3318
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
3319
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
3320
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
3321
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
3322
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3323
|
+
* @param {*} [options] Override http request option.
|
|
3324
|
+
* @throws {RequiredError}
|
|
3325
|
+
*/
|
|
3326
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options) {
|
|
3327
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3328
|
+
var _a, _b, _c;
|
|
3329
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options);
|
|
3330
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3331
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3332
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3333
|
+
});
|
|
3334
|
+
},
|
|
3122
3335
|
/**
|
|
3123
3336
|
* 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.
|
|
3124
3337
|
* @summary Get Top Results Analytics
|
|
@@ -3259,6 +3472,22 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
3259
3472
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3260
3473
|
});
|
|
3261
3474
|
},
|
|
3475
|
+
/**
|
|
3476
|
+
* Retrieves and returns the number of search events per day for the past 7 days from ClickHouse.
|
|
3477
|
+
* @summary Get daily search counts for the last 7 days
|
|
3478
|
+
* @param {string} xStoreID Unique store identifier
|
|
3479
|
+
* @param {*} [options] Override http request option.
|
|
3480
|
+
* @throws {RequiredError}
|
|
3481
|
+
*/
|
|
3482
|
+
apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID, options) {
|
|
3483
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3484
|
+
var _a, _b, _c;
|
|
3485
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID, options);
|
|
3486
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3487
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.apiAdminAnalyticsStoreXStoreIDSearchcountGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3488
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3489
|
+
});
|
|
3490
|
+
},
|
|
3262
3491
|
};
|
|
3263
3492
|
};
|
|
3264
3493
|
/**
|
|
@@ -3595,6 +3824,43 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3595
3824
|
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) {
|
|
3596
3825
|
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));
|
|
3597
3826
|
},
|
|
3827
|
+
/**
|
|
3828
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
3829
|
+
* @summary Get Query Insights
|
|
3830
|
+
* @param {string} xStoreID Store ID
|
|
3831
|
+
* @param {string} query Search query to analyze
|
|
3832
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
3833
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
3834
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3835
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3836
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3837
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3838
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3839
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
3840
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3841
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3842
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3843
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3844
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3845
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3846
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3847
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3848
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3849
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3850
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
3851
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3852
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3853
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
3854
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
3855
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
3856
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
3857
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3858
|
+
* @param {*} [options] Override http request option.
|
|
3859
|
+
* @throws {RequiredError}
|
|
3860
|
+
*/
|
|
3861
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options) {
|
|
3862
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options).then((request) => request(axios, basePath));
|
|
3863
|
+
},
|
|
3598
3864
|
/**
|
|
3599
3865
|
* 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.
|
|
3600
3866
|
* @summary Get Top Results Analytics
|
|
@@ -3705,6 +3971,16 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3705
3971
|
analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options) {
|
|
3706
3972
|
return localVarFp.analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options).then((request) => request(axios, basePath));
|
|
3707
3973
|
},
|
|
3974
|
+
/**
|
|
3975
|
+
* Retrieves and returns the number of search events per day for the past 7 days from ClickHouse.
|
|
3976
|
+
* @summary Get daily search counts for the last 7 days
|
|
3977
|
+
* @param {string} xStoreID Unique store identifier
|
|
3978
|
+
* @param {*} [options] Override http request option.
|
|
3979
|
+
* @throws {RequiredError}
|
|
3980
|
+
*/
|
|
3981
|
+
apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID, options) {
|
|
3982
|
+
return localVarFp.apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
3983
|
+
},
|
|
3708
3984
|
};
|
|
3709
3985
|
};
|
|
3710
3986
|
/**
|
|
@@ -4055,6 +4331,44 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
4055
4331
|
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) {
|
|
4056
4332
|
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));
|
|
4057
4333
|
}
|
|
4334
|
+
/**
|
|
4335
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
4336
|
+
* @summary Get Query Insights
|
|
4337
|
+
* @param {string} xStoreID Store ID
|
|
4338
|
+
* @param {string} query Search query to analyze
|
|
4339
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
4340
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
4341
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
4342
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
4343
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
4344
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
4345
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
4346
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
4347
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
4348
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
4349
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
4350
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
4351
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
4352
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
4353
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
4354
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
4355
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
4356
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
4357
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
4358
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
4359
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
4360
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
4361
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
4362
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
4363
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
4364
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
4365
|
+
* @param {*} [options] Override http request option.
|
|
4366
|
+
* @throws {RequiredError}
|
|
4367
|
+
* @memberof AnalyticsApi
|
|
4368
|
+
*/
|
|
4369
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options) {
|
|
4370
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
4371
|
+
}
|
|
4058
4372
|
/**
|
|
4059
4373
|
* 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.
|
|
4060
4374
|
* @summary Get Top Results Analytics
|
|
@@ -4170,6 +4484,17 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
4170
4484
|
analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options) {
|
|
4171
4485
|
return AnalyticsApiFp(this.configuration).analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options).then((request) => request(this.axios, this.basePath));
|
|
4172
4486
|
}
|
|
4487
|
+
/**
|
|
4488
|
+
* Retrieves and returns the number of search events per day for the past 7 days from ClickHouse.
|
|
4489
|
+
* @summary Get daily search counts for the last 7 days
|
|
4490
|
+
* @param {string} xStoreID Unique store identifier
|
|
4491
|
+
* @param {*} [options] Override http request option.
|
|
4492
|
+
* @throws {RequiredError}
|
|
4493
|
+
* @memberof AnalyticsApi
|
|
4494
|
+
*/
|
|
4495
|
+
apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID, options) {
|
|
4496
|
+
return AnalyticsApiFp(this.configuration).apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
4497
|
+
}
|
|
4173
4498
|
}
|
|
4174
4499
|
/**
|
|
4175
4500
|
* @export
|
|
@@ -4443,6 +4768,20 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
4443
4768
|
Asc: 'asc',
|
|
4444
4769
|
Desc: 'desc'
|
|
4445
4770
|
};
|
|
4771
|
+
/**
|
|
4772
|
+
* @export
|
|
4773
|
+
*/
|
|
4774
|
+
export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = {
|
|
4775
|
+
Any: 'any',
|
|
4776
|
+
All: 'all'
|
|
4777
|
+
};
|
|
4778
|
+
/**
|
|
4779
|
+
* @export
|
|
4780
|
+
*/
|
|
4781
|
+
export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = {
|
|
4782
|
+
Any: 'any',
|
|
4783
|
+
All: 'all'
|
|
4784
|
+
};
|
|
4446
4785
|
/**
|
|
4447
4786
|
* @export
|
|
4448
4787
|
*/
|
package/package.json
CHANGED
|
Binary file
|
|
Binary file
|