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,232 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../../core/resource.mjs";
|
|
3
|
+
export class Tiles extends APIResource {
|
|
4
|
+
/**
|
|
5
|
+
* Get bounce rate percentage for current period compared to the previous period
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* ```ts
|
|
9
|
+
* const bounceRateResponse =
|
|
10
|
+
* await client.v1.analytics.tiles.bounceRate({
|
|
11
|
+
* project_id: 'project_id',
|
|
12
|
+
* time_range: 'last_hour',
|
|
13
|
+
* });
|
|
14
|
+
* ```
|
|
15
|
+
*/
|
|
16
|
+
bounceRate(query, options) {
|
|
17
|
+
return this._client.get('/api/v1/analytics/tiles/bounce-rate', { query, ...options });
|
|
18
|
+
}
|
|
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, options) {
|
|
31
|
+
return this._client.get('/api/v1/analytics/tiles/dau', { query, ...options });
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Get monthly active user count (last 30 days) compared to the previous month
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```ts
|
|
38
|
+
* const mauResponse = await client.v1.analytics.tiles.mau({
|
|
39
|
+
* project_id: 'project_id',
|
|
40
|
+
* time_range: 'last_hour',
|
|
41
|
+
* });
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
mau(query, options) {
|
|
45
|
+
return this._client.get('/api/v1/analytics/tiles/mau', { query, ...options });
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Get average number of pages viewed per session for current period compared to
|
|
49
|
+
* the previous period
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* ```ts
|
|
53
|
+
* const pagesPerSessionResponse =
|
|
54
|
+
* await client.v1.analytics.tiles.pagesPerSession({
|
|
55
|
+
* project_id: 'project_id',
|
|
56
|
+
* time_range: 'last_hour',
|
|
57
|
+
* });
|
|
58
|
+
* ```
|
|
59
|
+
*/
|
|
60
|
+
pagesPerSession(query, options) {
|
|
61
|
+
return this._client.get('/api/v1/analytics/tiles/pages-per-session', { query, ...options });
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Get percentage of visitors with more than one session for current period
|
|
65
|
+
* compared to the previous period
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* ```ts
|
|
69
|
+
* const returnRateResponse =
|
|
70
|
+
* await client.v1.analytics.tiles.returnRate({
|
|
71
|
+
* project_id: 'project_id',
|
|
72
|
+
* time_range: 'last_hour',
|
|
73
|
+
* });
|
|
74
|
+
* ```
|
|
75
|
+
*/
|
|
76
|
+
returnRate(query, options) {
|
|
77
|
+
return this._client.get('/api/v1/analytics/tiles/return-rate', { query, ...options });
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Get average session duration in seconds for current period compared to the
|
|
81
|
+
* previous period
|
|
82
|
+
*
|
|
83
|
+
* @example
|
|
84
|
+
* ```ts
|
|
85
|
+
* const sessionDurationResponse =
|
|
86
|
+
* await client.v1.analytics.tiles.sessionDuration({
|
|
87
|
+
* project_id: 'project_id',
|
|
88
|
+
* time_range: 'last_hour',
|
|
89
|
+
* });
|
|
90
|
+
* ```
|
|
91
|
+
*/
|
|
92
|
+
sessionDuration(query, options) {
|
|
93
|
+
return this._client.get('/api/v1/analytics/tiles/session-duration', { query, ...options });
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Get average hours between consecutive visits per visitor for current period
|
|
97
|
+
* compared to the previous period
|
|
98
|
+
*
|
|
99
|
+
* @example
|
|
100
|
+
* ```ts
|
|
101
|
+
* const timeBetweenVisitsResponse =
|
|
102
|
+
* await client.v1.analytics.tiles.timeBetweenVisits({
|
|
103
|
+
* project_id: 'project_id',
|
|
104
|
+
* time_range: 'last_hour',
|
|
105
|
+
* });
|
|
106
|
+
* ```
|
|
107
|
+
*/
|
|
108
|
+
timeBetweenVisits(query, options) {
|
|
109
|
+
return this._client.get('/api/v1/analytics/tiles/time-between-visits', { query, ...options });
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Get unique visitor counts grouped by country code
|
|
113
|
+
*
|
|
114
|
+
* @example
|
|
115
|
+
* ```ts
|
|
116
|
+
* const countryTrafficSourceResponse =
|
|
117
|
+
* await client.v1.analytics.tiles.trafficByCountry({
|
|
118
|
+
* project_id: 'project_id',
|
|
119
|
+
* time_range: 'last_hour',
|
|
120
|
+
* });
|
|
121
|
+
* ```
|
|
122
|
+
*/
|
|
123
|
+
trafficByCountry(query, options) {
|
|
124
|
+
return this._client.get('/api/v1/analytics/tiles/traffic-by-country', { query, ...options });
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Get unique visitor counts grouped by referrer domain (traffic source)
|
|
128
|
+
*
|
|
129
|
+
* @example
|
|
130
|
+
* ```ts
|
|
131
|
+
* const refererTrafficSourceResponse =
|
|
132
|
+
* await client.v1.analytics.tiles.trafficByReferer({
|
|
133
|
+
* project_id: 'project_id',
|
|
134
|
+
* time_range: 'last_hour',
|
|
135
|
+
* });
|
|
136
|
+
* ```
|
|
137
|
+
*/
|
|
138
|
+
trafficByReferer(query, options) {
|
|
139
|
+
return this._client.get('/api/v1/analytics/tiles/traffic-by-referer', { query, ...options });
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* Get unique visitor counts grouped by UTM source, medium, and campaign
|
|
143
|
+
*
|
|
144
|
+
* @example
|
|
145
|
+
* ```ts
|
|
146
|
+
* const utmTrafficSourceResponse =
|
|
147
|
+
* await client.v1.analytics.tiles.trafficByUtm({
|
|
148
|
+
* project_id: 'project_id',
|
|
149
|
+
* time_range: 'last_hour',
|
|
150
|
+
* });
|
|
151
|
+
* ```
|
|
152
|
+
*/
|
|
153
|
+
trafficByUtm(query, options) {
|
|
154
|
+
return this._client.get('/api/v1/analytics/tiles/traffic-by-utm', { query, ...options });
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* Get unique session count for current period compared to the previous period
|
|
158
|
+
*
|
|
159
|
+
* @example
|
|
160
|
+
* ```ts
|
|
161
|
+
* const uniqueSessionsResponse =
|
|
162
|
+
* await client.v1.analytics.tiles.uniqueSessions({
|
|
163
|
+
* project_id: 'project_id',
|
|
164
|
+
* time_range: 'last_hour',
|
|
165
|
+
* });
|
|
166
|
+
* ```
|
|
167
|
+
*/
|
|
168
|
+
uniqueSessions(query, options) {
|
|
169
|
+
return this._client.get('/api/v1/analytics/tiles/unique-sessions', { query, ...options });
|
|
170
|
+
}
|
|
171
|
+
/**
|
|
172
|
+
* Get unique visitor count for current period compared to the previous period
|
|
173
|
+
*
|
|
174
|
+
* @example
|
|
175
|
+
* ```ts
|
|
176
|
+
* const uniqueVisitorsResponse =
|
|
177
|
+
* await client.v1.analytics.tiles.uniqueVisitors({
|
|
178
|
+
* project_id: 'project_id',
|
|
179
|
+
* time_range: 'last_hour',
|
|
180
|
+
* });
|
|
181
|
+
* ```
|
|
182
|
+
*/
|
|
183
|
+
uniqueVisitors(query, options) {
|
|
184
|
+
return this._client.get('/api/v1/analytics/tiles/unique-visitors', { query, ...options });
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* Get number of visitors by browser for current period compared to the previous
|
|
188
|
+
* period
|
|
189
|
+
*
|
|
190
|
+
* @example
|
|
191
|
+
* ```ts
|
|
192
|
+
* const visitorsByBrowserResponse =
|
|
193
|
+
* await client.v1.analytics.tiles.visitorsByBrowser({
|
|
194
|
+
* project_id: 'project_id',
|
|
195
|
+
* time_range: 'last_hour',
|
|
196
|
+
* });
|
|
197
|
+
* ```
|
|
198
|
+
*/
|
|
199
|
+
visitorsByBrowser(query, options) {
|
|
200
|
+
return this._client.get('/api/v1/analytics/tiles/visitors-by-browser', { query, ...options });
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* Get number of visitors by OS for current period compared to the previous period
|
|
204
|
+
*
|
|
205
|
+
* @example
|
|
206
|
+
* ```ts
|
|
207
|
+
* const visitorsByOsResponse =
|
|
208
|
+
* await client.v1.analytics.tiles.visitorsByOs({
|
|
209
|
+
* project_id: 'project_id',
|
|
210
|
+
* time_range: 'last_hour',
|
|
211
|
+
* });
|
|
212
|
+
* ```
|
|
213
|
+
*/
|
|
214
|
+
visitorsByOs(query, options) {
|
|
215
|
+
return this._client.get('/api/v1/analytics/tiles/visitors-by-os', { query, ...options });
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* Get weekly active user count (last 7 days) compared to the previous week
|
|
219
|
+
*
|
|
220
|
+
* @example
|
|
221
|
+
* ```ts
|
|
222
|
+
* const wauResponse = await client.v1.analytics.tiles.wau({
|
|
223
|
+
* project_id: 'project_id',
|
|
224
|
+
* time_range: 'last_hour',
|
|
225
|
+
* });
|
|
226
|
+
* ```
|
|
227
|
+
*/
|
|
228
|
+
wau(query, options) {
|
|
229
|
+
return this._client.get('/api/v1/analytics/tiles/wau', { query, ...options });
|
|
230
|
+
}
|
|
231
|
+
}
|
|
232
|
+
//# sourceMappingURL=tiles.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tiles.mjs","sourceRoot":"","sources":["../../../src/resources/v1/analytics/tiles.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,KAAM,SAAQ,WAAW;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"}
|
|
@@ -3,19 +3,6 @@ import * as AnalyticsAPI from "./analytics.mjs";
|
|
|
3
3
|
import { APIPromise } from "../../../core/api-promise.mjs";
|
|
4
4
|
import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
5
5
|
export declare class Visitors extends APIResource {
|
|
6
|
-
/**
|
|
7
|
-
* Get unique visitor counts grouped by country code
|
|
8
|
-
*
|
|
9
|
-
* @example
|
|
10
|
-
* ```ts
|
|
11
|
-
* const visitorsByCountryResponse =
|
|
12
|
-
* await client.v1.analytics.visitors.byCountry({
|
|
13
|
-
* project_id: 'project_id',
|
|
14
|
-
* time_range: 'last_hour',
|
|
15
|
-
* });
|
|
16
|
-
* ```
|
|
17
|
-
*/
|
|
18
|
-
byCountry(query: VisitorByCountryParams, options?: RequestOptions): APIPromise<AnalyticsAPI.VisitorsByCountryResponse>;
|
|
19
6
|
/**
|
|
20
7
|
* Get visitor counts grouped by device type (mobile, desktop, tablet) over a
|
|
21
8
|
* specified time range
|
|
@@ -30,19 +17,6 @@ export declare class Visitors extends APIResource {
|
|
|
30
17
|
* ```
|
|
31
18
|
*/
|
|
32
19
|
byDevice(query: VisitorByDeviceParams, options?: RequestOptions): APIPromise<AnalyticsAPI.VisitorsByDeviceResponse>;
|
|
33
|
-
/**
|
|
34
|
-
* Get unique visitor counts grouped by referrer domain (traffic source)
|
|
35
|
-
*
|
|
36
|
-
* @example
|
|
37
|
-
* ```ts
|
|
38
|
-
* const visitorsByOriginResponse =
|
|
39
|
-
* await client.v1.analytics.visitors.byOrigin({
|
|
40
|
-
* project_id: 'project_id',
|
|
41
|
-
* time_range: 'last_hour',
|
|
42
|
-
* });
|
|
43
|
-
* ```
|
|
44
|
-
*/
|
|
45
|
-
byOrigin(query: VisitorByOriginParams, options?: RequestOptions): APIPromise<AnalyticsAPI.VisitorsByOriginResponse>;
|
|
46
20
|
/**
|
|
47
21
|
* Manually identify a visitor by updating their profile information from the
|
|
48
22
|
* dashboard
|
|
@@ -70,20 +44,6 @@ export declare class Visitors extends APIResource {
|
|
|
70
44
|
* ```
|
|
71
45
|
*/
|
|
72
46
|
profile(query: VisitorProfileParams, options?: RequestOptions): APIPromise<AnalyticsAPI.VisitorProfileResponse>;
|
|
73
|
-
/**
|
|
74
|
-
* Get unique visitor counts over time, split by mobile and desktop devices for
|
|
75
|
-
* chart visualization
|
|
76
|
-
*
|
|
77
|
-
* @example
|
|
78
|
-
* ```ts
|
|
79
|
-
* const uniqueVisitorsTimelineResponse =
|
|
80
|
-
* await client.v1.analytics.visitors.timeline({
|
|
81
|
-
* project_id: 'project_id',
|
|
82
|
-
* time_range: 'last_hour',
|
|
83
|
-
* });
|
|
84
|
-
* ```
|
|
85
|
-
*/
|
|
86
|
-
timeline(query: VisitorTimelineParams, options?: RequestOptions): APIPromise<AnalyticsAPI.UniqueVisitorsTimelineResponse>;
|
|
87
47
|
/**
|
|
88
48
|
* Get top visitors grouped by identified information (user_id, external_id, email)
|
|
89
49
|
* with payment metrics including revenue, distinct payments, and time to first
|
|
@@ -100,17 +60,6 @@ export declare class Visitors extends APIResource {
|
|
|
100
60
|
*/
|
|
101
61
|
top(query: VisitorTopParams, options?: RequestOptions): APIPromise<AnalyticsAPI.TopVisitorsResponse>;
|
|
102
62
|
}
|
|
103
|
-
export interface VisitorByCountryParams {
|
|
104
|
-
project_id: string;
|
|
105
|
-
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
106
|
-
customer_id?: string;
|
|
107
|
-
limit?: number;
|
|
108
|
-
offset?: number;
|
|
109
|
-
referrer?: string;
|
|
110
|
-
utmtag?: string;
|
|
111
|
-
utmtagValue?: string;
|
|
112
|
-
visitor_id?: string;
|
|
113
|
-
}
|
|
114
63
|
export interface VisitorByDeviceParams {
|
|
115
64
|
project_id: string;
|
|
116
65
|
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
@@ -122,17 +71,6 @@ export interface VisitorByDeviceParams {
|
|
|
122
71
|
utmtagValue?: string;
|
|
123
72
|
visitor_id?: string;
|
|
124
73
|
}
|
|
125
|
-
export interface VisitorByOriginParams {
|
|
126
|
-
project_id: string;
|
|
127
|
-
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
128
|
-
customer_id?: string;
|
|
129
|
-
limit?: number;
|
|
130
|
-
offset?: number;
|
|
131
|
-
referrer?: string;
|
|
132
|
-
utmtag?: string;
|
|
133
|
-
utmtagValue?: string;
|
|
134
|
-
visitor_id?: string;
|
|
135
|
-
}
|
|
136
74
|
export interface VisitorIdentifyParams {
|
|
137
75
|
project_id: string;
|
|
138
76
|
visitor_id: string;
|
|
@@ -150,17 +88,6 @@ export interface VisitorProfileParams {
|
|
|
150
88
|
customer_id?: string;
|
|
151
89
|
visitor_id?: string;
|
|
152
90
|
}
|
|
153
|
-
export interface VisitorTimelineParams {
|
|
154
|
-
project_id: string;
|
|
155
|
-
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
156
|
-
customer_id?: string;
|
|
157
|
-
limit?: number;
|
|
158
|
-
offset?: number;
|
|
159
|
-
referrer?: string;
|
|
160
|
-
utmtag?: string;
|
|
161
|
-
utmtagValue?: string;
|
|
162
|
-
visitor_id?: string;
|
|
163
|
-
}
|
|
164
91
|
export interface VisitorTopParams {
|
|
165
92
|
project_id: string;
|
|
166
93
|
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
@@ -173,6 +100,6 @@ export interface VisitorTopParams {
|
|
|
173
100
|
visitor_id?: string;
|
|
174
101
|
}
|
|
175
102
|
export declare namespace Visitors {
|
|
176
|
-
export { type
|
|
103
|
+
export { type VisitorByDeviceParams as VisitorByDeviceParams, type VisitorIdentifyParams as VisitorIdentifyParams, type VisitorProfileParams as VisitorProfileParams, type VisitorTopParams as VisitorTopParams, };
|
|
177
104
|
}
|
|
178
105
|
//# sourceMappingURL=visitors.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"visitors.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/visitors.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC
|
|
1
|
+
{"version":3,"file":"visitors.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/visitors.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,wBAAwB,CAAC;IAIpD;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,sBAAsB,CAAC;IAIlD;;;;;;;;;;;OAWG;IACH,OAAO,CACL,KAAK,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,sBAAsB,CAAC;IAIlD;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,mBAAmB,CAAC;CAGrG;AAED,MAAM,WAAW,qBAAqB;IACpC,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,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,MAAM,CAAC;IAEnB,qBAAqB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnD,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,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,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
|
@@ -3,19 +3,6 @@ import * as AnalyticsAPI from "./analytics.js";
|
|
|
3
3
|
import { APIPromise } from "../../../core/api-promise.js";
|
|
4
4
|
import { RequestOptions } from "../../../internal/request-options.js";
|
|
5
5
|
export declare class Visitors extends APIResource {
|
|
6
|
-
/**
|
|
7
|
-
* Get unique visitor counts grouped by country code
|
|
8
|
-
*
|
|
9
|
-
* @example
|
|
10
|
-
* ```ts
|
|
11
|
-
* const visitorsByCountryResponse =
|
|
12
|
-
* await client.v1.analytics.visitors.byCountry({
|
|
13
|
-
* project_id: 'project_id',
|
|
14
|
-
* time_range: 'last_hour',
|
|
15
|
-
* });
|
|
16
|
-
* ```
|
|
17
|
-
*/
|
|
18
|
-
byCountry(query: VisitorByCountryParams, options?: RequestOptions): APIPromise<AnalyticsAPI.VisitorsByCountryResponse>;
|
|
19
6
|
/**
|
|
20
7
|
* Get visitor counts grouped by device type (mobile, desktop, tablet) over a
|
|
21
8
|
* specified time range
|
|
@@ -30,19 +17,6 @@ export declare class Visitors extends APIResource {
|
|
|
30
17
|
* ```
|
|
31
18
|
*/
|
|
32
19
|
byDevice(query: VisitorByDeviceParams, options?: RequestOptions): APIPromise<AnalyticsAPI.VisitorsByDeviceResponse>;
|
|
33
|
-
/**
|
|
34
|
-
* Get unique visitor counts grouped by referrer domain (traffic source)
|
|
35
|
-
*
|
|
36
|
-
* @example
|
|
37
|
-
* ```ts
|
|
38
|
-
* const visitorsByOriginResponse =
|
|
39
|
-
* await client.v1.analytics.visitors.byOrigin({
|
|
40
|
-
* project_id: 'project_id',
|
|
41
|
-
* time_range: 'last_hour',
|
|
42
|
-
* });
|
|
43
|
-
* ```
|
|
44
|
-
*/
|
|
45
|
-
byOrigin(query: VisitorByOriginParams, options?: RequestOptions): APIPromise<AnalyticsAPI.VisitorsByOriginResponse>;
|
|
46
20
|
/**
|
|
47
21
|
* Manually identify a visitor by updating their profile information from the
|
|
48
22
|
* dashboard
|
|
@@ -70,20 +44,6 @@ export declare class Visitors extends APIResource {
|
|
|
70
44
|
* ```
|
|
71
45
|
*/
|
|
72
46
|
profile(query: VisitorProfileParams, options?: RequestOptions): APIPromise<AnalyticsAPI.VisitorProfileResponse>;
|
|
73
|
-
/**
|
|
74
|
-
* Get unique visitor counts over time, split by mobile and desktop devices for
|
|
75
|
-
* chart visualization
|
|
76
|
-
*
|
|
77
|
-
* @example
|
|
78
|
-
* ```ts
|
|
79
|
-
* const uniqueVisitorsTimelineResponse =
|
|
80
|
-
* await client.v1.analytics.visitors.timeline({
|
|
81
|
-
* project_id: 'project_id',
|
|
82
|
-
* time_range: 'last_hour',
|
|
83
|
-
* });
|
|
84
|
-
* ```
|
|
85
|
-
*/
|
|
86
|
-
timeline(query: VisitorTimelineParams, options?: RequestOptions): APIPromise<AnalyticsAPI.UniqueVisitorsTimelineResponse>;
|
|
87
47
|
/**
|
|
88
48
|
* Get top visitors grouped by identified information (user_id, external_id, email)
|
|
89
49
|
* with payment metrics including revenue, distinct payments, and time to first
|
|
@@ -100,17 +60,6 @@ export declare class Visitors extends APIResource {
|
|
|
100
60
|
*/
|
|
101
61
|
top(query: VisitorTopParams, options?: RequestOptions): APIPromise<AnalyticsAPI.TopVisitorsResponse>;
|
|
102
62
|
}
|
|
103
|
-
export interface VisitorByCountryParams {
|
|
104
|
-
project_id: string;
|
|
105
|
-
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
106
|
-
customer_id?: string;
|
|
107
|
-
limit?: number;
|
|
108
|
-
offset?: number;
|
|
109
|
-
referrer?: string;
|
|
110
|
-
utmtag?: string;
|
|
111
|
-
utmtagValue?: string;
|
|
112
|
-
visitor_id?: string;
|
|
113
|
-
}
|
|
114
63
|
export interface VisitorByDeviceParams {
|
|
115
64
|
project_id: string;
|
|
116
65
|
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
@@ -122,17 +71,6 @@ export interface VisitorByDeviceParams {
|
|
|
122
71
|
utmtagValue?: string;
|
|
123
72
|
visitor_id?: string;
|
|
124
73
|
}
|
|
125
|
-
export interface VisitorByOriginParams {
|
|
126
|
-
project_id: string;
|
|
127
|
-
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
128
|
-
customer_id?: string;
|
|
129
|
-
limit?: number;
|
|
130
|
-
offset?: number;
|
|
131
|
-
referrer?: string;
|
|
132
|
-
utmtag?: string;
|
|
133
|
-
utmtagValue?: string;
|
|
134
|
-
visitor_id?: string;
|
|
135
|
-
}
|
|
136
74
|
export interface VisitorIdentifyParams {
|
|
137
75
|
project_id: string;
|
|
138
76
|
visitor_id: string;
|
|
@@ -150,17 +88,6 @@ export interface VisitorProfileParams {
|
|
|
150
88
|
customer_id?: string;
|
|
151
89
|
visitor_id?: string;
|
|
152
90
|
}
|
|
153
|
-
export interface VisitorTimelineParams {
|
|
154
|
-
project_id: string;
|
|
155
|
-
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
156
|
-
customer_id?: string;
|
|
157
|
-
limit?: number;
|
|
158
|
-
offset?: number;
|
|
159
|
-
referrer?: string;
|
|
160
|
-
utmtag?: string;
|
|
161
|
-
utmtagValue?: string;
|
|
162
|
-
visitor_id?: string;
|
|
163
|
-
}
|
|
164
91
|
export interface VisitorTopParams {
|
|
165
92
|
project_id: string;
|
|
166
93
|
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
@@ -173,6 +100,6 @@ export interface VisitorTopParams {
|
|
|
173
100
|
visitor_id?: string;
|
|
174
101
|
}
|
|
175
102
|
export declare namespace Visitors {
|
|
176
|
-
export { type
|
|
103
|
+
export { type VisitorByDeviceParams as VisitorByDeviceParams, type VisitorIdentifyParams as VisitorIdentifyParams, type VisitorProfileParams as VisitorProfileParams, type VisitorTopParams as VisitorTopParams, };
|
|
177
104
|
}
|
|
178
105
|
//# sourceMappingURL=visitors.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"visitors.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/visitors.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC
|
|
1
|
+
{"version":3,"file":"visitors.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/visitors.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,wBAAwB,CAAC;IAIpD;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,sBAAsB,CAAC;IAIlD;;;;;;;;;;;OAWG;IACH,OAAO,CACL,KAAK,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,sBAAsB,CAAC;IAIlD;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,mBAAmB,CAAC;CAGrG;AAED,MAAM,WAAW,qBAAqB;IACpC,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,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,MAAM,CAAC;IAEnB,qBAAqB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnD,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,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,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
|
@@ -4,21 +4,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.Visitors = void 0;
|
|
5
5
|
const resource_1 = require("../../../core/resource.js");
|
|
6
6
|
class Visitors extends resource_1.APIResource {
|
|
7
|
-
/**
|
|
8
|
-
* Get unique visitor counts grouped by country code
|
|
9
|
-
*
|
|
10
|
-
* @example
|
|
11
|
-
* ```ts
|
|
12
|
-
* const visitorsByCountryResponse =
|
|
13
|
-
* await client.v1.analytics.visitors.byCountry({
|
|
14
|
-
* project_id: 'project_id',
|
|
15
|
-
* time_range: 'last_hour',
|
|
16
|
-
* });
|
|
17
|
-
* ```
|
|
18
|
-
*/
|
|
19
|
-
byCountry(query, options) {
|
|
20
|
-
return this._client.get('/api/v1/analytics/visitors/country', { query, ...options });
|
|
21
|
-
}
|
|
22
7
|
/**
|
|
23
8
|
* Get visitor counts grouped by device type (mobile, desktop, tablet) over a
|
|
24
9
|
* specified time range
|
|
@@ -35,21 +20,6 @@ class Visitors extends resource_1.APIResource {
|
|
|
35
20
|
byDevice(query, options) {
|
|
36
21
|
return this._client.get('/api/v1/analytics/visitors/device', { query, ...options });
|
|
37
22
|
}
|
|
38
|
-
/**
|
|
39
|
-
* Get unique visitor counts grouped by referrer domain (traffic source)
|
|
40
|
-
*
|
|
41
|
-
* @example
|
|
42
|
-
* ```ts
|
|
43
|
-
* const visitorsByOriginResponse =
|
|
44
|
-
* await client.v1.analytics.visitors.byOrigin({
|
|
45
|
-
* project_id: 'project_id',
|
|
46
|
-
* time_range: 'last_hour',
|
|
47
|
-
* });
|
|
48
|
-
* ```
|
|
49
|
-
*/
|
|
50
|
-
byOrigin(query, options) {
|
|
51
|
-
return this._client.get('/api/v1/analytics/visitors/origin', { query, ...options });
|
|
52
|
-
}
|
|
53
23
|
/**
|
|
54
24
|
* Manually identify a visitor by updating their profile information from the
|
|
55
25
|
* dashboard
|
|
@@ -81,22 +51,6 @@ class Visitors extends resource_1.APIResource {
|
|
|
81
51
|
profile(query, options) {
|
|
82
52
|
return this._client.get('/api/v1/analytics/visitors/profile', { query, ...options });
|
|
83
53
|
}
|
|
84
|
-
/**
|
|
85
|
-
* Get unique visitor counts over time, split by mobile and desktop devices for
|
|
86
|
-
* chart visualization
|
|
87
|
-
*
|
|
88
|
-
* @example
|
|
89
|
-
* ```ts
|
|
90
|
-
* const uniqueVisitorsTimelineResponse =
|
|
91
|
-
* await client.v1.analytics.visitors.timeline({
|
|
92
|
-
* project_id: 'project_id',
|
|
93
|
-
* time_range: 'last_hour',
|
|
94
|
-
* });
|
|
95
|
-
* ```
|
|
96
|
-
*/
|
|
97
|
-
timeline(query, options) {
|
|
98
|
-
return this._client.get('/api/v1/analytics/visitors/timeline', { query, ...options });
|
|
99
|
-
}
|
|
100
54
|
/**
|
|
101
55
|
* Get top visitors grouped by identified information (user_id, external_id, email)
|
|
102
56
|
* with payment metrics including revenue, distinct payments, and time to first
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"visitors.js","sourceRoot":"","sources":["../../../src/resources/v1/analytics/visitors.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,MAAa,QAAS,SAAQ,sBAAW;IACvC
|
|
1
|
+
{"version":3,"file":"visitors.js","sourceRoot":"","sources":["../../../src/resources/v1/analytics/visitors.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,KAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CACL,KAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,KAAuB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF;AA7ED,4BA6EC"}
|
|
@@ -1,21 +1,6 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
import { APIResource } from "../../../core/resource.mjs";
|
|
3
3
|
export class Visitors extends APIResource {
|
|
4
|
-
/**
|
|
5
|
-
* Get unique visitor counts grouped by country code
|
|
6
|
-
*
|
|
7
|
-
* @example
|
|
8
|
-
* ```ts
|
|
9
|
-
* const visitorsByCountryResponse =
|
|
10
|
-
* await client.v1.analytics.visitors.byCountry({
|
|
11
|
-
* project_id: 'project_id',
|
|
12
|
-
* time_range: 'last_hour',
|
|
13
|
-
* });
|
|
14
|
-
* ```
|
|
15
|
-
*/
|
|
16
|
-
byCountry(query, options) {
|
|
17
|
-
return this._client.get('/api/v1/analytics/visitors/country', { query, ...options });
|
|
18
|
-
}
|
|
19
4
|
/**
|
|
20
5
|
* Get visitor counts grouped by device type (mobile, desktop, tablet) over a
|
|
21
6
|
* specified time range
|
|
@@ -32,21 +17,6 @@ export class Visitors extends APIResource {
|
|
|
32
17
|
byDevice(query, options) {
|
|
33
18
|
return this._client.get('/api/v1/analytics/visitors/device', { query, ...options });
|
|
34
19
|
}
|
|
35
|
-
/**
|
|
36
|
-
* Get unique visitor counts grouped by referrer domain (traffic source)
|
|
37
|
-
*
|
|
38
|
-
* @example
|
|
39
|
-
* ```ts
|
|
40
|
-
* const visitorsByOriginResponse =
|
|
41
|
-
* await client.v1.analytics.visitors.byOrigin({
|
|
42
|
-
* project_id: 'project_id',
|
|
43
|
-
* time_range: 'last_hour',
|
|
44
|
-
* });
|
|
45
|
-
* ```
|
|
46
|
-
*/
|
|
47
|
-
byOrigin(query, options) {
|
|
48
|
-
return this._client.get('/api/v1/analytics/visitors/origin', { query, ...options });
|
|
49
|
-
}
|
|
50
20
|
/**
|
|
51
21
|
* Manually identify a visitor by updating their profile information from the
|
|
52
22
|
* dashboard
|
|
@@ -78,22 +48,6 @@ export class Visitors extends APIResource {
|
|
|
78
48
|
profile(query, options) {
|
|
79
49
|
return this._client.get('/api/v1/analytics/visitors/profile', { query, ...options });
|
|
80
50
|
}
|
|
81
|
-
/**
|
|
82
|
-
* Get unique visitor counts over time, split by mobile and desktop devices for
|
|
83
|
-
* chart visualization
|
|
84
|
-
*
|
|
85
|
-
* @example
|
|
86
|
-
* ```ts
|
|
87
|
-
* const uniqueVisitorsTimelineResponse =
|
|
88
|
-
* await client.v1.analytics.visitors.timeline({
|
|
89
|
-
* project_id: 'project_id',
|
|
90
|
-
* time_range: 'last_hour',
|
|
91
|
-
* });
|
|
92
|
-
* ```
|
|
93
|
-
*/
|
|
94
|
-
timeline(query, options) {
|
|
95
|
-
return this._client.get('/api/v1/analytics/visitors/timeline', { query, ...options });
|
|
96
|
-
}
|
|
97
51
|
/**
|
|
98
52
|
* Get top visitors grouped by identified information (user_id, external_id, email)
|
|
99
53
|
* with payment metrics including revenue, distinct payments, and time to first
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"visitors.mjs","sourceRoot":"","sources":["../../../src/resources/v1/analytics/visitors.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC
|
|
1
|
+
{"version":3,"file":"visitors.mjs","sourceRoot":"","sources":["../../../src/resources/v1/analytics/visitors.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,KAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CACL,KAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,KAAuB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF"}
|
package/resources/v1/index.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { Analytics, type
|
|
1
|
+
export { Analytics, type BounceRateResponse, type CardPrecision, type ChurnRateResponse, type CohortAnalysisResponse, type CohortData, type CountryTrafficSourceData, type CountryTrafficSourceResponse, type DauResponse, type EventFilterOptionsResponse, type EventsOverTimeDataPoint, type ManualIdentifyRequest, type ManualIdentifyResponse, type MauResponse, type PagesPerSessionResponse, type RecentEvent, type RecentEventsResponse, type RefererTrafficSourceData, type RefererTrafficSourceResponse, type ReturnRateResponse, type SessionDurationResponse, type TimeBetweenVisitsResponse, type TimelineTileData, type TimelineTileResponse, type TopVisitor, type TopVisitorsResponse, type UniqueSessionsResponse, type UniqueVisitorsResponse, type UtmTrafficSourceResponse, type VisitorDataPoint, type VisitorEvent, type VisitorProfileResponse, type VisitorsByBrowserResponse, type VisitorsByDeviceResponse, type VisitorsByOsResponse, type WauResponse, type AnalyticsTimelineParams, } from "./analytics/index.mjs";
|
|
2
2
|
export { Auth, type LoginRequest, type LoginResponse, type AuthLoginParams } from "./auth.mjs";
|
|
3
3
|
export { PaymentProviders, type CreatePaymentProviderRequest, type ListPaymentProvidersResponse, type PaymentProviderResponse, type ProviderField, type ProviderInstructionsResponse, type UpdatePaymentProviderRequest, type PaymentProviderDeleteResponse, type PaymentProviderCreateParams, type PaymentProviderUpdateParams, type PaymentProviderListParams, type PaymentProviderInstructionsParams, } from "./payment-providers/index.mjs";
|
|
4
4
|
export { Projects, type CreateProjectRequest, type ListProjectsResponse, type Project, type ProjectResponse, type UpdateProjectRequest, type ProjectDeleteResponse, type ProjectCreateParams, type ProjectUpdateParams, } from "./projects.mjs";
|