@seekora-ai/admin-api 1.0.48 → 1.0.49

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/dist/esm/api.d.ts CHANGED
@@ -1066,11 +1066,11 @@ export interface AnalyticsExtendedKPIResponse {
1066
1066
  */
1067
1067
  'compare_summary'?: AnalyticsKPIMetrics;
1068
1068
  /**
1069
- *
1070
- * @type {Array<AnalyticsKPIPointExtended>}
1069
+ * Can be []KPIPointExtended or []ComparisonMetrics
1070
+ * @type {object}
1071
1071
  * @memberof AnalyticsExtendedKPIResponse
1072
1072
  */
1073
- 'data'?: Array<AnalyticsKPIPointExtended>;
1073
+ 'data'?: object;
1074
1074
  /**
1075
1075
  *
1076
1076
  * @type {string}
@@ -1138,12 +1138,24 @@ export interface AnalyticsFilterAnalyticsResponse {
1138
1138
  * @memberof AnalyticsFilterAnalyticsResponse
1139
1139
  */
1140
1140
  'filter_key'?: string;
1141
+ /**
1142
+ *
1143
+ * @type {number}
1144
+ * @memberof AnalyticsFilterAnalyticsResponse
1145
+ */
1146
+ 'limit'?: number;
1141
1147
  /**
1142
1148
  *
1143
1149
  * @type {string}
1144
1150
  * @memberof AnalyticsFilterAnalyticsResponse
1145
1151
  */
1146
1152
  'org_id'?: string;
1153
+ /**
1154
+ *
1155
+ * @type {number}
1156
+ * @memberof AnalyticsFilterAnalyticsResponse
1157
+ */
1158
+ 'page'?: number;
1147
1159
  /**
1148
1160
  *
1149
1161
  * @type {string}
@@ -1174,6 +1186,12 @@ export interface AnalyticsFilterAnalyticsResponse {
1174
1186
  * @memberof AnalyticsFilterAnalyticsResponse
1175
1187
  */
1176
1188
  'store_id'?: string;
1189
+ /**
1190
+ *
1191
+ * @type {number}
1192
+ * @memberof AnalyticsFilterAnalyticsResponse
1193
+ */
1194
+ 'total'?: number;
1177
1195
  }
1178
1196
  /**
1179
1197
  *
@@ -1409,12 +1427,24 @@ export interface AnalyticsFilterTrendsResponse {
1409
1427
  * @memberof AnalyticsFilterTrendsResponse
1410
1428
  */
1411
1429
  'granularity'?: string;
1430
+ /**
1431
+ *
1432
+ * @type {number}
1433
+ * @memberof AnalyticsFilterTrendsResponse
1434
+ */
1435
+ 'limit'?: number;
1412
1436
  /**
1413
1437
  *
1414
1438
  * @type {string}
1415
1439
  * @memberof AnalyticsFilterTrendsResponse
1416
1440
  */
1417
1441
  'org_id'?: string;
1442
+ /**
1443
+ *
1444
+ * @type {number}
1445
+ * @memberof AnalyticsFilterTrendsResponse
1446
+ */
1447
+ 'page'?: number;
1418
1448
  /**
1419
1449
  *
1420
1450
  * @type {string}
@@ -1445,6 +1475,12 @@ export interface AnalyticsFilterTrendsResponse {
1445
1475
  * @memberof AnalyticsFilterTrendsResponse
1446
1476
  */
1447
1477
  'top_filters'?: number;
1478
+ /**
1479
+ *
1480
+ * @type {number}
1481
+ * @memberof AnalyticsFilterTrendsResponse
1482
+ */
1483
+ 'total'?: number;
1448
1484
  /**
1449
1485
  *
1450
1486
  * @type {{ [key: string]: Array<AnalyticsTimeSeriesPoint>; }}
@@ -6015,11 +6051,17 @@ export interface DataTypesErrorMetaResponse {
6015
6051
  */
