@seekora-ai/admin-api 1.0.52 → 1.0.54
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +90 -36
- package/dist/api.d.ts +90 -36
- package/dist/esm/api.d.ts +90 -36
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.54.tgz +0 -0
- package/seekora-ai-admin-api-1.0.52.tgz +0 -0
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @seekora-ai/admin-api@1.0.
|
|
1
|
+
## @seekora-ai/admin-api@1.0.54
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @seekora-ai/admin-api@1.0.
|
|
39
|
+
npm install @seekora-ai/admin-api@1.0.54 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -1588,25 +1588,25 @@ export interface AnalyticsExtendedKPIResponse {
|
|
|
1588
1588
|
* @type {string}
|
|
1589
1589
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1590
1590
|
*/
|
|
1591
|
-
'
|
|
1591
|
+
'orgcode'?: string;
|
|
1592
1592
|
/**
|
|
1593
1593
|
*
|
|
1594
1594
|
* @type {string}
|
|
1595
1595
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1596
1596
|
*/
|
|
1597
1597
|
'start_time'?: string;
|
|
1598
|
-
/**
|
|
1599
|
-
*
|
|
1600
|
-
* @type {string}
|
|
1601
|
-
* @memberof AnalyticsExtendedKPIResponse
|
|
1602
|
-
*/
|
|
1603
|
-
'store_id'?: string;
|
|
1604
1598
|
/**
|
|
1605
1599
|
* Can be KPIMetrics or ComparisonMetrics
|
|
1606
1600
|
* @type {object}
|
|
1607
1601
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1608
1602
|
*/
|
|
1609
1603
|
'summary'?: object;
|
|
1604
|
+
/**
|
|
1605
|
+
*
|
|
1606
|
+
* @type {string}
|
|
1607
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
1608
|
+
*/
|
|
1609
|
+
'xstoreid'?: string;
|
|
1610
1610
|
}
|
|
1611
1611
|
/**
|
|
1612
1612
|
*
|
|
@@ -1699,7 +1699,7 @@ export interface AnalyticsFilterAnalyticsResponse {
|
|
|
1699
1699
|
* @type {string}
|
|
1700
1700
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1701
1701
|
*/
|
|
1702
|
-
'
|
|
1702
|
+
'orgcode'?: string;
|
|
1703
1703
|
/**
|
|
1704
1704
|
*
|
|
1705
1705
|
* @type {number}
|
|
@@ -1732,16 +1732,16 @@ export interface AnalyticsFilterAnalyticsResponse {
|
|
|
1732
1732
|
'statistics'?: Array<AnalyticsFilterUsageStatistics>;
|
|
1733
1733
|
/**
|
|
1734
1734
|
*
|
|
1735
|
-
* @type {
|
|
1735
|
+
* @type {number}
|
|
1736
1736
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1737
1737
|
*/
|
|
1738
|
-
'
|
|
1738
|
+
'total'?: number;
|
|
1739
1739
|
/**
|
|
1740
1740
|
*
|
|
1741
|
-
* @type {
|
|
1741
|
+
* @type {string}
|
|
1742
1742
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1743
1743
|
*/
|
|
1744
|
-
'
|
|
1744
|
+
'xstoreid'?: string;
|
|
1745
1745
|
}
|
|
1746
1746
|
/**
|
|
1747
1747
|
*
|
|
@@ -1988,7 +1988,7 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
1988
1988
|
* @type {string}
|
|
1989
1989
|
* @memberof AnalyticsFilterTrendsResponse
|
|
1990
1990
|
*/
|
|
1991
|
-
'
|
|
1991
|
+
'orgcode'?: string;
|
|
1992
1992
|
/**
|
|
1993
1993
|
*
|
|
1994
1994
|
* @type {number}
|
|
@@ -2013,12 +2013,6 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
2013
2013
|
* @memberof AnalyticsFilterTrendsResponse
|
|
2014
2014
|
*/
|
|
2015
2015
|
'start_time'?: string;
|
|
2016
|
-
/**
|
|
2017
|
-
*
|
|
2018
|
-
* @type {string}
|
|
2019
|
-
* @memberof AnalyticsFilterTrendsResponse
|
|
2020
|
-
*/
|
|
2021
|
-
'store_id'?: string;
|
|
2022
2016
|
/**
|
|
2023
2017
|
*
|
|
2024
2018
|
* @type {number}
|
|
@@ -2037,6 +2031,12 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
2037
2031
|
* @memberof AnalyticsFilterTrendsResponse
|
|
2038
2032
|
*/
|
|
2039
2033
|
'trends'?: { [key: string]: Array<AnalyticsTimeSeriesPoint>; };
|
|
2034
|
+
/**
|
|
2035
|
+
*
|
|
2036
|
+
* @type {string}
|
|
2037
|
+
* @memberof AnalyticsFilterTrendsResponse
|
|
2038
|
+
*/
|
|
2039
|
+
'xstoreid'?: string;
|
|
2040
2040
|
}
|
|
2041
2041
|
/**
|
|
2042
2042
|
*
|
|
@@ -2634,7 +2634,7 @@ export interface AnalyticsGeoResponse {
|
|
|
2634
2634
|
* @type {string}
|
|
2635
2635
|
* @memberof AnalyticsGeoResponse
|
|
2636
2636
|
*/
|
|
2637
|
-
'
|
|
2637
|
+
'orgcode'?: string;
|
|
2638
2638
|
/**
|
|
2639
2639
|
*
|
|
2640
2640
|
* @type {number}
|
|
@@ -2649,16 +2649,16 @@ export interface AnalyticsGeoResponse {
|
|
|
2649
2649
|
'start_time'?: string;
|
|
2650
2650
|
/**
|
|
2651
2651
|
*
|
|
2652
|
-
* @type {
|
|
2652
|
+
* @type {number}
|
|
2653
2653
|
* @memberof AnalyticsGeoResponse
|
|
2654
2654
|
*/
|
|
2655
|
-
'
|
|
2655
|
+
'total'?: number;
|
|
2656
2656
|
/**
|
|
2657
2657
|
*
|
|
2658
|
-
* @type {
|
|
2658
|
+
* @type {string}
|
|
2659
2659
|
* @memberof AnalyticsGeoResponse
|
|
2660
2660
|
*/
|
|
2661
|
-
'
|
|
2661
|
+
'xstoreid'?: string;
|
|
2662
2662
|
}
|
|
2663
2663
|
/**
|
|
2664
2664
|
*
|
|
@@ -2738,6 +2738,12 @@ export interface AnalyticsGeoTopResult {
|
|
|
2738
2738
|
* @memberof AnalyticsGeoTopResult
|
|
2739
2739
|
*/
|
|
2740
2740
|
'share'?: number;
|
|
2741
|
+
/**
|
|
2742
|
+
* Widget display fields for UI presentation
|
|
2743
|
+
* @type {AnalyticsWidgetData}
|
|
2744
|
+
* @memberof AnalyticsGeoTopResult
|
|
2745
|
+
*/
|
|
2746
|
+
'widget'?: AnalyticsWidgetData;
|
|
2741
2747
|
}
|
|
2742
2748
|
/**
|
|
2743
2749
|
*
|
|
@@ -4028,42 +4034,90 @@ export interface AnalyticsKPIMetrics {
|
|
|
4028
4034
|
* @memberof AnalyticsKPIMetrics
|
|
4029
4035
|
*/
|
|
4030
4036
|
'add_to_cart_rate'?: number;
|
|
4037
|
+
/**
|
|
4038
|
+
* True if there are searches to calculate add to cart rate
|
|
4039
|
+
* @type {boolean}
|
|
4040
|
+
* @memberof AnalyticsKPIMetrics
|
|
4041
|
+
*/
|
|
4042
|
+
'add_to_cart_rate_has_data'?: boolean;
|
|
4031
4043
|
/**
|
|
4032
4044
|
*
|
|
4033
4045
|
* @type {number}
|
|
4034
4046
|
* @memberof AnalyticsKPIMetrics
|
|
4035
4047
|
*/
|
|
4036
4048
|
'avg_order_value'?: number;
|
|
4049
|
+
/**
|
|
4050
|
+
* True if there are purchases to calculate AOV
|
|
4051
|
+
* @type {boolean}
|
|
4052
|
+
* @memberof AnalyticsKPIMetrics
|
|
4053
|
+
*/
|
|
4054
|
+
'avg_order_value_has_data'?: boolean;
|
|
4037
4055
|
/**
|
|
4038
4056
|
*
|
|
4039
4057
|
* @type {number}
|
|
4040
4058
|
* @memberof AnalyticsKPIMetrics
|
|
4041
4059
|
*/
|
|
4042
4060
|
'click_through_rate'?: number;
|
|
4061
|
+
/**
|
|
4062
|
+
* True if there are searches to calculate CTR
|
|
4063
|
+
* @type {boolean}
|
|
4064
|
+
* @memberof AnalyticsKPIMetrics
|
|
4065
|
+
*/
|
|
4066
|
+
'click_through_rate_has_data'?: boolean;
|
|
4043
4067
|
/**
|
|
4044
4068
|
*
|
|
4045
4069
|
* @type {number}
|
|
4046
4070
|
* @memberof AnalyticsKPIMetrics
|
|
4047
4071
|
*/
|
|
4048
4072
|
'conversion_rate'?: number;
|
|
4073
|
+
/**
|
|
4074
|
+
* True if there are searches to calculate conversion rate
|
|
4075
|
+
* @type {boolean}
|
|
4076
|
+
* @memberof AnalyticsKPIMetrics
|
|
4077
|
+
*/
|
|
4078
|
+
'conversion_rate_has_data'?: boolean;
|
|
4079
|
+
/**
|
|
4080
|
+
* Indicates if there\'s enough data for rates calculation
|
|
4081
|
+
* @type {boolean}
|
|
4082
|
+
* @memberof AnalyticsKPIMetrics
|
|
4083
|
+
*/
|
|
4084
|
+
'has_data'?: boolean;
|
|
4049
4085
|
/**
|
|
4050
4086
|
*
|
|
4051
4087
|
* @type {number}
|
|
4052
4088
|
* @memberof AnalyticsKPIMetrics
|
|
4053
4089
|
*/
|
|
4054
4090
|
'no_clicks_rate'?: number;
|
|
4091
|
+
/**
|
|
4092
|
+
* True if there are searches to calculate no clicks rate
|
|
4093
|
+
* @type {boolean}
|
|
4094
|
+
* @memberof AnalyticsKPIMetrics
|
|
4095
|
+
*/
|
|
4096
|
+
'no_clicks_rate_has_data'?: boolean;
|
|
4055
4097
|
/**
|
|
4056
4098
|
*
|
|
4057
4099
|
* @type {number}
|
|
4058
4100
|
* @memberof AnalyticsKPIMetrics
|
|
4059
4101
|
*/
|
|
4060
4102
|
'no_results_rate'?: number;
|
|
4103
|
+
/**
|
|
4104
|
+
* Individual has_data flags for each rate
|
|
4105
|
+
* @type {boolean}
|
|
4106
|
+
* @memberof AnalyticsKPIMetrics
|
|
4107
|
+
*/
|
|
4108
|
+
'no_results_rate_has_data'?: boolean;
|
|
4061
4109
|
/**
|
|
4062
4110
|
*
|
|
4063
4111
|
* @type {number}
|
|
4064
4112
|
* @memberof AnalyticsKPIMetrics
|
|
4065
4113
|
*/
|
|
4066
4114
|
'purchase_rate'?: number;
|
|
4115
|
+
/**
|
|
4116
|
+
* True if there are searches to calculate purchase rate
|
|
4117
|
+
* @type {boolean}
|
|
4118
|
+
* @memberof AnalyticsKPIMetrics
|
|
4119
|
+
*/
|
|
4120
|
+
'purchase_rate_has_data'?: boolean;
|
|
4067
4121
|
/**
|
|
4068
4122
|
*
|
|
4069
4123
|
* @type {number}
|
|
@@ -5174,7 +5228,7 @@ export interface AnalyticsQueryResponse {
|
|
|
5174
5228
|
* @type {string}
|
|
5175
5229
|
* @memberof AnalyticsQueryResponse
|
|
5176
5230
|
*/
|
|
5177
|
-
'
|
|
5231
|
+
'orgcode'?: string;
|
|
5178
5232
|
/**
|
|
5179
5233
|
*
|
|
5180
5234
|
* @type {number}
|
|
@@ -5195,16 +5249,16 @@ export interface AnalyticsQueryResponse {
|
|
|
5195
5249
|
'start_time'?: string;
|
|
5196
5250
|
/**
|
|
5197
5251
|
*
|
|
5198
|
-
* @type {
|
|
5252
|
+
* @type {number}
|
|
5199
5253
|
* @memberof AnalyticsQueryResponse
|
|
5200
5254
|
*/
|
|
5201
|
-
'
|
|
5255
|
+
'total'?: number;
|
|
5202
5256
|
/**
|
|
5203
5257
|
*
|
|
5204
|
-
* @type {
|
|
5258
|
+
* @type {string}
|
|
5205
5259
|
* @memberof AnalyticsQueryResponse
|
|
5206
5260
|
*/
|
|
5207
|
-
'
|
|
5261
|
+
'xstoreid'?: string;
|
|
5208
5262
|
}
|
|
5209
5263
|
/**
|
|
5210
5264
|
*
|
|
@@ -5385,7 +5439,7 @@ export interface AnalyticsQuerySuggestionRecord {
|
|
|
5385
5439
|
* @type {string}
|
|
5386
5440
|
* @memberof AnalyticsQuerySuggestionRecord
|
|
5387
5441
|
*/
|
|
5388
|
-
'
|
|
5442
|
+
'orgcode'?: string;
|
|
5389
5443
|
/**
|
|
5390
5444
|
* For auto-generated: actual search count
|
|
5391
5445
|
* @type {number}
|
|
@@ -5416,12 +5470,6 @@ export interface AnalyticsQuerySuggestionRecord {
|
|
|
5416
5470
|
* @memberof AnalyticsQuerySuggestionRecord
|
|
5417
5471
|
*/
|
|
5418
5472
|
'status'?: AnalyticsQuerySuggestionStatus;
|
|
5419
|
-
/**
|
|
5420
|
-
*
|
|
5421
|
-
* @type {string}
|
|
5422
|
-
* @memberof AnalyticsQuerySuggestionRecord
|
|
5423
|
-
*/
|
|
5424
|
-
'store_id'?: string;
|
|
5425
5473
|
/**
|
|
5426
5474
|
* Custom tags
|
|
5427
5475
|
* @type {Array<string>}
|
|
@@ -5440,6 +5488,12 @@ export interface AnalyticsQuerySuggestionRecord {
|
|
|
5440
5488
|
* @memberof AnalyticsQuerySuggestionRecord
|
|
5441
5489
|
*/
|
|
5442
5490
|
'updated_by'?: number;
|
|
5491
|
+
/**
|
|
5492
|
+
*
|
|
5493
|
+
* @type {string}
|
|
5494
|
+
* @memberof AnalyticsQuerySuggestionRecord
|
|
5495
|
+
*/
|
|
5496
|
+
'xstoreid'?: string;
|
|
5443
5497
|
}
|
|
5444
5498
|
|
|
5445
5499
|
|
package/dist/api.d.ts
CHANGED
|
@@ -1582,25 +1582,25 @@ export interface AnalyticsExtendedKPIResponse {
|
|
|
1582
1582
|
* @type {string}
|
|
1583
1583
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1584
1584
|
*/
|
|
1585
|
-
'
|
|
1585
|
+
'orgcode'?: string;
|
|
1586
1586
|
/**
|
|
1587
1587
|
*
|
|
1588
1588
|
* @type {string}
|
|
1589
1589
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1590
1590
|
*/
|
|
1591
1591
|
'start_time'?: string;
|
|
1592
|
-
/**
|
|
1593
|
-
*
|
|
1594
|
-
* @type {string}
|
|
1595
|
-
* @memberof AnalyticsExtendedKPIResponse
|
|
1596
|
-
*/
|
|
1597
|
-
'store_id'?: string;
|
|
1598
1592
|
/**
|
|
1599
1593
|
* Can be KPIMetrics or ComparisonMetrics
|
|
1600
1594
|
* @type {object}
|
|
1601
1595
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1602
1596
|
*/
|
|
1603
1597
|
'summary'?: object;
|
|
1598
|
+
/**
|
|
1599
|
+
*
|
|
1600
|
+
* @type {string}
|
|
1601
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
1602
|
+
*/
|
|
1603
|
+
'xstoreid'?: string;
|
|
1604
1604
|
}
|
|
1605
1605
|
/**
|
|
1606
1606
|
*
|
|
@@ -1693,7 +1693,7 @@ export interface AnalyticsFilterAnalyticsResponse {
|
|
|
1693
1693
|
* @type {string}
|
|
1694
1694
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1695
1695
|
*/
|
|
1696
|
-
'
|
|
1696
|
+
'orgcode'?: string;
|
|
1697
1697
|
/**
|
|
1698
1698
|
*
|
|
1699
1699
|
* @type {number}
|
|
@@ -1726,16 +1726,16 @@ export interface AnalyticsFilterAnalyticsResponse {
|
|
|
1726
1726
|
'statistics'?: Array<AnalyticsFilterUsageStatistics>;
|
|
1727
1727
|
/**
|
|
1728
1728
|
*
|
|
1729
|
-
* @type {
|
|
1729
|
+
* @type {number}
|
|
1730
1730
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1731
1731
|
*/
|
|
1732
|
-
'
|
|
1732
|
+
'total'?: number;
|
|
1733
1733
|
/**
|
|
1734
1734
|
*
|
|
1735
|
-
* @type {
|
|
1735
|
+
* @type {string}
|
|
1736
1736
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1737
1737
|
*/
|
|
1738
|
-
'
|
|
1738
|
+
'xstoreid'?: string;
|
|
1739
1739
|
}
|
|
1740
1740
|
/**
|
|
1741
1741
|
*
|
|
@@ -1982,7 +1982,7 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
1982
1982
|
* @type {string}
|
|
1983
1983
|
* @memberof AnalyticsFilterTrendsResponse
|
|
1984
1984
|
*/
|
|
1985
|
-
'
|
|
1985
|
+
'orgcode'?: string;
|
|
1986
1986
|
/**
|
|
1987
1987
|
*
|
|
1988
1988
|
* @type {number}
|
|
@@ -2007,12 +2007,6 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
2007
2007
|
* @memberof AnalyticsFilterTrendsResponse
|
|
2008
2008
|
*/
|
|
2009
2009
|
'start_time'?: string;
|
|
2010
|
-
/**
|
|
2011
|
-
*
|
|
2012
|
-
* @type {string}
|
|
2013
|
-
* @memberof AnalyticsFilterTrendsResponse
|
|
2014
|
-
*/
|
|
2015
|
-
'store_id'?: string;
|
|
2016
2010
|
/**
|
|
2017
2011
|
*
|
|
2018
2012
|
* @type {number}
|
|
@@ -2033,6 +2027,12 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
2033
2027
|
'trends'?: {
|
|
2034
2028
|
[key: string]: Array<AnalyticsTimeSeriesPoint>;
|
|
2035
2029
|
};
|
|
2030
|
+
/**
|
|
2031
|
+
*
|
|
2032
|
+
* @type {string}
|
|
2033
|
+
* @memberof AnalyticsFilterTrendsResponse
|
|
2034
|
+
*/
|
|
2035
|
+
'xstoreid'?: string;
|
|
2036
2036
|
}
|
|
2037
2037
|
/**
|
|
2038
2038
|
*
|
|
@@ -2630,7 +2630,7 @@ export interface AnalyticsGeoResponse {
|
|
|
2630
2630
|
* @type {string}
|
|
2631
2631
|
* @memberof AnalyticsGeoResponse
|
|
2632
2632
|
*/
|
|
2633
|
-
'
|
|
2633
|
+
'orgcode'?: string;
|
|
2634
2634
|
/**
|
|
2635
2635
|
*
|
|
2636
2636
|
* @type {number}
|
|
@@ -2645,16 +2645,16 @@ export interface AnalyticsGeoResponse {
|
|
|
2645
2645
|
'start_time'?: string;
|
|
2646
2646
|
/**
|
|
2647
2647
|
*
|
|
2648
|
-
* @type {
|
|
2648
|
+
* @type {number}
|
|
2649
2649
|
* @memberof AnalyticsGeoResponse
|
|
2650
2650
|
*/
|
|
2651
|
-
'
|
|
2651
|
+
'total'?: number;
|
|
2652
2652
|
/**
|
|
2653
2653
|
*
|
|
2654
|
-
* @type {
|
|
2654
|
+
* @type {string}
|
|
2655
2655
|
* @memberof AnalyticsGeoResponse
|
|
2656
2656
|
*/
|
|
2657
|
-
'
|
|
2657
|
+
'xstoreid'?: string;
|
|
2658
2658
|
}
|
|
2659
2659
|
/**
|
|
2660
2660
|
*
|
|
@@ -2734,6 +2734,12 @@ export interface AnalyticsGeoTopResult {
|
|
|
2734
2734
|
* @memberof AnalyticsGeoTopResult
|
|
2735
2735
|
*/
|
|
2736
2736
|
'share'?: number;
|
|
2737
|
+
/**
|
|
2738
|
+
* Widget display fields for UI presentation
|
|
2739
|
+
* @type {AnalyticsWidgetData}
|
|
2740
|
+
* @memberof AnalyticsGeoTopResult
|
|
2741
|
+
*/
|
|
2742
|
+
'widget'?: AnalyticsWidgetData;
|
|
2737
2743
|
}
|
|
2738
2744
|
/**
|
|
2739
2745
|
*
|
|
@@ -4026,42 +4032,90 @@ export interface AnalyticsKPIMetrics {
|
|
|
4026
4032
|
* @memberof AnalyticsKPIMetrics
|
|
4027
4033
|
*/
|
|
4028
4034
|
'add_to_cart_rate'?: number;
|
|
4035
|
+
/**
|
|
4036
|
+
* True if there are searches to calculate add to cart rate
|
|
4037
|
+
* @type {boolean}
|
|
4038
|
+
* @memberof AnalyticsKPIMetrics
|
|
4039
|
+
*/
|
|
4040
|
+
'add_to_cart_rate_has_data'?: boolean;
|
|
4029
4041
|
/**
|
|
4030
4042
|
*
|
|
4031
4043
|
* @type {number}
|
|
4032
4044
|
* @memberof AnalyticsKPIMetrics
|
|
4033
4045
|
*/
|
|
4034
4046
|
'avg_order_value'?: number;
|
|
4047
|
+
/**
|
|
4048
|
+
* True if there are purchases to calculate AOV
|
|
4049
|
+
* @type {boolean}
|
|
4050
|
+
* @memberof AnalyticsKPIMetrics
|
|
4051
|
+
*/
|
|
4052
|
+
'avg_order_value_has_data'?: boolean;
|
|
4035
4053
|
/**
|
|
4036
4054
|
*
|
|
4037
4055
|
* @type {number}
|
|
4038
4056
|
* @memberof AnalyticsKPIMetrics
|
|
4039
4057
|
*/
|
|
4040
4058
|
'click_through_rate'?: number;
|
|
4059
|
+
/**
|
|
4060
|
+
* True if there are searches to calculate CTR
|
|
4061
|
+
* @type {boolean}
|
|
4062
|
+
* @memberof AnalyticsKPIMetrics
|
|
4063
|
+
*/
|
|
4064
|
+
'click_through_rate_has_data'?: boolean;
|
|
4041
4065
|
/**
|
|
4042
4066
|
*
|
|
4043
4067
|
* @type {number}
|
|
4044
4068
|
* @memberof AnalyticsKPIMetrics
|
|
4045
4069
|
*/
|
|
4046
4070
|
'conversion_rate'?: number;
|
|
4071
|
+
/**
|
|
4072
|
+
* True if there are searches to calculate conversion rate
|
|
4073
|
+
* @type {boolean}
|
|
4074
|
+
* @memberof AnalyticsKPIMetrics
|
|
4075
|
+
*/
|
|
4076
|
+
'conversion_rate_has_data'?: boolean;
|
|
4077
|
+
/**
|
|
4078
|
+
* Indicates if there\'s enough data for rates calculation
|
|
4079
|
+
* @type {boolean}
|
|
4080
|
+
* @memberof AnalyticsKPIMetrics
|
|
4081
|
+
*/
|
|
4082
|
+
'has_data'?: boolean;
|
|
4047
4083
|
/**
|
|
4048
4084
|
*
|
|
4049
4085
|
* @type {number}
|
|
4050
4086
|
* @memberof AnalyticsKPIMetrics
|
|
4051
4087
|
*/
|
|
4052
4088
|
'no_clicks_rate'?: number;
|
|
4089
|
+
/**
|
|
4090
|
+
* True if there are searches to calculate no clicks rate
|
|
4091
|
+
* @type {boolean}
|
|
4092
|
+
* @memberof AnalyticsKPIMetrics
|
|
4093
|
+
*/
|
|
4094
|
+
'no_clicks_rate_has_data'?: boolean;
|
|
4053
4095
|
/**
|
|
4054
4096
|
*
|
|
4055
4097
|
* @type {number}
|
|
4056
4098
|
* @memberof AnalyticsKPIMetrics
|
|
4057
4099
|
*/
|
|
4058
4100
|
'no_results_rate'?: number;
|
|
4101
|
+
/**
|
|
4102
|
+
* Individual has_data flags for each rate
|
|
4103
|
+
* @type {boolean}
|
|
4104
|
+
* @memberof AnalyticsKPIMetrics
|
|
4105
|
+
*/
|
|
4106
|
+
'no_results_rate_has_data'?: boolean;
|
|
4059
4107
|
/**
|
|
4060
4108
|
*
|
|
4061
4109
|
* @type {number}
|
|
4062
4110
|
* @memberof AnalyticsKPIMetrics
|
|
4063
4111
|
*/
|
|
4064
4112
|
'purchase_rate'?: number;
|
|
4113
|
+
/**
|
|
4114
|
+
* True if there are searches to calculate purchase rate
|
|
4115
|
+
* @type {boolean}
|
|
4116
|
+
* @memberof AnalyticsKPIMetrics
|
|
4117
|
+
*/
|
|
4118
|
+
'purchase_rate_has_data'?: boolean;
|
|
4065
4119
|
/**
|
|
4066
4120
|
*
|
|
4067
4121
|
* @type {number}
|
|
@@ -5174,7 +5228,7 @@ export interface AnalyticsQueryResponse {
|
|
|
5174
5228
|
* @type {string}
|
|
5175
5229
|
* @memberof AnalyticsQueryResponse
|
|
5176
5230
|
*/
|
|
5177
|
-
'
|
|
5231
|
+
'orgcode'?: string;
|
|
5178
5232
|
/**
|
|
5179
5233
|
*
|
|
5180
5234
|
* @type {number}
|
|
@@ -5195,16 +5249,16 @@ export interface AnalyticsQueryResponse {
|
|
|
5195
5249
|
'start_time'?: string;
|
|
5196
5250
|
/**
|
|
5197
5251
|
*
|
|
5198
|
-
* @type {
|
|
5252
|
+
* @type {number}
|
|
5199
5253
|
* @memberof AnalyticsQueryResponse
|
|
5200
5254
|
*/
|
|
5201
|
-
'
|
|
5255
|
+
'total'?: number;
|
|
5202
5256
|
/**
|
|
5203
5257
|
*
|
|
5204
|
-
* @type {
|
|
5258
|
+
* @type {string}
|
|
5205
5259
|
* @memberof AnalyticsQueryResponse
|
|
5206
5260
|
*/
|
|
5207
|
-
'
|
|
5261
|
+
'xstoreid'?: string;
|
|
5208
5262
|
}
|
|
5209
5263
|
/**
|
|
5210
5264
|
*
|
|
@@ -5393,7 +5447,7 @@ export interface AnalyticsQuerySuggestionRecord {
|
|
|
5393
5447
|
* @type {string}
|
|
5394
5448
|
* @memberof AnalyticsQuerySuggestionRecord
|
|
5395
5449
|
*/
|
|
5396
|
-
'
|
|
5450
|
+
'orgcode'?: string;
|
|
5397
5451
|
/**
|
|
5398
5452
|
* For auto-generated: actual search count
|
|
5399
5453
|
* @type {number}
|
|
@@ -5424,12 +5478,6 @@ export interface AnalyticsQuerySuggestionRecord {
|
|
|
5424
5478
|
* @memberof AnalyticsQuerySuggestionRecord
|
|
5425
5479
|
*/
|
|
5426
5480
|
'status'?: AnalyticsQuerySuggestionStatus;
|
|
5427
|
-
/**
|
|
5428
|
-
*
|
|
5429
|
-
* @type {string}
|
|
5430
|
-
* @memberof AnalyticsQuerySuggestionRecord
|
|
5431
|
-
*/
|
|
5432
|
-
'store_id'?: string;
|
|
5433
5481
|
/**
|
|
5434
5482
|
* Custom tags
|
|
5435
5483
|
* @type {Array<string>}
|
|
@@ -5448,6 +5496,12 @@ export interface AnalyticsQuerySuggestionRecord {
|
|
|
5448
5496
|
* @memberof AnalyticsQuerySuggestionRecord
|
|
5449
5497
|
*/
|
|
5450
5498
|
'updated_by'?: number;
|
|
5499
|
+
/**
|
|
5500
|
+
*
|
|
5501
|
+
* @type {string}
|
|
5502
|
+
* @memberof AnalyticsQuerySuggestionRecord
|
|
5503
|
+
*/
|
|
5504
|
+
'xstoreid'?: string;
|
|
5451
5505
|
}
|
|
5452
5506
|
/**
|
|
5453
5507
|
*
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -1582,25 +1582,25 @@ export interface AnalyticsExtendedKPIResponse {
|
|
|
1582
1582
|
* @type {string}
|
|
1583
1583
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1584
1584
|
*/
|
|
1585
|
-
'
|
|
1585
|
+
'orgcode'?: string;
|
|
1586
1586
|
/**
|
|
1587
1587
|
*
|
|
1588
1588
|
* @type {string}
|
|
1589
1589
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1590
1590
|
*/
|
|
1591
1591
|
'start_time'?: string;
|
|
1592
|
-
/**
|
|
1593
|
-
*
|
|
1594
|
-
* @type {string}
|
|
1595
|
-
* @memberof AnalyticsExtendedKPIResponse
|
|
1596
|
-
*/
|
|
1597
|
-
'store_id'?: string;
|
|
1598
1592
|
/**
|
|
1599
1593
|
* Can be KPIMetrics or ComparisonMetrics
|
|
1600
1594
|
* @type {object}
|
|
1601
1595
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1602
1596
|
*/
|
|
1603
1597
|
'summary'?: object;
|
|
1598
|
+
/**
|
|
1599
|
+
*
|
|
1600
|
+
* @type {string}
|
|
1601
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
1602
|
+
*/
|
|
1603
|
+
'xstoreid'?: string;
|
|
1604
1604
|
}
|
|
1605
1605
|
/**
|
|
1606
1606
|
*
|
|
@@ -1693,7 +1693,7 @@ export interface AnalyticsFilterAnalyticsResponse {
|
|
|
1693
1693
|
* @type {string}
|
|
1694
1694
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1695
1695
|
*/
|
|
1696
|
-
'
|
|
1696
|
+
'orgcode'?: string;
|
|
1697
1697
|
/**
|
|
1698
1698
|
*
|
|
1699
1699
|
* @type {number}
|
|
@@ -1726,16 +1726,16 @@ export interface AnalyticsFilterAnalyticsResponse {
|
|
|
1726
1726
|
'statistics'?: Array<AnalyticsFilterUsageStatistics>;
|
|
1727
1727
|
/**
|
|
1728
1728
|
*
|
|
1729
|
-
* @type {
|
|
1729
|
+
* @type {number}
|
|
1730
1730
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1731
1731
|
*/
|
|
1732
|
-
'
|
|
1732
|
+
'total'?: number;
|
|
1733
1733
|
/**
|
|
1734
1734
|
*
|
|
1735
|
-
* @type {
|
|
1735
|
+
* @type {string}
|
|
1736
1736
|
* @memberof AnalyticsFilterAnalyticsResponse
|
|
1737
1737
|
*/
|
|
1738
|
-
'
|
|
1738
|
+
'xstoreid'?: string;
|
|
1739
1739
|
}
|
|
1740
1740
|
/**
|
|
1741
1741
|
*
|
|
@@ -1982,7 +1982,7 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
1982
1982
|
* @type {string}
|
|
1983
1983
|
* @memberof AnalyticsFilterTrendsResponse
|
|
1984
1984
|
*/
|
|
1985
|
-
'
|
|
1985
|
+
'orgcode'?: string;
|
|
1986
1986
|
/**
|
|
1987
1987
|
*
|
|
1988
1988
|
* @type {number}
|
|
@@ -2007,12 +2007,6 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
2007
2007
|
* @memberof AnalyticsFilterTrendsResponse
|
|
2008
2008
|
*/
|
|
2009
2009
|
'start_time'?: string;
|
|
2010
|
-
/**
|
|
2011
|
-
*
|
|
2012
|
-
* @type {string}
|
|
2013
|
-
* @memberof AnalyticsFilterTrendsResponse
|
|
2014
|
-
*/
|
|
2015
|
-
'store_id'?: string;
|
|
2016
2010
|
/**
|
|
2017
2011
|
*
|
|
2018
2012
|
* @type {number}
|
|
@@ -2033,6 +2027,12 @@ export interface AnalyticsFilterTrendsResponse {
|
|
|
2033
2027
|
'trends'?: {
|
|
2034
2028
|
[key: string]: Array<AnalyticsTimeSeriesPoint>;
|
|
2035
2029
|
};
|
|
2030
|
+
/**
|
|
2031
|
+
*
|
|
2032
|
+
* @type {string}
|
|
2033
|
+
* @memberof AnalyticsFilterTrendsResponse
|
|
2034
|
+
*/
|
|
2035
|
+
'xstoreid'?: string;
|
|
2036
2036
|
}
|
|
2037
2037
|
/**
|
|
2038
2038
|
*
|
|
@@ -2630,7 +2630,7 @@ export interface AnalyticsGeoResponse {
|
|
|
2630
2630
|
* @type {string}
|
|
2631
2631
|
* @memberof AnalyticsGeoResponse
|
|
2632
2632
|
*/
|
|
2633
|
-
'
|
|
2633
|
+
'orgcode'?: string;
|
|
2634
2634
|
/**
|
|
2635
2635
|
*
|
|
2636
2636
|
* @type {number}
|
|
@@ -2645,16 +2645,16 @@ export interface AnalyticsGeoResponse {
|
|
|
2645
2645
|
'start_time'?: string;
|
|
2646
2646
|
/**
|
|
2647
2647
|
*
|
|
2648
|
-
* @type {
|
|
2648
|
+
* @type {number}
|
|
2649
2649
|
* @memberof AnalyticsGeoResponse
|
|
2650
2650
|
*/
|
|
2651
|
-
'
|
|
2651
|
+
'total'?: number;
|
|
2652
2652
|
/**
|
|
2653
2653
|
*
|
|
2654
|
-
* @type {
|
|
2654
|
+
* @type {string}
|
|
2655
2655
|
* @memberof AnalyticsGeoResponse
|
|
2656
2656
|
*/
|
|
2657
|
-
'
|
|
2657
|
+
'xstoreid'?: string;
|
|
2658
2658
|
}
|
|
2659
2659
|
/**
|
|
2660
2660
|
*
|
|
@@ -2734,6 +2734,12 @@ export interface AnalyticsGeoTopResult {
|
|
|
2734
2734
|
* @memberof AnalyticsGeoTopResult
|
|
2735
2735
|
*/
|
|
2736
2736
|
'share'?: number;
|
|
2737
|
+
/**
|
|
2738
|
+
* Widget display fields for UI presentation
|
|
2739
|
+
* @type {AnalyticsWidgetData}
|
|
2740
|
+
* @memberof AnalyticsGeoTopResult
|
|
2741
|
+
*/
|
|
2742
|
+
'widget'?: AnalyticsWidgetData;
|
|
2737
2743
|
}
|
|
2738
2744
|
/**
|
|
2739
2745
|
*
|
|
@@ -4026,42 +4032,90 @@ export interface AnalyticsKPIMetrics {
|
|
|
4026
4032
|
* @memberof AnalyticsKPIMetrics
|
|
4027
4033
|
*/
|
|
4028
4034
|
'add_to_cart_rate'?: number;
|
|
4035
|
+
/**
|
|
4036
|
+
* True if there are searches to calculate add to cart rate
|
|
4037
|
+
* @type {boolean}
|
|
4038
|
+
* @memberof AnalyticsKPIMetrics
|
|
4039
|
+
*/
|
|
4040
|
+
'add_to_cart_rate_has_data'?: boolean;
|
|
4029
4041
|
/**
|
|
4030
4042
|
*
|
|
4031
4043
|
* @type {number}
|
|
4032
4044
|
* @memberof AnalyticsKPIMetrics
|
|
4033
4045
|
*/
|
|
4034
4046
|
'avg_order_value'?: number;
|
|
4047
|
+
/**
|
|
4048
|
+
* True if there are purchases to calculate AOV
|
|
4049
|
+
* @type {boolean}
|
|
4050
|
+
* @memberof AnalyticsKPIMetrics
|
|
4051
|
+
*/
|
|
4052
|
+
'avg_order_value_has_data'?: boolean;
|
|
4035
4053
|
/**
|
|
4036
4054
|
*
|
|
4037
4055
|
* @type {number}
|
|
4038
4056
|
* @memberof AnalyticsKPIMetrics
|
|
4039
4057
|
*/
|
|
4040
4058
|
'click_through_rate'?: number;
|
|
4059
|
+
/**
|
|
4060
|
+
* True if there are searches to calculate CTR
|
|
4061
|
+
* @type {boolean}
|
|
4062
|
+
* @memberof AnalyticsKPIMetrics
|
|
4063
|
+
*/
|
|
4064
|
+
'click_through_rate_has_data'?: boolean;
|
|
4041
4065
|
/**
|
|
4042
4066
|
*
|
|
4043
4067
|
* @type {number}
|
|
4044
4068
|
* @memberof AnalyticsKPIMetrics
|
|
4045
4069
|
*/
|
|
4046
4070
|
'conversion_rate'?: number;
|
|
4071
|
+
/**
|
|
4072
|
+
* True if there are searches to calculate conversion rate
|
|
4073
|
+
* @type {boolean}
|
|
4074
|
+
* @memberof AnalyticsKPIMetrics
|
|
4075
|
+
*/
|
|
4076
|
+
'conversion_rate_has_data'?: boolean;
|
|
4077
|
+
/**
|
|
4078
|
+
* Indicates if there\'s enough data for rates calculation
|
|
4079
|
+
* @type {boolean}
|
|
4080
|
+
* @memberof AnalyticsKPIMetrics
|
|
4081
|
+
*/
|
|
4082
|
+
'has_data'?: boolean;
|
|
4047
4083
|
/**
|
|
4048
4084
|
*
|
|
4049
4085
|
* @type {number}
|
|
4050
4086
|
* @memberof AnalyticsKPIMetrics
|
|
4051
4087
|
*/
|
|
4052
4088
|
'no_clicks_rate'?: number;
|
|
4089
|
+
/**
|
|
4090
|
+
* True if there are searches to calculate no clicks rate
|
|
4091
|
+
* @type {boolean}
|
|
4092
|
+
* @memberof AnalyticsKPIMetrics
|
|
4093
|
+
*/
|
|
4094
|
+
'no_clicks_rate_has_data'?: boolean;
|
|
4053
4095
|
/**
|
|
4054
4096
|
*
|
|
4055
4097
|
* @type {number}
|
|
4056
4098
|
* @memberof AnalyticsKPIMetrics
|
|
4057
4099
|
*/
|
|
4058
4100
|
'no_results_rate'?: number;
|
|
4101
|
+
/**
|
|
4102
|
+
* Individual has_data flags for each rate
|
|
4103
|
+
* @type {boolean}
|
|
4104
|
+
* @memberof AnalyticsKPIMetrics
|
|
4105
|
+
*/
|
|
4106
|
+
'no_results_rate_has_data'?: boolean;
|
|
4059
4107
|
/**
|
|
4060
4108
|
*
|
|
4061
4109
|
* @type {number}
|
|
4062
4110
|
* @memberof AnalyticsKPIMetrics
|
|
4063
4111
|
*/
|
|
4064
4112
|
'purchase_rate'?: number;
|
|
4113
|
+
/**
|
|
4114
|
+
* True if there are searches to calculate purchase rate
|
|
4115
|
+
* @type {boolean}
|
|
4116
|
+
* @memberof AnalyticsKPIMetrics
|
|
4117
|
+
*/
|
|
4118
|
+
'purchase_rate_has_data'?: boolean;
|
|
4065
4119
|
/**
|
|
4066
4120
|
*
|
|
4067
4121
|
* @type {number}
|
|
@@ -5174,7 +5228,7 @@ export interface AnalyticsQueryResponse {
|
|
|
5174
5228
|
* @type {string}
|
|
5175
5229
|
* @memberof AnalyticsQueryResponse
|
|
5176
5230
|
*/
|
|
5177
|
-
'
|
|
5231
|
+
'orgcode'?: string;
|
|
5178
5232
|
/**
|
|
5179
5233
|
*
|
|
5180
5234
|
* @type {number}
|
|
@@ -5195,16 +5249,16 @@ export interface AnalyticsQueryResponse {
|
|
|
5195
5249
|
'start_time'?: string;
|
|
5196
5250
|
/**
|
|
5197
5251
|
*
|
|
5198
|
-
* @type {
|
|
5252
|
+
* @type {number}
|
|
5199
5253
|
* @memberof AnalyticsQueryResponse
|
|
5200
5254
|
*/
|
|
5201
|
-
'
|
|
5255
|
+
'total'?: number;
|
|
5202
5256
|
/**
|
|
5203
5257
|
*
|
|
5204
|
-
* @type {
|
|
5258
|
+
* @type {string}
|
|
5205
5259
|
* @memberof AnalyticsQueryResponse
|
|
5206
5260
|
*/
|
|
5207
|
-
'
|
|
5261
|
+
'xstoreid'?: string;
|
|
5208
5262
|
}
|
|
5209
5263
|
/**
|
|
5210
5264
|
*
|
|
@@ -5393,7 +5447,7 @@ export interface AnalyticsQuerySuggestionRecord {
|
|
|
5393
5447
|
* @type {string}
|
|
5394
5448
|
* @memberof AnalyticsQuerySuggestionRecord
|
|
5395
5449
|
*/
|
|
5396
|
-
'
|
|
5450
|
+
'orgcode'?: string;
|
|
5397
5451
|
/**
|
|
5398
5452
|
* For auto-generated: actual search count
|
|
5399
5453
|
* @type {number}
|
|
@@ -5424,12 +5478,6 @@ export interface AnalyticsQuerySuggestionRecord {
|
|
|
5424
5478
|
* @memberof AnalyticsQuerySuggestionRecord
|
|
5425
5479
|
*/
|
|
5426
5480
|
'status'?: AnalyticsQuerySuggestionStatus;
|
|
5427
|
-
/**
|
|
5428
|
-
*
|
|
5429
|
-
* @type {string}
|
|
5430
|
-
* @memberof AnalyticsQuerySuggestionRecord
|
|
5431
|
-
*/
|
|
5432
|
-
'store_id'?: string;
|
|
5433
5481
|
/**
|
|
5434
5482
|
* Custom tags
|
|
5435
5483
|
* @type {Array<string>}
|
|
@@ -5448,6 +5496,12 @@ export interface AnalyticsQuerySuggestionRecord {
|
|
|
5448
5496
|
* @memberof AnalyticsQuerySuggestionRecord
|
|
5449
5497
|
*/
|
|
5450
5498
|
'updated_by'?: number;
|
|
5499
|
+
/**
|
|
5500
|
+
*
|
|
5501
|
+
* @type {string}
|
|
5502
|
+
* @memberof AnalyticsQuerySuggestionRecord
|
|
5503
|
+
*/
|
|
5504
|
+
'xstoreid'?: string;
|
|
5451
5505
|
}
|
|
5452
5506
|
/**
|
|
5453
5507
|
*
|
package/package.json
CHANGED
|
Binary file
|
|
Binary file
|