@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/api.js
CHANGED
|
@@ -23,11 +23,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
25
|
exports.AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortByEnum = exports.AnalyticsApi = exports.AnalyticsApiFactory = exports.AnalyticsApiFp = exports.AnalyticsApiAxiosParamCreator = exports.AccountSettingsApi = exports.AccountSettingsApiFactory = exports.AccountSettingsApiFp = exports.AccountSettingsApiAxiosParamCreator = exports.APICallsApi = exports.APICallsApiFactory = exports.APICallsApiFp = exports.APICallsApiAxiosParamCreator = exports.RefundRefundPreviewRequestDtoRefundTypeEnum = exports.DataTypesUpdateWordStatusRequestWordTypeEnum = exports.DataTypesUpdateStoreAccessRequestAccessLevelEnum = exports.DataTypesUpdatePluralDeclensionRequestTypeEnum = exports.DataTypesUpdateMemberRoleRequestMemberRoleEnum = exports.DataTypesStoreAccessRequestAccessLevelEnum = exports.DataTypesRefundCalculationRequestDtoRefundTypeEnum = exports.DataTypesRefundApprovalDtoActionEnum = exports.DataTypesProcessRefundRequestDtoRefundTypeEnum = exports.DataTypesInviteMemberRequestMemberRoleEnum = exports.DataTypesGrantStoreAccessRequestAccessLevelEnum = exports.DataTypesCreateTaskRequestTypeEnum = exports.DataTypesCreateTaskRequestIndexingStrategyEnum = exports.DataTypesCreateTaskRequestFrequencyEnum = exports.DataTypesCreateRefundRequestDtoRefundTypeEnum = exports.DataTypesCreatePluralDeclensionRequestTypeEnum = exports.DataTypesCreatePaymentOrderRequestPaymentTypeEnum = exports.DataTypesCreateCustomWordListRequestTypeEnum = exports.DataTypesBillingAlertRequestThresholdUnitEnum = exports.DataTypesBillingAlertRequestAlertTypeEnum = exports.AnalyticsRuleType = exports.AnalyticsQuerySuggestionStatus = exports.AnalyticsQuerySuggestionSource = exports.AnalyticsBulkOperation = exports.AnalyticsBannedMatchType = void 0;
|
|
26
|
-
exports.
|
|
27
|
-
exports.
|
|
28
|
-
exports.
|
|
29
|
-
exports.
|
|
30
|
-
exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.TeamApi = exports.TeamApiFactory = exports.TeamApiFp = exports.TeamApiAxiosParamCreator = exports.TaxManagementApi = exports.TaxManagementApiFactory = exports.TaxManagementApiFp = exports.TaxManagementApiAxiosParamCreator = exports.SubscriptionsApi = exports.SubscriptionsApiFactory = exports.SubscriptionsApiFp = exports.SubscriptionsApiAxiosParamCreator = exports.StoresApi = exports.StoresApiFactory = exports.StoresApiFp = exports.StoresApiAxiosParamCreator = exports.StoreDocumentsApi = exports.StoreDocumentsApiFactory = exports.StoreDocumentsApiFp = exports.StoreDocumentsApiAxiosParamCreator = exports.StoreCreationApi = exports.StoreCreationApiFactory = exports.StoreCreationApiFp = exports.StoreCreationApiAxiosParamCreator = exports.StopwordsApi = exports.StopwordsApiFactory = void 0;
|
|
26
|
+
exports.AutomatedRefundManagementApi = exports.AutomatedRefundManagementApiFactory = exports.AutomatedRefundManagementApiFp = exports.AutomatedRefundManagementApiAxiosParamCreator = exports.AuthApi = exports.AuthApiFactory = exports.AuthApiFp = exports.AuthApiAxiosParamCreator = exports.ArticlesApi = exports.ArticlesApiFactory = exports.ArticlesApiFp = exports.ArticlesApiAxiosParamCreator = exports.AnalyticsRulesApi = exports.AnalyticsRulesApiFactory = exports.AnalyticsRulesApiFp = exports.AnalyticsRulesApiAxiosParamCreator = exports.AnalyticsEventsApi = exports.AnalyticsEventsApiFactory = exports.AnalyticsEventsApiFp = exports.AnalyticsEventsApiAxiosParamCreator = exports.AdminAnalyticsStoreXStoreIDTagsSummaryGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDTagsSummaryGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDTagsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDTagsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetSortByEnum = void 0;
|
|
27
|
+
exports.FeatureLimitsAdminApi = exports.FeatureLimitsAdminApiFactory = exports.FeatureLimitsAdminApiFp = exports.FeatureLimitsAdminApiAxiosParamCreator = exports.FeatureLimitsApi = exports.FeatureLimitsApiFactory = exports.FeatureLimitsApiFp = exports.FeatureLimitsApiAxiosParamCreator = exports.DocumentsApi = exports.DocumentsApiFactory = exports.DocumentsApiFp = exports.DocumentsApiAxiosParamCreator = exports.CustomStopwordsApi = exports.CustomStopwordsApiFactory = exports.CustomStopwordsApiFp = exports.CustomStopwordsApiAxiosParamCreator = exports.CreditsTransactionsGetTypeEnum = exports.CreditsApi = exports.CreditsApiFactory = exports.CreditsApiFp = exports.CreditsApiAxiosParamCreator = exports.ConnectorsApi = exports.ConnectorsApiFactory = exports.ConnectorsApiFp = exports.ConnectorsApiAxiosParamCreator = exports.CompanyConfigApi = exports.CompanyConfigApiFactory = exports.CompanyConfigApiFp = exports.CompanyConfigApiAxiosParamCreator = exports.CommonApi = exports.CommonApiFactory = exports.CommonApiFp = exports.CommonApiAxiosParamCreator = exports.AdminBillingUsageDetailsGetGranularityEnum = exports.AdminBillingPaymentTransactionsGetSortOrderEnum = exports.AdminBillingPaymentTransactionsGetSortByEnum = exports.AdminBillingOrdersGetSortOrderEnum = exports.AdminBillingOrdersGetSortByEnum = exports.AdminBillingInvoicesGetSortOrderEnum = exports.AdminBillingInvoicesGetSortByEnum = exports.AdminBillingCreditTransactionsGetSortOrderEnum = exports.AdminBillingCreditTransactionsGetSortByEnum = exports.AdminBillingCreditPurchasesGetSortOrderEnum = exports.AdminBillingCreditPurchasesGetSortByEnum = exports.AdminBillingCreditLedgerGetSortOrderEnum = exports.AdminBillingCreditLedgerGetSortByEnum = exports.BillingDashboardApi = exports.BillingDashboardApiFactory = exports.BillingDashboardApiFp = exports.BillingDashboardApiAxiosParamCreator = void 0;
|
|
28
|
+
exports.ParentMenusApi = exports.ParentMenusApiFactory = exports.ParentMenusApiFp = exports.ParentMenusApiAxiosParamCreator = exports.OrganizationsApi = exports.OrganizationsApiFactory = exports.OrganizationsApiFp = exports.OrganizationsApiAxiosParamCreator = exports.OnboardingApi = exports.OnboardingApiFactory = exports.OnboardingApiFp = exports.OnboardingApiAxiosParamCreator = exports.NewsLettersApi = exports.NewsLettersApiFactory = exports.NewsLettersApiFp = exports.NewsLettersApiAxiosParamCreator = exports.MongoDbApi = exports.MongoDbApiFactory = exports.MongoDbApiFp = exports.MongoDbApiAxiosParamCreator = exports.ModulesApi = exports.ModulesApiFactory = exports.ModulesApiFp = exports.ModulesApiAxiosParamCreator = exports.MenusApi = exports.MenusApiFactory = exports.MenusApiFp = exports.MenusApiAxiosParamCreator = exports.LimitsApi = exports.LimitsApiFactory = exports.LimitsApiFp = exports.LimitsApiAxiosParamCreator = exports.AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum = exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortByEnum = exports.ItemAnalyticsApi = exports.ItemAnalyticsApiFactory = exports.ItemAnalyticsApiFp = exports.ItemAnalyticsApiAxiosParamCreator = void 0;
|
|
29
|
+
exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = exports.RoleRightsApi = exports.RoleRightsApiFactory = exports.RoleRightsApiFp = exports.RoleRightsApiAxiosParamCreator = exports.RequestsApi = exports.RequestsApiFactory = exports.RequestsApiFp = exports.RequestsApiAxiosParamCreator = exports.RegisterApi = exports.RegisterApiFactory = exports.RegisterApiFp = exports.RegisterApiAxiosParamCreator = exports.RefundManagementApi = exports.RefundManagementApiFactory = exports.RefundManagementApiFp = exports.RefundManagementApiAxiosParamCreator = exports.QuerySuggestionsManagementApi = exports.QuerySuggestionsManagementApiFactory = exports.QuerySuggestionsManagementApiFp = exports.QuerySuggestionsManagementApiAxiosParamCreator = exports.V1SuggestionsQueriesGetTimeRangeEnum = exports.V1SuggestionsQueriesGetTagsMatchModeEnum = exports.QuerySuggestionsApi = exports.QuerySuggestionsApiFactory = exports.QuerySuggestionsApiFp = exports.QuerySuggestionsApiAxiosParamCreator = exports.PluralsDeclensionsApi = exports.PluralsDeclensionsApiFactory = exports.PluralsDeclensionsApiFp = exports.PluralsDeclensionsApiAxiosParamCreator = exports.PlansApi = exports.PlansApiFactory = exports.PlansApiFp = exports.PlansApiAxiosParamCreator = exports.PaymentsApi = exports.PaymentsApiFactory = exports.PaymentsApiFp = exports.PaymentsApiAxiosParamCreator = exports.PaymentGatewayApi = exports.PaymentGatewayApiFactory = exports.PaymentGatewayApiFp = exports.PaymentGatewayApiAxiosParamCreator = void 0;
|
|
30
|
+
exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.TeamApi = exports.TeamApiFactory = exports.TeamApiFp = exports.TeamApiAxiosParamCreator = exports.TaxManagementApi = exports.TaxManagementApiFactory = exports.TaxManagementApiFp = exports.TaxManagementApiAxiosParamCreator = exports.SubscriptionsApi = exports.SubscriptionsApiFactory = exports.SubscriptionsApiFp = exports.SubscriptionsApiAxiosParamCreator = exports.StoresApi = exports.StoresApiFactory = exports.StoresApiFp = exports.StoresApiAxiosParamCreator = exports.StoreDocumentsApi = exports.StoreDocumentsApiFactory = exports.StoreDocumentsApiFp = exports.StoreDocumentsApiAxiosParamCreator = exports.StoreCreationApi = exports.StoreCreationApiFactory = exports.StoreCreationApiFp = exports.StoreCreationApiAxiosParamCreator = exports.StopwordsApi = exports.StopwordsApiFactory = exports.StopwordsApiFp = exports.StopwordsApiAxiosParamCreator = void 0;
|
|
31
31
|
const axios_1 = require("axios");
|
|
32
32
|
// Some imports not used depending on template conditions
|
|
33
33
|
// @ts-ignore
|
|
@@ -2324,6 +2324,145 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2324
2324
|
options: localVarRequestOptions,
|
|
2325
2325
|
};
|
|
2326
2326
|
}),
|
|
2327
|
+
/**
|
|
2328
|
+
* 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
|
|
2329
|
+
* @summary Get Query Insights
|
|
2330
|
+
* @param {string} xStoreID Store ID
|
|
2331
|
+
* @param {string} query Search query to analyze
|
|
2332
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
2333
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
2334
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
2335
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2336
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
2337
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
2338
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
2339
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
2340
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
2341
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
2342
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
2343
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
2344
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
2345
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
2346
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
2347
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
2348
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
2349
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
2350
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
2351
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
2352
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
2353
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
2354
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
2355
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
2356
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
2357
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
2358
|
+
* @param {*} [options] Override http request option.
|
|
2359
|
+
* @throws {RequiredError}
|
|
2360
|
+
*/
|
|
2361
|
+
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 = {}) {
|
|
2362
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
2363
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID);
|
|
2364
|
+
// verify required parameter 'query' is not null or undefined
|
|
2365
|
+
(0, common_1.assertParamExists)('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'query', query);
|
|
2366
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/{query}/insights`
|
|
2367
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
2368
|
+
.replace(`{${"query"}}`, encodeURIComponent(String(query)));
|
|
2369
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2370
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2371
|
+
let baseOptions;
|
|
2372
|
+
if (configuration) {
|
|
2373
|
+
baseOptions = configuration.baseOptions;
|
|
2374
|
+
}
|
|
2375
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2376
|
+
const localVarHeaderParameter = {};
|
|
2377
|
+
const localVarQueryParameter = {};
|
|
2378
|
+
// authentication BearerAuth required
|
|
2379
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
2380
|
+
if (startTime !== undefined) {
|
|
2381
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
2382
|
+
}
|
|
2383
|
+
if (endTime !== undefined) {
|
|
2384
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
2385
|
+
}
|
|
2386
|
+
if (analyticsTags !== undefined) {
|
|
2387
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
2388
|
+
}
|
|
2389
|
+
if (tagsMatchMode !== undefined) {
|
|
2390
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
2391
|
+
}
|
|
2392
|
+
if (tagsExclude !== undefined) {
|
|
2393
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
2394
|
+
}
|
|
2395
|
+
if (tagKeyFilter !== undefined) {
|
|
2396
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
2397
|
+
}
|
|
2398
|
+
if (tagValueFilter !== undefined) {
|
|
2399
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
2400
|
+
}
|
|
2401
|
+
if (search !== undefined) {
|
|
2402
|
+
localVarQueryParameter['search'] = search;
|
|
2403
|
+
}
|
|
2404
|
+
if (compareMode !== undefined) {
|
|
2405
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
2406
|
+
}
|
|
2407
|
+
if (compareStartTime !== undefined) {
|
|
2408
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
2409
|
+
}
|
|
2410
|
+
if (compareEndTime !== undefined) {
|
|
2411
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
2412
|
+
}
|
|
2413
|
+
if (compareAnalyticsTags !== undefined) {
|
|
2414
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
2415
|
+
}
|
|
2416
|
+
if (compareTagsMatchMode !== undefined) {
|
|
2417
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
2418
|
+
}
|
|
2419
|
+
if (compareTagsExclude !== undefined) {
|
|
2420
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
2421
|
+
}
|
|
2422
|
+
if (compareTagKeyFilter !== undefined) {
|
|
2423
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
2424
|
+
}
|
|
2425
|
+
if (compareTagValueFilter !== undefined) {
|
|
2426
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
2427
|
+
}
|
|
2428
|
+
if (resultsPage !== undefined) {
|
|
2429
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
2430
|
+
}
|
|
2431
|
+
if (resultsPageSize !== undefined) {
|
|
2432
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
2433
|
+
}
|
|
2434
|
+
if (resultsSearch !== undefined) {
|
|
2435
|
+
localVarQueryParameter['results_search'] = resultsSearch;
|
|
2436
|
+
}
|
|
2437
|
+
if (filtersPage !== undefined) {
|
|
2438
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
2439
|
+
}
|
|
2440
|
+
if (filtersPageSize !== undefined) {
|
|
2441
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
2442
|
+
}
|
|
2443
|
+
if (filtersSearch !== undefined) {
|
|
2444
|
+
localVarQueryParameter['filters_search'] = filtersSearch;
|
|
2445
|
+
}
|
|
2446
|
+
if (geoPage !== undefined) {
|
|
2447
|
+
localVarQueryParameter['geo_page'] = geoPage;
|
|
2448
|
+
}
|
|
2449
|
+
if (geoPageSize !== undefined) {
|
|
2450
|
+
localVarQueryParameter['geo_page_size'] = geoPageSize;
|
|
2451
|
+
}
|
|
2452
|
+
if (geoSearch !== undefined) {
|
|
2453
|
+
localVarQueryParameter['geo_search'] = geoSearch;
|
|
2454
|
+
}
|
|
2455
|
+
if (includeWidget !== undefined) {
|
|
2456
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
2457
|
+
}
|
|
2458
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2459
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2460
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2461
|
+
return {
|
|
2462
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2463
|
+
options: localVarRequestOptions,
|
|
2464
|
+
};
|
|
2465
|
+
}),
|
|
2327
2466
|
/**
|
|
2328
2467
|
* 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.
|
|
2329
2468
|
* @summary Get Top Results Analytics
|
|
@@ -2715,6 +2854,37 @@ const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
2715
2854
|
options: localVarRequestOptions,
|
|
2716
2855
|
};
|
|
2717
2856
|
}),
|
|
2857
|
+
/**
|
|
2858
|
+
* Retrieves and returns the number of search events per day for the past 7 days from ClickHouse.
|
|
2859
|
+
* @summary Get daily search counts for the last 7 days
|
|
2860
|
+
* @param {string} xStoreID Unique store identifier
|
|
2861
|
+
* @param {*} [options] Override http request option.
|
|
2862
|
+
* @throws {RequiredError}
|
|
2863
|
+
*/
|
|
2864
|
+
apiAdminAnalyticsStoreXStoreIDSearchcountGet: (xStoreID_1, ...args_1) => __awaiter(this, [xStoreID_1, ...args_1], void 0, function* (xStoreID, options = {}) {
|
|
2865
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
2866
|
+
(0, common_1.assertParamExists)('apiAdminAnalyticsStoreXStoreIDSearchcountGet', 'xStoreID', xStoreID);
|
|
2867
|
+
const localVarPath = `/api/admin/analytics/store/{xStoreID}/searchcount`
|
|
2868
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
2869
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2870
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2871
|
+
let baseOptions;
|
|
2872
|
+
if (configuration) {
|
|
2873
|
+
baseOptions = configuration.baseOptions;
|
|
2874
|
+
}
|
|
2875
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2876
|
+
const localVarHeaderParameter = {};
|
|
2877
|
+
const localVarQueryParameter = {};
|
|
2878
|
+
// authentication BearerAuth required
|
|
2879
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
2880
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2881
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2882
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2883
|
+
return {
|
|
2884
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2885
|
+
options: localVarRequestOptions,
|
|
2886
|
+
};
|
|
2887
|
+
}),
|
|
2718
2888
|
};
|
|
2719
2889
|
};
|
|
2720
2890
|
exports.AnalyticsApiAxiosParamCreator = AnalyticsApiAxiosParamCreator;
|
|
@@ -3136,6 +3306,49 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
3136
3306
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3137
3307
|
});
|
|
3138
3308
|
},
|
|
3309
|
+
/**
|
|
3310
|
+
* 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
|
|
3311
|
+
* @summary Get Query Insights
|
|
3312
|
+
* @param {string} xStoreID Store ID
|
|
3313
|
+
* @param {string} query Search query to analyze
|
|
3314
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
3315
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
3316
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3317
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3318
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3319
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3320
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3321
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
3322
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3323
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3324
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3325
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3326
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3327
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3328
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3329
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3330
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3331
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3332
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
3333
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3334
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3335
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
3336
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
3337
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
3338
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
3339
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3340
|
+
* @param {*} [options] Override http request option.
|
|
3341
|
+
* @throws {RequiredError}
|
|
3342
|
+
*/
|
|
3343
|
+
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) {
|
|
3344
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3345
|
+
var _a, _b, _c;
|
|
3346
|
+
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);
|
|
3347
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3348
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3349
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3350
|
+
});
|
|
3351
|
+
},
|
|
3139
3352
|
/**
|
|
3140
3353
|
* 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.
|
|
3141
3354
|
* @summary Get Top Results Analytics
|
|
@@ -3276,6 +3489,22 @@ const AnalyticsApiFp = function (configuration) {
|
|
|
3276
3489
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3277
3490
|
});
|
|
3278
3491
|
},
|
|
3492
|
+
/**
|
|
3493
|
+
* Retrieves and returns the number of search events per day for the past 7 days from ClickHouse.
|
|
3494
|
+
* @summary Get daily search counts for the last 7 days
|
|
3495
|
+
* @param {string} xStoreID Unique store identifier
|
|
3496
|
+
* @param {*} [options] Override http request option.
|
|
3497
|
+
* @throws {RequiredError}
|
|
3498
|
+
*/
|
|
3499
|
+
apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID, options) {
|
|
3500
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3501
|
+
var _a, _b, _c;
|
|
3502
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID, options);
|
|
3503
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3504
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsApi.apiAdminAnalyticsStoreXStoreIDSearchcountGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3505
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3506
|
+
});
|
|
3507
|
+
},
|
|
3279
3508
|
};
|
|
3280
3509
|
};
|
|
3281
3510
|
exports.AnalyticsApiFp = AnalyticsApiFp;
|
|
@@ -3613,6 +3842,43 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3613
3842
|
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) {
|
|
3614
3843
|
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));
|
|
3615
3844
|
},
|
|
3845
|
+
/**
|
|
3846
|
+
* 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
|
|
3847
|
+
* @summary Get Query Insights
|
|
3848
|
+
* @param {string} xStoreID Store ID
|
|
3849
|
+
* @param {string} query Search query to analyze
|
|
3850
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
3851
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
3852
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
3853
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
3854
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
3855
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
3856
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
3857
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
3858
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
3859
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
3860
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
3861
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
3862
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
3863
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
3864
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
3865
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
3866
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
3867
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
3868
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
3869
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
3870
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
3871
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
3872
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
3873
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
3874
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
3875
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
3876
|
+
* @param {*} [options] Override http request option.
|
|
3877
|
+
* @throws {RequiredError}
|
|
3878
|
+
*/
|
|
3879
|
+
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) {
|
|
3880
|
+
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));
|
|
3881
|
+
},
|
|
3616
3882
|
/**
|
|
3617
3883
|
* 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.
|
|
3618
3884
|
* @summary Get Top Results Analytics
|
|
@@ -3723,6 +3989,16 @@ const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
3723
3989
|
analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options) {
|
|
3724
3990
|
return localVarFp.analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options).then((request) => request(axios, basePath));
|
|
3725
3991
|
},
|
|
3992
|
+
/**
|
|
3993
|
+
* Retrieves and returns the number of search events per day for the past 7 days from ClickHouse.
|
|
3994
|
+
* @summary Get daily search counts for the last 7 days
|
|
3995
|
+
* @param {string} xStoreID Unique store identifier
|
|
3996
|
+
* @param {*} [options] Override http request option.
|
|
3997
|
+
* @throws {RequiredError}
|
|
3998
|
+
*/
|
|
3999
|
+
apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID, options) {
|
|
4000
|
+
return localVarFp.apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
4001
|
+
},
|
|
3726
4002
|
};
|
|
3727
4003
|
};
|
|
3728
4004
|
exports.AnalyticsApiFactory = AnalyticsApiFactory;
|
|
@@ -4074,6 +4350,44 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
4074
4350
|
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) {
|
|
4075
4351
|
return (0, exports.AnalyticsApiFp)(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
4076
4352
|
}
|
|
4353
|
+
/**
|
|
4354
|
+
* 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
|
|
4355
|
+
* @summary Get Query Insights
|
|
4356
|
+
* @param {string} xStoreID Store ID
|
|
4357
|
+
* @param {string} query Search query to analyze
|
|
4358
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
4359
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
4360
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
4361
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
4362
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
4363
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
4364
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
4365
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
4366
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
4367
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
4368
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
4369
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
4370
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
4371
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
4372
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
4373
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
4374
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
4375
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
4376
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
4377
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
4378
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
4379
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
4380
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
4381
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
4382
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
4383
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
4384
|
+
* @param {*} [options] Override http request option.
|
|
4385
|
+
* @throws {RequiredError}
|
|
4386
|
+
* @memberof AnalyticsApi
|
|
4387
|
+
*/
|
|
4388
|
+
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) {
|
|
4389
|
+
return (0, exports.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));
|
|
4390
|
+
}
|
|
4077
4391
|
/**
|
|
4078
4392
|
* 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.
|
|
4079
4393
|
* @summary Get Top Results Analytics
|
|
@@ -4189,6 +4503,17 @@ class AnalyticsApi extends base_1.BaseAPI {
|
|
|
4189
4503
|
analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options) {
|
|
4190
4504
|
return (0, exports.AnalyticsApiFp)(this.configuration).analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options).then((request) => request(this.axios, this.basePath));
|
|
4191
4505
|
}
|
|
4506
|
+
/**
|
|
4507
|
+
* Retrieves and returns the number of search events per day for the past 7 days from ClickHouse.
|
|
4508
|
+
* @summary Get daily search counts for the last 7 days
|
|
4509
|
+
* @param {string} xStoreID Unique store identifier
|
|
4510
|
+
* @param {*} [options] Override http request option.
|
|
4511
|
+
* @throws {RequiredError}
|
|
4512
|
+
* @memberof AnalyticsApi
|
|
4513
|
+
*/
|
|
4514
|
+
apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID, options) {
|
|
4515
|
+
return (0, exports.AnalyticsApiFp)(this.configuration).apiAdminAnalyticsStoreXStoreIDSearchcountGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
4516
|
+
}
|
|
4192
4517
|
}
|
|
4193
4518
|
exports.AnalyticsApi = AnalyticsApi;
|
|
4194
4519
|
/**
|
|
@@ -4463,6 +4788,20 @@ exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
4463
4788
|
Asc: 'asc',
|
|
4464
4789
|
Desc: 'desc'
|
|
4465
4790
|
};
|
|
4791
|
+
/**
|
|
4792
|
+
* @export
|
|
4793
|
+
*/
|
|
4794
|
+
exports.AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = {
|
|
4795
|
+
Any: 'any',
|
|
4796
|
+
All: 'all'
|
|
4797
|
+
};
|
|
4798
|
+
/**
|
|
4799
|
+
* @export
|
|
4800
|
+
*/
|
|
4801
|
+
exports.AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = {
|
|
4802
|
+
Any: 'any',
|
|
4803
|
+
All: 'all'
|
|
4804
|
+
};
|
|
4466
4805
|
/**
|
|
4467
4806
|
* @export
|
|
4468
4807
|
*/
|