6016
6052
  export interface DataTypesEventPayload {
6017
6053
  /**
6018
- *
6054
+ * Journey Tracking & Analytics
6019
6055
  * @type {Array<string>}
6020
6056
  * @memberof DataTypesEventPayload
6021
6057
  */
6022
6058
  'analytics_tags'?: Array<string>;
6059
+ /**
6060
+ * Anonymous user identifier
6061
+ * @type {string}
6062
+ * @memberof DataTypesEventPayload
6063
+ */
6064
+ 'anon_id'?: string;
6023
6065
  /**
6024
6066
  *
6025
6067
  * @type {string}
@@ -6027,13 +6069,13 @@ export interface DataTypesEventPayload {
6027
6069
  */
6028
6070
  'city'?: string;
6029
6071
  /**
6030
- *
6072
+ * Click/Interaction Event Fields
6031
6073
  * @type {string}
6032
6074
  * @memberof DataTypesEventPayload
6033
6075
  */
6034
6076
  'clicked_product_id'?: string;
6035
6077
  /**
6036
- * Geo data fields for direct submission
6078
+ * Enhanced Geo data fields for direct submission
6037
6079
  * @type {string}
6038
6080
  * @memberof DataTypesEventPayload
6039
6081
  */
@@ -6044,6 +6086,12 @@ export interface DataTypesEventPayload {
6044
6086
  * @memberof DataTypesEventPayload
6045
6087
  */
6046
6088
  'country_code'?: string;
6089
+ /**
6090
+ * Currency for value
6091
+ * @type {string}
6092
+ * @memberof DataTypesEventPayload
6093
+ */
6094
+ 'currency'?: string;
6047
6095
  /**
6048
6096
  *
6049
6097
  * @type {string}
@@ -6051,7 +6099,7 @@ export interface DataTypesEventPayload {
6051
6099
  */
6052
6100
  'device_type'?: string;
6053
6101
  /**
6054
- *
6102
+ * Core Event Information
6055
6103
  * @type {string}
6056
6104
  * @memberof DataTypesEventPayload
6057
6105
  */
@@ -6063,25 +6111,25 @@ export interface DataTypesEventPayload {
6063
6111
  */
6064
6112
  'event_name'?: string;
6065
6113
  /**
6066
- *
6114
+ * Device & Location Context
6067
6115
  * @type {string}
6068
6116
  * @memberof DataTypesEventPayload
6069
6117
  */
6070
6118
  'ip'?: string;
6071
6119
  /**
6072
- *
6120
+ * Performance
6073
6121
  * @type {number}
6074
6122
  * @memberof DataTypesEventPayload
6075
6123
  */
6076
6124
  'latency_ms'?: number;
6077
6125
  /**
6078
- *
6126
+ * Legacy field
6079
6127
  * @type {string}
6080
6128
  * @memberof DataTypesEventPayload
6081
6129
  */
6082
6130
  'location'?: string;
6083
6131
  /**
6084
- *
6132
+ * Flexible metadata including search_id, position, etc.
6085
6133
  * @type {{ [key: string]: any; }}
6086
6134
  * @memberof DataTypesEventPayload
6087
6135
  */
@@ -6095,7 +6143,13 @@ export interface DataTypesEventPayload {
6095
6143
  */
6096
6144
  'org_id'?: string;
6097
6145
  /**
6098
- *
6146
+ * web, ios, android
6147
+ * @type {string}
6148
+ * @memberof DataTypesEventPayload
6149
+ */
6150
+ 'platform'?: string;
6151
+ /**
6152
+ * Search Event Fields
6099
6153
  * @type {string}
6100
6154
  * @memberof DataTypesEventPayload
6101
6155
  */
@@ -6113,7 +6167,13 @@ export interface DataTypesEventPayload {
6113
6167
  */
6114
6168
  'results_count'?: number;
6115
6169
  /**
6116
- *
6170
+ * Session identifier for journey tracking
6171
+ * @type {string}
6172
+ * @memberof DataTypesEventPayload
6173
+ */
6174
+ 'session_id'?: string;
6175
+ /**
6176
+ * Organization Context
6117
6177
  * @type {string}
6118
6178
  * @memberof DataTypesEventPayload
6119
6179
  */
@@ -6125,11 +6185,17 @@ export interface DataTypesEventPayload {
6125
6185
  */
6126
6186
  'timestamp'?: string;
6127
6187
  /**
6128
- *
6188
+ * User Context
6129
6189
  * @type {string}
6130
6190
  * @memberof DataTypesEventPayload
6131
6191
  */
6132
6192
  'user_id'?: string;
6193
+ /**
6194
+ * Business Context
6195
+ * @type {number}
6196
+ * @memberof DataTypesEventPayload
6197
+ */
6198
+ 'value'?: number;
6133
6199
  }
6134
6200
  /**
6135
6201
  *
@@ -13191,12 +13257,20 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
13191
13257
  */
13192
13258
  adminAnalyticsStoreXStoreIDQueriesNoResultsGet: (xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
13193
13259
  /**
13194
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
13260
+ * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
13195
13261
  * @summary Get Query Insights
13196
13262
  * @param {string} xStoreID Store ID
13197
13263
  * @param {string} query Search query to analyze
13198
13264
  * @param {string} [startTime] Start time in RFC3339 format
13199
13265
  * @param {string} [endTime] End time in RFC3339 format
13266
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
13267
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
13268
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
13269
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
13270
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
13271
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
13272
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
13273
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
13200
13274
  * @param {number} [resultsPage] Page number for popular results pagination
13201
13275
  * @param {number} [resultsPageSize] Number of results per page for popular results
13202
13276
  * @param {number} [filtersPage] Page number for popular filters pagination
@@ -13205,7 +13279,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
13205
13279
  * @param {*} [options] Override http request option.
13206
13280
  * @throws {RequiredError}
13207
13281
  */
13208
- adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
13282
+ adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
13209
13283
  /**
13210
13284
  * 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.
13211
13285
  * @summary Get Top Results Analytics
@@ -13548,12 +13622,20 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
13548
13622
  */
13549
13623
  adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>>;
13550
13624
  /**
13551
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
13625
+ * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
13552
13626
  * @summary Get Query Insights
13553
13627
  * @param {string} xStoreID Store ID
13554
13628
  * @param {string} query Search query to analyze
13555
13629
  * @param {string} [startTime] Start time in RFC3339 format
13556
13630
  * @param {string} [endTime] End time in RFC3339 format
13631
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
13632
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
13633
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
13634
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
13635
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
13636
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
13637
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
13638
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
13557
13639
  * @param {number} [resultsPage] Page number for popular results pagination
13558
13640
  * @param {number} [resultsPageSize] Number of results per page for popular results
13559
13641
  * @param {number} [filtersPage] Page number for popular filters pagination
@@ -13562,7 +13644,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
13562
13644
  * @param {*} [options] Override http request option.
13563
13645
  * @throws {RequiredError}
13564
13646
  */
13565
- adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>>;
13647
+ adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>>;
13566
13648
  /**
13567
13649
  * 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.
13568
13650
  * @summary Get Top Results Analytics
@@ -13905,12 +13987,20 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
13905
13987
  */
13906
13988
  adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>;
13907
13989
  /**
13908
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
13990
+ * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
13909
13991
  * @summary Get Query Insights
13910
13992
  * @param {string} xStoreID Store ID
13911
13993
  * @param {string} query Search query to analyze
13912
13994
  * @param {string} [startTime] Start time in RFC3339 format
13913
13995
  * @param {string} [endTime] End time in RFC3339 format
13996
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
13997
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
13998
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
13999
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
14000
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
14001
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
14002
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
14003
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
13914
14004
  * @param {number} [resultsPage] Page number for popular results pagination
13915
14005
  * @param {number} [resultsPageSize] Number of results per page for popular results
13916
14006
  * @param {number} [filtersPage] Page number for popular filters pagination
@@ -13919,7 +14009,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
13919
14009
  * @param {*} [options] Override http request option.
13920
14010
  * @throws {RequiredError}
13921
14011
  */
13922
- adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>;
14012
+ adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>;
13923
14013
  /**
13924
14014
  * 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.
13925
14015
  * @summary Get Top Results Analytics
@@ -14277,12 +14367,20 @@ export declare class AnalyticsApi extends BaseAPI {
14277
14367
  */
14278
14368
  adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response, any, {}>>;
14279
14369
  /**
14280
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
14370
+ * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
14281
14371
  * @summary Get Query Insights
14282
14372
  * @param {string} xStoreID Store ID
14283
14373
  * @param {string} query Search query to analyze
14284
14374
  * @param {string} [startTime] Start time in RFC3339 format
14285
14375
  * @param {string} [endTime] End time in RFC3339 format
14376
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
14377
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
14378
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
14379
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
14380
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
14381
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
14382
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
14383
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
14286
14384
  * @param {number} [resultsPage] Page number for popular results pagination
14287
14385
  * @param {number} [resultsPageSize] Number of results per page for popular results
14288
14386
  * @param {number} [filtersPage] Page number for popular filters pagination
@@ -14292,7 +14390,7 @@ export declare class AnalyticsApi extends BaseAPI {
14292
14390
  * @throws {RequiredError}
14293
14391
  * @memberof AnalyticsApi
14294
14392
  */
14295
- adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any, {}>>;
14393
+ adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any, {}>>;
14296
14394
  /**
14297
14395
  * 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.
14298
14396
  * @summary Get Top Results Analytics
@@ -14658,6 +14756,14 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum
14658
14756
  readonly Desc: "desc";
14659
14757
  };
14660
14758
  export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
14759
+ /**
14760
+ * @export
14761
+ */
14762
+ export declare const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum: {
14763
+ readonly Any: "any";
14764
+ readonly All: "all";
14765
+ };
14766
+ export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum];
14661
14767
  /**
14662
14768
  * @export
14663
14769
  */
package/dist/esm/api.js CHANGED
@@ -1993,12 +1993,20 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
1993
1993
  };
1994
1994
  }),
1995
1995
  /**
1996
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
1996
+ * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
1997
1997
  * @summary Get Query Insights
1998
1998
  * @param {string} xStoreID Store ID
1999
1999
  * @param {string} query Search query to analyze
2000
2000
  * @param {string} [startTime] Start time in RFC3339 format
2001
2001
  * @param {string} [endTime] End time in RFC3339 format
2002
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
2003
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
2004
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
2005
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
2006
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
2007
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
2008
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
2009
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
2002
2010
  * @param {number} [resultsPage] Page number for popular results pagination
2003
2011
  * @param {number} [resultsPageSize] Number of results per page for popular results
2004
2012
  * @param {number} [filtersPage] Page number for popular filters pagination
@@ -2007,7 +2015,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
2007
2015
  * @param {*} [options] Override http request option.
2008
2016
  * @throws {RequiredError}
2009
2017
  */
2010
- adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID_1, query_1, startTime_1, endTime_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, startTime_1, endTime_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1], void 0, function* (xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options = {}) {
2018
+ adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1) => __awaiter(this, [xStoreID_1, query_1, startTime_1, endTime_1, compareMode_1, compareStartTime_1, compareEndTime_1, compareAnalyticsTags_1, compareTagsMatchMode_1, compareTagsExclude_1, compareTagKeyFilter_1, compareTagValueFilter_1, resultsPage_1, resultsPageSize_1, filtersPage_1, filtersPageSize_1, includeWidget_1, ...args_1], void 0, function* (xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options = {}) {
2011
2019
  // verify required parameter 'xStoreID' is not null or undefined
2012
2020
  assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID);
2013
2021
  // verify required parameter 'query' is not null or undefined
@@ -2032,6 +2040,30 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
2032
2040
  if (endTime !== undefined) {
2033
2041
  localVarQueryParameter['end_time'] = endTime;
2034
2042
  }
2043
+ if (compareMode !== undefined) {
2044
+ localVarQueryParameter['compare_mode'] = compareMode;
2045
+ }
2046
+ if (compareStartTime !== undefined) {
2047
+ localVarQueryParameter['compare_start_time'] = compareStartTime;
2048
+ }
2049
+ if (compareEndTime !== undefined) {
2050
+ localVarQueryParameter['compare_end_time'] = compareEndTime;
2051
+ }
2052
+ if (compareAnalyticsTags !== undefined) {
2053
+ localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
2054
+ }
2055
+ if (compareTagsMatchMode !== undefined) {
2056
+ localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
2057
+ }
2058
+ if (compareTagsExclude !== undefined) {
2059
+ localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
2060
+ }
2061
+ if (compareTagKeyFilter !== undefined) {
2062
+ localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
2063
+ }
2064
+ if (compareTagValueFilter !== undefined) {
2065
+ localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
2066
+ }
2035
2067
  if (resultsPage !== undefined) {
2036
2068
  localVarQueryParameter['results_page'] = resultsPage;
2037
2069
  }
@@ -2713,12 +2745,20 @@ export const AnalyticsApiFp = function (configuration) {
2713
2745
  });
2714
2746
  },
