@seekora-ai/admin-api 1.0.49 → 1.0.50
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 +17 -2
- package/api.ts +921 -19
- package/dist/api.d.ts +810 -46
- package/dist/api.js +281 -18
- package/dist/esm/api.d.ts +810 -46
- package/dist/esm/api.js +278 -15
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.50.tgz +0 -0
- package/seekora-ai-admin-api-1.0.49.tgz +0 -0
package/dist/esm/api.d.ts
CHANGED
|
@@ -357,6 +357,49 @@ export interface AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response {
|
|
|
357
357
|
*/
|
|
358
358
|
'total'?: number;
|
|
359
359
|
}
|
|
360
|
+
/**
|
|
361
|
+
*
|
|
362
|
+
* @export
|
|
363
|
+
* @interface AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response
|
|
364
|
+
*/
|
|
365
|
+
export interface AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response {
|
|
366
|
+
/**
|
|
367
|
+
* Comparison metadata when in compare mode
|
|
368
|
+
* @type {AnalyticsComparisonMeta}
|
|
369
|
+
* @memberof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response
|
|
370
|
+
*/
|
|
371
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
372
|
+
/**
|
|
373
|
+
*
|
|
374
|
+
* @type {AnalyticsItemInsights}
|
|
375
|
+
* @memberof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response
|
|
376
|
+
*/
|
|
377
|
+
'data'?: AnalyticsItemInsights;
|
|
378
|
+
/**
|
|
379
|
+
*
|
|
380
|
+
* @type {string}
|
|
381
|
+
* @memberof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response
|
|
382
|
+
*/
|
|
383
|
+
'error'?: string;
|
|
384
|
+
/**
|
|
385
|
+
*
|
|
386
|
+
* @type {string}
|
|
387
|
+
* @memberof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response
|
|
388
|
+
*/
|
|
389
|
+
'status'?: string;
|
|
390
|
+
/**
|
|
391
|
+
*
|
|
392
|
+
* @type {string}
|
|
393
|
+
* @memberof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response
|
|
394
|
+
*/
|
|
395
|
+
'timestamp'?: string;
|
|
396
|
+
/**
|
|
397
|
+
*
|
|
398
|
+
* @type {number}
|
|
399
|
+
* @memberof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGet200Response
|
|
400
|
+
*/
|
|
401
|
+
'total'?: number;
|
|
402
|
+
}
|
|
360
403
|
/**
|
|
361
404
|
*
|
|
362
405
|
* @export
|
|
@@ -1917,6 +1960,86 @@ export interface AnalyticsItemComparisonAnalyticsComparisonMetrics {
|
|
|
1917
1960
|
*/
|
|
1918
1961
|
'worst_performer'?: string;
|
|
1919
1962
|
}
|
|
1963
|
+
/**
|
|
1964
|
+
*
|
|
1965
|
+
* @export
|
|
1966
|
+
* @interface AnalyticsItemCompetitor
|
|
1967
|
+
*/
|
|
1968
|
+
export interface AnalyticsItemCompetitor {
|
|
1969
|
+
/**
|
|
1970
|
+
*
|
|
1971
|
+
* @type {number}
|
|
1972
|
+
* @memberof AnalyticsItemCompetitor
|
|
1973
|
+
*/
|
|
1974
|
+
'avg_position'?: number;
|
|
1975
|
+
/**
|
|
1976
|
+
*
|
|
1977
|
+
* @type {number}
|
|
1978
|
+
* @memberof AnalyticsItemCompetitor
|
|
1979
|
+
*/
|
|
1980
|
+
'competition_score'?: number;
|
|
1981
|
+
/**
|
|
1982
|
+
*
|
|
1983
|
+
* @type {string}
|
|
1984
|
+
* @memberof AnalyticsItemCompetitor
|
|
1985
|
+
*/
|
|
1986
|
+
'item_id'?: string;
|
|
1987
|
+
/**
|
|
1988
|
+
*
|
|
1989
|
+
* @type {string}
|
|
1990
|
+
* @memberof AnalyticsItemCompetitor
|
|
1991
|
+
*/
|
|
1992
|
+
'item_name'?: string;
|
|
1993
|
+
/**
|
|
1994
|
+
* percentage of shared context
|
|
1995
|
+
* @type {number}
|
|
1996
|
+
* @memberof AnalyticsItemCompetitor
|
|
1997
|
+
*/
|
|
1998
|
+
'overlap'?: number;
|
|
1999
|
+
/**
|
|
2000
|
+
*
|
|
2001
|
+
* @type {number}
|
|
2002
|
+
* @memberof AnalyticsItemCompetitor
|
|
2003
|
+
*/
|
|
2004
|
+
'shared_filters'?: number;
|
|
2005
|
+
/**
|
|
2006
|
+
*
|
|
2007
|
+
* @type {number}
|
|
2008
|
+
* @memberof AnalyticsItemCompetitor
|
|
2009
|
+
*/
|
|
2010
|
+
'shared_queries'?: number;
|
|
2011
|
+
}
|
|
2012
|
+
/**
|
|
2013
|
+
*
|
|
2014
|
+
* @export
|
|
2015
|
+
* @interface AnalyticsItemCompetitorAnalysis
|
|
2016
|
+
*/
|
|
2017
|
+
export interface AnalyticsItemCompetitorAnalysis {
|
|
2018
|
+
/**
|
|
2019
|
+
*
|
|
2020
|
+
* @type {Array<AnalyticsItemCompetitor>}
|
|
2021
|
+
* @memberof AnalyticsItemCompetitorAnalysis
|
|
2022
|
+
*/
|
|
2023
|
+
'competing_items'?: Array<AnalyticsItemCompetitor>;
|
|
2024
|
+
/**
|
|
2025
|
+
*
|
|
2026
|
+
* @type {number}
|
|
2027
|
+
* @memberof AnalyticsItemCompetitorAnalysis
|
|
2028
|
+
*/
|
|
2029
|
+
'market_share'?: number;
|
|
2030
|
+
/**
|
|
2031
|
+
* average position relative to competitors
|
|
2032
|
+
* @type {number}
|
|
2033
|
+
* @memberof AnalyticsItemCompetitorAnalysis
|
|
2034
|
+
*/
|
|
2035
|
+
'position_advantage'?: number;
|
|
2036
|
+
/**
|
|
2037
|
+
*
|
|
2038
|
+
* @type {Array<AnalyticsSharedQueryAnalysis>}
|
|
2039
|
+
* @memberof AnalyticsItemCompetitorAnalysis
|
|
2040
|
+
*/
|
|
2041
|
+
'shared_queries'?: Array<AnalyticsSharedQueryAnalysis>;
|
|
2042
|
+
}
|
|
1920
2043
|
/**
|
|
1921
2044
|
*
|
|
1922
2045
|
* @export
|
|
@@ -1997,6 +2120,207 @@ export interface AnalyticsItemDiscoveryAnalytics {
|
|
|
1997
2120
|
*/
|
|
1998
2121
|
'total_impressions'?: number;
|
|
1999
2122
|
}
|
|
2123
|
+
/**
|
|
2124
|
+
*
|
|
2125
|
+
* @export
|
|
2126
|
+
* @interface AnalyticsItemGeoAnalytic
|
|
2127
|
+
*/
|
|
2128
|
+
export interface AnalyticsItemGeoAnalytic {
|
|
2129
|
+
/**
|
|
2130
|
+
*
|
|
2131
|
+
* @type {number}
|
|
2132
|
+
* @memberof AnalyticsItemGeoAnalytic
|
|
2133
|
+
*/
|
|
2134
|
+
'avg_position'?: number;
|
|
2135
|
+
/**
|
|
2136
|
+
*
|
|
2137
|
+
* @type {string}
|
|
2138
|
+
* @memberof AnalyticsItemGeoAnalytic
|
|
2139
|
+
*/
|
|
2140
|
+
'city'?: string;
|
|
2141
|
+
/**
|
|
2142
|
+
*
|
|
2143
|
+
* @type {number}
|
|
2144
|
+
* @memberof AnalyticsItemGeoAnalytic
|
|
2145
|
+
*/
|
|
2146
|
+
'click_through_rate'?: number;
|
|
2147
|
+
/**
|
|
2148
|
+
*
|
|
2149
|
+
* @type {number}
|
|
2150
|
+
* @memberof AnalyticsItemGeoAnalytic
|
|
2151
|
+
*/
|
|
2152
|
+
'clicks'?: number;
|
|
2153
|
+
/**
|
|
2154
|
+
*
|
|
2155
|
+
* @type {string}
|
|
2156
|
+
* @memberof AnalyticsItemGeoAnalytic
|
|
2157
|
+
*/
|
|
2158
|
+
'country'?: string;
|
|
2159
|
+
/**
|
|
2160
|
+
*
|
|
2161
|
+
* @type {string}
|
|
2162
|
+
* @memberof AnalyticsItemGeoAnalytic
|
|
2163
|
+
*/
|
|
2164
|
+
'country_code'?: string;
|
|
2165
|
+
/**
|
|
2166
|
+
*
|
|
2167
|
+
* @type {number}
|
|
2168
|
+
* @memberof AnalyticsItemGeoAnalytic
|
|
2169
|
+
*/
|
|
2170
|
+
'impressions'?: number;
|
|
2171
|
+
/**
|
|
2172
|
+
*
|
|
2173
|
+
* @type {string}
|
|
2174
|
+
* @memberof AnalyticsItemGeoAnalytic
|
|
2175
|
+
*/
|
|
2176
|
+
'region'?: string;
|
|
2177
|
+
/**
|
|
2178
|
+
* percentage of total impressions for this item
|
|
2179
|
+
* @type {number}
|
|
2180
|
+
* @memberof AnalyticsItemGeoAnalytic
|
|
2181
|
+
*/
|
|
2182
|
+
'share'?: number;
|
|
2183
|
+
/**
|
|
2184
|
+
*
|
|
2185
|
+
* @type {number}
|
|
2186
|
+
* @memberof AnalyticsItemGeoAnalytic
|
|
2187
|
+
*/
|
|
2188
|
+
'unique_users'?: number;
|
|
2189
|
+
}
|
|
2190
|
+
/**
|
|
2191
|
+
*
|
|
2192
|
+
* @export
|
|
2193
|
+
* @interface AnalyticsItemGeoAnalyticsSection
|
|
2194
|
+
*/
|
|
2195
|
+
export interface AnalyticsItemGeoAnalyticsSection {
|
|
2196
|
+
/**
|
|
2197
|
+
*
|
|
2198
|
+
* @type {Array<AnalyticsItemGeoAnalytic>}
|
|
2199
|
+
* @memberof AnalyticsItemGeoAnalyticsSection
|
|
2200
|
+
*/
|
|
2201
|
+
'items'?: Array<AnalyticsItemGeoAnalytic>;
|
|
2202
|
+
/**
|
|
2203
|
+
*
|
|
2204
|
+
* @type {AnalyticsPaginationMeta}
|
|
2205
|
+
* @memberof AnalyticsItemGeoAnalyticsSection
|
|
2206
|
+
*/
|
|
2207
|
+
'meta'?: AnalyticsPaginationMeta;
|
|
2208
|
+
}
|
|
2209
|
+
/**
|
|
2210
|
+
*
|
|
2211
|
+
* @export
|
|
2212
|
+
* @interface AnalyticsItemInsights
|
|
2213
|
+
*/
|
|
2214
|
+
export interface AnalyticsItemInsights {
|
|
2215
|
+
/**
|
|
2216
|
+
*
|
|
2217
|
+
* @type {number}
|
|
2218
|
+
* @memberof AnalyticsItemInsights
|
|
2219
|
+
*/
|
|
2220
|
+
'avg_position'?: number;
|
|
2221
|
+
/**
|
|
2222
|
+
*
|
|
2223
|
+
* @type {number}
|
|
2224
|
+
* @memberof AnalyticsItemInsights
|
|
2225
|
+
*/
|
|
2226
|
+
'click_through_rate'?: number;
|
|
2227
|
+
/**
|
|
2228
|
+
*
|
|
2229
|
+
* @type {AnalyticsItemCompetitorAnalysis}
|
|
2230
|
+
* @memberof AnalyticsItemInsights
|
|
2231
|
+
*/
|
|
2232
|
+
'competitor_analysis'?: AnalyticsItemCompetitorAnalysis;
|
|
2233
|
+
/**
|
|
2234
|
+
*
|
|
2235
|
+
* @type {number}
|
|
2236
|
+
* @memberof AnalyticsItemInsights
|
|
2237
|
+
*/
|
|
2238
|
+
'conversion_rate'?: number;
|
|
2239
|
+
/**
|
|
2240
|
+
*
|
|
2241
|
+
* @type {number}
|
|
2242
|
+
* @memberof AnalyticsItemInsights
|
|
2243
|
+
*/
|
|
2244
|
+
'discovery_score'?: number;
|
|
2245
|
+
/**
|
|
2246
|
+
*
|
|
2247
|
+
* @type {AnalyticsItemGeoAnalyticsSection}
|
|
2248
|
+
* @memberof AnalyticsItemInsights
|
|
2249
|
+
*/
|
|
2250
|
+
'geo_analytics'?: AnalyticsItemGeoAnalyticsSection;
|
|
2251
|
+
/**
|
|
2252
|
+
*
|
|
2253
|
+
* @type {string}
|
|
2254
|
+
* @memberof AnalyticsItemInsights
|
|
2255
|
+
*/
|
|
2256
|
+
'item_id'?: string;
|
|
2257
|
+
/**
|
|
2258
|
+
*
|
|
2259
|
+
* @type {string}
|
|
2260
|
+
* @memberof AnalyticsItemInsights
|
|
2261
|
+
*/
|
|
2262
|
+
'item_name'?: string;
|
|
2263
|
+
/**
|
|
2264
|
+
*
|
|
2265
|
+
* @type {string}
|
|
2266
|
+
* @memberof AnalyticsItemInsights
|
|
2267
|
+
*/
|
|
2268
|
+
'last_seen'?: string;
|
|
2269
|
+
/**
|
|
2270
|
+
*
|
|
2271
|
+
* @type {Array<AnalyticsItemTrendData>}
|
|
2272
|
+
* @memberof AnalyticsItemInsights
|
|
2273
|
+
*/
|
|
2274
|
+
'performance_trends'?: Array<AnalyticsItemTrendData>;
|
|
2275
|
+
/**
|
|
2276
|
+
*
|
|
2277
|
+
* @type {AnalyticsItemPopularFiltersSection}
|
|
2278
|
+
* @memberof AnalyticsItemInsights
|
|
2279
|
+
*/
|
|
2280
|
+
'popular_filters'?: AnalyticsItemPopularFiltersSection;
|
|
2281
|
+
/**
|
|
2282
|
+
*
|
|
2283
|
+
* @type {AnalyticsItemPopularQueriesSection}
|
|
2284
|
+
* @memberof AnalyticsItemInsights
|
|
2285
|
+
*/
|
|
2286
|
+
'popular_queries'?: AnalyticsItemPopularQueriesSection;
|
|
2287
|
+
/**
|
|
2288
|
+
*
|
|
2289
|
+
* @type {Array<AnalyticsItemPositionBucket>}
|
|
2290
|
+
* @memberof AnalyticsItemInsights
|
|
2291
|
+
*/
|
|
2292
|
+
'position_distribution'?: Array<AnalyticsItemPositionBucket>;
|
|
2293
|
+
/**
|
|
2294
|
+
*
|
|
2295
|
+
* @type {number}
|
|
2296
|
+
* @memberof AnalyticsItemInsights
|
|
2297
|
+
*/
|
|
2298
|
+
'top_10_impression_rate'?: number;
|
|
2299
|
+
/**
|
|
2300
|
+
*
|
|
2301
|
+
* @type {number}
|
|
2302
|
+
* @memberof AnalyticsItemInsights
|
|
2303
|
+
*/
|
|
2304
|
+
'top_3_impression_rate'?: number;
|
|
2305
|
+
/**
|
|
2306
|
+
*
|
|
2307
|
+
* @type {number}
|
|
2308
|
+
* @memberof AnalyticsItemInsights
|
|
2309
|
+
*/
|
|
2310
|
+
'total_impressions'?: number;
|
|
2311
|
+
/**
|
|
2312
|
+
*
|
|
2313
|
+
* @type {number}
|
|
2314
|
+
* @memberof AnalyticsItemInsights
|
|
2315
|
+
*/
|
|
2316
|
+
'unique_searches'?: number;
|
|
2317
|
+
/**
|
|
2318
|
+
*
|
|
2319
|
+
* @type {number}
|
|
2320
|
+
* @memberof AnalyticsItemInsights
|
|
2321
|
+
*/
|
|
2322
|
+
'unique_users'?: number;
|
|
2323
|
+
}
|
|
2000
2324
|
/**
|
|
2001
2325
|
*
|
|
2002
2326
|
* @export
|
|
@@ -2193,82 +2517,237 @@ export interface AnalyticsItemPerformanceWithWidget {
|
|
|
2193
2517
|
'impressions'?: number;
|
|
2194
2518
|
/**
|
|
2195
2519
|
*
|
|
2196
|
-
* @type {string}
|
|
2197
|
-
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2520
|
+
* @type {string}
|
|
2521
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2522
|
+
*/
|
|
2523
|
+
'item_id'?: string;
|
|
2524
|
+
/**
|
|
2525
|
+
*
|
|
2526
|
+
* @type {string}
|
|
2527
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2528
|
+
*/
|
|
2529
|
+
'item_name'?: string;
|
|
2530
|
+
/**
|
|
2531
|
+
*
|
|
2532
|
+
* @type {number}
|
|
2533
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2534
|
+
*/
|
|
2535
|
+
'revenue'?: number;
|
|
2536
|
+
/**
|
|
2537
|
+
*
|
|
2538
|
+
* @type {number}
|
|
2539
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2540
|
+
*/
|
|
2541
|
+
'revenue_per_item'?: number;
|
|
2542
|
+
/**
|
|
2543
|
+
*
|
|
2544
|
+
* @type {number}
|
|
2545
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2546
|
+
*/
|
|
2547
|
+
'top_10_impressions'?: number;
|
|
2548
|
+
/**
|
|
2549
|
+
*
|
|
2550
|
+
* @type {number}
|
|
2551
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2552
|
+
*/
|
|
2553
|
+
'top_3_impression_rate'?: number;
|
|
2554
|
+
/**
|
|
2555
|
+
*
|
|
2556
|
+
* @type {number}
|
|
2557
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2558
|
+
*/
|
|
2559
|
+
'top_3_impressions'?: number;
|
|
2560
|
+
/**
|
|
2561
|
+
*
|
|
2562
|
+
* @type {number}
|
|
2563
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2564
|
+
*/
|
|
2565
|
+
'unique_filters'?: number;
|
|
2566
|
+
/**
|
|
2567
|
+
*
|
|
2568
|
+
* @type {number}
|
|
2569
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2570
|
+
*/
|
|
2571
|
+
'unique_queries'?: number;
|
|
2572
|
+
/**
|
|
2573
|
+
*
|
|
2574
|
+
* @type {number}
|
|
2575
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2576
|
+
*/
|
|
2577
|
+
'unique_searches'?: number;
|
|
2578
|
+
/**
|
|
2579
|
+
*
|
|
2580
|
+
* @type {number}
|
|
2581
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2582
|
+
*/
|
|
2583
|
+
'unique_sorts'?: number;
|
|
2584
|
+
/**
|
|
2585
|
+
*
|
|
2586
|
+
* @type {number}
|
|
2587
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2588
|
+
*/
|
|
2589
|
+
'unique_users'?: number;
|
|
2590
|
+
/**
|
|
2591
|
+
* Widget display data for UI presentation
|
|
2592
|
+
* @type {AnalyticsWidgetData}
|
|
2593
|
+
* @memberof AnalyticsItemPerformanceWithWidget
|
|
2594
|
+
*/
|
|
2595
|
+
'widget'?: AnalyticsWidgetData;
|
|
2596
|
+
}
|
|
2597
|
+
/**
|
|
2598
|
+
*
|
|
2599
|
+
* @export
|
|
2600
|
+
* @interface AnalyticsItemPopularFilter
|
|
2601
|
+
*/
|
|
2602
|
+
export interface AnalyticsItemPopularFilter {
|
|
2603
|
+
/**
|
|
2604
|
+
*
|
|
2605
|
+
* @type {number}
|
|
2606
|
+
* @memberof AnalyticsItemPopularFilter
|
|
2607
|
+
*/
|
|
2608
|
+
'avg_position'?: number;
|
|
2609
|
+
/**
|
|
2610
|
+
*
|
|
2611
|
+
* @type {string}
|
|
2612
|
+
* @memberof AnalyticsItemPopularFilter
|
|
2613
|
+
*/
|
|
2614
|
+
'filter_key'?: string;
|
|
2615
|
+
/**
|
|
2616
|
+
*
|
|
2617
|
+
* @type {string}
|
|
2618
|
+
* @memberof AnalyticsItemPopularFilter
|
|
2619
|
+
*/
|
|
2620
|
+
'filter_value'?: string;
|
|
2621
|
+
/**
|
|
2622
|
+
*
|
|
2623
|
+
* @type {number}
|
|
2624
|
+
* @memberof AnalyticsItemPopularFilter
|
|
2625
|
+
*/
|
|
2626
|
+
'impressions'?: number;
|
|
2627
|
+
/**
|
|
2628
|
+
* percentage of impressions for this item
|
|
2629
|
+
* @type {number}
|
|
2630
|
+
* @memberof AnalyticsItemPopularFilter
|
|
2631
|
+
*/
|
|
2632
|
+
'share'?: number;
|
|
2633
|
+
}
|
|
2634
|
+
/**
|
|
2635
|
+
*
|
|
2636
|
+
* @export
|
|
2637
|
+
* @interface AnalyticsItemPopularFiltersSection
|
|
2638
|
+
*/
|
|
2639
|
+
export interface AnalyticsItemPopularFiltersSection {
|
|
2640
|
+
/**
|
|
2641
|
+
*
|
|
2642
|
+
* @type {Array<AnalyticsItemPopularFilter>}
|
|
2643
|
+
* @memberof AnalyticsItemPopularFiltersSection
|
|
2644
|
+
*/
|
|
2645
|
+
'items'?: Array<AnalyticsItemPopularFilter>;
|
|
2646
|
+
/**
|
|
2647
|
+
*
|
|
2648
|
+
* @type {AnalyticsPaginationMeta}
|
|
2649
|
+
* @memberof AnalyticsItemPopularFiltersSection
|
|
2650
|
+
*/
|
|
2651
|
+
'meta'?: AnalyticsPaginationMeta;
|
|
2652
|
+
}
|
|
2653
|
+
/**
|
|
2654
|
+
*
|
|
2655
|
+
* @export
|
|
2656
|
+
* @interface AnalyticsItemPopularQueriesSection
|
|
2657
|
+
*/
|
|
2658
|
+
export interface AnalyticsItemPopularQueriesSection {
|
|
2659
|
+
/**
|
|
2660
|
+
*
|
|
2661
|
+
* @type {Array<AnalyticsItemPopularQuery>}
|
|
2662
|
+
* @memberof AnalyticsItemPopularQueriesSection
|
|
2198
2663
|
*/
|
|
2199
|
-
'
|
|
2664
|
+
'items'?: Array<AnalyticsItemPopularQuery>;
|
|
2200
2665
|
/**
|
|
2201
2666
|
*
|
|
2202
|
-
* @type {
|
|
2203
|
-
* @memberof
|
|
2667
|
+
* @type {AnalyticsPaginationMeta}
|
|
2668
|
+
* @memberof AnalyticsItemPopularQueriesSection
|
|
2204
2669
|
*/
|
|
2205
|
-
'
|
|
2670
|
+
'meta'?: AnalyticsPaginationMeta;
|
|
2671
|
+
}
|
|
2672
|
+
/**
|
|
2673
|
+
*
|
|
2674
|
+
* @export
|
|
2675
|
+
* @interface AnalyticsItemPopularQuery
|
|
2676
|
+
*/
|
|
2677
|
+
export interface AnalyticsItemPopularQuery {
|
|
2206
2678
|
/**
|
|
2207
2679
|
*
|
|
2208
2680
|
* @type {number}
|
|
2209
|
-
* @memberof
|
|
2681
|
+
* @memberof AnalyticsItemPopularQuery
|
|
2210
2682
|
*/
|
|
2211
|
-
'
|
|
2683
|
+
'avg_position'?: number;
|
|
2212
2684
|
/**
|
|
2213
2685
|
*
|
|
2214
2686
|
* @type {number}
|
|
2215
|
-
* @memberof
|
|
2687
|
+
* @memberof AnalyticsItemPopularQuery
|
|
2216
2688
|
*/
|
|
2217
|
-
'
|
|
2689
|
+
'click_through_rate'?: number;
|
|
2218
2690
|
/**
|
|
2219
2691
|
*
|
|
2220
2692
|
* @type {number}
|
|
2221
|
-
* @memberof
|
|
2693
|
+
* @memberof AnalyticsItemPopularQuery
|
|
2222
2694
|
*/
|
|
2223
|
-
'
|
|
2695
|
+
'clicks'?: number;
|
|
2224
2696
|
/**
|
|
2225
2697
|
*
|
|
2226
2698
|
* @type {number}
|
|
2227
|
-
* @memberof
|
|
2699
|
+
* @memberof AnalyticsItemPopularQuery
|
|
2228
2700
|
*/
|
|
2229
|
-
'
|
|
2701
|
+
'impressions'?: number;
|
|
2230
2702
|
/**
|
|
2231
2703
|
*
|
|
2232
|
-
* @type {
|
|
2233
|
-
* @memberof
|
|
2704
|
+
* @type {string}
|
|
2705
|
+
* @memberof AnalyticsItemPopularQuery
|
|
2234
2706
|
*/
|
|
2235
|
-
'
|
|
2707
|
+
'query'?: string;
|
|
2236
2708
|
/**
|
|
2237
|
-
*
|
|
2709
|
+
* percentage of total impressions for this item
|
|
2238
2710
|
* @type {number}
|
|
2239
|
-
* @memberof
|
|
2711
|
+
* @memberof AnalyticsItemPopularQuery
|
|
2240
2712
|
*/
|
|
2241
|
-
'
|
|
2713
|
+
'share'?: number;
|
|
2714
|
+
}
|
|
2715
|
+
/**
|
|
2716
|
+
*
|
|
2717
|
+
* @export
|
|
2718
|
+
* @interface AnalyticsItemPositionBucket
|
|
2719
|
+
*/
|
|
2720
|
+
export interface AnalyticsItemPositionBucket {
|
|
2242
2721
|
/**
|
|
2243
2722
|
*
|
|
2244
2723
|
* @type {number}
|
|
2245
|
-
* @memberof
|
|
2724
|
+
* @memberof AnalyticsItemPositionBucket
|
|
2246
2725
|
*/
|
|
2247
|
-
'
|
|
2726
|
+
'click_rate'?: number;
|
|
2248
2727
|
/**
|
|
2249
2728
|
*
|
|
2250
2729
|
* @type {number}
|
|
2251
|
-
* @memberof
|
|
2730
|
+
* @memberof AnalyticsItemPositionBucket
|
|
2252
2731
|
*/
|
|
2253
|
-
'
|
|
2732
|
+
'clicks'?: number;
|
|
2254
2733
|
/**
|
|
2255
2734
|
*
|
|
2256
2735
|
* @type {number}
|
|
2257
|
-
* @memberof
|
|
2736
|
+
* @memberof AnalyticsItemPositionBucket
|
|
2258
2737
|
*/
|
|
2259
|
-
'
|
|
2738
|
+
'impressions'?: number;
|
|
2260
2739
|
/**
|
|
2261
|
-
*
|
|
2262
|
-
* @type {
|
|
2263
|
-
* @memberof
|
|
2740
|
+
* \"1\", \"2\", \"3\", \"4-5\", \"6-10\", \"11-20\", \"21+\"
|
|
2741
|
+
* @type {string}
|
|
2742
|
+
* @memberof AnalyticsItemPositionBucket
|
|
2264
2743
|
*/
|
|
2265
|
-
'
|
|
2744
|
+
'position_range'?: string;
|
|
2266
2745
|
/**
|
|
2267
|
-
*
|
|
2268
|
-
* @type {
|
|
2269
|
-
* @memberof
|
|
2746
|
+
* percentage of total impressions for this item
|
|
2747
|
+
* @type {number}
|
|
2748
|
+
* @memberof AnalyticsItemPositionBucket
|
|
2270
2749
|
*/
|
|
2271
|
-
'
|
|
2750
|
+
'share'?: number;
|
|
2272
2751
|
}
|
|
2273
2752
|
/**
|
|
2274
2753
|
*
|
|
@@ -2834,6 +3313,86 @@ export interface AnalyticsQueryFilterUsage {
|
|
|
2834
3313
|
*/
|
|
2835
3314
|
'unique_searches'?: number;
|
|
2836
3315
|
}
|
|
3316
|
+
/**
|
|
3317
|
+
*
|
|
3318
|
+
* @export
|
|
3319
|
+
* @interface AnalyticsQueryGeoAnalytic
|
|
3320
|
+
*/
|
|
3321
|
+
export interface AnalyticsQueryGeoAnalytic {
|
|
3322
|
+
/**
|
|
3323
|
+
*
|
|
3324
|
+
* @type {string}
|
|
3325
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
3326
|
+
*/
|
|
3327
|
+
'city'?: string;
|
|
3328
|
+
/**
|
|
3329
|
+
*
|
|
3330
|
+
* @type {number}
|
|
3331
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
3332
|
+
*/
|
|
3333
|
+
'click_through_rate'?: number;
|
|
3334
|
+
/**
|
|
3335
|
+
*
|
|
3336
|
+
* @type {number}
|
|
3337
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
3338
|
+
*/
|
|
3339
|
+
'clicks'?: number;
|
|
3340
|
+
/**
|
|
3341
|
+
*
|
|
3342
|
+
* @type {string}
|
|
3343
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
3344
|
+
*/
|
|
3345
|
+
'country'?: string;
|
|
3346
|
+
/**
|
|
3347
|
+
*
|
|
3348
|
+
* @type {string}
|
|
3349
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
3350
|
+
*/
|
|
3351
|
+
'country_code'?: string;
|
|
3352
|
+
/**
|
|
3353
|
+
*
|
|
3354
|
+
* @type {string}
|
|
3355
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
3356
|
+
*/
|
|
3357
|
+
'region'?: string;
|
|
3358
|
+
/**
|
|
3359
|
+
*
|
|
3360
|
+
* @type {number}
|
|
3361
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
3362
|
+
*/
|
|
3363
|
+
'searches'?: number;
|
|
3364
|
+
/**
|
|
3365
|
+
* percentage of total searches for this query
|
|
3366
|
+
* @type {number}
|
|
3367
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
3368
|
+
*/
|
|
3369
|
+
'share'?: number;
|
|
3370
|
+
/**
|
|
3371
|
+
*
|
|
3372
|
+
* @type {number}
|
|
3373
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
3374
|
+
*/
|
|
3375
|
+
'unique_users'?: number;
|
|
3376
|
+
}
|
|
3377
|
+
/**
|
|
3378
|
+
*
|
|
3379
|
+
* @export
|
|
3380
|
+
* @interface AnalyticsQueryGeoAnalyticsSection
|
|
3381
|
+
*/
|
|
3382
|
+
export interface AnalyticsQueryGeoAnalyticsSection {
|
|
3383
|
+
/**
|
|
3384
|
+
*
|
|
3385
|
+
* @type {Array<AnalyticsQueryGeoAnalytic>}
|
|
3386
|
+
* @memberof AnalyticsQueryGeoAnalyticsSection
|
|
3387
|
+
*/
|
|
3388
|
+
'items'?: Array<AnalyticsQueryGeoAnalytic>;
|
|
3389
|
+
/**
|
|
3390
|
+
*
|
|
3391
|
+
* @type {AnalyticsPaginationMeta}
|
|
3392
|
+
* @memberof AnalyticsQueryGeoAnalyticsSection
|
|
3393
|
+
*/
|
|
3394
|
+
'meta'?: AnalyticsPaginationMeta;
|
|
3395
|
+
}
|
|
2837
3396
|
/**
|
|
2838
3397
|
*
|
|
2839
3398
|
* @export
|
|
@@ -2870,6 +3429,12 @@ export interface AnalyticsQueryInsights {
|
|
|
2870
3429
|
* @memberof AnalyticsQueryInsights
|
|
2871
3430
|
*/
|
|
2872
3431
|
'filter_analytics'?: AnalyticsQueryFilterAnalytics;
|
|
3432
|
+
/**
|
|
3433
|
+
*
|
|
3434
|
+
* @type {AnalyticsQueryGeoAnalyticsSection}
|
|
3435
|
+
* @memberof AnalyticsQueryInsights
|
|
3436
|
+
*/
|
|
3437
|
+
'geo_analytics'?: AnalyticsQueryGeoAnalyticsSection;
|
|
2873
3438
|
/**
|
|
2874
3439
|
*
|
|
2875
3440
|
* @type {string}
|
|
@@ -3219,6 +3784,49 @@ export interface AnalyticsQueryResponse {
|
|
|
3219
3784
|
*/
|
|
3220
3785
|
'total'?: number;
|
|
3221
3786
|
}
|
|
3787
|
+
/**
|
|
3788
|
+
*
|
|
3789
|
+
* @export
|
|
3790
|
+
* @interface AnalyticsSharedQueryAnalysis
|
|
3791
|
+
*/
|
|
3792
|
+
export interface AnalyticsSharedQueryAnalysis {
|
|
3793
|
+
/**
|
|
3794
|
+
*
|
|
3795
|
+
* @type {string}
|
|
3796
|
+
* @memberof AnalyticsSharedQueryAnalysis
|
|
3797
|
+
*/
|
|
3798
|
+
'competitor_id'?: string;
|
|
3799
|
+
/**
|
|
3800
|
+
*
|
|
3801
|
+
* @type {number}
|
|
3802
|
+
* @memberof AnalyticsSharedQueryAnalysis
|
|
3803
|
+
*/
|
|
3804
|
+
'competitor_position'?: number;
|
|
3805
|
+
/**
|
|
3806
|
+
*
|
|
3807
|
+
* @type {number}
|
|
3808
|
+
* @memberof AnalyticsSharedQueryAnalysis
|
|
3809
|
+
*/
|
|
3810
|
+
'impressions'?: number;
|
|
3811
|
+
/**
|
|
3812
|
+
*
|
|
3813
|
+
* @type {number}
|
|
3814
|
+
* @memberof AnalyticsSharedQueryAnalysis
|
|
3815
|
+
*/
|
|
3816
|
+
'position_advantage'?: number;
|
|
3817
|
+
/**
|
|
3818
|
+
*
|
|
3819
|
+
* @type {string}
|
|
3820
|
+
* @memberof AnalyticsSharedQueryAnalysis
|
|
3821
|
+
*/
|
|
3822
|
+
'query'?: string;
|
|
3823
|
+
/**
|
|
3824
|
+
*
|
|
3825
|
+
* @type {number}
|
|
3826
|
+
* @memberof AnalyticsSharedQueryAnalysis
|
|
3827
|
+
*/
|
|
3828
|
+
'this_item_position'?: number;
|
|
3829
|
+
}
|
|
3222
3830
|
/**
|
|
3223
3831
|
*
|
|
3224
3832
|
* @export
|
|
@@ -13257,7 +13865,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
13257
13865
|
*/
|
|
13258
13866
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: (xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13259
13867
|
/**
|
|
13260
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
13868
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
13261
13869
|
* @summary Get Query Insights
|
|
13262
13870
|
* @param {string} xStoreID Store ID
|
|
13263
13871
|
* @param {string} query Search query to analyze
|
|
@@ -13274,12 +13882,14 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
13274
13882
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
13275
13883
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
13276
13884
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
13277
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
13885
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
13886
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
13887
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
13278
13888
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
13279
13889
|
* @param {*} [options] Override http request option.
|
|
13280
13890
|
* @throws {RequiredError}
|
|
13281
13891
|
*/
|
|
13282
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13892
|
+
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>;
|
|
13283
13893
|
/**
|
|
13284
13894
|
* 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.
|
|
13285
13895
|
* @summary Get Top Results Analytics
|
|
@@ -13622,7 +14232,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
13622
14232
|
*/
|
|
13623
14233
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>>;
|
|
13624
14234
|
/**
|
|
13625
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
14235
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
13626
14236
|
* @summary Get Query Insights
|
|
13627
14237
|
* @param {string} xStoreID Store ID
|
|
13628
14238
|
* @param {string} query Search query to analyze
|
|
@@ -13639,12 +14249,14 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
13639
14249
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
13640
14250
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
13641
14251
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
13642
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
14252
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
14253
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
14254
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
13643
14255
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
13644
14256
|
* @param {*} [options] Override http request option.
|
|
13645
14257
|
* @throws {RequiredError}
|
|
13646
14258
|
*/
|
|
13647
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>>;
|
|
14259
|
+
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>>;
|
|
13648
14260
|
/**
|
|
13649
14261
|
* 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.
|
|
13650
14262
|
* @summary Get Top Results Analytics
|
|
@@ -13987,7 +14599,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
13987
14599
|
*/
|
|
13988
14600
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>;
|
|
13989
14601
|
/**
|
|
13990
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
14602
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
13991
14603
|
* @summary Get Query Insights
|
|
13992
14604
|
* @param {string} xStoreID Store ID
|
|
13993
14605
|
* @param {string} query Search query to analyze
|
|
@@ -14004,12 +14616,14 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
14004
14616
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
14005
14617
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
14006
14618
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
14007
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
14619
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
14620
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
14621
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
14008
14622
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
14009
14623
|
* @param {*} [options] Override http request option.
|
|
14010
14624
|
* @throws {RequiredError}
|
|
14011
14625
|
*/
|
|
14012
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>;
|
|
14626
|
+
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>;
|
|
14013
14627
|
/**
|
|
14014
14628
|
* 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.
|
|
14015
14629
|
* @summary Get Top Results Analytics
|
|
@@ -14367,7 +14981,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
14367
14981
|
*/
|
|
14368
14982
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response, any, {}>>;
|
|
14369
14983
|
/**
|
|
14370
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
14984
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
14371
14985
|
* @summary Get Query Insights
|
|
14372
14986
|
* @param {string} xStoreID Store ID
|
|
14373
14987
|
* @param {string} query Search query to analyze
|
|
@@ -14384,13 +14998,15 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
14384
14998
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
14385
14999
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
14386
15000
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
14387
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
15001
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
15002
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
15003
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
14388
15004
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
14389
15005
|
* @param {*} [options] Override http request option.
|
|
14390
15006
|
* @throws {RequiredError}
|
|
14391
15007
|
* @memberof AnalyticsApi
|
|
14392
15008
|
*/
|
|
14393
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any, {}>>;
|
|
15009
|
+
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, {}>>;
|
|
14394
15010
|
/**
|
|
14395
15011
|
* 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.
|
|
14396
15012
|
* @summary Get Top Results Analytics
|
|
@@ -16510,6 +17126,37 @@ export declare const ItemAnalyticsApiAxiosParamCreator: (configuration?: Configu
|
|
|
16510
17126
|
* @throws {RequiredError}
|
|
16511
17127
|
*/
|
|
16512
17128
|
adminAnalyticsStoreXStoreIDItemsItemIdGet: (xStoreID: string, itemId: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17129
|
+
/**
|
|
17130
|
+
* Retrieve comprehensive analytics insights for a specific item including popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
17131
|
+
* @summary Get Item Insights
|
|
17132
|
+
* @param {string} xStoreID Store ID
|
|
17133
|
+
* @param {string} itemId Item ID to analyze
|
|
17134
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
17135
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
17136
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
17137
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
17138
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
17139
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
17140
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
17141
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
17142
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
17143
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
17144
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
17145
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
17146
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
17147
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
17148
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
17149
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
17150
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
17151
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
17152
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
17153
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
17154
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
17155
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
17156
|
+
* @param {*} [options] Override http request option.
|
|
17157
|
+
* @throws {RequiredError}
|
|
17158
|
+
*/
|
|
17159
|
+
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>;
|
|
16513
17160
|
/**
|
|
16514
17161
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
16515
17162
|
* @summary Get Item Performance Analytics
|
|
@@ -16642,6 +17289,37 @@ export declare const ItemAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
16642
17289
|
* @throws {RequiredError}
|
|
16643
17290
|
*/
|
|
16644
17291
|
adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>>;
|
|
17292
|
+
/**
|
|
17293
|
+
* Retrieve comprehensive analytics insights for a specific item including popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
17294
|
+
* @summary Get Item Insights
|
|
17295
|
+
* @param {string} xStoreID Store ID
|
|
17296
|
+
* @param {string} itemId Item ID to analyze
|
|
17297
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
17298
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
17299
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
17300
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
17301
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
17302
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
17303
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
17304
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
17305
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
17306
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
17307
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
17308
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
17309
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
17310
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
17311
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
17312
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
17313
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
17314
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
17315
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
17316
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
17317
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
17318
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
17319
|
+
* @param {*} [options] Override http request option.
|
|
17320
|
+
* @throws {RequiredError}
|
|
17321
|
+
*/
|
|
17322
|
+
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>>;
|
|
16645
17323
|
/**
|
|
16646
17324
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
16647
17325
|
* @summary Get Item Performance Analytics
|
|
@@ -16774,6 +17452,37 @@ export declare const ItemAnalyticsApiFactory: (configuration?: Configuration, ba
|
|
|
16774
17452
|
* @throws {RequiredError}
|
|
16775
17453
|
*/
|
|
16776
17454
|
adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse>;
|
|
17455
|
+
/**
|
|
17456
|
+
* Retrieve comprehensive analytics insights for a specific item including popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
17457
|
+
* @summary Get Item Insights
|
|
17458
|
+
* @param {string} xStoreID Store ID
|
|
17459
|
+
* @param {string} itemId Item ID to analyze
|
|
17460
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
17461
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
17462
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
17463
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
17464
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
17465
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
17466
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
17467
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
17468
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
17469
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
17470
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
17471
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
17472
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
17473
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
17474
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
17475
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
17476
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
17477
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
17478
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
17479
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
17480
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
17481
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
17482
|
+
* @param {*} [options] Override http request option.
|
|
17483
|
+
* @throws {RequiredError}
|
|
17484
|
+
*/
|
|
17485
|
+
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>;
|
|
16777
17486
|
/**
|
|
16778
17487
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
16779
17488
|
* @summary Get Item Performance Analytics
|
|
@@ -16912,6 +17621,38 @@ export declare class ItemAnalyticsApi extends BaseAPI {
|
|
|
16912
17621
|
* @memberof ItemAnalyticsApi
|
|
16913
17622
|
*/
|
|
16914
17623
|
adminAnalyticsStoreXStoreIDItemsItemIdGet(xStoreID: string, itemId: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsAnalyticsAPIResponse, any, {}>>;
|
|
17624
|
+
/**
|
|
17625
|
+
* Retrieve comprehensive analytics insights for a specific item including popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
|
|
17626
|
+
* @summary Get Item Insights
|
|
17627
|
+
* @param {string} xStoreID Store ID
|
|
17628
|
+
* @param {string} itemId Item ID to analyze
|
|
17629
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
17630
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
17631
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
17632
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
17633
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
17634
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
17635
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
17636
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
17637
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
17638
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
17639
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
17640
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
17641
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
17642
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
17643
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
17644
|
+
* @param {number} [resultsPage] Page number for popular queries pagination
|
|
17645
|
+
* @param {number} [resultsPageSize] Number of queries per page for popular queries
|
|
17646
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
17647
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
17648
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
17649
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
17650
|
+
* @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
|
|
17651
|
+
* @param {*} [options] Override http request option.
|
|
17652
|
+
* @throws {RequiredError}
|
|
17653
|
+
* @memberof ItemAnalyticsApi
|
|
17654
|
+
*/
|
|
17655
|
+
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, {}>>;
|
|
16915
17656
|
/**
|
|
16916
17657
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
16917
17658
|
* @summary Get Item Performance Analytics
|
|
@@ -17014,6 +17755,29 @@ export declare const AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum: {
|
|
|
17014
17755
|
readonly Desc: "desc";
|
|
17015
17756
|
};
|
|
17016
17757
|
export type AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum];
|
|
17758
|
+
/**
|
|
17759
|
+
* @export
|
|
17760
|
+
*/
|
|
17761
|
+
export declare const AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum: {
|
|
17762
|
+
readonly Any: "any";
|
|
17763
|
+
readonly All: "all";
|
|
17764
|
+
};
|
|
17765
|
+
export type AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum];
|
|
17766
|
+
/**
|
|
17767
|
+
* @export
|
|
17768
|
+
*/
|
|
17769
|
+
export declare const AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum: {
|
|
17770
|
+
readonly Any: "any";
|
|
17771
|
+
readonly All: "all";
|
|
17772
|
+
};
|
|
17773
|
+
export type AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum];
|
|
17774
|
+
/**
|
|
17775
|
+
* @export
|
|
17776
|
+
*/
|
|
17777
|
+
export declare const AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum: {
|
|
17778
|
+
readonly Date: "date";
|
|
17779
|
+
};
|
|
17780
|
+
export type AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum = typeof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum[keyof typeof AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum];
|
|
17017
17781
|
/**
|
|
17018
17782
|
* @export
|
|
17019
17783
|
*/
|