@seekora-ai/admin-api 1.0.48 → 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 +1114 -74
- package/dist/api.d.ts +896 -26
- package/dist/api.js +344 -18
- package/dist/esm/api.d.ts +896 -26
- package/dist/esm/api.js +341 -15
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.50.tgz +0 -0
- package/seekora-ai-admin-api-1.0.48.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
|
|
@@ -1066,11 +1109,11 @@ export interface AnalyticsExtendedKPIResponse {
|
|
|
1066
1109
|
*/
|
|
1067
1110
|
'compare_summary'?: AnalyticsKPIMetrics;
|
|
1068
1111
|
/**
|
|
1069
|
-
*
|
|
1070
|
-
* @type {
|
|
1112
|
+
* Can be []KPIPointExtended or []ComparisonMetrics
|
|
1113
|
+
* @type {object}
|
|
1071
1114
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1072
1115
|
*/
|
|
1073
|
-
'data'?:
|
|
1116
|
+
'data'?: object;
|
|
1074
1117
|
/**
|
|
1075
1118
|
*
|
|
1076
1119
|
* @type {string}
|
|
@@ -1138,12 +1181,24 @@ export interface AnalyticsFilterAnalyticsResponse {
|
|
|
1138
1181
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1139
1182
|
*/
|
|
1140
1183
|
'filter_key'?: string;
|
|
1184
|
+
/**
|
|
1185
|
+
*
|
|
1186
|
+
* @type {number}
|
|
1187
|
+
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1188
|
+
*/
|
|
1189
|
+
'limit'?: number;
|
|
1141
1190
|
/**
|
|
1142
1191
|
*
|
|
1143
1192
|
* @type {string}
|
|
1144
1193
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1145
1194
|
*/
|
|
1146
1195
|
'org_id'?: string;
|
|
1196
|
+
/**
|
|
1197
|
+
*
|
|
1198
|
+
* @type {number}
|
|
1199
|
+
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1200
|
+
*/
|
|
1201
|
+
'page'?: number;
|
|
1147
1202
|
/**
|
|
1148
1203
|
*
|
|
1149
1204
|
* @type {string}
|
|
@@ -1174,6 +1229,12 @@ export interface AnalyticsFilterAnalyticsResponse {
|
|
|
1174
1229
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1175
1230
|
*/
|
|
1176
1231
|
'store_id'?: string;
|
|
1232
|
+
/**
|
|
1233
|
+
*
|
|
1234
|
+
* @type {number}
|
|
1235
|
+
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1236
|
+
*/
|
|
1237
|
+
'total'?: number;
|
|
1177
1238
|
}
|
|
1178
1239
|
/**
|
|
1179
1240
|
*
|
|
@@ -1409,12 +1470,24 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
1409
1470
|
* @memberof AnalyticsFilterTrendsResponse
|
|
1410
1471
|
*/
|
|
1411
1472
|
'granularity'?: string;
|
|
1473
|
+
/**
|
|
1474
|
+
*
|
|
1475
|
+
* @type {number}
|
|
1476
|
+
* @memberof AnalyticsFilterTrendsResponse
|
|
1477
|
+
*/
|
|
1478
|
+
'limit'?: number;
|
|
1412
1479
|
/**
|
|
1413
1480
|
*
|
|
1414
1481
|
* @type {string}
|
|
1415
1482
|
* @memberof AnalyticsFilterTrendsResponse
|
|
1416
1483
|
*/
|
|
1417
1484
|
'org_id'?: string;
|
|
1485
|
+
/**
|
|
1486
|
+
*
|
|
1487
|
+
* @type {number}
|
|
1488
|
+
* @memberof AnalyticsFilterTrendsResponse
|
|
1489
|
+
*/
|
|
1490
|
+
'page'?: number;
|
|
1418
1491
|
/**
|
|
1419
1492
|
*
|
|
1420
1493
|
* @type {string}
|
|
@@ -1445,6 +1518,12 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
1445
1518
|
* @memberof AnalyticsFilterTrendsResponse
|
|
1446
1519
|
*/
|
|
1447
1520
|
'top_filters'?: number;
|
|
1521
|
+
/**
|
|
1522
|
+
*
|
|
1523
|
+
* @type {number}
|
|
1524
|
+
* @memberof AnalyticsFilterTrendsResponse
|
|
1525
|
+
*/
|
|
1526
|
+
'total'?: number;
|
|
1448
1527
|
/**
|
|
1449
1528
|
*
|
|
1450
1529
|
* @type {{ [key: string]: Array<AnalyticsTimeSeriesPoint>; }}
|
|
@@ -1881,6 +1960,86 @@ export interface AnalyticsItemComparisonAnalyticsComparisonMetrics {
|
|
|
1881
1960
|
*/
|
|
1882
1961
|
'worst_performer'?: string;
|
|
1883
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
|
+
}
|
|
1884
2043
|
/**
|
|
1885
2044
|
*
|
|
1886
2045
|
* @export
|
|
@@ -1961,6 +2120,207 @@ export interface AnalyticsItemDiscoveryAnalytics {
|
|
|
1961
2120
|
*/
|
|
1962
2121
|
'total_impressions'?: number;
|
|
1963
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
|
+
}
|
|
1964
2324
|
/**
|
|
1965
2325
|
*
|
|
1966
2326
|
* @export
|
|
@@ -2234,6 +2594,161 @@ export interface AnalyticsItemPerformanceWithWidget {
|
|
|
2234
2594
|
*/
|
|
2235
2595
|
'widget'?: AnalyticsWidgetData;
|
|
2236
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
|
|
2663
|
+
*/
|
|
2664
|
+
'items'?: Array<AnalyticsItemPopularQuery>;
|
|
2665
|
+
/**
|
|
2666
|
+
*
|
|
2667
|
+
* @type {AnalyticsPaginationMeta}
|
|
2668
|
+
* @memberof AnalyticsItemPopularQueriesSection
|
|
2669
|
+
*/
|
|
2670
|
+
'meta'?: AnalyticsPaginationMeta;
|
|
2671
|
+
}
|
|
2672
|
+
/**
|
|
2673
|
+
*
|
|
2674
|
+
* @export
|
|
2675
|
+
* @interface AnalyticsItemPopularQuery
|
|
2676
|
+
*/
|
|
2677
|
+
export interface AnalyticsItemPopularQuery {
|
|
2678
|
+
/**
|
|
2679
|
+
*
|
|
2680
|
+
* @type {number}
|
|
2681
|
+
* @memberof AnalyticsItemPopularQuery
|
|
2682
|
+
*/
|
|
2683
|
+
'avg_position'?: number;
|
|
2684
|
+
/**
|
|
2685
|
+
*
|
|
2686
|
+
* @type {number}
|
|
2687
|
+
* @memberof AnalyticsItemPopularQuery
|
|
2688
|
+
*/
|
|
2689
|
+
'click_through_rate'?: number;
|
|
2690
|
+
/**
|
|
2691
|
+
*
|
|
2692
|
+
* @type {number}
|
|
2693
|
+
* @memberof AnalyticsItemPopularQuery
|
|
2694
|
+
*/
|
|
2695
|
+
'clicks'?: number;
|
|
2696
|
+
/**
|
|
2697
|
+
*
|
|
2698
|
+
* @type {number}
|
|
2699
|
+
* @memberof AnalyticsItemPopularQuery
|
|
2700
|
+
*/
|
|
2701
|
+
'impressions'?: number;
|
|
2702
|
+
/**
|
|
2703
|
+
*
|
|
2704
|
+
* @type {string}
|
|
2705
|
+
* @memberof AnalyticsItemPopularQuery
|
|
2706
|
+
*/
|
|
2707
|
+
'query'?: string;
|
|
2708
|
+
/**
|
|
2709
|
+
* percentage of total impressions for this item
|
|
2710
|
+
* @type {number}
|
|
2711
|
+
* @memberof AnalyticsItemPopularQuery
|
|
2712
|
+
*/
|
|
2713
|
+
'share'?: number;
|
|
2714
|
+
}
|
|
2715
|
+
/**
|
|
2716
|
+
*
|
|
2717
|
+
* @export
|
|
2718
|
+
* @interface AnalyticsItemPositionBucket
|
|
2719
|
+
*/
|
|
2720
|
+
export interface AnalyticsItemPositionBucket {
|
|
2721
|
+
/**
|
|
2722
|
+
*
|
|
2723
|
+
* @type {number}
|
|
2724
|
+
* @memberof AnalyticsItemPositionBucket
|
|
2725
|
+
*/
|
|
2726
|
+
'click_rate'?: number;
|
|
2727
|
+
/**
|
|
2728
|
+
*
|
|
2729
|
+
* @type {number}
|
|
2730
|
+
* @memberof AnalyticsItemPositionBucket
|
|
2731
|
+
*/
|
|
2732
|
+
'clicks'?: number;
|
|
2733
|
+
/**
|
|
2734
|
+
*
|
|
2735
|
+
* @type {number}
|
|
2736
|
+
* @memberof AnalyticsItemPositionBucket
|
|
2737
|
+
*/
|
|
2738
|
+
'impressions'?: number;
|
|
2739
|
+
/**
|
|
2740
|
+
* \"1\", \"2\", \"3\", \"4-5\", \"6-10\", \"11-20\", \"21+\"
|
|
2741
|
+
* @type {string}
|
|
2742
|
+
* @memberof AnalyticsItemPositionBucket
|
|
2743
|
+
*/
|
|
2744
|
+
'position_range'?: string;
|
|
2745
|
+
/**
|
|
2746
|
+
* percentage of total impressions for this item
|
|
2747
|
+
* @type {number}
|
|
2748
|
+
* @memberof AnalyticsItemPositionBucket
|
|
2749
|
+
*/
|
|
2750
|
+
'share'?: number;
|
|
2751
|
+
}
|
|
2237
2752
|
/**
|
|
2238
2753
|
*
|
|
2239
2754
|
* @export
|
|
@@ -2798,6 +3313,86 @@ export interface AnalyticsQueryFilterUsage {
|
|
|
2798
3313
|
*/
|
|
2799
3314
|
'unique_searches'?: number;
|
|
2800
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
|
+
}
|
|
2801
3396
|
/**
|
|
2802
3397
|
*
|
|
2803
3398
|
* @export
|
|
@@ -2834,6 +3429,12 @@ export interface AnalyticsQueryInsights {
|
|
|
2834
3429
|
* @memberof AnalyticsQueryInsights
|
|
2835
3430
|
*/
|
|
2836
3431
|
'filter_analytics'?: AnalyticsQueryFilterAnalytics;
|
|
3432
|
+
/**
|
|
3433
|
+
*
|
|
3434
|
+
* @type {AnalyticsQueryGeoAnalyticsSection}
|
|
3435
|
+
* @memberof AnalyticsQueryInsights
|
|
3436
|
+
*/
|
|
3437
|
+
'geo_analytics'?: AnalyticsQueryGeoAnalyticsSection;
|
|
2837
3438
|
/**
|
|
2838
3439
|
*
|
|
2839
3440
|
* @type {string}
|
|
@@ -3183,6 +3784,49 @@ export interface AnalyticsQueryResponse {
|
|
|
3183
3784
|
*/
|
|
3184
3785
|
'total'?: number;
|
|
3185
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
|
+
}
|
|
3186
3830
|
/**
|
|
3187
3831
|
*
|
|
3188
3832
|
* @export
|
|
@@ -6015,11 +6659,17 @@ export interface DataTypesErrorMetaResponse {
|
|
|
6015
6659
|
*/
|
|
6016
6660
|
export interface DataTypesEventPayload {
|
|
6017
6661
|
/**
|
|
6018
|
-
*
|
|
6662
|
+
* Journey Tracking & Analytics
|
|
6019
6663
|
* @type {Array<string>}
|
|
6020
6664
|
* @memberof DataTypesEventPayload
|
|
6021
6665
|
*/
|
|
6022
6666
|
'analytics_tags'?: Array<string>;
|
|
6667
|
+
/**
|
|
6668
|
+
* Anonymous user identifier
|
|
6669
|
+
* @type {string}
|
|
6670
|
+
* @memberof DataTypesEventPayload
|
|
6671
|
+
*/
|
|
6672
|
+
'anon_id'?: string;
|
|
6023
6673
|
/**
|
|
6024
6674
|
*
|
|
6025
6675
|
* @type {string}
|
|
@@ -6027,13 +6677,13 @@ export interface DataTypesEventPayload {
|
|
|
6027
6677
|
*/
|
|
6028
6678
|
'city'?: string;
|
|
6029
6679
|
/**
|
|
6030
|
-
*
|
|
6680
|
+
* Click/Interaction Event Fields
|
|
6031
6681
|
* @type {string}
|
|
6032
6682
|
* @memberof DataTypesEventPayload
|
|
6033
6683
|
*/
|
|
6034
6684
|
'clicked_product_id'?: string;
|
|
6035
6685
|
/**
|
|
6036
|
-
* Geo data fields for direct submission
|
|
6686
|
+
* Enhanced Geo data fields for direct submission
|
|
6037
6687
|
* @type {string}
|
|
6038
6688
|
* @memberof DataTypesEventPayload
|
|
6039
6689
|
*/
|
|
@@ -6044,6 +6694,12 @@ export interface DataTypesEventPayload {
|
|
|
6044
6694
|
* @memberof DataTypesEventPayload
|
|
6045
6695
|
*/
|
|
6046
6696
|
'country_code'?: string;
|
|
6697
|
+
/**
|
|
6698
|
+
* Currency for value
|
|
6699
|
+
* @type {string}
|
|
6700
|
+
* @memberof DataTypesEventPayload
|
|
6701
|
+
*/
|
|
6702
|
+
'currency'?: string;
|
|
6047
6703
|
/**
|
|
6048
6704
|
*
|
|
6049
6705
|
* @type {string}
|
|
@@ -6051,7 +6707,7 @@ export interface DataTypesEventPayload {
|
|
|
6051
6707
|
*/
|
|
6052
6708
|
'device_type'?: string;
|
|
6053
6709
|
/**
|
|
6054
|
-
*
|
|
6710
|
+
* Core Event Information
|
|
6055
6711
|
* @type {string}
|
|
6056
6712
|
* @memberof DataTypesEventPayload
|
|
6057
6713
|
*/
|
|
@@ -6063,25 +6719,25 @@ export interface DataTypesEventPayload {
|
|
|
6063
6719
|
*/
|
|
6064
6720
|
'event_name'?: string;
|
|
6065
6721
|
/**
|
|
6066
|
-
*
|
|
6722
|
+
* Device & Location Context
|
|
6067
6723
|
* @type {string}
|
|
6068
6724
|
* @memberof DataTypesEventPayload
|
|
6069
6725
|
*/
|
|
6070
6726
|
'ip'?: string;
|
|
6071
6727
|
/**
|
|
6072
|
-
*
|
|
6728
|
+
* Performance
|
|
6073
6729
|
* @type {number}
|
|
6074
6730
|
* @memberof DataTypesEventPayload
|
|
6075
6731
|
*/
|
|
6076
6732
|
'latency_ms'?: number;
|
|
6077
6733
|
/**
|
|
6078
|
-
*
|
|
6734
|
+
* Legacy field
|
|
6079
6735
|
* @type {string}
|
|
6080
6736
|
* @memberof DataTypesEventPayload
|
|
6081
6737
|
*/
|
|
6082
6738
|
'location'?: string;
|
|
6083
6739
|
/**
|
|
6084
|
-
*
|
|
6740
|
+
* Flexible metadata including search_id, position, etc.
|
|
6085
6741
|
* @type {{ [key: string]: any; }}
|
|
6086
6742
|
* @memberof DataTypesEventPayload
|
|
6087
6743
|
*/
|
|
@@ -6095,7 +6751,13 @@ export interface DataTypesEventPayload {
|
|
|
6095
6751
|
*/
|
|
6096
6752
|
'org_id'?: string;
|
|
6097
6753
|
/**
|
|
6098
|
-
*
|
|
6754
|
+
* web, ios, android
|
|
6755
|
+
* @type {string}
|
|
6756
|
+
* @memberof DataTypesEventPayload
|
|
6757
|
+
*/
|
|
6758
|
+
'platform'?: string;
|
|
6759
|
+
/**
|
|
6760
|
+
* Search Event Fields
|
|
6099
6761
|
* @type {string}
|
|
6100
6762
|
* @memberof DataTypesEventPayload
|
|
6101
6763
|
*/
|
|
@@ -6113,7 +6775,13 @@ export interface DataTypesEventPayload {
|
|
|
6113
6775
|
*/
|
|
6114
6776
|
'results_count'?: number;
|
|
6115
6777
|
/**
|
|
6116
|
-
*
|
|
6778
|
+
* Session identifier for journey tracking
|
|
6779
|
+
* @type {string}
|
|
6780
|
+
* @memberof DataTypesEventPayload
|
|
6781
|
+
*/
|
|
6782
|
+
'session_id'?: string;
|
|
6783
|
+
/**
|
|
6784
|
+
* Organization Context
|
|
6117
6785
|
* @type {string}
|
|
6118
6786
|
* @memberof DataTypesEventPayload
|
|
6119
6787
|
*/
|
|
@@ -6125,11 +6793,17 @@ export interface DataTypesEventPayload {
|
|
|
6125
6793
|
*/
|
|
6126
6794
|
'timestamp'?: string;
|
|
6127
6795
|
/**
|
|
6128
|
-
*
|
|
6796
|
+
* User Context
|
|
6129
6797
|
* @type {string}
|
|
6130
6798
|
* @memberof DataTypesEventPayload
|
|
6131
6799
|
*/
|
|
6132
6800
|
'user_id'?: string;
|
|
6801
|
+
/**
|
|
6802
|
+
* Business Context
|
|
6803
|
+
* @type {number}
|
|
6804
|
+
* @memberof DataTypesEventPayload
|
|
6805
|
+
*/
|
|
6806
|
+
'value'?: number;
|
|
6133
6807
|
}
|
|
6134
6808
|
/**
|
|
6135
6809
|
*
|
|
@@ -13191,21 +13865,31 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
13191
13865
|
*/
|
|
13192
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>;
|
|
13193
13867
|
/**
|
|
13194
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
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
|
|
13195
13869
|
* @summary Get Query Insights
|
|
13196
13870
|
* @param {string} xStoreID Store ID
|
|
13197
13871
|
* @param {string} query Search query to analyze
|
|
13198
13872
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13199
13873
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13874
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13875
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13876
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13877
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13878
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13879
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13880
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13881
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13200
13882
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
13201
13883
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
13202
13884
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
13203
|
-
* @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
|
|
13204
13888
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
13205
13889
|
* @param {*} [options] Override http request option.
|
|
13206
13890
|
* @throws {RequiredError}
|
|
13207
13891
|
*/
|
|
13208
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID: string, query: string, startTime?: string, endTime?: 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>;
|
|
13209
13893
|
/**
|
|
13210
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.
|
|
13211
13895
|
* @summary Get Top Results Analytics
|
|
@@ -13548,21 +14232,31 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
13548
14232
|
*/
|
|
13549
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>>;
|
|
13550
14234
|
/**
|
|
13551
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
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
|
|
13552
14236
|
* @summary Get Query Insights
|
|
13553
14237
|
* @param {string} xStoreID Store ID
|
|
13554
14238
|
* @param {string} query Search query to analyze
|
|
13555
14239
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13556
14240
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14241
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14242
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14243
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14244
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14245
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14246
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14247
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14248
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13557
14249
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
13558
14250
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
13559
14251
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
13560
|
-
* @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
|
|
13561
14255
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
13562
14256
|
* @param {*} [options] Override http request option.
|
|
13563
14257
|
* @throws {RequiredError}
|
|
13564
14258
|
*/
|
|
13565
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>>;
|
|
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>>;
|
|
13566
14260
|
/**
|
|
13567
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.
|
|
13568
14262
|
* @summary Get Top Results Analytics
|
|
@@ -13905,21 +14599,31 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
13905
14599
|
*/
|
|
13906
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>;
|
|
13907
14601
|
/**
|
|
13908
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
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
|
|
13909
14603
|
* @summary Get Query Insights
|
|
13910
14604
|
* @param {string} xStoreID Store ID
|
|
13911
14605
|
* @param {string} query Search query to analyze
|
|
13912
14606
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13913
14607
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14608
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14609
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14610
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14611
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14612
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14613
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14614
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14615
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13914
14616
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
13915
14617
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
13916
14618
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
13917
|
-
* @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
|
|
13918
14622
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
13919
14623
|
* @param {*} [options] Override http request option.
|
|
13920
14624
|
* @throws {RequiredError}
|
|
13921
14625
|
*/
|
|
13922
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: 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>;
|
|
13923
14627
|
/**
|
|
13924
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.
|
|
13925
14629
|
* @summary Get Top Results Analytics
|
|
@@ -14277,22 +14981,32 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
14277
14981
|
*/
|
|
14278
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, {}>>;
|
|
14279
14983
|
/**
|
|
14280
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
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
|
|
14281
14985
|
* @summary Get Query Insights
|
|
14282
14986
|
* @param {string} xStoreID Store ID
|
|
14283
14987
|
* @param {string} query Search query to analyze
|
|
14284
14988
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14285
14989
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14990
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14991
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14992
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14993
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14994
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14995
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14996
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14997
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14286
14998
|
* @param {number} [resultsPage] Page number for popular results pagination
|
|
14287
14999
|
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
14288
15000
|
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
14289
|
-
* @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
|
|
14290
15004
|
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
14291
15005
|
* @param {*} [options] Override http request option.
|
|
14292
15006
|
* @throws {RequiredError}
|
|
14293
15007
|
* @memberof AnalyticsApi
|
|
14294
15008
|
*/
|
|
14295
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any, {}>>;
|
|
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, {}>>;
|
|
14296
15010
|
/**
|
|
14297
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.
|
|
14298
15012
|
* @summary Get Top Results Analytics
|
|
@@ -14658,6 +15372,14 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum
|
|
|
14658
15372
|
readonly Desc: "desc";
|
|
14659
15373
|
};
|
|
14660
15374
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
15375
|
+
/**
|
|
15376
|
+
* @export
|
|
15377
|
+
*/
|
|
15378
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum: {
|
|
15379
|
+
readonly Any: "any";
|
|
15380
|
+
readonly All: "all";
|
|
15381
|
+
};
|
|
15382
|
+
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum];
|
|
14661
15383
|
/**
|
|
14662
15384
|
* @export
|
|
14663
15385
|
*/
|
|
@@ -16404,6 +17126,37 @@ export declare const ItemAnalyticsApiAxiosParamCreator: (configuration?: Configu
|
|
|
16404
17126
|
* @throws {RequiredError}
|
|
16405
17127
|
*/
|
|
16406
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>;
|
|
16407
17160
|
/**
|
|
16408
17161
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
16409
17162
|
* @summary Get Item Performance Analytics
|
|
@@ -16536,6 +17289,37 @@ export declare const ItemAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
16536
17289
|
* @throws {RequiredError}
|
|
16537
17290
|
*/
|
|
16538
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>>;
|
|
16539
17323
|
/**
|
|
16540
17324
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
16541
17325
|
* @summary Get Item Performance Analytics
|
|
@@ -16668,6 +17452,37 @@ export declare const ItemAnalyticsApiFactory: (configuration?: Configuration, ba
|
|
|
16668
17452
|
* @throws {RequiredError}
|
|
16669
17453
|
*/
|
|
16670
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>;
|
|
16671
17486
|
/**
|
|
16672
17487
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
16673
17488
|
* @summary Get Item Performance Analytics
|
|
@@ -16806,6 +17621,38 @@ export declare class ItemAnalyticsApi extends BaseAPI {
|
|
|
16806
17621
|
* @memberof ItemAnalyticsApi
|
|
16807
17622
|
*/
|
|
16808
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, {}>>;
|
|
16809
17656
|
/**
|
|
16810
17657
|
* Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
|
|
16811
17658
|
* @summary Get Item Performance Analytics
|
|
@@ -16908,6 +17755,29 @@ export declare const AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum: {
|
|
|
16908
17755
|
readonly Desc: "desc";
|
|
16909
17756
|
};
|
|
16910
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];
|
|
16911
17781
|
/**
|
|
16912
17782
|
* @export
|
|
16913
17783
|
*/
|