2715
2747
  /**
2716
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
2748
+ * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
2717
2749
  * @summary Get Query Insights
2718
2750
  * @param {string} xStoreID Store ID
2719
2751
  * @param {string} query Search query to analyze
2720
2752
  * @param {string} [startTime] Start time in RFC3339 format
2721
2753
  * @param {string} [endTime] End time in RFC3339 format
2754
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
2755
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
2756
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
2757
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
2758
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
2759
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
2760
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
2761
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
2722
2762
  * @param {number} [resultsPage] Page number for popular results pagination
2723
2763
  * @param {number} [resultsPageSize] Number of results per page for popular results
2724
2764
  * @param {number} [filtersPage] Page number for popular filters pagination
@@ -2727,10 +2767,10 @@ export const AnalyticsApiFp = function (configuration) {
2727
2767
  * @param {*} [options] Override http request option.
2728
2768
  * @throws {RequiredError}
2729
2769
  */
2730
- adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
2770
+ adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
2731
2771
  return __awaiter(this, void 0, void 0, function* () {
2732
2772
  var _a, _b, _c;
2733
- const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
2773
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
2734
2774
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
2735
2775
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
2736
2776
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -3131,12 +3171,20 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
3131
3171
  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));
3132
3172
  },
3133
3173
  /**
3134
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
3174
+ * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
3135
3175
  * @summary Get Query Insights
3136
3176
  * @param {string} xStoreID Store ID
3137
3177
  * @param {string} query Search query to analyze
3138
3178
  * @param {string} [startTime] Start time in RFC3339 format
3139
3179
  * @param {string} [endTime] End time in RFC3339 format
3180
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
3181
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
3182
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
3183
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
3184
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
3185
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
3186
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
3187
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
3140
3188
  * @param {number} [resultsPage] Page number for popular results pagination
3141
3189
  * @param {number} [resultsPageSize] Number of results per page for popular results
3142
3190
  * @param {number} [filtersPage] Page number for popular filters pagination
@@ -3145,8 +3193,8 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
3145
3193
  * @param {*} [options] Override http request option.
3146
3194
  * @throws {RequiredError}
3147
3195
  */
