@pushwoosh/rpc-v2-http-api-data 0.1.434 → 0.1.435

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/data.js CHANGED
@@ -17470,6 +17470,24 @@ export const data = {
17470
17470
  "method": "delete",
17471
17471
  "path": "/api/statistics_dashboards_widgets/{code}"
17472
17472
  },
17473
+ "GetLinearChartMetrics": {
17474
+ "request": "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetLinearChartMetricsRequest",
17475
+ "response": "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetLinearChartMetricsResponse",
17476
+ "method": "post",
17477
+ "path": "/api/statistics_dashboards_widgets/get_linear_chart_metrics"
17478
+ },
17479
+ "GetTotalsChartMetrics": {
17480
+ "request": "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetTotalsChartMetricsRequest",
17481
+ "response": "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetTotalsChartMetricsResponse",
17482
+ "method": "post",
17483
+ "path": "/api/statistics_dashboards_widgets/get_totals_chart_metrics"
17484
+ },
17485
+ "GetFunnel": {
17486
+ "request": "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetFunnelRequest",
17487
+ "response": "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetFunnelResponse",
17488
+ "method": "post",
17489
+ "path": "/api/statistics_dashboards_widgets/get_funnel"
17490
+ },
17473
17491
  "GetCategoryTree": {
17474
17492
  "request": "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetCategoryTreeRequest",
17475
17493
  "response": "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetCategoryTreeResponse",
@@ -17603,6 +17621,356 @@ export const data = {
17603
17621
  "type": "I",
17604
17622
  "fields": {}
17605
17623
  },
17624
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.TimeInterval": {
17625
+ "type": "E",
17626
+ "values": [
17627
+ "TIME_INTERVAL_UNSPECIFIED",
17628
+ "HOUR",
17629
+ "DAY",
17630
+ "WEEK",
17631
+ "MONTH",
17632
+ "MINUTE"
17633
+ ]
17634
+ },
17635
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.Breakdown": {
17636
+ "type": "E",
17637
+ "values": [
17638
+ "BREAKDOWN_UNKNOWN",
17639
+ "PLATFORMS",
17640
+ "EVENT_ATTRIBUTE",
17641
+ "TAG_VALUES"
17642
+ ]
17643
+ },
17644
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.MathOperator": {
17645
+ "type": "E",
17646
+ "values": [
17647
+ "MATH_OPERATOR_UNSPECIFIED",
17648
+ "EQ",
17649
+ "NOT_EQ",
17650
+ "GTE",
17651
+ "LTE",
17652
+ "BETWEEN",
17653
+ "IN",
17654
+ "NOT_IN",
17655
+ "ANY",
17656
+ "NOT_SET"
17657
+ ]
17658
+ },
17659
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.Value": {
17660
+ "type": "I",
17661
+ "fields": {
17662
+ "string": {
17663
+ "type": "string"
17664
+ },
17665
+ "integer": {
17666
+ "type": "number"
17667
+ },
17668
+ "decimal": {
17669
+ "type": "number"
17670
+ },
17671
+ "boolean": {
17672
+ "type": "boolean"
17673
+ },
17674
+ "list": {
17675
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.List"
17676
+ },
17677
+ "date": {
17678
+ "type": "Date"
17679
+ }
17680
+ },
17681
+ "oneofs": {
17682
+ "kind": {
17683
+ "oneof": [
17684
+ "string",
17685
+ "integer",
17686
+ "decimal",
17687
+ "boolean",
17688
+ "list",
17689
+ "date"
17690
+ ]
17691
+ }
17692
+ }
17693
+ },
17694
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.List": {
17695
+ "type": "I",
17696
+ "fields": {
17697
+ "values": {
17698
+ "type": "string",
17699
+ "array": true
17700
+ }
17701
+ }
17702
+ },
17703
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.AttributeCondition": {
17704
+ "type": "I",
17705
+ "fields": {
17706
+ "name": {
17707
+ "type": "string"
17708
+ },
17709
+ "operator": {
17710
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.MathOperator"
17711
+ },
17712
+ "values": {
17713
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.Value",
17714
+ "array": true
17715
+ }
17716
+ }
17717
+ },
17718
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.Metric": {
17719
+ "type": "I",
17720
+ "fields": {
17721
+ "id": {
17722
+ "type": "number"
17723
+ },
17724
+ "eventName": {
17725
+ "type": "string"
17726
+ },
17727
+ "attributeConditions": {
17728
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.AttributeCondition",
17729
+ "array": true
17730
+ },
17731
+ "tag": {
17732
+ "type": "string"
17733
+ }
17734
+ }
17735
+ },
17736
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.ChartParams.TypeFilter": {
17737
+ "type": "E",
17738
+ "values": [
17739
+ "Platform",
17740
+ "Segment",
17741
+ "Push",
17742
+ "Email",
17743
+ "Campaign",
17744
+ "Journey"
17745
+ ]
17746
+ },
17747
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.ChartParams.TimeRange": {
17748
+ "type": "I",
17749
+ "fields": {
17750
+ "from": {
17751
+ "type": "Date"
17752
+ },
17753
+ "to": {
17754
+ "type": "Date"
17755
+ },
17756
+ "interval": {
17757
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.TimeInterval"
17758
+ }
17759
+ }
17760
+ },
17761
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.ChartParams.Filters": {
17762
+ "type": "I",
17763
+ "fields": {
17764
+ "platforms": {
17765
+ "type": "number",
17766
+ "array": true
17767
+ },
17768
+ "messagesIds": {
17769
+ "type": "number",
17770
+ "array": true
17771
+ },
17772
+ "campaignsCodes": {
17773
+ "type": "string",
17774
+ "array": true
17775
+ },
17776
+ "attributeConditions": {
17777
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.AttributeCondition",
17778
+ "array": true
17779
+ },
17780
+ "segment": {
17781
+ "type": "string"
17782
+ }
17783
+ }
17784
+ },
17785
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.ChartParams.Filter": {
17786
+ "type": "I",
17787
+ "fields": {
17788
+ "type": {
17789
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.ChartParams.TypeFilter"
17790
+ },
17791
+ "platforms": {
17792
+ "type": "number",
17793
+ "array": true
17794
+ },
17795
+ "segment": {
17796
+ "type": "string"
17797
+ },
17798
+ "pushId": {
17799
+ "type": "number"
17800
+ },
17801
+ "emailId": {
17802
+ "type": "number"
17803
+ },
17804
+ "campaign": {
17805
+ "type": "string"
17806
+ },
17807
+ "journey": {
17808
+ "type": "string"
17809
+ },
17810
+ "jPoints": {
17811
+ "type": "string",
17812
+ "array": true
17813
+ }
17814
+ }
17815
+ },
17816
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.ChartParams.BreakdownParams": {
17817
+ "type": "I",
17818
+ "fields": {
17819
+ "type": {
17820
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.Breakdown"
17821
+ },
17822
+ "eventAttribute": {
17823
+ "type": "string"
17824
+ },
17825
+ "metric": {
17826
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.Metric"
17827
+ }
17828
+ }
17829
+ },
17830
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.ChartParams": {
17831
+ "type": "I",
17832
+ "fields": {
17833
+ "timeRange": {
17834
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.ChartParams.TimeRange"
17835
+ },
17836
+ "metrics": {
17837
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.Metric",
17838
+ "array": true
17839
+ },
17840
+ "filters": {
17841
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.ChartParams.Filters"
17842
+ },
17843
+ "fltrs": {
17844
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.ChartParams.Filter",
17845
+ "array": true
17846
+ },
17847
+ "breakdown": {
17848
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.ChartParams.BreakdownParams"
17849
+ },
17850
+ "application": {
17851
+ "type": "string"
17852
+ },
17853
+ "timezone": {
17854
+ "type": "string"
17855
+ }
17856
+ }
17857
+ },
17858
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetLinearChartMetricsRequest": {
17859
+ "type": "I",
17860
+ "fields": {
17861
+ "params": {
17862
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.ChartParams"
17863
+ }
17864
+ }
17865
+ },
17866
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetLinearChartMetricsResponse.Breakdown": {
17867
+ "type": "I",
17868
+ "fields": {
17869
+ "breakdown": {
17870
+ "type": "string"
17871
+ },
17872
+ "values": {
17873
+ "type": "number",
17874
+ "array": true
17875
+ }
17876
+ }
17877
+ },
17878
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetLinearChartMetricsResponse.Metric": {
17879
+ "type": "I",
17880
+ "fields": {
17881
+ "metric": {
17882
+ "type": "string"
17883
+ },
17884
+ "breakdowns": {
17885
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetLinearChartMetricsResponse.Breakdown",
17886
+ "array": true
17887
+ }
17888
+ }
17889
+ },
17890
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetLinearChartMetricsResponse": {
17891
+ "type": "I",
17892
+ "fields": {
17893
+ "timestamps": {
17894
+ "type": "Date",
17895
+ "array": true
17896
+ },
17897
+ "metrics": {
17898
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetLinearChartMetricsResponse.Metric",
17899
+ "array": true
17900
+ }
17901
+ }
17902
+ },
17903
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetTotalsChartMetricsRequest": {
17904
+ "type": "I",
17905
+ "fields": {
17906
+ "params": {
17907
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.ChartParams"
17908
+ }
17909
+ }
17910
+ },
17911
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetTotalsChartMetricsResponse.Breakdown": {
17912
+ "type": "I",
17913
+ "fields": {
17914
+ "breakdown": {
17915
+ "type": "string"
17916
+ },
17917
+ "value": {
17918
+ "type": "number"
17919
+ }
17920
+ }
17921
+ },
17922
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetTotalsChartMetricsResponse.Metric": {
17923
+ "type": "I",
17924
+ "fields": {
17925
+ "metric": {
17926
+ "type": "string"
17927
+ },
17928
+ "breakdowns": {
17929
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetTotalsChartMetricsResponse.Breakdown",
17930
+ "array": true
17931
+ }
17932
+ }
17933
+ },
17934
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetTotalsChartMetricsResponse": {
17935
+ "type": "I",
17936
+ "fields": {
17937
+ "metrics": {
17938
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetTotalsChartMetricsResponse.Metric",
17939
+ "array": true
17940
+ }
17941
+ }
17942
+ },
17943
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetFunnelRequest": {
17944
+ "type": "I",
17945
+ "fields": {
17946
+ "params": {
17947
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.ChartParams"
17948
+ }
17949
+ }
17950
+ },
17951
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetFunnelResponse.Step": {
17952
+ "type": "I",
17953
+ "fields": {
17954
+ "breakdown": {
17955
+ "type": "string"
17956
+ },
17957
+ "count": {
17958
+ "type": "number"
17959
+ },
17960
+ "percent": {
17961
+ "type": "number"
17962
+ }
17963
+ }
17964
+ },
17965
+ "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetFunnelResponse": {
17966
+ "type": "I",
17967
+ "fields": {
17968
+ "steps": {
17969
+ "type": "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetFunnelResponse.Step",
17970
+ "array": true
17971
+ }
17972
+ }
17973
+ },
17606
17974
  "pushwoosh.rpc_v2.statistics_dashboards_widgets.GetCategoryTreeRequest": {
17607
17975
  "type": "I",
17608
17976
  "fields": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-v2-http-api-data",
3
- "version": "0.1.434",
3
+ "version": "0.1.435",
4
4
  "description": "RPC V2 HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",
@@ -3,6 +3,9 @@ export interface StatisticsDashboardsWidgetsService {
3
3
  Create(request: CreateDashboardWidgetRequest): Promise<CreateDashboardWidgetResponse>;
4
4
  Update(request: UpdateDashboardWidgetRequest): Promise<UpdateDashboardWidgetResponse>;
5
5
  Delete(request: DeleteDashboardWidgetRequest): Promise<DeleteDashboardWidgetResponse>;
6
+ GetLinearChartMetrics(request: GetLinearChartMetricsRequest): Promise<GetLinearChartMetricsResponse>;
7
+ GetTotalsChartMetrics(request: GetTotalsChartMetricsRequest): Promise<GetTotalsChartMetricsResponse>;
8
+ GetFunnel(request: GetFunnelRequest): Promise<GetFunnelResponse>;
6
9
  GetCategoryTree(request: GetCategoryTreeRequest): Promise<GetCategoryTreeResponse>;
7
10
  }
8
11
  export type WidgetType = 'WIDGET_TYPE_UNKNOWN' | 'LINE' | 'BARS' | 'PIE' | 'NUMBER' | 'FUNNEL' | 'RETENTION';
@@ -45,6 +48,128 @@ export type DeleteDashboardWidgetRequest = {
45
48
  code?: string;
46
49
  };
47
50
  export type DeleteDashboardWidgetResponse = {};
51
+ export type TimeInterval = 'TIME_INTERVAL_UNSPECIFIED' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'MINUTE';
52
+ export type Breakdown = 'BREAKDOWN_UNKNOWN' | 'PLATFORMS' | 'EVENT_ATTRIBUTE' | 'TAG_VALUES';
53
+ export type MathOperator = 'MATH_OPERATOR_UNSPECIFIED' | 'EQ' | 'NOT_EQ' | 'GTE' | 'LTE' | 'BETWEEN' | 'IN' | 'NOT_IN' | 'ANY' | 'NOT_SET';
54
+ export type Value_kind_string = {
55
+ type: 'string';
56
+ data: string;
57
+ };
58
+ export type Value_kind_integer = {
59
+ type: 'integer';
60
+ data: number;
61
+ };
62
+ export type Value_kind_decimal = {
63
+ type: 'decimal';
64
+ data: number;
65
+ };
66
+ export type Value_kind_boolean = {
67
+ type: 'boolean';
68
+ data: boolean;
69
+ };
70
+ export type Value_kind_list = {
71
+ type: 'list';
72
+ data: List;
73
+ };
74
+ export type Value_kind_date = {
75
+ type: 'date';
76
+ data: Date;
77
+ };
78
+ export type Value_kind = Value_kind_string | Value_kind_integer | Value_kind_decimal | Value_kind_boolean | Value_kind_list | Value_kind_date;
79
+ export type Value = {
80
+ kind: Value_kind;
81
+ };
82
+ export type List = {
83
+ values: string[];
84
+ };
85
+ export type AttributeCondition = {
86
+ name: string;
87
+ operator: MathOperator;
88
+ values: Value[];
89
+ };
90
+ export type Metric = {
91
+ id: number;
92
+ eventName: string;
93
+ attributeConditions: AttributeCondition[];
94
+ tag: string;
95
+ };
96
+ export type ChartParams_TypeFilter = 'Platform' | 'Segment' | 'Push' | 'Email' | 'Campaign' | 'Journey';
97
+ export type ChartParams_TimeRange = {
98
+ from: Date;
99
+ to: Date;
100
+ interval: TimeInterval;
101
+ };
102
+ export type ChartParams_Filters = {
103
+ platforms: number[];
104
+ messagesIds: number[];
105
+ campaignsCodes: string[];
106
+ attributeConditions: AttributeCondition[];
107
+ segment: string;
108
+ };
109
+ export type ChartParams_Filter = {
110
+ type: ChartParams_TypeFilter;
111
+ platforms: number[];
112
+ segment: string;
113
+ pushId: number;
114
+ emailId: number;
115
+ campaign: string;
116
+ journey: string;
117
+ jPoints: string[];
118
+ };
119
+ export type ChartParams_BreakdownParams = {
120
+ type: Breakdown;
121
+ eventAttribute: string;
122
+ metric: Metric;
123
+ };
124
+ export type ChartParams = {
125
+ timeRange: ChartParams_TimeRange;
126
+ metrics: Metric[];
127
+ filters: ChartParams_Filters;
128
+ fltrs: ChartParams_Filter[];
129
+ breakdown: ChartParams_BreakdownParams;
130
+ application: string;
131
+ timezone: string;
132
+ };
133
+ export type GetLinearChartMetricsRequest = {
134
+ params?: ChartParams;
135
+ };
136
+ export type GetLinearChartMetricsResponse_Breakdown = {
137
+ breakdown: string;
138
+ values: number[];
139
+ };
140
+ export type GetLinearChartMetricsResponse_Metric = {
141
+ metric: string;
142
+ breakdowns: GetLinearChartMetricsResponse_Breakdown[];
143
+ };
144
+ export type GetLinearChartMetricsResponse = {
145
+ timestamps: Date[];
146
+ metrics: GetLinearChartMetricsResponse_Metric[];
147
+ };
148
+ export type GetTotalsChartMetricsRequest = {
149
+ params?: ChartParams;
150
+ };
151
+ export type GetTotalsChartMetricsResponse_Breakdown = {
152
+ breakdown: string;
153
+ value: number;
154
+ };
155
+ export type GetTotalsChartMetricsResponse_Metric = {
156
+ metric: string;
157
+ breakdowns: GetTotalsChartMetricsResponse_Breakdown[];
158
+ };
159
+ export type GetTotalsChartMetricsResponse = {
160
+ metrics: GetTotalsChartMetricsResponse_Metric[];
161
+ };
162
+ export type GetFunnelRequest = {
163
+ params?: ChartParams;
164
+ };
165
+ export type GetFunnelResponse_Step = {
166
+ breakdown: string;
167
+ count: number;
168
+ percent: number;
169
+ };
170
+ export type GetFunnelResponse = {
171
+ steps: GetFunnelResponse_Step[];
172
+ };
48
173
  export type GetCategoryTreeRequest = {
49
174
  application?: string;
50
175
  };