zorihq 0.13.0 → 0.15.0
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/CHANGELOG.md +16 -0
- package/package.json +1 -1
- package/resources/v1/analytics/analytics.d.mts +44 -82
- package/resources/v1/analytics/analytics.d.mts.map +1 -1
- package/resources/v1/analytics/analytics.d.ts +44 -82
- package/resources/v1/analytics/analytics.d.ts.map +1 -1
- package/resources/v1/analytics/analytics.js +11 -9
- package/resources/v1/analytics/analytics.js.map +1 -1
- package/resources/v1/analytics/analytics.mjs +12 -10
- package/resources/v1/analytics/analytics.mjs.map +1 -1
- package/resources/v1/analytics/events.d.mts +8 -6
- package/resources/v1/analytics/events.d.mts.map +1 -1
- package/resources/v1/analytics/events.d.ts +8 -6
- package/resources/v1/analytics/events.d.ts.map +1 -1
- package/resources/v1/analytics/events.js +3 -2
- package/resources/v1/analytics/events.js.map +1 -1
- package/resources/v1/analytics/events.mjs +3 -2
- package/resources/v1/analytics/events.mjs.map +1 -1
- package/resources/v1/analytics/index.d.mts +6 -5
- package/resources/v1/analytics/index.d.mts.map +1 -1
- package/resources/v1/analytics/index.d.ts +6 -5
- package/resources/v1/analytics/index.d.ts.map +1 -1
- package/resources/v1/analytics/index.js +3 -1
- package/resources/v1/analytics/index.js.map +1 -1
- package/resources/v1/analytics/index.mjs +2 -1
- package/resources/v1/analytics/index.mjs.map +1 -1
- package/resources/v1/analytics/retention.d.mts +1 -25
- package/resources/v1/analytics/retention.d.mts.map +1 -1
- package/resources/v1/analytics/retention.d.ts +1 -25
- package/resources/v1/analytics/retention.d.ts.map +1 -1
- package/resources/v1/analytics/retention.js +0 -15
- package/resources/v1/analytics/retention.js.map +1 -1
- package/resources/v1/analytics/retention.mjs +0 -15
- package/resources/v1/analytics/retention.mjs.map +1 -1
- package/resources/v1/analytics/sessions.d.mts +0 -54
- package/resources/v1/analytics/sessions.d.mts.map +1 -1
- package/resources/v1/analytics/sessions.d.ts +0 -54
- package/resources/v1/analytics/sessions.d.ts.map +1 -1
- package/resources/v1/analytics/sessions.js +0 -30
- package/resources/v1/analytics/sessions.js.map +1 -1
- package/resources/v1/analytics/sessions.mjs +0 -30
- package/resources/v1/analytics/sessions.mjs.map +1 -1
- package/resources/v1/analytics/tiles.d.mts +401 -0
- package/resources/v1/analytics/tiles.d.mts.map +1 -0
- package/resources/v1/analytics/tiles.d.ts +401 -0
- package/resources/v1/analytics/tiles.d.ts.map +1 -0
- package/resources/v1/analytics/tiles.js +208 -0
- package/resources/v1/analytics/tiles.js.map +1 -0
- package/resources/v1/analytics/tiles.mjs +204 -0
- package/resources/v1/analytics/tiles.mjs.map +1 -0
- package/resources/v1/analytics/users.d.mts +0 -30
- package/resources/v1/analytics/users.d.mts.map +1 -1
- package/resources/v1/analytics/users.d.ts +0 -30
- package/resources/v1/analytics/users.d.ts.map +1 -1
- package/resources/v1/analytics/users.js +0 -15
- package/resources/v1/analytics/users.js.map +1 -1
- package/resources/v1/analytics/users.mjs +0 -15
- package/resources/v1/analytics/users.mjs.map +1 -1
- package/resources/v1/analytics/visitors.d.mts +4 -75
- package/resources/v1/analytics/visitors.d.mts.map +1 -1
- package/resources/v1/analytics/visitors.d.ts +4 -75
- package/resources/v1/analytics/visitors.d.ts.map +1 -1
- package/resources/v1/analytics/visitors.js +3 -47
- package/resources/v1/analytics/visitors.js.map +1 -1
- package/resources/v1/analytics/visitors.mjs +3 -47
- package/resources/v1/analytics/visitors.mjs.map +1 -1
- package/resources/v1/index.d.mts +1 -1
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +1 -1
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/v1.d.mts +2 -2
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +2 -2
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs.map +1 -1
- package/src/resources/v1/analytics/analytics.ts +119 -145
- package/src/resources/v1/analytics/events.ts +9 -6
- package/src/resources/v1/analytics/index.ts +33 -23
- package/src/resources/v1/analytics/retention.ts +0 -40
- package/src/resources/v1/analytics/sessions.ts +1 -89
- package/src/resources/v1/analytics/tiles.ts +663 -0
- package/src/resources/v1/analytics/users.ts +1 -44
- package/src/resources/v1/analytics/visitors.ts +3 -122
- package/src/resources/v1/index.ts +2 -13
- package/src/resources/v1/v1.ts +4 -26
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -6,25 +6,6 @@ import { APIPromise } from '../../../core/api-promise';
|
|
|
6
6
|
import { RequestOptions } from '../../../internal/request-options';
|
|
7
7
|
|
|
8
8
|
export class Visitors extends APIResource {
|
|
9
|
-
/**
|
|
10
|
-
* Get unique visitor counts grouped by country code
|
|
11
|
-
*
|
|
12
|
-
* @example
|
|
13
|
-
* ```ts
|
|
14
|
-
* const visitorsByCountryResponse =
|
|
15
|
-
* await client.v1.analytics.visitors.byCountry({
|
|
16
|
-
* project_id: 'project_id',
|
|
17
|
-
* time_range: 'last_hour',
|
|
18
|
-
* });
|
|
19
|
-
* ```
|
|
20
|
-
*/
|
|
21
|
-
byCountry(
|
|
22
|
-
query: VisitorByCountryParams,
|
|
23
|
-
options?: RequestOptions,
|
|
24
|
-
): APIPromise<AnalyticsAPI.VisitorsByCountryResponse> {
|
|
25
|
-
return this._client.get('/api/v1/analytics/visitors/country', { query, ...options });
|
|
26
|
-
}
|
|
27
|
-
|
|
28
9
|
/**
|
|
29
10
|
* Get visitor counts grouped by device type (mobile, desktop, tablet) over a
|
|
30
11
|
* specified time range
|
|
@@ -45,25 +26,6 @@ export class Visitors extends APIResource {
|
|
|
45
26
|
return this._client.get('/api/v1/analytics/visitors/device', { query, ...options });
|
|
46
27
|
}
|
|
47
28
|
|
|
48
|
-
/**
|
|
49
|
-
* Get unique visitor counts grouped by referrer domain (traffic source)
|
|
50
|
-
*
|
|
51
|
-
* @example
|
|
52
|
-
* ```ts
|
|
53
|
-
* const visitorsByOriginResponse =
|
|
54
|
-
* await client.v1.analytics.visitors.byOrigin({
|
|
55
|
-
* project_id: 'project_id',
|
|
56
|
-
* time_range: 'last_hour',
|
|
57
|
-
* });
|
|
58
|
-
* ```
|
|
59
|
-
*/
|
|
60
|
-
byOrigin(
|
|
61
|
-
query: VisitorByOriginParams,
|
|
62
|
-
options?: RequestOptions,
|
|
63
|
-
): APIPromise<AnalyticsAPI.VisitorsByOriginResponse> {
|
|
64
|
-
return this._client.get('/api/v1/analytics/visitors/origin', { query, ...options });
|
|
65
|
-
}
|
|
66
|
-
|
|
67
29
|
/**
|
|
68
30
|
* Manually identify a visitor by updating their profile information from the
|
|
69
31
|
* dashboard
|
|
@@ -104,27 +66,9 @@ export class Visitors extends APIResource {
|
|
|
104
66
|
}
|
|
105
67
|
|
|
106
68
|
/**
|
|
107
|
-
* Get
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
* @example
|
|
111
|
-
* ```ts
|
|
112
|
-
* const uniqueVisitorsTimelineResponse =
|
|
113
|
-
* await client.v1.analytics.visitors.timeline({
|
|
114
|
-
* project_id: 'project_id',
|
|
115
|
-
* time_range: 'last_hour',
|
|
116
|
-
* });
|
|
117
|
-
* ```
|
|
118
|
-
*/
|
|
119
|
-
timeline(
|
|
120
|
-
query: VisitorTimelineParams,
|
|
121
|
-
options?: RequestOptions,
|
|
122
|
-
): APIPromise<AnalyticsAPI.UniqueVisitorsTimelineResponse> {
|
|
123
|
-
return this._client.get('/api/v1/analytics/visitors/timeline', { query, ...options });
|
|
124
|
-
}
|
|
125
|
-
|
|
126
|
-
/**
|
|
127
|
-
* Get a list of the most active visitors ranked by event count
|
|
69
|
+
* Get top visitors grouped by identified information (user_id, external_id, email)
|
|
70
|
+
* with payment metrics including revenue, distinct payments, and time to first
|
|
71
|
+
* purchase
|
|
128
72
|
*
|
|
129
73
|
* @example
|
|
130
74
|
* ```ts
|
|
@@ -140,26 +84,6 @@ export class Visitors extends APIResource {
|
|
|
140
84
|
}
|
|
141
85
|
}
|
|
142
86
|
|
|
143
|
-
export interface VisitorByCountryParams {
|
|
144
|
-
project_id: string;
|
|
145
|
-
|
|
146
|
-
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
147
|
-
|
|
148
|
-
customer_id?: string;
|
|
149
|
-
|
|
150
|
-
limit?: number;
|
|
151
|
-
|
|
152
|
-
offset?: number;
|
|
153
|
-
|
|
154
|
-
referrer?: string;
|
|
155
|
-
|
|
156
|
-
utmtag?: string;
|
|
157
|
-
|
|
158
|
-
utmtagValue?: string;
|
|
159
|
-
|
|
160
|
-
visitor_id?: string;
|
|
161
|
-
}
|
|
162
|
-
|
|
163
87
|
export interface VisitorByDeviceParams {
|
|
164
88
|
project_id: string;
|
|
165
89
|
|
|
@@ -180,26 +104,6 @@ export interface VisitorByDeviceParams {
|
|
|
180
104
|
visitor_id?: string;
|
|
181
105
|
}
|
|
182
106
|
|
|
183
|
-
export interface VisitorByOriginParams {
|
|
184
|
-
project_id: string;
|
|
185
|
-
|
|
186
|
-
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
187
|
-
|
|
188
|
-
customer_id?: string;
|
|
189
|
-
|
|
190
|
-
limit?: number;
|
|
191
|
-
|
|
192
|
-
offset?: number;
|
|
193
|
-
|
|
194
|
-
referrer?: string;
|
|
195
|
-
|
|
196
|
-
utmtag?: string;
|
|
197
|
-
|
|
198
|
-
utmtagValue?: string;
|
|
199
|
-
|
|
200
|
-
visitor_id?: string;
|
|
201
|
-
}
|
|
202
|
-
|
|
203
107
|
export interface VisitorIdentifyParams {
|
|
204
108
|
project_id: string;
|
|
205
109
|
|
|
@@ -226,26 +130,6 @@ export interface VisitorProfileParams {
|
|
|
226
130
|
visitor_id?: string;
|
|
227
131
|
}
|
|
228
132
|
|
|
229
|
-
export interface VisitorTimelineParams {
|
|
230
|
-
project_id: string;
|
|
231
|
-
|
|
232
|
-
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
233
|
-
|
|
234
|
-
customer_id?: string;
|
|
235
|
-
|
|
236
|
-
limit?: number;
|
|
237
|
-
|
|
238
|
-
offset?: number;
|
|
239
|
-
|
|
240
|
-
referrer?: string;
|
|
241
|
-
|
|
242
|
-
utmtag?: string;
|
|
243
|
-
|
|
244
|
-
utmtagValue?: string;
|
|
245
|
-
|
|
246
|
-
visitor_id?: string;
|
|
247
|
-
}
|
|
248
|
-
|
|
249
133
|
export interface VisitorTopParams {
|
|
250
134
|
project_id: string;
|
|
251
135
|
|
|
@@ -268,12 +152,9 @@ export interface VisitorTopParams {
|
|
|
268
152
|
|
|
269
153
|
export declare namespace Visitors {
|
|
270
154
|
export {
|
|
271
|
-
type VisitorByCountryParams as VisitorByCountryParams,
|
|
272
155
|
type VisitorByDeviceParams as VisitorByDeviceParams,
|
|
273
|
-
type VisitorByOriginParams as VisitorByOriginParams,
|
|
274
156
|
type VisitorIdentifyParams as VisitorIdentifyParams,
|
|
275
157
|
type VisitorProfileParams as VisitorProfileParams,
|
|
276
|
-
type VisitorTimelineParams as VisitorTimelineParams,
|
|
277
158
|
type VisitorTopParams as VisitorTopParams,
|
|
278
159
|
};
|
|
279
160
|
}
|
|
@@ -2,34 +2,23 @@
|
|
|
2
2
|
|
|
3
3
|
export {
|
|
4
4
|
Analytics,
|
|
5
|
-
type ActiveUsersResponse,
|
|
6
|
-
type BounceRateByPageMetric,
|
|
7
|
-
type BounceRateResponse,
|
|
8
5
|
type ChurnRateResponse,
|
|
9
6
|
type CohortAnalysisResponse,
|
|
10
7
|
type CohortData,
|
|
11
|
-
type CountryDataPoint,
|
|
12
|
-
type DashboardMetricsResponse,
|
|
13
8
|
type EventFilterOptionsResponse,
|
|
14
9
|
type EventsOverTimeDataPoint,
|
|
15
10
|
type ManualIdentifyRequest,
|
|
16
11
|
type ManualIdentifyResponse,
|
|
17
|
-
type OriginDataPoint,
|
|
18
12
|
type RecentEvent,
|
|
19
13
|
type RecentEventsResponse,
|
|
20
|
-
type ReturnRateResponse,
|
|
21
|
-
type SessionMetricsResponse,
|
|
22
14
|
type TopVisitor,
|
|
23
15
|
type TopVisitorsResponse,
|
|
24
|
-
type UniqueVisitorsDataPoint,
|
|
25
|
-
type UniqueVisitorsTimelineResponse,
|
|
26
16
|
type VisitorDataPoint,
|
|
27
17
|
type VisitorEvent,
|
|
28
18
|
type VisitorProfileResponse,
|
|
29
|
-
type VisitorsByCountryResponse,
|
|
30
19
|
type VisitorsByDeviceResponse,
|
|
31
|
-
type
|
|
32
|
-
type
|
|
20
|
+
type AnalyticsRetrieveTimelineResponse,
|
|
21
|
+
type AnalyticsRetrieveTimelineParams,
|
|
33
22
|
} from './analytics/index';
|
|
34
23
|
export { Auth, type LoginRequest, type LoginResponse, type AuthLoginParams } from './auth';
|
|
35
24
|
export {
|
package/src/resources/v1/v1.ts
CHANGED
|
@@ -17,35 +17,24 @@ import {
|
|
|
17
17
|
} from './projects';
|
|
18
18
|
import * as AnalyticsAPI from './analytics/analytics';
|
|
19
19
|
import {
|
|
20
|
-
ActiveUsersResponse,
|
|
21
20
|
Analytics,
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
BounceRateResponse,
|
|
21
|
+
AnalyticsRetrieveTimelineParams,
|
|
22
|
+
AnalyticsRetrieveTimelineResponse,
|
|
25
23
|
ChurnRateResponse,
|
|
26
24
|
CohortAnalysisResponse,
|
|
27
25
|
CohortData,
|
|
28
|
-
CountryDataPoint,
|
|
29
|
-
DashboardMetricsResponse,
|
|
30
26
|
EventFilterOptionsResponse,
|
|
31
27
|
EventsOverTimeDataPoint,
|
|
32
28
|
ManualIdentifyRequest,
|
|
33
29
|
ManualIdentifyResponse,
|
|
34
|
-
OriginDataPoint,
|
|
35
30
|
RecentEvent,
|
|
36
31
|
RecentEventsResponse,
|
|
37
|
-
ReturnRateResponse,
|
|
38
|
-
SessionMetricsResponse,
|
|
39
32
|
TopVisitor,
|
|
40
33
|
TopVisitorsResponse,
|
|
41
|
-
UniqueVisitorsDataPoint,
|
|
42
|
-
UniqueVisitorsTimelineResponse,
|
|
43
34
|
VisitorDataPoint,
|
|
44
35
|
VisitorEvent,
|
|
45
36
|
VisitorProfileResponse,
|
|
46
|
-
VisitorsByCountryResponse,
|
|
47
37
|
VisitorsByDeviceResponse,
|
|
48
|
-
VisitorsByOriginResponse,
|
|
49
38
|
} from './analytics/analytics';
|
|
50
39
|
import * as PaymentProvidersAPI from './payment-providers/payment-providers';
|
|
51
40
|
import {
|
|
@@ -108,34 +97,23 @@ export declare namespace V1 {
|
|
|
108
97
|
|
|
109
98
|
export {
|
|
110
99
|
Analytics as Analytics,
|
|
111
|
-
type ActiveUsersResponse as ActiveUsersResponse,
|
|
112
|
-
type BounceRateByPageMetric as BounceRateByPageMetric,
|
|
113
|
-
type BounceRateResponse as BounceRateResponse,
|
|
114
100
|
type ChurnRateResponse as ChurnRateResponse,
|
|
115
101
|
type CohortAnalysisResponse as CohortAnalysisResponse,
|
|
116
102
|
type CohortData as CohortData,
|
|
117
|
-
type CountryDataPoint as CountryDataPoint,
|
|
118
|
-
type DashboardMetricsResponse as DashboardMetricsResponse,
|
|
119
103
|
type EventFilterOptionsResponse as EventFilterOptionsResponse,
|
|
120
104
|
type EventsOverTimeDataPoint as EventsOverTimeDataPoint,
|
|
121
105
|
type ManualIdentifyRequest as ManualIdentifyRequest,
|
|
122
106
|
type ManualIdentifyResponse as ManualIdentifyResponse,
|
|
123
|
-
type OriginDataPoint as OriginDataPoint,
|
|
124
107
|
type RecentEvent as RecentEvent,
|
|
125
108
|
type RecentEventsResponse as RecentEventsResponse,
|
|
126
|
-
type ReturnRateResponse as ReturnRateResponse,
|
|
127
|
-
type SessionMetricsResponse as SessionMetricsResponse,
|
|
128
109
|
type TopVisitor as TopVisitor,
|
|
129
110
|
type TopVisitorsResponse as TopVisitorsResponse,
|
|
130
|
-
type UniqueVisitorsDataPoint as UniqueVisitorsDataPoint,
|
|
131
|
-
type UniqueVisitorsTimelineResponse as UniqueVisitorsTimelineResponse,
|
|
132
111
|
type VisitorDataPoint as VisitorDataPoint,
|
|
133
112
|
type VisitorEvent as VisitorEvent,
|
|
134
113
|
type VisitorProfileResponse as VisitorProfileResponse,
|
|
135
|
-
type VisitorsByCountryResponse as VisitorsByCountryResponse,
|
|
136
114
|
type VisitorsByDeviceResponse as VisitorsByDeviceResponse,
|
|
137
|
-
type
|
|
138
|
-
type
|
|
115
|
+
type AnalyticsRetrieveTimelineResponse as AnalyticsRetrieveTimelineResponse,
|
|
116
|
+
type AnalyticsRetrieveTimelineParams as AnalyticsRetrieveTimelineParams,
|
|
139
117
|
};
|
|
140
118
|
|
|
141
119
|
export {
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '0.
|
|
1
|
+
export const VERSION = '0.15.0'; // x-release-please-version
|
package/version.d.mts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.
|
|
1
|
+
export declare const VERSION = "0.15.0";
|
|
2
2
|
//# sourceMappingURL=version.d.mts.map
|
package/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.
|
|
1
|
+
export declare const VERSION = "0.15.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/version.js
CHANGED
package/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = '0.
|
|
1
|
+
export const VERSION = '0.15.0'; // x-release-please-version
|
|
2
2
|
//# sourceMappingURL=version.mjs.map
|