3148
- adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
3149
- return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(axios, basePath));
3196
+ adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
3197
+ return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(axios, basePath));
3150
3198
  },
3151
3199
  /**
3152
3200
  * 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.
@@ -3538,12 +3586,20 @@ export class AnalyticsApi extends BaseAPI {
3538
3586
  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));
3539
3587
  }
3540
3588
  /**
3541
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
3589
+ * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
3542
3590
  * @summary Get Query Insights
3543
3591
  * @param {string} xStoreID Store ID
3544
3592
  * @param {string} query Search query to analyze
3545
3593
  * @param {string} [startTime] Start time in RFC3339 format
3546
3594
  * @param {string} [endTime] End time in RFC3339 format
3595
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
3596
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
3597
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
3598
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
3599
+ * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
3600
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
3601
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
3602
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
3547
3603
  * @param {number} [resultsPage] Page number for popular results pagination
3548
3604
  * @param {number} [resultsPageSize] Number of results per page for popular results
3549
3605
  * @param {number} [filtersPage] Page number for popular filters pagination
@@ -3553,8 +3609,8 @@ export class AnalyticsApi extends BaseAPI {
3553
3609
  * @throws {RequiredError}
3554
3610
  * @memberof AnalyticsApi
3555
3611
  */
3556
- adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
3557
- return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
3612
+ adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options) {
3613
+ return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
3558
3614
  }
3559
3615
  /**
3560
3616
  * 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.
@@ -3896,6 +3952,13 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
3896
3952
  Asc: 'asc',
3897
3953
  Desc: 'desc'
3898
3954
  };
3955
+ /**
3956
+ * @export
3957
+ */
3958
+ export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = {
3959
+ Any: 'any',
3960
+ All: 'all'
3961
+ };
3899
3962
  /**
3900
3963
  * @export
3901
3964
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seekora-ai/admin-api",
3
- "version": "1.0.48",
3
+ "version": "1.0.49",
4
4
  "description": "OpenAPI client for @seekora-ai/admin-api",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
Binary file
Binary file