@seekora-ai/admin-api 1.0.64 → 1.0.65
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 +2 -2
- package/api.ts +242 -56
- package/dist/api.d.ts +159 -41
- package/dist/api.js +173 -47
- package/dist/esm/api.d.ts +159 -41
- package/dist/esm/api.js +169 -43
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.65.tgz +0 -0
- package/seekora-ai-admin-api-1.0.64.tgz +0 -0
package/dist/api.d.ts
CHANGED
|
@@ -7662,12 +7662,24 @@ export interface BillingServicePaymentTransactionSummary {
|
|
|
7662
7662
|
* @memberof BillingServicePaymentTransactionSummary
|
|
7663
7663
|
*/
|
|
7664
7664
|
'gateway'?: BillingServiceNullableString;
|
|
7665
|
+
/**
|
|
7666
|
+
* Gateway order identifier
|
|
7667
|
+
* @type {BillingServiceNullableString}
|
|
7668
|
+
* @memberof BillingServicePaymentTransactionSummary
|
|
7669
|
+
*/
|
|
7670
|
+
'gateway_order_id'?: BillingServiceNullableString;
|
|
7665
7671
|
/**
|
|
7666
7672
|
*
|
|
7667
7673
|
* @type {BillingServiceNullableString}
|
|
7668
7674
|
* @memberof BillingServicePaymentTransactionSummary
|
|
7669
7675
|
*/
|
|
7670
7676
|
'gateway_payment_id'?: BillingServiceNullableString;
|
|
7677
|
+
/**
|
|
7678
|
+
* Database primary key
|
|
7679
|
+
* @type {BillingServiceNullableInt64}
|
|
7680
|
+
* @memberof BillingServicePaymentTransactionSummary
|
|
7681
|
+
*/
|
|
7682
|
+
'order_id'?: BillingServiceNullableInt64;
|
|
7671
7683
|
/**
|
|
7672
7684
|
*
|
|
7673
7685
|
* @type {number}
|
|
@@ -7687,7 +7699,7 @@ export interface BillingServicePaymentTransactionSummary {
|
|
|
7687
7699
|
*/
|
|
7688
7700
|
'payment_date'?: string;
|
|
7689
7701
|
/**
|
|
7690
|
-
*
|
|
7702
|
+
* Database primary key
|
|
7691
7703
|
* @type {number}
|
|
7692
7704
|
* @memberof BillingServicePaymentTransactionSummary
|
|
7693
7705
|
*/
|
|
@@ -7716,6 +7728,12 @@ export interface BillingServicePaymentTransactionSummary {
|
|
|
7716
7728
|
* @memberof BillingServicePaymentTransactionSummary
|
|
7717
7729
|
*/
|
|
7718
7730
|
'refund_status'?: BillingServiceNullableString;
|
|
7731
|
+
/**
|
|
7732
|
+
* Actual payment identifier
|
|
7733
|
+
* @type {string}
|
|
7734
|
+
* @memberof BillingServicePaymentTransactionSummary
|
|
7735
|
+
*/
|
|
7736
|
+
'transaction_id'?: string;
|
|
7719
7737
|
}
|
|
7720
7738
|
/**
|
|
7721
7739
|
*
|
|
@@ -8933,6 +8951,12 @@ export interface DataTypesCreateRefundRequestDto {
|
|
|
8933
8951
|
* @memberof DataTypesCreateRefundRequestDto
|
|
8934
8952
|
*/
|
|
8935
8953
|
'auto_approve_after'?: string;
|
|
8954
|
+
/**
|
|
8955
|
+
*
|
|
8956
|
+
* @type {string}
|
|
8957
|
+
* @memberof DataTypesCreateRefundRequestDto
|
|
8958
|
+
*/
|
|
8959
|
+
'currency': string;
|
|
8936
8960
|
/**
|
|
8937
8961
|
*
|
|
8938
8962
|
* @type {string}
|
|
@@ -8948,13 +8972,13 @@ export interface DataTypesCreateRefundRequestDto {
|
|
|
8948
8972
|
[key: string]: any;
|
|
8949
8973
|
};
|
|
8950
8974
|
/**
|
|
8951
|
-
*
|
|
8952
|
-
* @type {
|
|
8975
|
+
* Gateway order ID (e.g., \"order_RMeeXimPIbrYqH\")
|
|
8976
|
+
* @type {string}
|
|
8953
8977
|
* @memberof DataTypesCreateRefundRequestDto
|
|
8954
8978
|
*/
|
|
8955
|
-
'order_id':
|
|
8979
|
+
'order_id': string;
|
|
8956
8980
|
/**
|
|
8957
|
-
*
|
|
8981
|
+
* Gateway payment ID (e.g., \"pay_RMeeuvyPSbZp2Y\")
|
|
8958
8982
|
* @type {string}
|
|
8959
8983
|
* @memberof DataTypesCreateRefundRequestDto
|
|
8960
8984
|
*/
|
|
@@ -14504,17 +14528,23 @@ export interface DataTypesRefundRequestResponseDto {
|
|
|
14504
14528
|
*/
|
|
14505
14529
|
'expires_at'?: string;
|
|
14506
14530
|
/**
|
|
14507
|
-
*
|
|
14508
|
-
* @type {
|
|
14531
|
+
* Gateway order ID
|
|
14532
|
+
* @type {string}
|
|
14509
14533
|
* @memberof DataTypesRefundRequestResponseDto
|
|
14510
14534
|
*/
|
|
14511
|
-
'order_id'?:
|
|
14535
|
+
'order_id'?: string;
|
|
14512
14536
|
/**
|
|
14513
|
-
*
|
|
14537
|
+
* Gateway payment ID
|
|
14514
14538
|
* @type {string}
|
|
14515
14539
|
* @memberof DataTypesRefundRequestResponseDto
|
|
14516
14540
|
*/
|
|
14517
14541
|
'payment_id'?: string;
|
|
14542
|
+
/**
|
|
14543
|
+
* UUID for external reference
|
|
14544
|
+
* @type {string}
|
|
14545
|
+
* @memberof DataTypesRefundRequestResponseDto
|
|
14546
|
+
*/
|
|
14547
|
+
'refund_id'?: string;
|
|
14518
14548
|
/**
|
|
14519
14549
|
*
|
|
14520
14550
|
* @type {number}
|
|
@@ -14627,6 +14657,12 @@ export interface DataTypesRefundStatusDto {
|
|
|
14627
14657
|
* @memberof DataTypesRefundStatusDto
|
|
14628
14658
|
*/
|
|
14629
14659
|
'credit_adjustments'?: Array<DataTypesCreditAdjustmentDto>;
|
|
14660
|
+
/**
|
|
14661
|
+
*
|
|
14662
|
+
* @type {string}
|
|
14663
|
+
* @memberof DataTypesRefundStatusDto
|
|
14664
|
+
*/
|
|
14665
|
+
'currency'?: string;
|
|
14630
14666
|
/**
|
|
14631
14667
|
* Processing information
|
|
14632
14668
|
* @type {string}
|
|
@@ -14657,6 +14693,12 @@ export interface DataTypesRefundStatusDto {
|
|
|
14657
14693
|
* @memberof DataTypesRefundStatusDto
|
|
14658
14694
|
*/
|
|
14659
14695
|
'reason'?: string;
|
|
14696
|
+
/**
|
|
14697
|
+
* UUID for external reference
|
|
14698
|
+
* @type {string}
|
|
14699
|
+
* @memberof DataTypesRefundStatusDto
|
|
14700
|
+
*/
|
|
14701
|
+
'refund_id'?: string;
|
|
14660
14702
|
/**
|
|
14661
14703
|
*
|
|
14662
14704
|
* @type {number}
|
|
@@ -18211,6 +18253,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
18211
18253
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
18212
18254
|
* @param {string} [endTime] End time in RFC3339 format
|
|
18213
18255
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum} [granularity] Time granularity
|
|
18256
|
+
* @param {string} [search] Search term to filter geographic locations (case-insensitive partial match on country, region, city)
|
|
18214
18257
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
18215
18258
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
18216
18259
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
@@ -18234,7 +18277,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
18234
18277
|
* @param {*} [options] Override http request option.
|
|
18235
18278
|
* @throws {RequiredError}
|
|
18236
18279
|
*/
|
|
18237
|
-
adminAnalyticsStoreXStoreIDGeoGet: (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18280
|
+
adminAnalyticsStoreXStoreIDGeoGet: (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18238
18281
|
/**
|
|
18239
18282
|
* Retrieve comprehensive analytics insights for a specific geographic location including all core metrics (Total Searches, Total Clicks, CTR, Conversions, CVR, Revenue), popular queries with performance metrics, top results by region with average rankings, popular filters used per region with performance impact, and totals & rates with optional comparison mode and internal pagination for each subsection
|
|
18240
18283
|
* @summary Get Geographic Insights
|
|
@@ -18259,14 +18302,17 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
18259
18302
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
18260
18303
|
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
18261
18304
|
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
18305
|
+
* @param {string} [geoQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
18262
18306
|
* @param {number} [resultsPage] Page number for top results pagination
|
|
18263
18307
|
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
18308
|
+
* @param {string} [geoResultsSearch] Search term to filter top results (case-insensitive partial match on item IDs)
|
|
18264
18309
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
18265
18310
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
18311
|
+
* @param {string} [geoFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
18266
18312
|
* @param {*} [options] Override http request option.
|
|
18267
18313
|
* @throws {RequiredError}
|
|
18268
18314
|
*/
|
|
18269
|
-
adminAnalyticsStoreXStoreIDGeoInsightsGet: (xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18315
|
+
adminAnalyticsStoreXStoreIDGeoInsightsGet: (xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, geoQueriesSearch?: string, resultsPage?: number, resultsPageSize?: number, geoResultsSearch?: string, filtersPage?: number, filtersPageSize?: number, geoFiltersSearch?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18270
18316
|
/**
|
|
18271
18317
|
* Check the health status of analytics service and ClickHouse connection
|
|
18272
18318
|
* @summary Analytics Health Check
|
|
@@ -18413,6 +18459,12 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
18413
18459
|
* @param {string} query Search query to analyze
|
|
18414
18460
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
18415
18461
|
* @param {string} [endTime] End time in RFC3339 format
|
|
18462
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
18463
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
18464
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
18465
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
18466
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
18467
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
18416
18468
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
18417
18469
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
18418
18470
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -18423,15 +18475,18 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
18423
18475
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
18424
18476
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
18425
18477
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
18478
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
18426
18479
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
18427
18480
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
18481
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
18428
18482
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
18429
18483
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
18484
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
18430
18485
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
18431
18486
|
* @param {*} [options] Override http request option.
|
|
18432
18487
|
* @throws {RequiredError}
|
|
18433
18488
|
*/
|
|
18434
|
-
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, geoPage?: number, geoPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18489
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18435
18490
|
/**
|
|
18436
18491
|
* 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.
|
|
18437
18492
|
* @summary Get Top Results Analytics
|
|
@@ -18610,6 +18665,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
18610
18665
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
18611
18666
|
* @param {string} [endTime] End time in RFC3339 format
|
|
18612
18667
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum} [granularity] Time granularity
|
|
18668
|
+
* @param {string} [search] Search term to filter geographic locations (case-insensitive partial match on country, region, city)
|
|
18613
18669
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
18614
18670
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
18615
18671
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
@@ -18633,7 +18689,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
18633
18689
|
* @param {*} [options] Override http request option.
|
|
18634
18690
|
* @throws {RequiredError}
|
|
18635
18691
|
*/
|
|
18636
|
-
adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDGeoGet200Response>>;
|
|
18692
|
+
adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDGeoGet200Response>>;
|
|
18637
18693
|
/**
|
|
18638
18694
|
* Retrieve comprehensive analytics insights for a specific geographic location including all core metrics (Total Searches, Total Clicks, CTR, Conversions, CVR, Revenue), popular queries with performance metrics, top results by region with average rankings, popular filters used per region with performance impact, and totals & rates with optional comparison mode and internal pagination for each subsection
|
|
18639
18695
|
* @summary Get Geographic Insights
|
|
@@ -18658,14 +18714,17 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
18658
18714
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
18659
18715
|
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
18660
18716
|
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
18717
|
+
* @param {string} [geoQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
18661
18718
|
* @param {number} [resultsPage] Page number for top results pagination
|
|
18662
18719
|
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
18720
|
+
* @param {string} [geoResultsSearch] Search term to filter top results (case-insensitive partial match on item IDs)
|
|
18663
18721
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
18664
18722
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
18723
|
+
* @param {string} [geoFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
18665
18724
|
* @param {*} [options] Override http request option.
|
|
18666
18725
|
* @throws {RequiredError}
|
|
18667
18726
|
*/
|
|
18668
|
-
adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDGeoInsightsGet200Response>>;
|
|
18727
|
+
adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, geoQueriesSearch?: string, resultsPage?: number, resultsPageSize?: number, geoResultsSearch?: string, filtersPage?: number, filtersPageSize?: number, geoFiltersSearch?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDGeoInsightsGet200Response>>;
|
|
18669
18728
|
/**
|
|
18670
18729
|
* Check the health status of analytics service and ClickHouse connection
|
|
18671
18730
|
* @summary Analytics Health Check
|
|
@@ -18812,6 +18871,12 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
18812
18871
|
* @param {string} query Search query to analyze
|
|
18813
18872
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
18814
18873
|
* @param {string} [endTime] End time in RFC3339 format
|
|
18874
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
18875
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
18876
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
18877
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
18878
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
18879
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
18815
18880
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
18816
18881
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
18817
18882
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -18822,15 +18887,18 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
18822
18887
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
18823
18888
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
18824
18889
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
18890
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
18825
18891
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
18826
18892
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
18893
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
18827
18894
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
18828
18895
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
18896
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
18829
18897
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
18830
18898
|
* @param {*} [options] Override http request option.
|
|
18831
18899
|
* @throws {RequiredError}
|
|
18832
18900
|
*/
|
|
18833
|
-
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, geoPage?: number, geoPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>>;
|
|
18901
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>>;
|
|
18834
18902
|
/**
|
|
18835
18903
|
* 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.
|
|
18836
18904
|
* @summary Get Top Results Analytics
|
|
@@ -19009,6 +19077,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
19009
19077
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
19010
19078
|
* @param {string} [endTime] End time in RFC3339 format
|
|
19011
19079
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum} [granularity] Time granularity
|
|
19080
|
+
* @param {string} [search] Search term to filter geographic locations (case-insensitive partial match on country, region, city)
|
|
19012
19081
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
19013
19082
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
19014
19083
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
@@ -19032,7 +19101,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
19032
19101
|
* @param {*} [options] Override http request option.
|
|
19033
19102
|
* @throws {RequiredError}
|
|
19034
19103
|
*/
|
|
19035
|
-
adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDGeoGet200Response>;
|
|
19104
|
+
adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDGeoGet200Response>;
|
|
19036
19105
|
/**
|
|
19037
19106
|
* Retrieve comprehensive analytics insights for a specific geographic location including all core metrics (Total Searches, Total Clicks, CTR, Conversions, CVR, Revenue), popular queries with performance metrics, top results by region with average rankings, popular filters used per region with performance impact, and totals & rates with optional comparison mode and internal pagination for each subsection
|
|
19038
19107
|
* @summary Get Geographic Insights
|
|
@@ -19057,14 +19126,17 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
19057
19126
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
19058
19127
|
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
19059
19128
|
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
19129
|
+
* @param {string} [geoQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
19060
19130
|
* @param {number} [resultsPage] Page number for top results pagination
|
|
19061
19131
|
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
19132
|
+
* @param {string} [geoResultsSearch] Search term to filter top results (case-insensitive partial match on item IDs)
|
|
19062
19133
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
19063
19134
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
19135
|
+
* @param {string} [geoFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
19064
19136
|
* @param {*} [options] Override http request option.
|
|
19065
19137
|
* @throws {RequiredError}
|
|
19066
19138
|
*/
|
|
19067
|
-
adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDGeoInsightsGet200Response>;
|
|
19139
|
+
adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, geoQueriesSearch?: string, resultsPage?: number, resultsPageSize?: number, geoResultsSearch?: string, filtersPage?: number, filtersPageSize?: number, geoFiltersSearch?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDGeoInsightsGet200Response>;
|
|
19068
19140
|
/**
|
|
19069
19141
|
* Check the health status of analytics service and ClickHouse connection
|
|
19070
19142
|
* @summary Analytics Health Check
|
|
@@ -19211,6 +19283,12 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
19211
19283
|
* @param {string} query Search query to analyze
|
|
19212
19284
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
19213
19285
|
* @param {string} [endTime] End time in RFC3339 format
|
|
19286
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
19287
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
19288
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
19289
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
19290
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
19291
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
19214
19292
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
19215
19293
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
19216
19294
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -19221,15 +19299,18 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
19221
19299
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
19222
19300
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
19223
19301
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
19302
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
19224
19303
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
19225
19304
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
19305
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
19226
19306
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
19227
19307
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
19308
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
19228
19309
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
19229
19310
|
* @param {*} [options] Override http request option.
|
|
19230
19311
|
* @throws {RequiredError}
|
|
19231
19312
|
*/
|
|
19232
|
-
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, geoPage?: number, geoPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>;
|
|
19313
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>;
|
|
19233
19314
|
/**
|
|
19234
19315
|
* 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.
|
|
19235
19316
|
* @summary Get Top Results Analytics
|
|
@@ -19416,6 +19497,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
19416
19497
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
19417
19498
|
* @param {string} [endTime] End time in RFC3339 format
|
|
19418
19499
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum} [granularity] Time granularity
|
|
19500
|
+
* @param {string} [search] Search term to filter geographic locations (case-insensitive partial match on country, region, city)
|
|
19419
19501
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
19420
19502
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
19421
19503
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
@@ -19440,7 +19522,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
19440
19522
|
* @throws {RequiredError}
|
|
19441
19523
|
* @memberof AnalyticsApi
|
|
19442
19524
|
*/
|
|
19443
|
-
adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDGeoGet200Response, any, {}>>;
|
|
19525
|
+
adminAnalyticsStoreXStoreIDGeoGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDGeoGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDGeoGet200Response, any, {}>>;
|
|
19444
19526
|
/**
|
|
19445
19527
|
* Retrieve comprehensive analytics insights for a specific geographic location including all core metrics (Total Searches, Total Clicks, CTR, Conversions, CVR, Revenue), popular queries with performance metrics, top results by region with average rankings, popular filters used per region with performance impact, and totals & rates with optional comparison mode and internal pagination for each subsection
|
|
19446
19528
|
* @summary Get Geographic Insights
|
|
@@ -19465,15 +19547,18 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
19465
19547
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
19466
19548
|
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
19467
19549
|
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
19550
|
+
* @param {string} [geoQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
19468
19551
|
* @param {number} [resultsPage] Page number for top results pagination
|
|
19469
19552
|
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
19553
|
+
* @param {string} [geoResultsSearch] Search term to filter top results (case-insensitive partial match on item IDs)
|
|
19470
19554
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
19471
19555
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
19556
|
+
* @param {string} [geoFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
19472
19557
|
* @param {*} [options] Override http request option.
|
|
19473
19558
|
* @throws {RequiredError}
|
|
19474
19559
|
* @memberof AnalyticsApi
|
|
19475
19560
|
*/
|
|
19476
|
-
adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDGeoInsightsGet200Response, any, {}>>;
|
|
19561
|
+
adminAnalyticsStoreXStoreIDGeoInsightsGet(xStoreID: string, country?: string, region?: string, city?: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, queriesPage?: number, queriesPageSize?: number, geoQueriesSearch?: string, resultsPage?: number, resultsPageSize?: number, geoResultsSearch?: string, filtersPage?: number, filtersPageSize?: number, geoFiltersSearch?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDGeoInsightsGet200Response, any, {}>>;
|
|
19477
19562
|
/**
|
|
19478
19563
|
* Check the health status of analytics service and ClickHouse connection
|
|
19479
19564
|
* @summary Analytics Health Check
|
|
@@ -19626,6 +19711,12 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
19626
19711
|
* @param {string} query Search query to analyze
|
|
19627
19712
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
19628
19713
|
* @param {string} [endTime] End time in RFC3339 format
|
|
19714
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
19715
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
19716
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
19717
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
19718
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
19719
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
19629
19720
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
19630
19721
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
19631
19722
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -19636,16 +19727,19 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
19636
19727
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
19637
19728
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
19638
19729
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
19730
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
19639
19731
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
19640
19732
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
19733
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
19641
19734
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
19642
19735
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
19736
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
19643
19737
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
19644
19738
|
* @param {*} [options] Override http request option.
|
|
19645
19739
|
* @throws {RequiredError}
|
|
19646
19740
|
* @memberof AnalyticsApi
|
|
19647
19741
|
*/
|
|
19648
|
-
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, geoPage?: number, geoPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any, {}>>;
|
|
19742
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any, {}>>;
|
|
19649
19743
|
/**
|
|
19650
19744
|
* 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.
|
|
19651
19745
|
* @summary Get Top Results Analytics
|
|
@@ -20027,6 +20121,14 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum
|
|
|
20027
20121
|
readonly Desc: "desc";
|
|
20028
20122
|
};
|
|
20029
20123
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
20124
|
+
/**
|
|
20125
|
+
* @export
|
|
20126
|
+
*/
|
|
20127
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum: {
|
|
20128
|
+
readonly Any: "any";
|
|
20129
|
+
readonly All: "all";
|
|
20130
|
+
};
|
|
20131
|
+
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum];
|
|
20030
20132
|
/**
|
|
20031
20133
|
* @export
|
|
20032
20134
|
*/
|
|
@@ -22165,6 +22267,7 @@ export declare const ItemAnalyticsApiAxiosParamCreator: (configuration?: Configu
|
|
|
22165
22267
|
* @param {string} xStoreID Store ID
|
|
22166
22268
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
22167
22269
|
* @param {string} [endTime] End time in RFC3339 format
|
|
22270
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
22168
22271
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
22169
22272
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
22170
22273
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -22179,7 +22282,7 @@ export declare const ItemAnalyticsApiAxiosParamCreator: (configuration?: Configu
|
|
|
22179
22282
|
* @param {*} [options] Override http request option.
|
|
22180
22283
|
* @throws {RequiredError}
|
|
22181
22284
|
*/
|
|
22182
|
-
adminAnalyticsStoreXStoreIDItemsGet: (xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22285
|
+
adminAnalyticsStoreXStoreIDItemsGet: (xStoreID: string, startTime?: string, endTime?: string, search?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22183
22286
|
/**
|
|
22184
22287
|
* Retrieve detailed analytics for a specific item including performance metrics and discovery data
|
|
22185
22288
|
* @summary Get Item Details
|
|
@@ -22213,15 +22316,18 @@ export declare const ItemAnalyticsApiAxiosParamCreator: (configuration?: Configu
|
|
|
22213
22316
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22214
22317
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
22215
22318
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
22319
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
22216
22320
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22217
22321
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
22322
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22218
22323
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22219
22324
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22325
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22220
22326
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
22221
22327
|
* @param {*} [options] Override http request option.
|
|
22222
22328
|
* @throws {RequiredError}
|
|
22223
22329
|
*/
|
|
22224
|
-
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet: (xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22330
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet: (xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, itemQueriesSearch?: string, filtersPage?: number, filtersPageSize?: number, itemFiltersSearch?: string, geoPage?: number, geoPageSize?: number, itemGeoSearch?: string, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22225
22331
|
/**
|
|
22226
22332
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
22227
22333
|
* @summary Get Item Performance Analytics
|
|
@@ -22328,6 +22434,7 @@ export declare const ItemAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
22328
22434
|
* @param {string} xStoreID Store ID
|
|
22329
22435
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
22330
22436
|
* @param {string} [endTime] End time in RFC3339 format
|
|
22437
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
22331
22438
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
22332
22439
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
22333
22440
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -22342,7 +22449,7 @@ export declare const ItemAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
22342
22449
|
* @param {*} [options] Override http request option.
|
|
22343
22450
|
* @throws {RequiredError}
|
|
22344
22451
|
*/
|
|
22345
|
-
adminAnalyticsStoreXStoreIDItemsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>>;
|
|
22452
|
+
adminAnalyticsStoreXStoreIDItemsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>>;
|
|
22346
22453
|
/**
|
|
22347
22454
|
* Retrieve detailed analytics for a specific item including performance metrics and discovery data
|
|
22348
22455
|
* @summary Get Item Details
|
|
@@ -22376,15 +22483,18 @@ export declare const ItemAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
22376
22483
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22377
22484
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
22378
22485
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
22486
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
22379
22487
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22380
22488
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
22489
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22381
22490
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22382
22491
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22492
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22383
22493
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
22384
22494
|
* @param {*} [options] Override http request option.
|
|
22385
22495
|
* @throws {RequiredError}
|
|
22386
22496
|
*/
|
|
22387
|
-
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response>>;
|
|
22497
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, itemQueriesSearch?: string, filtersPage?: number, filtersPageSize?: number, itemFiltersSearch?: string, geoPage?: number, geoPageSize?: number, itemGeoSearch?: string, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response>>;
|
|
22388
22498
|
/**
|
|
22389
22499
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
22390
22500
|
* @summary Get Item Performance Analytics
|
|
@@ -22491,6 +22601,7 @@ export declare const ItemAnalyticsApiFactory: (configuration?: Configuration, ba
|
|
|
22491
22601
|
* @param {string} xStoreID Store ID
|
|
22492
22602
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
22493
22603
|
* @param {string} [endTime] End time in RFC3339 format
|
|
22604
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
22494
22605
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
22495
22606
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
22496
22607
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -22505,7 +22616,7 @@ export declare const ItemAnalyticsApiFactory: (configuration?: Configuration, ba
|
|
|
22505
22616
|
* @param {*} [options] Override http request option.
|
|
22506
22617
|
* @throws {RequiredError}
|
|
22507
22618
|
*/
|
|
22508
|
-
adminAnalyticsStoreXStoreIDItemsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse>;
|
|
22619
|
+
adminAnalyticsStoreXStoreIDItemsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse>;
|
|
22509
22620
|
/**
|
|
22510
22621
|
* Retrieve detailed analytics for a specific item including performance metrics and discovery data
|
|
22511
22622
|
* @summary Get Item Details
|
|
@@ -22539,15 +22650,18 @@ export declare const ItemAnalyticsApiFactory: (configuration?: Configuration, ba
|
|
|
22539
22650
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22540
22651
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
22541
22652
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
22653
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
22542
22654
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22543
22655
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
22656
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22544
22657
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22545
22658
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22659
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22546
22660
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
22547
22661
|
* @param {*} [options] Override http request option.
|
|
22548
22662
|
* @throws {RequiredError}
|
|
22549
22663
|
*/
|
|
22550
|
-
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response>;
|
|
22664
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, itemQueriesSearch?: string, filtersPage?: number, filtersPageSize?: number, itemFiltersSearch?: string, geoPage?: number, geoPageSize?: number, itemGeoSearch?: string, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response>;
|
|
22551
22665
|
/**
|
|
22552
22666
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
22553
22667
|
* @summary Get Item Performance Analytics
|
|
@@ -22658,6 +22772,7 @@ export declare class ItemAnalyticsApi extends BaseAPI {
|
|
|
22658
22772
|
* @param {string} xStoreID Store ID
|
|
22659
22773
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
22660
22774
|
* @param {string} [endTime] End time in RFC3339 format
|
|
22775
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
22661
22776
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
22662
22777
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
22663
22778
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -22673,7 +22788,7 @@ export declare class ItemAnalyticsApi extends BaseAPI {
|
|
|
22673
22788
|
* @throws {RequiredError}
|
|
22674
22789
|
* @memberof ItemAnalyticsApi
|
|
22675
22790
|
*/
|
|
22676
|
-
adminAnalyticsStoreXStoreIDItemsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsAnalyticsAPIResponse, any, {}>>;
|
|
22791
|
+
adminAnalyticsStoreXStoreIDItemsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsAnalyticsAPIResponse, any, {}>>;
|
|
22677
22792
|
/**
|
|
22678
22793
|
* Retrieve detailed analytics for a specific item including performance metrics and discovery data
|
|
22679
22794
|
* @summary Get Item Details
|
|
@@ -22708,16 +22823,19 @@ export declare class ItemAnalyticsApi extends BaseAPI {
|
|
|
22708
22823
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22709
22824
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
22710
22825
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
22826
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
22711
22827
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22712
22828
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
22829
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22713
22830
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22714
22831
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22832
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22715
22833
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
22716
22834
|
* @param {*} [options] Override http request option.
|
|
22717
22835
|
* @throws {RequiredError}
|
|
22718
22836
|
* @memberof ItemAnalyticsApi
|
|
22719
22837
|
*/
|
|
22720
|
-
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, geoPage?: number, geoPageSize?: number, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response, any, {}>>;
|
|
22838
|
+
adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, itemQueriesSearch?: string, filtersPage?: number, filtersPageSize?: number, itemFiltersSearch?: string, geoPage?: number, geoPageSize?: number, itemGeoSearch?: string, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response, any, {}>>;
|
|
22721
22839
|
/**
|
|
22722
22840
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
22723
22841
|
* @summary Get Item Performance Analytics
|
|
@@ -27314,13 +27432,13 @@ export declare const RefundManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
27314
27432
|
*/
|
|
27315
27433
|
paymentGatewayRefundRequestPost: (dataTypesCreateRefundRequestDto: DataTypesCreateRefundRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
27316
27434
|
/**
|
|
27317
|
-
* Gets the current status and details of a refund request
|
|
27435
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
27318
27436
|
* @summary Get refund request status
|
|
27319
|
-
* @param {
|
|
27437
|
+
* @param {string} id Refund ID (UUID)
|
|
27320
27438
|
* @param {*} [options] Override http request option.
|
|
27321
27439
|
* @throws {RequiredError}
|
|
27322
27440
|
*/
|
|
27323
|
-
paymentGatewayRefundStatusIdGet: (id:
|
|
27441
|
+
paymentGatewayRefundStatusIdGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
27324
27442
|
/**
|
|
27325
27443
|
* Gets a paginated list of refund requests with filtering
|
|
27326
27444
|
* @summary List refund requests
|
|
@@ -27368,13 +27486,13 @@ export declare const RefundManagementApiFp: (configuration?: Configuration) => {
|
|
|
27368
27486
|
*/
|
|
27369
27487
|
paymentGatewayRefundRequestPost(dataTypesCreateRefundRequestDto: DataTypesCreateRefundRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRefundRequestResponseDto>>;
|
|
27370
27488
|
/**
|
|
27371
|
-
* Gets the current status and details of a refund request
|
|
27489
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
27372
27490
|
* @summary Get refund request status
|
|
27373
|
-
* @param {
|
|
27491
|
+
* @param {string} id Refund ID (UUID)
|
|
27374
27492
|
* @param {*} [options] Override http request option.
|
|
27375
27493
|
* @throws {RequiredError}
|
|
27376
27494
|
*/
|
|
27377
|
-
paymentGatewayRefundStatusIdGet(id:
|
|
27495
|
+
paymentGatewayRefundStatusIdGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRefundStatusDto>>;
|
|
27378
27496
|
/**
|
|
27379
27497
|
* Gets a paginated list of refund requests with filtering
|
|
27380
27498
|
* @summary List refund requests
|
|
@@ -27422,13 +27540,13 @@ export declare const RefundManagementApiFactory: (configuration?: Configuration,
|
|
|
27422
27540
|
*/
|
|
27423
27541
|
paymentGatewayRefundRequestPost(dataTypesCreateRefundRequestDto: DataTypesCreateRefundRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRefundRequestResponseDto>;
|
|
27424
27542
|
/**
|
|
27425
|
-
* Gets the current status and details of a refund request
|
|
27543
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
27426
27544
|
* @summary Get refund request status
|
|
27427
|
-
* @param {
|
|
27545
|
+
* @param {string} id Refund ID (UUID)
|
|
27428
27546
|
* @param {*} [options] Override http request option.
|
|
27429
27547
|
* @throws {RequiredError}
|
|
27430
27548
|
*/
|
|
27431
|
-
paymentGatewayRefundStatusIdGet(id:
|
|
27549
|
+
paymentGatewayRefundStatusIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRefundStatusDto>;
|
|
27432
27550
|
/**
|
|
27433
27551
|
* Gets a paginated list of refund requests with filtering
|
|
27434
27552
|
* @summary List refund requests
|
|
@@ -27481,14 +27599,14 @@ export declare class RefundManagementApi extends BaseAPI {
|
|
|
27481
27599
|
*/
|
|
27482
27600
|
paymentGatewayRefundRequestPost(dataTypesCreateRefundRequestDto: DataTypesCreateRefundRequestDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesRefundRequestResponseDto, any, {}>>;
|
|
27483
27601
|
/**
|
|
27484
|
-
* Gets the current status and details of a refund request
|
|
27602
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
27485
27603
|
* @summary Get refund request status
|
|
27486
|
-
* @param {
|
|
27604
|
+
* @param {string} id Refund ID (UUID)
|
|
27487
27605
|
* @param {*} [options] Override http request option.
|
|
27488
27606
|
* @throws {RequiredError}
|
|
27489
27607
|
* @memberof RefundManagementApi
|
|
27490
27608
|
*/
|
|
27491
|
-
paymentGatewayRefundStatusIdGet(id:
|
|
27609
|
+
paymentGatewayRefundStatusIdGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesRefundStatusDto, any, {}>>;
|
|
27492
27610
|
/**
|
|
27493
27611
|
* Gets a paginated list of refund requests with filtering
|
|
27494
27612
|
* @summary List refund requests
|