zorihq 0.12.0 → 0.14.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 +18 -11
- package/resources/v1/analytics/analytics.d.mts.map +1 -1
- package/resources/v1/analytics/analytics.d.ts +18 -11
- package/resources/v1/analytics/analytics.d.ts.map +1 -1
- package/resources/v1/analytics/analytics.js +2 -4
- package/resources/v1/analytics/analytics.js.map +1 -1
- package/resources/v1/analytics/analytics.mjs +2 -4
- package/resources/v1/analytics/analytics.mjs.map +1 -1
- package/resources/v1/analytics/events.d.mts +24 -26
- package/resources/v1/analytics/events.d.mts.map +1 -1
- package/resources/v1/analytics/events.d.ts +24 -26
- package/resources/v1/analytics/events.d.ts.map +1 -1
- package/resources/v1/analytics/events.js +7 -10
- package/resources/v1/analytics/events.js.map +1 -1
- package/resources/v1/analytics/events.mjs +7 -10
- package/resources/v1/analytics/events.mjs.map +1 -1
- package/resources/v1/analytics/retention.d.mts +24 -30
- package/resources/v1/analytics/retention.d.mts.map +1 -1
- package/resources/v1/analytics/retention.d.ts +24 -30
- package/resources/v1/analytics/retention.d.ts.map +1 -1
- package/resources/v1/analytics/retention.js +6 -12
- package/resources/v1/analytics/retention.js.map +1 -1
- package/resources/v1/analytics/retention.mjs +6 -12
- package/resources/v1/analytics/retention.mjs.map +1 -1
- package/resources/v1/analytics/sessions.d.mts +16 -20
- package/resources/v1/analytics/sessions.d.mts.map +1 -1
- package/resources/v1/analytics/sessions.d.ts +16 -20
- package/resources/v1/analytics/sessions.d.ts.map +1 -1
- package/resources/v1/analytics/sessions.js +4 -8
- package/resources/v1/analytics/sessions.js.map +1 -1
- package/resources/v1/analytics/sessions.mjs +4 -8
- package/resources/v1/analytics/sessions.mjs.map +1 -1
- package/resources/v1/analytics/users.d.mts +8 -10
- package/resources/v1/analytics/users.d.mts.map +1 -1
- package/resources/v1/analytics/users.d.ts +8 -10
- package/resources/v1/analytics/users.d.ts.map +1 -1
- package/resources/v1/analytics/users.js +2 -4
- package/resources/v1/analytics/users.js.map +1 -1
- package/resources/v1/analytics/users.mjs +2 -4
- package/resources/v1/analytics/users.mjs.map +1 -1
- package/resources/v1/analytics/visitors.d.mts +47 -64
- package/resources/v1/analytics/visitors.d.mts.map +1 -1
- package/resources/v1/analytics/visitors.d.ts +47 -64
- package/resources/v1/analytics/visitors.d.ts.map +1 -1
- package/resources/v1/analytics/visitors.js +14 -25
- package/resources/v1/analytics/visitors.js.map +1 -1
- package/resources/v1/analytics/visitors.mjs +14 -25
- package/resources/v1/analytics/visitors.mjs.map +1 -1
- package/src/resources/v1/analytics/analytics.ts +27 -11
- package/src/resources/v1/analytics/events.ts +25 -26
- package/src/resources/v1/analytics/retention.ts +24 -30
- package/src/resources/v1/analytics/sessions.ts +16 -20
- package/src/resources/v1/analytics/users.ts +8 -10
- package/src/resources/v1/analytics/visitors.ts +47 -70
- 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
|
@@ -8,10 +8,8 @@ export class Users extends APIResource {
|
|
|
8
8
|
* ```ts
|
|
9
9
|
* const activeUsersResponse =
|
|
10
10
|
* await client.v1.analytics.users.active({
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* projectID: 'projectID',
|
|
14
|
-
* timeBoundaries: 'last_hour',
|
|
11
|
+
* project_id: 'project_id',
|
|
12
|
+
* time_range: 'last_hour',
|
|
15
13
|
* });
|
|
16
14
|
* ```
|
|
17
15
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"users.mjs","sourceRoot":"","sources":["../../../src/resources/v1/analytics/users.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC
|
|
1
|
+
{"version":3,"file":"users.mjs","sourceRoot":"","sources":["../../../src/resources/v1/analytics/users.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF"}
|
|
@@ -10,10 +10,8 @@ export declare class Visitors extends APIResource {
|
|
|
10
10
|
* ```ts
|
|
11
11
|
* const visitorsByCountryResponse =
|
|
12
12
|
* await client.v1.analytics.visitors.byCountry({
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* projectID: 'projectID',
|
|
16
|
-
* timeBoundaries: 'last_hour',
|
|
13
|
+
* project_id: 'project_id',
|
|
14
|
+
* time_range: 'last_hour',
|
|
17
15
|
* });
|
|
18
16
|
* ```
|
|
19
17
|
*/
|
|
@@ -26,10 +24,8 @@ export declare class Visitors extends APIResource {
|
|
|
26
24
|
* ```ts
|
|
27
25
|
* const visitorsByDeviceResponse =
|
|
28
26
|
* await client.v1.analytics.visitors.byDevice({
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* projectID: 'projectID',
|
|
32
|
-
* timeBoundaries: 'last_hour',
|
|
27
|
+
* project_id: 'project_id',
|
|
28
|
+
* time_range: 'last_hour',
|
|
33
29
|
* });
|
|
34
30
|
* ```
|
|
35
31
|
*/
|
|
@@ -41,10 +37,8 @@ export declare class Visitors extends APIResource {
|
|
|
41
37
|
* ```ts
|
|
42
38
|
* const visitorsByOriginResponse =
|
|
43
39
|
* await client.v1.analytics.visitors.byOrigin({
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
* projectID: 'projectID',
|
|
47
|
-
* timeBoundaries: 'last_hour',
|
|
40
|
+
* project_id: 'project_id',
|
|
41
|
+
* time_range: 'last_hour',
|
|
48
42
|
* });
|
|
49
43
|
* ```
|
|
50
44
|
*/
|
|
@@ -71,10 +65,7 @@ export declare class Visitors extends APIResource {
|
|
|
71
65
|
* ```ts
|
|
72
66
|
* const visitorProfileResponse =
|
|
73
67
|
* await client.v1.analytics.visitors.profile({
|
|
74
|
-
*
|
|
75
|
-
* offset: 0,
|
|
76
|
-
* projectID: 'projectID',
|
|
77
|
-
* timeBoundaries: 'last_hour',
|
|
68
|
+
* project_id: 'project_id',
|
|
78
69
|
* });
|
|
79
70
|
* ```
|
|
80
71
|
*/
|
|
@@ -87,62 +78,60 @@ export declare class Visitors extends APIResource {
|
|
|
87
78
|
* ```ts
|
|
88
79
|
* const uniqueVisitorsTimelineResponse =
|
|
89
80
|
* await client.v1.analytics.visitors.timeline({
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
* projectID: 'projectID',
|
|
93
|
-
* timeBoundaries: 'last_hour',
|
|
81
|
+
* project_id: 'project_id',
|
|
82
|
+
* time_range: 'last_hour',
|
|
94
83
|
* });
|
|
95
84
|
* ```
|
|
96
85
|
*/
|
|
97
86
|
timeline(query: VisitorTimelineParams, options?: RequestOptions): APIPromise<AnalyticsAPI.UniqueVisitorsTimelineResponse>;
|
|
98
87
|
/**
|
|
99
|
-
* Get
|
|
88
|
+
* Get top visitors grouped by identified information (user_id, external_id, email)
|
|
89
|
+
* with payment metrics including revenue, distinct payments, and time to first
|
|
90
|
+
* purchase
|
|
100
91
|
*
|
|
101
92
|
* @example
|
|
102
93
|
* ```ts
|
|
103
94
|
* const topVisitorsResponse =
|
|
104
95
|
* await client.v1.analytics.visitors.top({
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
* projectID: 'projectID',
|
|
108
|
-
* timeBoundaries: 'last_hour',
|
|
96
|
+
* project_id: 'project_id',
|
|
97
|
+
* time_range: 'last_hour',
|
|
109
98
|
* });
|
|
110
99
|
* ```
|
|
111
100
|
*/
|
|
112
101
|
top(query: VisitorTopParams, options?: RequestOptions): APIPromise<AnalyticsAPI.TopVisitorsResponse>;
|
|
113
102
|
}
|
|
114
103
|
export interface VisitorByCountryParams {
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
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;
|
|
120
109
|
referrer?: string;
|
|
121
110
|
utmtag?: string;
|
|
122
111
|
utmtagValue?: string;
|
|
123
|
-
|
|
112
|
+
visitor_id?: string;
|
|
124
113
|
}
|
|
125
114
|
export interface VisitorByDeviceParams {
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
115
|
+
project_id: string;
|
|
116
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
117
|
+
customer_id?: string;
|
|
118
|
+
limit?: number;
|
|
119
|
+
offset?: number;
|
|
131
120
|
referrer?: string;
|
|
132
121
|
utmtag?: string;
|
|
133
122
|
utmtagValue?: string;
|
|
134
|
-
|
|
123
|
+
visitor_id?: string;
|
|
135
124
|
}
|
|
136
125
|
export interface VisitorByOriginParams {
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
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;
|
|
142
131
|
referrer?: string;
|
|
143
132
|
utmtag?: string;
|
|
144
133
|
utmtagValue?: string;
|
|
145
|
-
|
|
134
|
+
visitor_id?: string;
|
|
146
135
|
}
|
|
147
136
|
export interface VisitorIdentifyParams {
|
|
148
137
|
project_id: string;
|
|
@@ -157,37 +146,31 @@ export interface VisitorIdentifyParams {
|
|
|
157
146
|
user_id?: string;
|
|
158
147
|
}
|
|
159
148
|
export interface VisitorProfileParams {
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
164
|
-
customerID?: string;
|
|
165
|
-
referrer?: string;
|
|
166
|
-
utmtag?: string;
|
|
167
|
-
utmtagValue?: string;
|
|
168
|
-
visitorID?: string;
|
|
149
|
+
project_id: string;
|
|
150
|
+
customer_id?: string;
|
|
151
|
+
visitor_id?: string;
|
|
169
152
|
}
|
|
170
153
|
export interface VisitorTimelineParams {
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
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;
|
|
176
159
|
referrer?: string;
|
|
177
160
|
utmtag?: string;
|
|
178
161
|
utmtagValue?: string;
|
|
179
|
-
|
|
162
|
+
visitor_id?: string;
|
|
180
163
|
}
|
|
181
164
|
export interface VisitorTopParams {
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
165
|
+
project_id: string;
|
|
166
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
167
|
+
customer_id?: string;
|
|
168
|
+
limit?: number;
|
|
169
|
+
offset?: number;
|
|
187
170
|
referrer?: string;
|
|
188
171
|
utmtag?: string;
|
|
189
172
|
utmtagValue?: string;
|
|
190
|
-
|
|
173
|
+
visitor_id?: string;
|
|
191
174
|
}
|
|
192
175
|
export declare namespace Visitors {
|
|
193
176
|
export { type VisitorByCountryParams as VisitorByCountryParams, type VisitorByDeviceParams as VisitorByDeviceParams, type VisitorByOriginParams as VisitorByOriginParams, type VisitorIdentifyParams as VisitorIdentifyParams, type VisitorProfileParams as VisitorProfileParams, type VisitorTimelineParams as VisitorTimelineParams, type VisitorTopParams as VisitorTopParams, };
|
|
@@ -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;;;;;;;;;;;OAWG;IACH,SAAS,CACP,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,yBAAyB,CAAC;IAIrD;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,wBAAwB,CAAC;IAIpD;;;;;;;;;;;OAWG;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;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,8BAA8B,CAAC;IAI1D;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,mBAAmB,CAAC;CAGrG;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,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,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,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,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,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
|
@@ -10,10 +10,8 @@ export declare class Visitors extends APIResource {
|
|
|
10
10
|
* ```ts
|
|
11
11
|
* const visitorsByCountryResponse =
|
|
12
12
|
* await client.v1.analytics.visitors.byCountry({
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* projectID: 'projectID',
|
|
16
|
-
* timeBoundaries: 'last_hour',
|
|
13
|
+
* project_id: 'project_id',
|
|
14
|
+
* time_range: 'last_hour',
|
|
17
15
|
* });
|
|
18
16
|
* ```
|
|
19
17
|
*/
|
|
@@ -26,10 +24,8 @@ export declare class Visitors extends APIResource {
|
|
|
26
24
|
* ```ts
|
|
27
25
|
* const visitorsByDeviceResponse =
|
|
28
26
|
* await client.v1.analytics.visitors.byDevice({
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* projectID: 'projectID',
|
|
32
|
-
* timeBoundaries: 'last_hour',
|
|
27
|
+
* project_id: 'project_id',
|
|
28
|
+
* time_range: 'last_hour',
|
|
33
29
|
* });
|
|
34
30
|
* ```
|
|
35
31
|
*/
|
|
@@ -41,10 +37,8 @@ export declare class Visitors extends APIResource {
|
|
|
41
37
|
* ```ts
|
|
42
38
|
* const visitorsByOriginResponse =
|
|
43
39
|
* await client.v1.analytics.visitors.byOrigin({
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
* projectID: 'projectID',
|
|
47
|
-
* timeBoundaries: 'last_hour',
|
|
40
|
+
* project_id: 'project_id',
|
|
41
|
+
* time_range: 'last_hour',
|
|
48
42
|
* });
|
|
49
43
|
* ```
|
|
50
44
|
*/
|
|
@@ -71,10 +65,7 @@ export declare class Visitors extends APIResource {
|
|
|
71
65
|
* ```ts
|
|
72
66
|
* const visitorProfileResponse =
|
|
73
67
|
* await client.v1.analytics.visitors.profile({
|
|
74
|
-
*
|
|
75
|
-
* offset: 0,
|
|
76
|
-
* projectID: 'projectID',
|
|
77
|
-
* timeBoundaries: 'last_hour',
|
|
68
|
+
* project_id: 'project_id',
|
|
78
69
|
* });
|
|
79
70
|
* ```
|
|
80
71
|
*/
|
|
@@ -87,62 +78,60 @@ export declare class Visitors extends APIResource {
|
|
|
87
78
|
* ```ts
|
|
88
79
|
* const uniqueVisitorsTimelineResponse =
|
|
89
80
|
* await client.v1.analytics.visitors.timeline({
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
* projectID: 'projectID',
|
|
93
|
-
* timeBoundaries: 'last_hour',
|
|
81
|
+
* project_id: 'project_id',
|
|
82
|
+
* time_range: 'last_hour',
|
|
94
83
|
* });
|
|
95
84
|
* ```
|
|
96
85
|
*/
|
|
97
86
|
timeline(query: VisitorTimelineParams, options?: RequestOptions): APIPromise<AnalyticsAPI.UniqueVisitorsTimelineResponse>;
|
|
98
87
|
/**
|
|
99
|
-
* Get
|
|
88
|
+
* Get top visitors grouped by identified information (user_id, external_id, email)
|
|
89
|
+
* with payment metrics including revenue, distinct payments, and time to first
|
|
90
|
+
* purchase
|
|
100
91
|
*
|
|
101
92
|
* @example
|
|
102
93
|
* ```ts
|
|
103
94
|
* const topVisitorsResponse =
|
|
104
95
|
* await client.v1.analytics.visitors.top({
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
* projectID: 'projectID',
|
|
108
|
-
* timeBoundaries: 'last_hour',
|
|
96
|
+
* project_id: 'project_id',
|
|
97
|
+
* time_range: 'last_hour',
|
|
109
98
|
* });
|
|
110
99
|
* ```
|
|
111
100
|
*/
|
|
112
101
|
top(query: VisitorTopParams, options?: RequestOptions): APIPromise<AnalyticsAPI.TopVisitorsResponse>;
|
|
113
102
|
}
|
|
114
103
|
export interface VisitorByCountryParams {
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
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;
|
|
120
109
|
referrer?: string;
|
|
121
110
|
utmtag?: string;
|
|
122
111
|
utmtagValue?: string;
|
|
123
|
-
|
|
112
|
+
visitor_id?: string;
|
|
124
113
|
}
|
|
125
114
|
export interface VisitorByDeviceParams {
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
115
|
+
project_id: string;
|
|
116
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
117
|
+
customer_id?: string;
|
|
118
|
+
limit?: number;
|
|
119
|
+
offset?: number;
|
|
131
120
|
referrer?: string;
|
|
132
121
|
utmtag?: string;
|
|
133
122
|
utmtagValue?: string;
|
|
134
|
-
|
|
123
|
+
visitor_id?: string;
|
|
135
124
|
}
|
|
136
125
|
export interface VisitorByOriginParams {
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
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;
|
|
142
131
|
referrer?: string;
|
|
143
132
|
utmtag?: string;
|
|
144
133
|
utmtagValue?: string;
|
|
145
|
-
|
|
134
|
+
visitor_id?: string;
|
|
146
135
|
}
|
|
147
136
|
export interface VisitorIdentifyParams {
|
|
148
137
|
project_id: string;
|
|
@@ -157,37 +146,31 @@ export interface VisitorIdentifyParams {
|
|
|
157
146
|
user_id?: string;
|
|
158
147
|
}
|
|
159
148
|
export interface VisitorProfileParams {
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
164
|
-
customerID?: string;
|
|
165
|
-
referrer?: string;
|
|
166
|
-
utmtag?: string;
|
|
167
|
-
utmtagValue?: string;
|
|
168
|
-
visitorID?: string;
|
|
149
|
+
project_id: string;
|
|
150
|
+
customer_id?: string;
|
|
151
|
+
visitor_id?: string;
|
|
169
152
|
}
|
|
170
153
|
export interface VisitorTimelineParams {
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
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;
|
|
176
159
|
referrer?: string;
|
|
177
160
|
utmtag?: string;
|
|
178
161
|
utmtagValue?: string;
|
|
179
|
-
|
|
162
|
+
visitor_id?: string;
|
|
180
163
|
}
|
|
181
164
|
export interface VisitorTopParams {
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
165
|
+
project_id: string;
|
|
166
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
167
|
+
customer_id?: string;
|
|
168
|
+
limit?: number;
|
|
169
|
+
offset?: number;
|
|
187
170
|
referrer?: string;
|
|
188
171
|
utmtag?: string;
|
|
189
172
|
utmtagValue?: string;
|
|
190
|
-
|
|
173
|
+
visitor_id?: string;
|
|
191
174
|
}
|
|
192
175
|
export declare namespace Visitors {
|
|
193
176
|
export { type VisitorByCountryParams as VisitorByCountryParams, type VisitorByDeviceParams as VisitorByDeviceParams, type VisitorByOriginParams as VisitorByOriginParams, type VisitorIdentifyParams as VisitorIdentifyParams, type VisitorProfileParams as VisitorProfileParams, type VisitorTimelineParams as VisitorTimelineParams, type VisitorTopParams as VisitorTopParams, };
|
|
@@ -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;;;;;;;;;;;OAWG;IACH,SAAS,CACP,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,yBAAyB,CAAC;IAIrD;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,wBAAwB,CAAC;IAIpD;;;;;;;;;;;OAWG;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;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,8BAA8B,CAAC;IAI1D;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,mBAAmB,CAAC;CAGrG;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,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,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,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,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,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
|
@@ -11,10 +11,8 @@ class Visitors extends resource_1.APIResource {
|
|
|
11
11
|
* ```ts
|
|
12
12
|
* const visitorsByCountryResponse =
|
|
13
13
|
* await client.v1.analytics.visitors.byCountry({
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* projectID: 'projectID',
|
|
17
|
-
* timeBoundaries: 'last_hour',
|
|
14
|
+
* project_id: 'project_id',
|
|
15
|
+
* time_range: 'last_hour',
|
|
18
16
|
* });
|
|
19
17
|
* ```
|
|
20
18
|
*/
|
|
@@ -29,10 +27,8 @@ class Visitors extends resource_1.APIResource {
|
|
|
29
27
|
* ```ts
|
|
30
28
|
* const visitorsByDeviceResponse =
|
|
31
29
|
* await client.v1.analytics.visitors.byDevice({
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
* projectID: 'projectID',
|
|
35
|
-
* timeBoundaries: 'last_hour',
|
|
30
|
+
* project_id: 'project_id',
|
|
31
|
+
* time_range: 'last_hour',
|
|
36
32
|
* });
|
|
37
33
|
* ```
|
|
38
34
|
*/
|
|
@@ -46,10 +42,8 @@ class Visitors extends resource_1.APIResource {
|
|
|
46
42
|
* ```ts
|
|
47
43
|
* const visitorsByOriginResponse =
|
|
48
44
|
* await client.v1.analytics.visitors.byOrigin({
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
* projectID: 'projectID',
|
|
52
|
-
* timeBoundaries: 'last_hour',
|
|
45
|
+
* project_id: 'project_id',
|
|
46
|
+
* time_range: 'last_hour',
|
|
53
47
|
* });
|
|
54
48
|
* ```
|
|
55
49
|
*/
|
|
@@ -80,10 +74,7 @@ class Visitors extends resource_1.APIResource {
|
|
|
80
74
|
* ```ts
|
|
81
75
|
* const visitorProfileResponse =
|
|
82
76
|
* await client.v1.analytics.visitors.profile({
|
|
83
|
-
*
|
|
84
|
-
* offset: 0,
|
|
85
|
-
* projectID: 'projectID',
|
|
86
|
-
* timeBoundaries: 'last_hour',
|
|
77
|
+
* project_id: 'project_id',
|
|
87
78
|
* });
|
|
88
79
|
* ```
|
|
89
80
|
*/
|
|
@@ -98,10 +89,8 @@ class Visitors extends resource_1.APIResource {
|
|
|
98
89
|
* ```ts
|
|
99
90
|
* const uniqueVisitorsTimelineResponse =
|
|
100
91
|
* await client.v1.analytics.visitors.timeline({
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
* projectID: 'projectID',
|
|
104
|
-
* timeBoundaries: 'last_hour',
|
|
92
|
+
* project_id: 'project_id',
|
|
93
|
+
* time_range: 'last_hour',
|
|
105
94
|
* });
|
|
106
95
|
* ```
|
|
107
96
|
*/
|
|
@@ -109,16 +98,16 @@ class Visitors extends resource_1.APIResource {
|
|
|
109
98
|
return this._client.get('/api/v1/analytics/visitors/timeline', { query, ...options });
|
|
110
99
|
}
|
|
111
100
|
/**
|
|
112
|
-
* Get
|
|
101
|
+
* Get top visitors grouped by identified information (user_id, external_id, email)
|
|
102
|
+
* with payment metrics including revenue, distinct payments, and time to first
|
|
103
|
+
* purchase
|
|
113
104
|
*
|
|
114
105
|
* @example
|
|
115
106
|
* ```ts
|
|
116
107
|
* const topVisitorsResponse =
|
|
117
108
|
* await client.v1.analytics.visitors.top({
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
* projectID: 'projectID',
|
|
121
|
-
* timeBoundaries: 'last_hour',
|
|
109
|
+
* project_id: 'project_id',
|
|
110
|
+
* time_range: 'last_hour',
|
|
122
111
|
* });
|
|
123
112
|
* ```
|
|
124
113
|
*/
|
|
@@ -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;;;;;;;;;;;OAWG;IACH,SAAS,CACP,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;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;;;;;;;;;;;OAWG;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;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,KAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,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;AAvID,4BAuIC"}
|
|
@@ -8,10 +8,8 @@ export class Visitors extends APIResource {
|
|
|
8
8
|
* ```ts
|
|
9
9
|
* const visitorsByCountryResponse =
|
|
10
10
|
* await client.v1.analytics.visitors.byCountry({
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* projectID: 'projectID',
|
|
14
|
-
* timeBoundaries: 'last_hour',
|
|
11
|
+
* project_id: 'project_id',
|
|
12
|
+
* time_range: 'last_hour',
|
|
15
13
|
* });
|
|
16
14
|
* ```
|
|
17
15
|
*/
|
|
@@ -26,10 +24,8 @@ export class Visitors extends APIResource {
|
|
|
26
24
|
* ```ts
|
|
27
25
|
* const visitorsByDeviceResponse =
|
|
28
26
|
* await client.v1.analytics.visitors.byDevice({
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* projectID: 'projectID',
|
|
32
|
-
* timeBoundaries: 'last_hour',
|
|
27
|
+
* project_id: 'project_id',
|
|
28
|
+
* time_range: 'last_hour',
|
|
33
29
|
* });
|
|
34
30
|
* ```
|
|
35
31
|
*/
|
|
@@ -43,10 +39,8 @@ export class Visitors extends APIResource {
|
|
|
43
39
|
* ```ts
|
|
44
40
|
* const visitorsByOriginResponse =
|
|
45
41
|
* await client.v1.analytics.visitors.byOrigin({
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
* projectID: 'projectID',
|
|
49
|
-
* timeBoundaries: 'last_hour',
|
|
42
|
+
* project_id: 'project_id',
|
|
43
|
+
* time_range: 'last_hour',
|
|
50
44
|
* });
|
|
51
45
|
* ```
|
|
52
46
|
*/
|
|
@@ -77,10 +71,7 @@ export class Visitors extends APIResource {
|
|
|
77
71
|
* ```ts
|
|
78
72
|
* const visitorProfileResponse =
|
|
79
73
|
* await client.v1.analytics.visitors.profile({
|
|
80
|
-
*
|
|
81
|
-
* offset: 0,
|
|
82
|
-
* projectID: 'projectID',
|
|
83
|
-
* timeBoundaries: 'last_hour',
|
|
74
|
+
* project_id: 'project_id',
|
|
84
75
|
* });
|
|
85
76
|
* ```
|
|
86
77
|
*/
|
|
@@ -95,10 +86,8 @@ export class Visitors extends APIResource {
|
|
|
95
86
|
* ```ts
|
|
96
87
|
* const uniqueVisitorsTimelineResponse =
|
|
97
88
|
* await client.v1.analytics.visitors.timeline({
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
* projectID: 'projectID',
|
|
101
|
-
* timeBoundaries: 'last_hour',
|
|
89
|
+
* project_id: 'project_id',
|
|
90
|
+
* time_range: 'last_hour',
|
|
102
91
|
* });
|
|
103
92
|
* ```
|
|
104
93
|
*/
|
|
@@ -106,16 +95,16 @@ export class Visitors extends APIResource {
|
|
|
106
95
|
return this._client.get('/api/v1/analytics/visitors/timeline', { query, ...options });
|
|
107
96
|
}
|
|
108
97
|
/**
|
|
109
|
-
* Get
|
|
98
|
+
* Get top visitors grouped by identified information (user_id, external_id, email)
|
|
99
|
+
* with payment metrics including revenue, distinct payments, and time to first
|
|
100
|
+
* purchase
|
|
110
101
|
*
|
|
111
102
|
* @example
|
|
112
103
|
* ```ts
|
|
113
104
|
* const topVisitorsResponse =
|
|
114
105
|
* await client.v1.analytics.visitors.top({
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
* projectID: 'projectID',
|
|
118
|
-
* timeBoundaries: 'last_hour',
|
|
106
|
+
* project_id: 'project_id',
|
|
107
|
+
* time_range: 'last_hour',
|
|
119
108
|
* });
|
|
120
109
|
* ```
|
|
121
110
|
*/
|
|
@@ -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;;;;;;;;;;;OAWG;IACH,SAAS,CACP,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;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;;;;;;;;;;;OAWG;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;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,KAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,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"}
|