@seekora-ai/admin-api 1.1.15 → 1.1.16
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 +23 -2
- package/api.ts +1368 -19
- package/dist/api.d.ts +1297 -94
- package/dist/api.js +276 -5
- package/dist/esm/api.d.ts +1297 -94
- package/dist/esm/api.js +271 -0
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.16.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
|
|
@@ -3119,6 +3258,49 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
3119
3258
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3120
3259
|
});
|
|
3121
3260
|
},
|
|
3261
|
+
/**
|
|
3262
|
+
* 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
|
|
3263
|
+
* @summary Get Query Insights
|
|
3264
|
+
* @param {string} xStoreID Store ID
|
|
3265
|
+
* @param {string} query Search query to analyze
|
|
3266
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
3267
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
3268
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3269
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3270
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3271
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3272
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3273
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
3274
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3275
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3276
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3277
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3278
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3279
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3280
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3281
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3282
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3283
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3284
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
3285
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3286
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3287
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
3288
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
3289
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
3290
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
3291
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3292
|
+
* @param {*} [options] Override http request option.
|
|
3293
|
+
* @throws {RequiredError}
|
|
3294
|
+
*/
|
|
3295
|
+
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) {
|
|
3296
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3297
|
+
var _a, _b, _c;
|
|
3298
|
+
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);
|
|
3299
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3300
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3301
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3302
|
+
});
|
|
3303
|
+
},
|
|
3122
3304
|
/**
|
|
3123
3305
|
* 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
3306
|
* @summary Get Top Results Analytics
|
|
@@ -3595,6 +3777,43 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3595
3777
|
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
3778
|
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
3779
|
},
|
|
3780
|
+
/**
|
|
3781
|
+
* 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
|
|
3782
|
+
* @summary Get Query Insights
|
|
3783
|
+
* @param {string} xStoreID Store ID
|
|
3784
|
+
* @param {string} query Search query to analyze
|
|
3785
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
3786
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
3787
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3788
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3789
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3790
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3791
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3792
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
3793
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3794
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3795
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3796
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3797
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3798
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3799
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3800
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3801
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3802
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3803
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
3804
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3805
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3806
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
3807
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
3808
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
3809
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
3810
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3811
|
+
* @param {*} [options] Override http request option.
|
|
3812
|
+
* @throws {RequiredError}
|
|
3813
|
+
*/
|
|
3814
|
+
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) {
|
|
3815
|
+
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));
|
|
3816
|
+
},
|
|
3598
3817
|
/**
|
|
3599
3818
|
* 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
3819
|
* @summary Get Top Results Analytics
|
|
@@ -4055,6 +4274,44 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
4055
4274
|
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
4275
|
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
4276
|
}
|
|
4277
|
+
/**
|
|
4278
|
+
* 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
|
|
4279
|
+
* @summary Get Query Insights
|
|
4280
|
+
* @param {string} xStoreID Store ID
|
|
4281
|
+
* @param {string} query Search query to analyze
|
|
4282
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
4283
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
4284
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
4285
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
4286
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
4287
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
4288
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
4289
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
4290
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
4291
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
4292
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
4293
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
4294
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
4295
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
4296
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
4297
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
4298
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
4299
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
4300
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
4301
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
4302
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
4303
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
4304
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
4305
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
4306
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
4307
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
4308
|
+
* @param {*} [options] Override http request option.
|
|
4309
|
+
* @throws {RequiredError}
|
|
4310
|
+
* @memberof AnalyticsApi
|
|
4311
|
+
*/
|
|
4312
|
+
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) {
|
|
4313
|
+
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));
|
|
4314
|
+
}
|
|
4058
4315
|
/**
|
|
4059
4316
|
* 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
4317
|
* @summary Get Top Results Analytics
|
|
@@ -4443,6 +4700,20 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
4443
4700
|
Asc: 'asc',
|
|
4444
4701
|
Desc: 'desc'
|
|
4445
4702
|
};
|
|
4703
|
+
/**
|
|
4704
|
+
* @export
|
|
4705
|
+
*/
|
|
4706
|
+
export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = {
|
|
4707
|
+
Any: 'any',
|
|
4708
|
+
All: 'all'
|
|
4709
|
+
};
|
|
4710
|
+
/**
|
|
4711
|
+
* @export
|
|
4712
|
+
*/
|
|
4713
|
+
export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = {
|
|
4714
|
+
Any: 'any',
|
|
4715
|
+
All: 'all'
|
|
4716
|
+
};
|
|
4446
4717
|
/**
|
|
4447
4718
|
* @export
|
|
4448
4719
|
*/
|
package/package.json
CHANGED
|
Binary file
|
|
Binary file
|