@seekora-ai/admin-api 1.0.64 → 1.0.66
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 +257 -63
- package/dist/api.d.ts +167 -45
- package/dist/api.js +187 -54
- package/dist/esm/api.d.ts +167 -45
- package/dist/esm/api.js +183 -50
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.66.tgz +0 -0
- package/seekora-ai-admin-api-1.0.64.tgz +0 -0
package/dist/esm/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,21 +18475,25 @@ 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
|
|
18438
18493
|
* @param {string} xStoreID Store ID
|
|
18439
18494
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
18440
18495
|
* @param {string} [endTime] End time in RFC3339 format
|
|
18496
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs)
|
|
18441
18497
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
18442
18498
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
18443
18499
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
@@ -18465,7 +18521,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
18465
18521
|
* @param {*} [options] Override http request option.
|
|
18466
18522
|
* @throws {RequiredError}
|
|
18467
18523
|
*/
|
|
18468
|
-
adminAnalyticsStoreXStoreIDResultsGet: (xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18524
|
+
adminAnalyticsStoreXStoreIDResultsGet: (xStoreID: string, startTime?: string, endTime?: string, search?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18469
18525
|
/**
|
|
18470
18526
|
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
18471
18527
|
* @summary Get Analytics Tags
|
|
@@ -18610,6 +18666,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
18610
18666
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
18611
18667
|
* @param {string} [endTime] End time in RFC3339 format
|
|
18612
18668
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum} [granularity] Time granularity
|
|
18669
|
+
* @param {string} [search] Search term to filter geographic locations (case-insensitive partial match on country, region, city)
|
|
18613
18670
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
18614
18671
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
18615
18672
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
@@ -18633,7 +18690,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
18633
18690
|
* @param {*} [options] Override http request option.
|
|
18634
18691
|
* @throws {RequiredError}
|
|
18635
18692
|
*/
|
|
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>>;
|
|
18693
|
+
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
18694
|
/**
|
|
18638
18695
|
* 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
18696
|
* @summary Get Geographic Insights
|
|
@@ -18658,14 +18715,17 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
18658
18715
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
18659
18716
|
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
18660
18717
|
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
18718
|
+
* @param {string} [geoQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
18661
18719
|
* @param {number} [resultsPage] Page number for top results pagination
|
|
18662
18720
|
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
18721
|
+
* @param {string} [geoResultsSearch] Search term to filter top results (case-insensitive partial match on item IDs)
|
|
18663
18722
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
18664
18723
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
18724
|
+
* @param {string} [geoFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
18665
18725
|
* @param {*} [options] Override http request option.
|
|
18666
18726
|
* @throws {RequiredError}
|
|
18667
18727
|
*/
|
|
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>>;
|
|
18728
|
+
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
18729
|
/**
|
|
18670
18730
|
* Check the health status of analytics service and ClickHouse connection
|
|
18671
18731
|
* @summary Analytics Health Check
|
|
@@ -18812,6 +18872,12 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
18812
18872
|
* @param {string} query Search query to analyze
|
|
18813
18873
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
18814
18874
|
* @param {string} [endTime] End time in RFC3339 format
|
|
18875
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
18876
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
18877
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
18878
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
18879
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
18880
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
18815
18881
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
18816
18882
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
18817
18883
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -18822,21 +18888,25 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
18822
18888
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
18823
18889
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
18824
18890
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
18891
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
18825
18892
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
18826
18893
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
18894
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
18827
18895
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
18828
18896
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
18897
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
18829
18898
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
18830
18899
|
* @param {*} [options] Override http request option.
|
|
18831
18900
|
* @throws {RequiredError}
|
|
18832
18901
|
*/
|
|
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>>;
|
|
18902
|
+
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
18903
|
/**
|
|
18835
18904
|
* 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
18905
|
* @summary Get Top Results Analytics
|
|
18837
18906
|
* @param {string} xStoreID Store ID
|
|
18838
18907
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
18839
18908
|
* @param {string} [endTime] End time in RFC3339 format
|
|
18909
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs)
|
|
18840
18910
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
18841
18911
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
18842
18912
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
@@ -18864,7 +18934,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
18864
18934
|
* @param {*} [options] Override http request option.
|
|
18865
18935
|
* @throws {RequiredError}
|
|
18866
18936
|
*/
|
|
18867
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response>>;
|
|
18937
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response>>;
|
|
18868
18938
|
/**
|
|
18869
18939
|
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
18870
18940
|
* @summary Get Analytics Tags
|
|
@@ -19009,6 +19079,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
19009
19079
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
19010
19080
|
* @param {string} [endTime] End time in RFC3339 format
|
|
19011
19081
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum} [granularity] Time granularity
|
|
19082
|
+
* @param {string} [search] Search term to filter geographic locations (case-insensitive partial match on country, region, city)
|
|
19012
19083
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
19013
19084
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
19014
19085
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
@@ -19032,7 +19103,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
19032
19103
|
* @param {*} [options] Override http request option.
|
|
19033
19104
|
* @throws {RequiredError}
|
|
19034
19105
|
*/
|
|
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>;
|
|
19106
|
+
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
19107
|
/**
|
|
19037
19108
|
* 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
19109
|
* @summary Get Geographic Insights
|
|
@@ -19057,14 +19128,17 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
19057
19128
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
19058
19129
|
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
19059
19130
|
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
19131
|
+
* @param {string} [geoQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
19060
19132
|
* @param {number} [resultsPage] Page number for top results pagination
|
|
19061
19133
|
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
19134
|
+
* @param {string} [geoResultsSearch] Search term to filter top results (case-insensitive partial match on item IDs)
|
|
19062
19135
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
19063
19136
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
19137
|
+
* @param {string} [geoFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
19064
19138
|
* @param {*} [options] Override http request option.
|
|
19065
19139
|
* @throws {RequiredError}
|
|
19066
19140
|
*/
|
|
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>;
|
|
19141
|
+
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
19142
|
/**
|
|
19069
19143
|
* Check the health status of analytics service and ClickHouse connection
|
|
19070
19144
|
* @summary Analytics Health Check
|
|
@@ -19211,6 +19285,12 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
19211
19285
|
* @param {string} query Search query to analyze
|
|
19212
19286
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
19213
19287
|
* @param {string} [endTime] End time in RFC3339 format
|
|
19288
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
19289
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
19290
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
19291
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
19292
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
19293
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
19214
19294
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
19215
19295
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
19216
19296
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -19221,21 +19301,25 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
19221
19301
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
19222
19302
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
19223
19303
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
19304
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
19224
19305
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
19225
19306
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
19307
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
19226
19308
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
19227
19309
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
19310
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
19228
19311
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
19229
19312
|
* @param {*} [options] Override http request option.
|
|
19230
19313
|
* @throws {RequiredError}
|
|
19231
19314
|
*/
|
|
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>;
|
|
19315
|
+
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
19316
|
/**
|
|
19234
19317
|
* 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
19318
|
* @summary Get Top Results Analytics
|
|
19236
19319
|
* @param {string} xStoreID Store ID
|
|
19237
19320
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
19238
19321
|
* @param {string} [endTime] End time in RFC3339 format
|
|
19322
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs)
|
|
19239
19323
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
19240
19324
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
19241
19325
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
@@ -19263,7 +19347,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
19263
19347
|
* @param {*} [options] Override http request option.
|
|
19264
19348
|
* @throws {RequiredError}
|
|
19265
19349
|
*/
|
|
19266
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response>;
|
|
19350
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response>;
|
|
19267
19351
|
/**
|
|
19268
19352
|
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
19269
19353
|
* @summary Get Analytics Tags
|
|
@@ -19416,6 +19500,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
19416
19500
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
19417
19501
|
* @param {string} [endTime] End time in RFC3339 format
|
|
19418
19502
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum} [granularity] Time granularity
|
|
19503
|
+
* @param {string} [search] Search term to filter geographic locations (case-insensitive partial match on country, region, city)
|
|
19419
19504
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
19420
19505
|
* @param {AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
19421
19506
|
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
@@ -19440,7 +19525,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
19440
19525
|
* @throws {RequiredError}
|
|
19441
19526
|
* @memberof AnalyticsApi
|
|
19442
19527
|
*/
|
|
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, {}>>;
|
|
19528
|
+
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
19529
|
/**
|
|
19445
19530
|
* 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
19531
|
* @summary Get Geographic Insights
|
|
@@ -19465,15 +19550,18 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
19465
19550
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
19466
19551
|
* @param {number} [queriesPage] Page number for popular queries pagination
|
|
19467
19552
|
* @param {number} [queriesPageSize] Number of queries per page for popular queries
|
|
19553
|
+
* @param {string} [geoQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
19468
19554
|
* @param {number} [resultsPage] Page number for top results pagination
|
|
19469
19555
|
* @param {number} [resultsPageSize] Number of results per page for top results
|
|
19556
|
+
* @param {string} [geoResultsSearch] Search term to filter top results (case-insensitive partial match on item IDs)
|
|
19470
19557
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
19471
19558
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
19559
|
+
* @param {string} [geoFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
19472
19560
|
* @param {*} [options] Override http request option.
|
|
19473
19561
|
* @throws {RequiredError}
|
|
19474
19562
|
* @memberof AnalyticsApi
|
|
19475
19563
|
*/
|
|
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, {}>>;
|
|
19564
|
+
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
19565
|
/**
|
|
19478
19566
|
* Check the health status of analytics service and ClickHouse connection
|
|
19479
19567
|
* @summary Analytics Health Check
|
|
@@ -19626,6 +19714,12 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
19626
19714
|
* @param {string} query Search query to analyze
|
|
19627
19715
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
19628
19716
|
* @param {string} [endTime] End time in RFC3339 format
|
|
19717
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
19718
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
19719
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
19720
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
19721
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
19722
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
19629
19723
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
19630
19724
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
19631
19725
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -19636,22 +19730,26 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
19636
19730
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
19637
19731
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
19638
19732
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
19733
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
19639
19734
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
19640
19735
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
19736
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
19641
19737
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
19642
19738
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
19739
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
19643
19740
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
19644
19741
|
* @param {*} [options] Override http request option.
|
|
19645
19742
|
* @throws {RequiredError}
|
|
19646
19743
|
* @memberof AnalyticsApi
|
|
19647
19744
|
*/
|
|
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, {}>>;
|
|
19745
|
+
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
19746
|
/**
|
|
19650
19747
|
* 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
19748
|
* @summary Get Top Results Analytics
|
|
19652
19749
|
* @param {string} xStoreID Store ID
|
|
19653
19750
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
19654
19751
|
* @param {string} [endTime] End time in RFC3339 format
|
|
19752
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs)
|
|
19655
19753
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
19656
19754
|
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
19657
19755
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
@@ -19680,7 +19778,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
19680
19778
|
* @throws {RequiredError}
|
|
19681
19779
|
* @memberof AnalyticsApi
|
|
19682
19780
|
*/
|
|
19683
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response, any, {}>>;
|
|
19781
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response, any, {}>>;
|
|
19684
19782
|
/**
|
|
19685
19783
|
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
19686
19784
|
* @summary Get Analytics Tags
|
|
@@ -20027,6 +20125,14 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum
|
|
|
20027
20125
|
readonly Desc: "desc";
|
|
20028
20126
|
};
|
|
20029
20127
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
20128
|
+
/**
|
|
20129
|
+
* @export
|
|
20130
|
+
*/
|
|
20131
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum: {
|
|
20132
|
+
readonly Any: "any";
|
|
20133
|
+
readonly All: "all";
|
|
20134
|
+
};
|
|
20135
|
+
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum];
|
|
20030
20136
|
/**
|
|
20031
20137
|
* @export
|
|
20032
20138
|
*/
|
|
@@ -22165,6 +22271,7 @@ export declare const ItemAnalyticsApiAxiosParamCreator: (configuration?: Configu
|
|
|
22165
22271
|
* @param {string} xStoreID Store ID
|
|
22166
22272
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
22167
22273
|
* @param {string} [endTime] End time in RFC3339 format
|
|
22274
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
22168
22275
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
22169
22276
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
22170
22277
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -22179,7 +22286,7 @@ export declare const ItemAnalyticsApiAxiosParamCreator: (configuration?: Configu
|
|
|
22179
22286
|
* @param {*} [options] Override http request option.
|
|
22180
22287
|
* @throws {RequiredError}
|
|
22181
22288
|
*/
|
|
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>;
|
|
22289
|
+
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
22290
|
/**
|
|
22184
22291
|
* Retrieve detailed analytics for a specific item including performance metrics and discovery data
|
|
22185
22292
|
* @summary Get Item Details
|
|
@@ -22213,15 +22320,18 @@ export declare const ItemAnalyticsApiAxiosParamCreator: (configuration?: Configu
|
|
|
22213
22320
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22214
22321
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
22215
22322
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
22323
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
22216
22324
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22217
22325
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
22326
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22218
22327
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22219
22328
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22329
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22220
22330
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
22221
22331
|
* @param {*} [options] Override http request option.
|
|
22222
22332
|
* @throws {RequiredError}
|
|
22223
22333
|
*/
|
|
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>;
|
|
22334
|
+
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
22335
|
/**
|
|
22226
22336
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
22227
22337
|
* @summary Get Item Performance Analytics
|
|
@@ -22328,6 +22438,7 @@ export declare const ItemAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
22328
22438
|
* @param {string} xStoreID Store ID
|
|
22329
22439
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
22330
22440
|
* @param {string} [endTime] End time in RFC3339 format
|
|
22441
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
22331
22442
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
22332
22443
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
22333
22444
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -22342,7 +22453,7 @@ export declare const ItemAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
22342
22453
|
* @param {*} [options] Override http request option.
|
|
22343
22454
|
* @throws {RequiredError}
|
|
22344
22455
|
*/
|
|
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>>;
|
|
22456
|
+
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
22457
|
/**
|
|
22347
22458
|
* Retrieve detailed analytics for a specific item including performance metrics and discovery data
|
|
22348
22459
|
* @summary Get Item Details
|
|
@@ -22376,15 +22487,18 @@ export declare const ItemAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
22376
22487
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22377
22488
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
22378
22489
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
22490
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
22379
22491
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22380
22492
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
22493
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22381
22494
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22382
22495
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22496
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22383
22497
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
22384
22498
|
* @param {*} [options] Override http request option.
|
|
22385
22499
|
* @throws {RequiredError}
|
|
22386
22500
|
*/
|
|
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>>;
|
|
22501
|
+
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
22502
|
/**
|
|
22389
22503
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
22390
22504
|
* @summary Get Item Performance Analytics
|
|
@@ -22491,6 +22605,7 @@ export declare const ItemAnalyticsApiFactory: (configuration?: Configuration, ba
|
|
|
22491
22605
|
* @param {string} xStoreID Store ID
|
|
22492
22606
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
22493
22607
|
* @param {string} [endTime] End time in RFC3339 format
|
|
22608
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
22494
22609
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
22495
22610
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
22496
22611
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -22505,7 +22620,7 @@ export declare const ItemAnalyticsApiFactory: (configuration?: Configuration, ba
|
|
|
22505
22620
|
* @param {*} [options] Override http request option.
|
|
22506
22621
|
* @throws {RequiredError}
|
|
22507
22622
|
*/
|
|
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>;
|
|
22623
|
+
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
22624
|
/**
|
|
22510
22625
|
* Retrieve detailed analytics for a specific item including performance metrics and discovery data
|
|
22511
22626
|
* @summary Get Item Details
|
|
@@ -22539,15 +22654,18 @@ export declare const ItemAnalyticsApiFactory: (configuration?: Configuration, ba
|
|
|
22539
22654
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22540
22655
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
22541
22656
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
22657
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
22542
22658
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22543
22659
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
22660
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22544
22661
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22545
22662
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22663
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22546
22664
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
22547
22665
|
* @param {*} [options] Override http request option.
|
|
22548
22666
|
* @throws {RequiredError}
|
|
22549
22667
|
*/
|
|
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>;
|
|
22668
|
+
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
22669
|
/**
|
|
22552
22670
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
22553
22671
|
* @summary Get Item Performance Analytics
|
|
@@ -22658,6 +22776,7 @@ export declare class ItemAnalyticsApi extends BaseAPI {
|
|
|
22658
22776
|
* @param {string} xStoreID Store ID
|
|
22659
22777
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
22660
22778
|
* @param {string} [endTime] End time in RFC3339 format
|
|
22779
|
+
* @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
|
|
22661
22780
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
22662
22781
|
* @param {number} [itemLimit] Maximum number of items to return
|
|
22663
22782
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
@@ -22673,7 +22792,7 @@ export declare class ItemAnalyticsApi extends BaseAPI {
|
|
|
22673
22792
|
* @throws {RequiredError}
|
|
22674
22793
|
* @memberof ItemAnalyticsApi
|
|
22675
22794
|
*/
|
|
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, {}>>;
|
|
22795
|
+
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
22796
|
/**
|
|
22678
22797
|
* Retrieve detailed analytics for a specific item including performance metrics and discovery data
|
|
22679
22798
|
* @summary Get Item Details
|
|
@@ -22708,16 +22827,19 @@ export declare class ItemAnalyticsApi extends BaseAPI {
|
|
|
22708
22827
|
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22709
22828
|
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
22710
22829
|
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
22830
|
+
* @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
|
|
22711
22831
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22712
22832
|
* @param {number} [filtersPageSize] Number of filters per page
|
|
22833
|
+
* @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22713
22834
|
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22714
22835
|
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22836
|
+
* @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22715
22837
|
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
22716
22838
|
* @param {*} [options] Override http request option.
|
|
22717
22839
|
* @throws {RequiredError}
|
|
22718
22840
|
* @memberof ItemAnalyticsApi
|
|
22719
22841
|
*/
|
|
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, {}>>;
|
|
22842
|
+
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
22843
|
/**
|
|
22722
22844
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
22723
22845
|
* @summary Get Item Performance Analytics
|
|
@@ -27314,13 +27436,13 @@ export declare const RefundManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
27314
27436
|
*/
|
|
27315
27437
|
paymentGatewayRefundRequestPost: (dataTypesCreateRefundRequestDto: DataTypesCreateRefundRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
27316
27438
|
/**
|
|
27317
|
-
* Gets the current status and details of a refund request
|
|
27439
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
27318
27440
|
* @summary Get refund request status
|
|
27319
|
-
* @param {
|
|
27441
|
+
* @param {string} id Refund ID (UUID)
|
|
27320
27442
|
* @param {*} [options] Override http request option.
|
|
27321
27443
|
* @throws {RequiredError}
|
|
27322
27444
|
*/
|
|
27323
|
-
paymentGatewayRefundStatusIdGet: (id:
|
|
27445
|
+
paymentGatewayRefundStatusIdGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
27324
27446
|
/**
|
|
27325
27447
|
* Gets a paginated list of refund requests with filtering
|
|
27326
27448
|
* @summary List refund requests
|
|
@@ -27368,13 +27490,13 @@ export declare const RefundManagementApiFp: (configuration?: Configuration) => {
|
|
|
27368
27490
|
*/
|
|
27369
27491
|
paymentGatewayRefundRequestPost(dataTypesCreateRefundRequestDto: DataTypesCreateRefundRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRefundRequestResponseDto>>;
|
|
27370
27492
|
/**
|
|
27371
|
-
* Gets the current status and details of a refund request
|
|
27493
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
27372
27494
|
* @summary Get refund request status
|
|
27373
|
-
* @param {
|
|
27495
|
+
* @param {string} id Refund ID (UUID)
|
|
27374
27496
|
* @param {*} [options] Override http request option.
|
|
27375
27497
|
* @throws {RequiredError}
|
|
27376
27498
|
*/
|
|
27377
|
-
paymentGatewayRefundStatusIdGet(id:
|
|
27499
|
+
paymentGatewayRefundStatusIdGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRefundStatusDto>>;
|
|
27378
27500
|
/**
|
|
27379
27501
|
* Gets a paginated list of refund requests with filtering
|
|
27380
27502
|
* @summary List refund requests
|
|
@@ -27422,13 +27544,13 @@ export declare const RefundManagementApiFactory: (configuration?: Configuration,
|
|
|
27422
27544
|
*/
|
|
27423
27545
|
paymentGatewayRefundRequestPost(dataTypesCreateRefundRequestDto: DataTypesCreateRefundRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRefundRequestResponseDto>;
|
|
27424
27546
|
/**
|
|
27425
|
-
* Gets the current status and details of a refund request
|
|
27547
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
27426
27548
|
* @summary Get refund request status
|
|
27427
|
-
* @param {
|
|
27549
|
+
* @param {string} id Refund ID (UUID)
|
|
27428
27550
|
* @param {*} [options] Override http request option.
|
|
27429
27551
|
* @throws {RequiredError}
|
|
27430
27552
|
*/
|
|
27431
|
-
paymentGatewayRefundStatusIdGet(id:
|
|
27553
|
+
paymentGatewayRefundStatusIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRefundStatusDto>;
|
|
27432
27554
|
/**
|
|
27433
27555
|
* Gets a paginated list of refund requests with filtering
|
|
27434
27556
|
* @summary List refund requests
|
|
@@ -27481,14 +27603,14 @@ export declare class RefundManagementApi extends BaseAPI {
|
|
|
27481
27603
|
*/
|
|
27482
27604
|
paymentGatewayRefundRequestPost(dataTypesCreateRefundRequestDto: DataTypesCreateRefundRequestDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesRefundRequestResponseDto, any, {}>>;
|
|
27483
27605
|
/**
|
|
27484
|
-
* Gets the current status and details of a refund request
|
|
27606
|
+
* Gets the current status and details of a refund request by refund_id (UUID)
|
|
27485
27607
|
* @summary Get refund request status
|
|
27486
|
-
* @param {
|
|
27608
|
+
* @param {string} id Refund ID (UUID)
|
|
27487
27609
|
* @param {*} [options] Override http request option.
|
|
27488
27610
|
* @throws {RequiredError}
|
|
27489
27611
|
* @memberof RefundManagementApi
|
|
27490
27612
|
*/
|
|
27491
|
-
paymentGatewayRefundStatusIdGet(id:
|
|
27613
|
+
paymentGatewayRefundStatusIdGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesRefundStatusDto, any, {}>>;
|
|
27492
27614
|
/**
|
|
27493
27615
|
* Gets a paginated list of refund requests with filtering
|
|
27494
27616
|
* @summary List refund requests
|