zorihq 0.14.0 → 0.17.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 +24 -0
- package/client.d.mts +4 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +4 -4
- package/client.d.ts.map +1 -1
- package/client.js +15 -9
- package/client.js.map +1 -1
- package/client.mjs +15 -9
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/v1/analytics/analytics.d.mts +109 -71
- package/resources/v1/analytics/analytics.d.mts.map +1 -1
- package/resources/v1/analytics/analytics.d.ts +109 -71
- package/resources/v1/analytics/analytics.d.ts.map +1 -1
- package/resources/v1/analytics/analytics.js +10 -14
- package/resources/v1/analytics/analytics.js.map +1 -1
- package/resources/v1/analytics/analytics.mjs +11 -15
- package/resources/v1/analytics/analytics.mjs.map +1 -1
- package/resources/v1/analytics/index.d.mts +4 -5
- package/resources/v1/analytics/index.d.mts.map +1 -1
- package/resources/v1/analytics/index.d.ts +4 -5
- package/resources/v1/analytics/index.d.ts.map +1 -1
- package/resources/v1/analytics/index.js +3 -5
- package/resources/v1/analytics/index.js.map +1 -1
- package/resources/v1/analytics/index.mjs +2 -3
- 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/tiles.d.mts +372 -0
- package/resources/v1/analytics/tiles.d.mts.map +1 -0
- package/resources/v1/analytics/tiles.d.ts +372 -0
- package/resources/v1/analytics/tiles.d.ts.map +1 -0
- package/resources/v1/analytics/tiles.js +236 -0
- package/resources/v1/analytics/tiles.js.map +1 -0
- package/resources/v1/analytics/tiles.mjs +232 -0
- package/resources/v1/analytics/tiles.mjs.map +1 -0
- package/resources/v1/analytics/visitors.d.mts +1 -74
- package/resources/v1/analytics/visitors.d.mts.map +1 -1
- package/resources/v1/analytics/visitors.d.ts +1 -74
- package/resources/v1/analytics/visitors.d.ts.map +1 -1
- package/resources/v1/analytics/visitors.js +0 -46
- package/resources/v1/analytics/visitors.js.map +1 -1
- package/resources/v1/analytics/visitors.mjs +0 -46
- 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/client.ts +20 -14
- package/src/resources/v1/analytics/analytics.ts +187 -109
- package/src/resources/v1/analytics/index.ts +37 -21
- package/src/resources/v1/analytics/retention.ts +0 -40
- package/src/resources/v1/analytics/tiles.ts +606 -0
- package/src/resources/v1/analytics/visitors.ts +0 -121
- package/src/resources/v1/index.ts +19 -11
- package/src/resources/v1/v1.ts +38 -22
- 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
- package/resources/v1/analytics/sessions.d.mts +0 -58
- package/resources/v1/analytics/sessions.d.mts.map +0 -1
- package/resources/v1/analytics/sessions.d.ts +0 -58
- package/resources/v1/analytics/sessions.d.ts.map +0 -1
- package/resources/v1/analytics/sessions.js +0 -39
- package/resources/v1/analytics/sessions.js.map +0 -1
- package/resources/v1/analytics/sessions.mjs +0 -35
- package/resources/v1/analytics/sessions.mjs.map +0 -1
- package/resources/v1/analytics/users.d.mts +0 -34
- package/resources/v1/analytics/users.d.mts.map +0 -1
- package/resources/v1/analytics/users.d.ts +0 -34
- package/resources/v1/analytics/users.d.ts.map +0 -1
- package/resources/v1/analytics/users.js +0 -24
- package/resources/v1/analytics/users.js.map +0 -1
- package/resources/v1/analytics/users.mjs +0 -20
- package/resources/v1/analytics/users.mjs.map +0 -1
- package/src/resources/v1/analytics/sessions.ts +0 -93
- package/src/resources/v1/analytics/users.ts +0 -48
|
@@ -0,0 +1,372 @@
|
|
|
1
|
+
import { APIResource } from "../../../core/resource.js";
|
|
2
|
+
import * as AnalyticsAPI from "./analytics.js";
|
|
3
|
+
import { APIPromise } from "../../../core/api-promise.js";
|
|
4
|
+
import { RequestOptions } from "../../../internal/request-options.js";
|
|
5
|
+
export declare class Tiles extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Get bounce rate percentage for current period compared to the previous period
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const bounceRateResponse =
|
|
12
|
+
* await client.v1.analytics.tiles.bounceRate({
|
|
13
|
+
* project_id: 'project_id',
|
|
14
|
+
* time_range: 'last_hour',
|
|
15
|
+
* });
|
|
16
|
+
* ```
|
|
17
|
+
*/
|
|
18
|
+
bounceRate(query: TileBounceRateParams, options?: RequestOptions): APIPromise<AnalyticsAPI.BounceRateResponse>;
|
|
19
|
+
/**
|
|
20
|
+
* Get daily active user count (last 24h) compared to the previous day
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```ts
|
|
24
|
+
* const dauResponse = await client.v1.analytics.tiles.dau({
|
|
25
|
+
* project_id: 'project_id',
|
|
26
|
+
* time_range: 'last_hour',
|
|
27
|
+
* });
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
dau(query: TileDauParams, options?: RequestOptions): APIPromise<AnalyticsAPI.DauResponse>;
|
|
31
|
+
/**
|
|
32
|
+
* Get monthly active user count (last 30 days) compared to the previous month
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* ```ts
|
|
36
|
+
* const mauResponse = await client.v1.analytics.tiles.mau({
|
|
37
|
+
* project_id: 'project_id',
|
|
38
|
+
* time_range: 'last_hour',
|
|
39
|
+
* });
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
mau(query: TileMauParams, options?: RequestOptions): APIPromise<AnalyticsAPI.MauResponse>;
|
|
43
|
+
/**
|
|
44
|
+
* Get average number of pages viewed per session for current period compared to
|
|
45
|
+
* the previous period
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* ```ts
|
|
49
|
+
* const pagesPerSessionResponse =
|
|
50
|
+
* await client.v1.analytics.tiles.pagesPerSession({
|
|
51
|
+
* project_id: 'project_id',
|
|
52
|
+
* time_range: 'last_hour',
|
|
53
|
+
* });
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
pagesPerSession(query: TilePagesPerSessionParams, options?: RequestOptions): APIPromise<AnalyticsAPI.PagesPerSessionResponse>;
|
|
57
|
+
/**
|
|
58
|
+
* Get percentage of visitors with more than one session for current period
|
|
59
|
+
* compared to the previous period
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* const returnRateResponse =
|
|
64
|
+
* await client.v1.analytics.tiles.returnRate({
|
|
65
|
+
* project_id: 'project_id',
|
|
66
|
+
* time_range: 'last_hour',
|
|
67
|
+
* });
|
|
68
|
+
* ```
|
|
69
|
+
*/
|
|
70
|
+
returnRate(query: TileReturnRateParams, options?: RequestOptions): APIPromise<AnalyticsAPI.ReturnRateResponse>;
|
|
71
|
+
/**
|
|
72
|
+
* Get average session duration in seconds for current period compared to the
|
|
73
|
+
* previous period
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* ```ts
|
|
77
|
+
* const sessionDurationResponse =
|
|
78
|
+
* await client.v1.analytics.tiles.sessionDuration({
|
|
79
|
+
* project_id: 'project_id',
|
|
80
|
+
* time_range: 'last_hour',
|
|
81
|
+
* });
|
|
82
|
+
* ```
|
|
83
|
+
*/
|
|
84
|
+
sessionDuration(query: TileSessionDurationParams, options?: RequestOptions): APIPromise<AnalyticsAPI.SessionDurationResponse>;
|
|
85
|
+
/**
|
|
86
|
+
* Get average hours between consecutive visits per visitor for current period
|
|
87
|
+
* compared to the previous period
|
|
88
|
+
*
|
|
89
|
+
* @example
|
|
90
|
+
* ```ts
|
|
91
|
+
* const timeBetweenVisitsResponse =
|
|
92
|
+
* await client.v1.analytics.tiles.timeBetweenVisits({
|
|
93
|
+
* project_id: 'project_id',
|
|
94
|
+
* time_range: 'last_hour',
|
|
95
|
+
* });
|
|
96
|
+
* ```
|
|
97
|
+
*/
|
|
98
|
+
timeBetweenVisits(query: TileTimeBetweenVisitsParams, options?: RequestOptions): APIPromise<AnalyticsAPI.TimeBetweenVisitsResponse>;
|
|
99
|
+
/**
|
|
100
|
+
* Get unique visitor counts grouped by country code
|
|
101
|
+
*
|
|
102
|
+
* @example
|
|
103
|
+
* ```ts
|
|
104
|
+
* const countryTrafficSourceResponse =
|
|
105
|
+
* await client.v1.analytics.tiles.trafficByCountry({
|
|
106
|
+
* project_id: 'project_id',
|
|
107
|
+
* time_range: 'last_hour',
|
|
108
|
+
* });
|
|
109
|
+
* ```
|
|
110
|
+
*/
|
|
111
|
+
trafficByCountry(query: TileTrafficByCountryParams, options?: RequestOptions): APIPromise<AnalyticsAPI.CountryTrafficSourceResponse>;
|
|
112
|
+
/**
|
|
113
|
+
* Get unique visitor counts grouped by referrer domain (traffic source)
|
|
114
|
+
*
|
|
115
|
+
* @example
|
|
116
|
+
* ```ts
|
|
117
|
+
* const refererTrafficSourceResponse =
|
|
118
|
+
* await client.v1.analytics.tiles.trafficByReferer({
|
|
119
|
+
* project_id: 'project_id',
|
|
120
|
+
* time_range: 'last_hour',
|
|
121
|
+
* });
|
|
122
|
+
* ```
|
|
123
|
+
*/
|
|
124
|
+
trafficByReferer(query: TileTrafficByRefererParams, options?: RequestOptions): APIPromise<AnalyticsAPI.RefererTrafficSourceResponse>;
|
|
125
|
+
/**
|
|
126
|
+
* Get unique visitor counts grouped by UTM source, medium, and campaign
|
|
127
|
+
*
|
|
128
|
+
* @example
|
|
129
|
+
* ```ts
|
|
130
|
+
* const utmTrafficSourceResponse =
|
|
131
|
+
* await client.v1.analytics.tiles.trafficByUtm({
|
|
132
|
+
* project_id: 'project_id',
|
|
133
|
+
* time_range: 'last_hour',
|
|
134
|
+
* });
|
|
135
|
+
* ```
|
|
136
|
+
*/
|
|
137
|
+
trafficByUtm(query: TileTrafficByUtmParams, options?: RequestOptions): APIPromise<AnalyticsAPI.UtmTrafficSourceResponse>;
|
|
138
|
+
/**
|
|
139
|
+
* Get unique session count for current period compared to the previous period
|
|
140
|
+
*
|
|
141
|
+
* @example
|
|
142
|
+
* ```ts
|
|
143
|
+
* const uniqueSessionsResponse =
|
|
144
|
+
* await client.v1.analytics.tiles.uniqueSessions({
|
|
145
|
+
* project_id: 'project_id',
|
|
146
|
+
* time_range: 'last_hour',
|
|
147
|
+
* });
|
|
148
|
+
* ```
|
|
149
|
+
*/
|
|
150
|
+
uniqueSessions(query: TileUniqueSessionsParams, options?: RequestOptions): APIPromise<AnalyticsAPI.UniqueSessionsResponse>;
|
|
151
|
+
/**
|
|
152
|
+
* Get unique visitor count for current period compared to the previous period
|
|
153
|
+
*
|
|
154
|
+
* @example
|
|
155
|
+
* ```ts
|
|
156
|
+
* const uniqueVisitorsResponse =
|
|
157
|
+
* await client.v1.analytics.tiles.uniqueVisitors({
|
|
158
|
+
* project_id: 'project_id',
|
|
159
|
+
* time_range: 'last_hour',
|
|
160
|
+
* });
|
|
161
|
+
* ```
|
|
162
|
+
*/
|
|
163
|
+
uniqueVisitors(query: TileUniqueVisitorsParams, options?: RequestOptions): APIPromise<AnalyticsAPI.UniqueVisitorsResponse>;
|
|
164
|
+
/**
|
|
165
|
+
* Get number of visitors by browser for current period compared to the previous
|
|
166
|
+
* period
|
|
167
|
+
*
|
|
168
|
+
* @example
|
|
169
|
+
* ```ts
|
|
170
|
+
* const visitorsByBrowserResponse =
|
|
171
|
+
* await client.v1.analytics.tiles.visitorsByBrowser({
|
|
172
|
+
* project_id: 'project_id',
|
|
173
|
+
* time_range: 'last_hour',
|
|
174
|
+
* });
|
|
175
|
+
* ```
|
|
176
|
+
*/
|
|
177
|
+
visitorsByBrowser(query: TileVisitorsByBrowserParams, options?: RequestOptions): APIPromise<AnalyticsAPI.VisitorsByBrowserResponse>;
|
|
178
|
+
/**
|
|
179
|
+
* Get number of visitors by OS for current period compared to the previous period
|
|
180
|
+
*
|
|
181
|
+
* @example
|
|
182
|
+
* ```ts
|
|
183
|
+
* const visitorsByOsResponse =
|
|
184
|
+
* await client.v1.analytics.tiles.visitorsByOs({
|
|
185
|
+
* project_id: 'project_id',
|
|
186
|
+
* time_range: 'last_hour',
|
|
187
|
+
* });
|
|
188
|
+
* ```
|
|
189
|
+
*/
|
|
190
|
+
visitorsByOs(query: TileVisitorsByOsParams, options?: RequestOptions): APIPromise<AnalyticsAPI.VisitorsByOsResponse>;
|
|
191
|
+
/**
|
|
192
|
+
* Get weekly active user count (last 7 days) compared to the previous week
|
|
193
|
+
*
|
|
194
|
+
* @example
|
|
195
|
+
* ```ts
|
|
196
|
+
* const wauResponse = await client.v1.analytics.tiles.wau({
|
|
197
|
+
* project_id: 'project_id',
|
|
198
|
+
* time_range: 'last_hour',
|
|
199
|
+
* });
|
|
200
|
+
* ```
|
|
201
|
+
*/
|
|
202
|
+
wau(query: TileWauParams, options?: RequestOptions): APIPromise<AnalyticsAPI.WauResponse>;
|
|
203
|
+
}
|
|
204
|
+
export interface TileBounceRateParams {
|
|
205
|
+
project_id: string;
|
|
206
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
207
|
+
customer_id?: string;
|
|
208
|
+
limit?: number;
|
|
209
|
+
offset?: number;
|
|
210
|
+
referrer?: string;
|
|
211
|
+
utmtag?: string;
|
|
212
|
+
utmtagValue?: string;
|
|
213
|
+
visitor_id?: string;
|
|
214
|
+
}
|
|
215
|
+
export interface TileDauParams {
|
|
216
|
+
project_id: string;
|
|
217
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
218
|
+
customer_id?: string;
|
|
219
|
+
limit?: number;
|
|
220
|
+
offset?: number;
|
|
221
|
+
referrer?: string;
|
|
222
|
+
utmtag?: string;
|
|
223
|
+
utmtagValue?: string;
|
|
224
|
+
visitor_id?: string;
|
|
225
|
+
}
|
|
226
|
+
export interface TileMauParams {
|
|
227
|
+
project_id: string;
|
|
228
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
229
|
+
customer_id?: string;
|
|
230
|
+
limit?: number;
|
|
231
|
+
offset?: number;
|
|
232
|
+
referrer?: string;
|
|
233
|
+
utmtag?: string;
|
|
234
|
+
utmtagValue?: string;
|
|
235
|
+
visitor_id?: string;
|
|
236
|
+
}
|
|
237
|
+
export interface TilePagesPerSessionParams {
|
|
238
|
+
project_id: string;
|
|
239
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
240
|
+
customer_id?: string;
|
|
241
|
+
limit?: number;
|
|
242
|
+
offset?: number;
|
|
243
|
+
referrer?: string;
|
|
244
|
+
utmtag?: string;
|
|
245
|
+
utmtagValue?: string;
|
|
246
|
+
visitor_id?: string;
|
|
247
|
+
}
|
|
248
|
+
export interface TileReturnRateParams {
|
|
249
|
+
project_id: string;
|
|
250
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
251
|
+
customer_id?: string;
|
|
252
|
+
limit?: number;
|
|
253
|
+
offset?: number;
|
|
254
|
+
referrer?: string;
|
|
255
|
+
utmtag?: string;
|
|
256
|
+
utmtagValue?: string;
|
|
257
|
+
visitor_id?: string;
|
|
258
|
+
}
|
|
259
|
+
export interface TileSessionDurationParams {
|
|
260
|
+
project_id: string;
|
|
261
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
262
|
+
customer_id?: string;
|
|
263
|
+
limit?: number;
|
|
264
|
+
offset?: number;
|
|
265
|
+
referrer?: string;
|
|
266
|
+
utmtag?: string;
|
|
267
|
+
utmtagValue?: string;
|
|
268
|
+
visitor_id?: string;
|
|
269
|
+
}
|
|
270
|
+
export interface TileTimeBetweenVisitsParams {
|
|
271
|
+
project_id: string;
|
|
272
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
273
|
+
customer_id?: string;
|
|
274
|
+
limit?: number;
|
|
275
|
+
offset?: number;
|
|
276
|
+
referrer?: string;
|
|
277
|
+
utmtag?: string;
|
|
278
|
+
utmtagValue?: string;
|
|
279
|
+
visitor_id?: string;
|
|
280
|
+
}
|
|
281
|
+
export interface TileTrafficByCountryParams {
|
|
282
|
+
project_id: string;
|
|
283
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
284
|
+
customer_id?: string;
|
|
285
|
+
limit?: number;
|
|
286
|
+
offset?: number;
|
|
287
|
+
referrer?: string;
|
|
288
|
+
utmtag?: string;
|
|
289
|
+
utmtagValue?: string;
|
|
290
|
+
visitor_id?: string;
|
|
291
|
+
}
|
|
292
|
+
export interface TileTrafficByRefererParams {
|
|
293
|
+
project_id: string;
|
|
294
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
295
|
+
customer_id?: string;
|
|
296
|
+
limit?: number;
|
|
297
|
+
offset?: number;
|
|
298
|
+
referrer?: string;
|
|
299
|
+
utmtag?: string;
|
|
300
|
+
utmtagValue?: string;
|
|
301
|
+
visitor_id?: string;
|
|
302
|
+
}
|
|
303
|
+
export interface TileTrafficByUtmParams {
|
|
304
|
+
project_id: string;
|
|
305
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
306
|
+
customer_id?: string;
|
|
307
|
+
limit?: number;
|
|
308
|
+
offset?: number;
|
|
309
|
+
referrer?: string;
|
|
310
|
+
utmtag?: string;
|
|
311
|
+
utmtagValue?: string;
|
|
312
|
+
visitor_id?: string;
|
|
313
|
+
}
|
|
314
|
+
export interface TileUniqueSessionsParams {
|
|
315
|
+
project_id: string;
|
|
316
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
317
|
+
customer_id?: string;
|
|
318
|
+
limit?: number;
|
|
319
|
+
offset?: number;
|
|
320
|
+
referrer?: string;
|
|
321
|
+
utmtag?: string;
|
|
322
|
+
utmtagValue?: string;
|
|
323
|
+
visitor_id?: string;
|
|
324
|
+
}
|
|
325
|
+
export interface TileUniqueVisitorsParams {
|
|
326
|
+
project_id: string;
|
|
327
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
328
|
+
customer_id?: string;
|
|
329
|
+
limit?: number;
|
|
330
|
+
offset?: number;
|
|
331
|
+
referrer?: string;
|
|
332
|
+
utmtag?: string;
|
|
333
|
+
utmtagValue?: string;
|
|
334
|
+
visitor_id?: string;
|
|
335
|
+
}
|
|
336
|
+
export interface TileVisitorsByBrowserParams {
|
|
337
|
+
project_id: string;
|
|
338
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
339
|
+
customer_id?: string;
|
|
340
|
+
limit?: number;
|
|
341
|
+
offset?: number;
|
|
342
|
+
referrer?: string;
|
|
343
|
+
utmtag?: string;
|
|
344
|
+
utmtagValue?: string;
|
|
345
|
+
visitor_id?: string;
|
|
346
|
+
}
|
|
347
|
+
export interface TileVisitorsByOsParams {
|
|
348
|
+
project_id: string;
|
|
349
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
350
|
+
customer_id?: string;
|
|
351
|
+
limit?: number;
|
|
352
|
+
offset?: number;
|
|
353
|
+
referrer?: string;
|
|
354
|
+
utmtag?: string;
|
|
355
|
+
utmtagValue?: string;
|
|
356
|
+
visitor_id?: string;
|
|
357
|
+
}
|
|
358
|
+
export interface TileWauParams {
|
|
359
|
+
project_id: string;
|
|
360
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
361
|
+
customer_id?: string;
|
|
362
|
+
limit?: number;
|
|
363
|
+
offset?: number;
|
|
364
|
+
referrer?: string;
|
|
365
|
+
utmtag?: string;
|
|
366
|
+
utmtagValue?: string;
|
|
367
|
+
visitor_id?: string;
|
|
368
|
+
}
|
|
369
|
+
export declare namespace Tiles {
|
|
370
|
+
export { type TileBounceRateParams as TileBounceRateParams, type TileDauParams as TileDauParams, type TileMauParams as TileMauParams, type TilePagesPerSessionParams as TilePagesPerSessionParams, type TileReturnRateParams as TileReturnRateParams, type TileSessionDurationParams as TileSessionDurationParams, type TileTimeBetweenVisitsParams as TileTimeBetweenVisitsParams, type TileTrafficByCountryParams as TileTrafficByCountryParams, type TileTrafficByRefererParams as TileTrafficByRefererParams, type TileTrafficByUtmParams as TileTrafficByUtmParams, type TileUniqueSessionsParams as TileUniqueSessionsParams, type TileUniqueVisitorsParams as TileUniqueVisitorsParams, type TileVisitorsByBrowserParams as TileVisitorsByBrowserParams, type TileVisitorsByOsParams as TileVisitorsByOsParams, type TileWauParams as TileWauParams, };
|
|
371
|
+
}
|
|
372
|
+
//# sourceMappingURL=tiles.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tiles.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/tiles.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;OAWG;IACH,UAAU,CACR,KAAK,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,kBAAkB,CAAC;IAI9C;;;;;;;;;;OAUG;IACH,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,WAAW,CAAC;IAIzF;;;;;;;;;;OAUG;IACH,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,WAAW,CAAC;IAIzF;;;;;;;;;;;;OAYG;IACH,eAAe,CACb,KAAK,EAAE,yBAAyB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,uBAAuB,CAAC;IAInD;;;;;;;;;;;;OAYG;IACH,UAAU,CACR,KAAK,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,kBAAkB,CAAC;IAI9C;;;;;;;;;;;;OAYG;IACH,eAAe,CACb,KAAK,EAAE,yBAAyB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,uBAAuB,CAAC;IAInD;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,KAAK,EAAE,2BAA2B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,yBAAyB,CAAC;IAIrD;;;;;;;;;;;OAWG;IACH,gBAAgB,CACd,KAAK,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,4BAA4B,CAAC;IAIxD;;;;;;;;;;;OAWG;IACH,gBAAgB,CACd,KAAK,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,4BAA4B,CAAC;IAIxD;;;;;;;;;;;OAWG;IACH,YAAY,CACV,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,wBAAwB,CAAC;IAIpD;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,sBAAsB,CAAC;IAIlD;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,sBAAsB,CAAC;IAIlD;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,KAAK,EAAE,2BAA2B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,yBAAyB,CAAC;IAIrD;;;;;;;;;;;OAWG;IACH,YAAY,CACV,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,oBAAoB,CAAC;IAIhD;;;;;;;;;;OAUG;IACH,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,WAAW,CAAC;CAG1F;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}
|
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Tiles = void 0;
|
|
5
|
+
const resource_1 = require("../../../core/resource.js");
|
|
6
|
+
class Tiles extends resource_1.APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Get bounce rate percentage for current period compared to the previous period
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const bounceRateResponse =
|
|
13
|
+
* await client.v1.analytics.tiles.bounceRate({
|
|
14
|
+
* project_id: 'project_id',
|
|
15
|
+
* time_range: 'last_hour',
|
|
16
|
+
* });
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
bounceRate(query, options) {
|
|
20
|
+
return this._client.get('/api/v1/analytics/tiles/bounce-rate', { query, ...options });
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Get daily active user count (last 24h) compared to the previous day
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```ts
|
|
27
|
+
* const dauResponse = await client.v1.analytics.tiles.dau({
|
|
28
|
+
* project_id: 'project_id',
|
|
29
|
+
* time_range: 'last_hour',
|
|
30
|
+
* });
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
dau(query, options) {
|
|
34
|
+
return this._client.get('/api/v1/analytics/tiles/dau', { query, ...options });
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Get monthly active user count (last 30 days) compared to the previous month
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```ts
|
|
41
|
+
* const mauResponse = await client.v1.analytics.tiles.mau({
|
|
42
|
+
* project_id: 'project_id',
|
|
43
|
+
* time_range: 'last_hour',
|
|
44
|
+
* });
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
mau(query, options) {
|
|
48
|
+
return this._client.get('/api/v1/analytics/tiles/mau', { query, ...options });
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Get average number of pages viewed per session for current period compared to
|
|
52
|
+
* the previous period
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* ```ts
|
|
56
|
+
* const pagesPerSessionResponse =
|
|
57
|
+
* await client.v1.analytics.tiles.pagesPerSession({
|
|
58
|
+
* project_id: 'project_id',
|
|
59
|
+
* time_range: 'last_hour',
|
|
60
|
+
* });
|
|
61
|
+
* ```
|
|
62
|
+
*/
|
|
63
|
+
pagesPerSession(query, options) {
|
|
64
|
+
return this._client.get('/api/v1/analytics/tiles/pages-per-session', { query, ...options });
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Get percentage of visitors with more than one session for current period
|
|
68
|
+
* compared to the previous period
|
|
69
|
+
*
|
|
70
|
+
* @example
|
|
71
|
+
* ```ts
|
|
72
|
+
* const returnRateResponse =
|
|
73
|
+
* await client.v1.analytics.tiles.returnRate({
|
|
74
|
+
* project_id: 'project_id',
|
|
75
|
+
* time_range: 'last_hour',
|
|
76
|
+
* });
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
returnRate(query, options) {
|
|
80
|
+
return this._client.get('/api/v1/analytics/tiles/return-rate', { query, ...options });
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Get average session duration in seconds for current period compared to the
|
|
84
|
+
* previous period
|
|
85
|
+
*
|
|
86
|
+
* @example
|
|
87
|
+
* ```ts
|
|
88
|
+
* const sessionDurationResponse =
|
|
89
|
+
* await client.v1.analytics.tiles.sessionDuration({
|
|
90
|
+
* project_id: 'project_id',
|
|
91
|
+
* time_range: 'last_hour',
|
|
92
|
+
* });
|
|
93
|
+
* ```
|
|
94
|
+
*/
|
|
95
|
+
sessionDuration(query, options) {
|
|
96
|
+
return this._client.get('/api/v1/analytics/tiles/session-duration', { query, ...options });
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Get average hours between consecutive visits per visitor for current period
|
|
100
|
+
* compared to the previous period
|
|
101
|
+
*
|
|
102
|
+
* @example
|
|
103
|
+
* ```ts
|
|
104
|
+
* const timeBetweenVisitsResponse =
|
|
105
|
+
* await client.v1.analytics.tiles.timeBetweenVisits({
|
|
106
|
+
* project_id: 'project_id',
|
|
107
|
+
* time_range: 'last_hour',
|
|
108
|
+
* });
|
|
109
|
+
* ```
|
|
110
|
+
*/
|
|
111
|
+
timeBetweenVisits(query, options) {
|
|
112
|
+
return this._client.get('/api/v1/analytics/tiles/time-between-visits', { query, ...options });
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* Get unique visitor counts grouped by country code
|
|
116
|
+
*
|
|
117
|
+
* @example
|
|
118
|
+
* ```ts
|
|
119
|
+
* const countryTrafficSourceResponse =
|
|
120
|
+
* await client.v1.analytics.tiles.trafficByCountry({
|
|
121
|
+
* project_id: 'project_id',
|
|
122
|
+
* time_range: 'last_hour',
|
|
123
|
+
* });
|
|
124
|
+
* ```
|
|
125
|
+
*/
|
|
126
|
+
trafficByCountry(query, options) {
|
|
127
|
+
return this._client.get('/api/v1/analytics/tiles/traffic-by-country', { query, ...options });
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* Get unique visitor counts grouped by referrer domain (traffic source)
|
|
131
|
+
*
|
|
132
|
+
* @example
|
|
133
|
+
* ```ts
|
|
134
|
+
* const refererTrafficSourceResponse =
|
|
135
|
+
* await client.v1.analytics.tiles.trafficByReferer({
|
|
136
|
+
* project_id: 'project_id',
|
|
137
|
+
* time_range: 'last_hour',
|
|
138
|
+
* });
|
|
139
|
+
* ```
|
|
140
|
+
*/
|
|
141
|
+
trafficByReferer(query, options) {
|
|
142
|
+
return this._client.get('/api/v1/analytics/tiles/traffic-by-referer', { query, ...options });
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Get unique visitor counts grouped by UTM source, medium, and campaign
|
|
146
|
+
*
|
|
147
|
+
* @example
|
|
148
|
+
* ```ts
|
|
149
|
+
* const utmTrafficSourceResponse =
|
|
150
|
+
* await client.v1.analytics.tiles.trafficByUtm({
|
|
151
|
+
* project_id: 'project_id',
|
|
152
|
+
* time_range: 'last_hour',
|
|
153
|
+
* });
|
|
154
|
+
* ```
|
|
155
|
+
*/
|
|
156
|
+
trafficByUtm(query, options) {
|
|
157
|
+
return this._client.get('/api/v1/analytics/tiles/traffic-by-utm', { query, ...options });
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* Get unique session count for current period compared to the previous period
|
|
161
|
+
*
|
|
162
|
+
* @example
|
|
163
|
+
* ```ts
|
|
164
|
+
* const uniqueSessionsResponse =
|
|
165
|
+
* await client.v1.analytics.tiles.uniqueSessions({
|
|
166
|
+
* project_id: 'project_id',
|
|
167
|
+
* time_range: 'last_hour',
|
|
168
|
+
* });
|
|
169
|
+
* ```
|
|
170
|
+
*/
|
|
171
|
+
uniqueSessions(query, options) {
|
|
172
|
+
return this._client.get('/api/v1/analytics/tiles/unique-sessions', { query, ...options });
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* Get unique visitor count for current period compared to the previous period
|
|
176
|
+
*
|
|
177
|
+
* @example
|
|
178
|
+
* ```ts
|
|
179
|
+
* const uniqueVisitorsResponse =
|
|
180
|
+
* await client.v1.analytics.tiles.uniqueVisitors({
|
|
181
|
+
* project_id: 'project_id',
|
|
182
|
+
* time_range: 'last_hour',
|
|
183
|
+
* });
|
|
184
|
+
* ```
|
|
185
|
+
*/
|
|
186
|
+
uniqueVisitors(query, options) {
|
|
187
|
+
return this._client.get('/api/v1/analytics/tiles/unique-visitors', { query, ...options });
|
|
188
|
+
}
|
|
189
|
+
/**
|
|
190
|
+
* Get number of visitors by browser for current period compared to the previous
|
|
191
|
+
* period
|
|
192
|
+
*
|
|
193
|
+
* @example
|
|
194
|
+
* ```ts
|
|
195
|
+
* const visitorsByBrowserResponse =
|
|
196
|
+
* await client.v1.analytics.tiles.visitorsByBrowser({
|
|
197
|
+
* project_id: 'project_id',
|
|
198
|
+
* time_range: 'last_hour',
|
|
199
|
+
* });
|
|
200
|
+
* ```
|
|
201
|
+
*/
|
|
202
|
+
visitorsByBrowser(query, options) {
|
|
203
|
+
return this._client.get('/api/v1/analytics/tiles/visitors-by-browser', { query, ...options });
|
|
204
|
+
}
|
|
205
|
+
/**
|
|
206
|
+
* Get number of visitors by OS for current period compared to the previous period
|
|
207
|
+
*
|
|
208
|
+
* @example
|
|
209
|
+
* ```ts
|
|
210
|
+
* const visitorsByOsResponse =
|
|
211
|
+
* await client.v1.analytics.tiles.visitorsByOs({
|
|
212
|
+
* project_id: 'project_id',
|
|
213
|
+
* time_range: 'last_hour',
|
|
214
|
+
* });
|
|
215
|
+
* ```
|
|
216
|
+
*/
|
|
217
|
+
visitorsByOs(query, options) {
|
|
218
|
+
return this._client.get('/api/v1/analytics/tiles/visitors-by-os', { query, ...options });
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* Get weekly active user count (last 7 days) compared to the previous week
|
|
222
|
+
*
|
|
223
|
+
* @example
|
|
224
|
+
* ```ts
|
|
225
|
+
* const wauResponse = await client.v1.analytics.tiles.wau({
|
|
226
|
+
* project_id: 'project_id',
|
|
227
|
+
* time_range: 'last_hour',
|
|
228
|
+
* });
|
|
229
|
+
* ```
|
|
230
|
+
*/
|
|
231
|
+
wau(query, options) {
|
|
232
|
+
return this._client.get('/api/v1/analytics/tiles/wau', { query, ...options });
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
exports.Tiles = Tiles;
|
|
236
|
+
//# sourceMappingURL=tiles.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tiles.js","sourceRoot":"","sources":["../../../src/resources/v1/analytics/tiles.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;OAWG;IACH,UAAU,CACR,KAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,KAAoB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,KAAoB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,eAAe,CACb,KAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2CAA2C,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,UAAU,CACR,KAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,eAAe,CACb,KAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0CAA0C,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,KAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6CAA6C,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,gBAAgB,CACd,KAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,gBAAgB,CACd,KAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wCAAwC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yCAAyC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yCAAyC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,KAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6CAA6C,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wCAAwC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,KAAoB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAtRD,sBAsRC"}
|