zorihq 0.14.0 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/package.json +1 -1
- package/resources/v1/analytics/analytics.d.mts +34 -81
- package/resources/v1/analytics/analytics.d.mts.map +1 -1
- package/resources/v1/analytics/analytics.d.ts +34 -81
- package/resources/v1/analytics/analytics.d.ts.map +1 -1
- package/resources/v1/analytics/analytics.js +11 -9
- package/resources/v1/analytics/analytics.js.map +1 -1
- package/resources/v1/analytics/analytics.mjs +12 -10
- package/resources/v1/analytics/analytics.mjs.map +1 -1
- package/resources/v1/analytics/index.d.mts +6 -5
- package/resources/v1/analytics/index.d.mts.map +1 -1
- package/resources/v1/analytics/index.d.ts +6 -5
- package/resources/v1/analytics/index.d.ts.map +1 -1
- package/resources/v1/analytics/index.js +3 -1
- package/resources/v1/analytics/index.js.map +1 -1
- package/resources/v1/analytics/index.mjs +2 -1
- package/resources/v1/analytics/index.mjs.map +1 -1
- package/resources/v1/analytics/retention.d.mts +1 -25
- package/resources/v1/analytics/retention.d.mts.map +1 -1
- package/resources/v1/analytics/retention.d.ts +1 -25
- package/resources/v1/analytics/retention.d.ts.map +1 -1
- package/resources/v1/analytics/retention.js +0 -15
- package/resources/v1/analytics/retention.js.map +1 -1
- package/resources/v1/analytics/retention.mjs +0 -15
- package/resources/v1/analytics/retention.mjs.map +1 -1
- package/resources/v1/analytics/sessions.d.mts +0 -54
- package/resources/v1/analytics/sessions.d.mts.map +1 -1
- package/resources/v1/analytics/sessions.d.ts +0 -54
- package/resources/v1/analytics/sessions.d.ts.map +1 -1
- package/resources/v1/analytics/sessions.js +0 -30
- package/resources/v1/analytics/sessions.js.map +1 -1
- package/resources/v1/analytics/sessions.mjs +0 -30
- package/resources/v1/analytics/sessions.mjs.map +1 -1
- package/resources/v1/analytics/tiles.d.mts +401 -0
- package/resources/v1/analytics/tiles.d.mts.map +1 -0
- package/resources/v1/analytics/tiles.d.ts +401 -0
- package/resources/v1/analytics/tiles.d.ts.map +1 -0
- package/resources/v1/analytics/tiles.js +208 -0
- package/resources/v1/analytics/tiles.js.map +1 -0
- package/resources/v1/analytics/tiles.mjs +204 -0
- package/resources/v1/analytics/tiles.mjs.map +1 -0
- package/resources/v1/analytics/users.d.mts +0 -30
- package/resources/v1/analytics/users.d.mts.map +1 -1
- package/resources/v1/analytics/users.d.ts +0 -30
- package/resources/v1/analytics/users.d.ts.map +1 -1
- package/resources/v1/analytics/users.js +0 -15
- package/resources/v1/analytics/users.js.map +1 -1
- package/resources/v1/analytics/users.mjs +0 -15
- package/resources/v1/analytics/users.mjs.map +1 -1
- package/resources/v1/analytics/visitors.d.mts +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/resources/v1/analytics/analytics.ts +100 -144
- package/src/resources/v1/analytics/index.ts +33 -23
- package/src/resources/v1/analytics/retention.ts +0 -40
- package/src/resources/v1/analytics/sessions.ts +1 -89
- package/src/resources/v1/analytics/tiles.ts +663 -0
- package/src/resources/v1/analytics/users.ts +1 -44
- package/src/resources/v1/analytics/visitors.ts +0 -121
- package/src/resources/v1/index.ts +2 -13
- package/src/resources/v1/v1.ts +4 -26
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.15.0 (2025-11-16)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.14.0...v0.15.0](https://github.com/ZoriHQ/typescript-api-sdk/compare/v0.14.0...v0.15.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* Feature/card for dashboard ([f8989c4](https://github.com/ZoriHQ/typescript-api-sdk/commit/f8989c4295e01744d25849b2d094a81728ede5ce))
|
|
10
|
+
|
|
3
11
|
## 0.14.0 (2025-11-11)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v0.13.0...v0.14.0](https://github.com/ZoriHQ/typescript-api-sdk/compare/v0.13.0...v0.14.0)
|
package/package.json
CHANGED
|
@@ -2,13 +2,15 @@ import { APIResource } from "../../../core/resource.mjs";
|
|
|
2
2
|
import * as EventsAPI from "./events.mjs";
|
|
3
3
|
import { EventFilterOptionsParams, EventRecentParams, Events } from "./events.mjs";
|
|
4
4
|
import * as RetentionAPI from "./retention.mjs";
|
|
5
|
-
import { Retention, RetentionChurnRateParams, RetentionCohortsParams
|
|
5
|
+
import { Retention, RetentionChurnRateParams, RetentionCohortsParams } from "./retention.mjs";
|
|
6
6
|
import * as SessionsAPI from "./sessions.mjs";
|
|
7
|
-
import {
|
|
7
|
+
import { Sessions } from "./sessions.mjs";
|
|
8
|
+
import * as TilesAPI from "./tiles.mjs";
|
|
9
|
+
import { TileGetBounceRateParams, TileGetBounceRateResponse, TileGetDailyActiveUsersParams, TileGetDailyActiveUsersResponse, TileGetMonthlyActiveUsersParams, TileGetMonthlyActiveUsersResponse, TileGetPagesPerSessionParams, TileGetPagesPerSessionResponse, TileGetReturnRateParams, TileGetReturnRateResponse, TileGetSessionDurationParams, TileGetSessionDurationResponse, TileGetTimeBetweenVisitsParams, TileGetTimeBetweenVisitsResponse, TileGetTrafficByCountryParams, TileGetTrafficByCountryResponse, TileGetTrafficByRefererParams, TileGetTrafficByRefererResponse, TileGetTrafficByUtmParams, TileGetTrafficByUtmResponse, TileGetUniqueSessionsParams, TileGetUniqueSessionsResponse, TileGetUniqueVisitorsParams, TileGetUniqueVisitorsResponse, TileGetWeeklyActiveUsersParams, TileGetWeeklyActiveUsersResponse, Tiles } from "./tiles.mjs";
|
|
8
10
|
import * as UsersAPI from "./users.mjs";
|
|
9
|
-
import {
|
|
11
|
+
import { Users } from "./users.mjs";
|
|
10
12
|
import * as VisitorsAPI from "./visitors.mjs";
|
|
11
|
-
import {
|
|
13
|
+
import { VisitorByDeviceParams, VisitorIdentifyParams, VisitorProfileParams, VisitorTopParams, Visitors } from "./visitors.mjs";
|
|
12
14
|
import { APIPromise } from "../../../core/api-promise.mjs";
|
|
13
15
|
import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
14
16
|
export declare class Analytics extends APIResource {
|
|
@@ -17,34 +19,19 @@ export declare class Analytics extends APIResource {
|
|
|
17
19
|
sessions: SessionsAPI.Sessions;
|
|
18
20
|
users: UsersAPI.Users;
|
|
19
21
|
retention: RetentionAPI.Retention;
|
|
22
|
+
tiles: TilesAPI.Tiles;
|
|
20
23
|
/**
|
|
21
|
-
* Get
|
|
22
|
-
*
|
|
24
|
+
* Get unique visitor counts over time, split by mobile and desktop devices for
|
|
25
|
+
* chart visualization
|
|
23
26
|
*
|
|
24
27
|
* @example
|
|
25
28
|
* ```ts
|
|
26
|
-
* const
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* time_range: 'last_hour',
|
|
30
|
-
* });
|
|
29
|
+
* const response = await client.v1.analytics.retrieveTimeline(
|
|
30
|
+
* { project_id: 'project_id', time_range: 'last_hour' },
|
|
31
|
+
* );
|
|
31
32
|
* ```
|
|
32
33
|
*/
|
|
33
|
-
|
|
34
|
-
}
|
|
35
|
-
export interface ActiveUsersResponse {
|
|
36
|
-
dau?: number;
|
|
37
|
-
mau?: number;
|
|
38
|
-
wau?: number;
|
|
39
|
-
}
|
|
40
|
-
export interface BounceRateByPageMetric {
|
|
41
|
-
bounce_rate?: number;
|
|
42
|
-
page?: string;
|
|
43
|
-
sessions?: number;
|
|
44
|
-
}
|
|
45
|
-
export interface BounceRateResponse {
|
|
46
|
-
by_page?: Array<BounceRateByPageMetric>;
|
|
47
|
-
overall_bounce_rate?: number;
|
|
34
|
+
retrieveTimeline(query: AnalyticsRetrieveTimelineParams, options?: RequestOptions): APIPromise<AnalyticsRetrieveTimelineResponse>;
|
|
48
35
|
}
|
|
49
36
|
export interface ChurnRateResponse {
|
|
50
37
|
churn_rate_percent?: number;
|
|
@@ -65,25 +52,6 @@ export interface CohortData {
|
|
|
65
52
|
week_2_retention?: number;
|
|
66
53
|
week_4_retention?: number;
|
|
67
54
|
}
|
|
68
|
-
export interface CountryDataPoint {
|
|
69
|
-
country_code?: string;
|
|
70
|
-
percentage?: number;
|
|
71
|
-
unique_visitors?: number;
|
|
72
|
-
}
|
|
73
|
-
export interface DashboardMetricsResponse {
|
|
74
|
-
avg_pages_per_session?: number;
|
|
75
|
-
avg_session_duration_seconds?: number;
|
|
76
|
-
bounce_rate?: number;
|
|
77
|
-
dau?: number;
|
|
78
|
-
mau?: number;
|
|
79
|
-
return_rate?: number;
|
|
80
|
-
sessions_today?: number;
|
|
81
|
-
total_events?: number;
|
|
82
|
-
total_sessions_in_period?: number;
|
|
83
|
-
unique_sessions?: number;
|
|
84
|
-
unique_visitors?: number;
|
|
85
|
-
wau?: number;
|
|
86
|
-
}
|
|
87
55
|
export interface EventFilterOptionsResponse {
|
|
88
56
|
event_names?: Array<string>;
|
|
89
57
|
pages?: Array<string>;
|
|
@@ -110,11 +78,6 @@ export interface ManualIdentifyResponse {
|
|
|
110
78
|
success?: boolean;
|
|
111
79
|
visitor_id?: string;
|
|
112
80
|
}
|
|
113
|
-
export interface OriginDataPoint {
|
|
114
|
-
origin?: string;
|
|
115
|
-
percentage?: number;
|
|
116
|
-
unique_visitors?: number;
|
|
117
|
-
}
|
|
118
81
|
export interface RecentEvent {
|
|
119
82
|
browser_name?: string;
|
|
120
83
|
click_element_category?: string;
|
|
@@ -151,17 +114,6 @@ export interface RecentEventsResponse {
|
|
|
151
114
|
offset?: number;
|
|
152
115
|
total?: number;
|
|
153
116
|
}
|
|
154
|
-
export interface ReturnRateResponse {
|
|
155
|
-
avg_time_between_sessions_hours?: number;
|
|
156
|
-
return_rate_percent?: number;
|
|
157
|
-
returning_users?: number;
|
|
158
|
-
total_users?: number;
|
|
159
|
-
}
|
|
160
|
-
export interface SessionMetricsResponse {
|
|
161
|
-
average_pages_per_session?: number;
|
|
162
|
-
average_session_duration_seconds?: number;
|
|
163
|
-
total_sessions?: number;
|
|
164
|
-
}
|
|
165
117
|
export interface TopVisitor {
|
|
166
118
|
browser_name?: string;
|
|
167
119
|
currency?: string;
|
|
@@ -186,14 +138,6 @@ export interface TopVisitorsResponse {
|
|
|
186
138
|
total?: number;
|
|
187
139
|
visitors?: Array<TopVisitor>;
|
|
188
140
|
}
|
|
189
|
-
export interface UniqueVisitorsDataPoint {
|
|
190
|
-
desktop?: number;
|
|
191
|
-
mobile?: number;
|
|
192
|
-
timestamp?: string;
|
|
193
|
-
}
|
|
194
|
-
export interface UniqueVisitorsTimelineResponse {
|
|
195
|
-
data?: Array<UniqueVisitorsDataPoint>;
|
|
196
|
-
}
|
|
197
141
|
export interface VisitorDataPoint {
|
|
198
142
|
desktop?: number;
|
|
199
143
|
mobile?: number;
|
|
@@ -245,16 +189,24 @@ export interface VisitorProfileResponse {
|
|
|
245
189
|
user_id?: string;
|
|
246
190
|
visitor_id?: string;
|
|
247
191
|
}
|
|
248
|
-
export interface VisitorsByCountryResponse {
|
|
249
|
-
data?: Array<CountryDataPoint>;
|
|
250
|
-
}
|
|
251
192
|
export interface VisitorsByDeviceResponse {
|
|
252
193
|
data?: Array<VisitorDataPoint>;
|
|
253
194
|
}
|
|
254
|
-
export interface
|
|
255
|
-
data?: Array<
|
|
256
|
-
|
|
257
|
-
|
|
195
|
+
export interface AnalyticsRetrieveTimelineResponse {
|
|
196
|
+
data?: Array<AnalyticsRetrieveTimelineResponse.Data>;
|
|
197
|
+
precision?: 'minutes' | 'hourly' | 'daily' | 'weekly' | 'monthly';
|
|
198
|
+
total_visits?: number;
|
|
199
|
+
}
|
|
200
|
+
export declare namespace AnalyticsRetrieveTimelineResponse {
|
|
201
|
+
interface Data {
|
|
202
|
+
num_desktop_visits?: number;
|
|
203
|
+
num_mobile_visits?: number;
|
|
204
|
+
num_revenue?: number;
|
|
205
|
+
num_unknown_visits?: number;
|
|
206
|
+
time_bucket?: string;
|
|
207
|
+
}
|
|
208
|
+
}
|
|
209
|
+
export interface AnalyticsRetrieveTimelineParams {
|
|
258
210
|
project_id: string;
|
|
259
211
|
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
260
212
|
customer_id?: string;
|
|
@@ -266,11 +218,12 @@ export interface AnalyticsDashboardParams {
|
|
|
266
218
|
visitor_id?: string;
|
|
267
219
|
}
|
|
268
220
|
export declare namespace Analytics {
|
|
269
|
-
export { type
|
|
270
|
-
export { Visitors as Visitors, type
|
|
221
|
+
export { type ChurnRateResponse as ChurnRateResponse, type CohortAnalysisResponse as CohortAnalysisResponse, type CohortData as CohortData, type EventFilterOptionsResponse as EventFilterOptionsResponse, type EventsOverTimeDataPoint as EventsOverTimeDataPoint, type ManualIdentifyRequest as ManualIdentifyRequest, type ManualIdentifyResponse as ManualIdentifyResponse, type RecentEvent as RecentEvent, type RecentEventsResponse as RecentEventsResponse, type TopVisitor as TopVisitor, type TopVisitorsResponse as TopVisitorsResponse, type VisitorDataPoint as VisitorDataPoint, type VisitorEvent as VisitorEvent, type VisitorProfileResponse as VisitorProfileResponse, type VisitorsByDeviceResponse as VisitorsByDeviceResponse, type AnalyticsRetrieveTimelineResponse as AnalyticsRetrieveTimelineResponse, type AnalyticsRetrieveTimelineParams as AnalyticsRetrieveTimelineParams, };
|
|
222
|
+
export { Visitors as Visitors, type VisitorByDeviceParams as VisitorByDeviceParams, type VisitorIdentifyParams as VisitorIdentifyParams, type VisitorProfileParams as VisitorProfileParams, type VisitorTopParams as VisitorTopParams, };
|
|
271
223
|
export { Events as Events, type EventFilterOptionsParams as EventFilterOptionsParams, type EventRecentParams as EventRecentParams, };
|
|
272
|
-
export { Sessions as Sessions
|
|
273
|
-
export { Users as Users
|
|
274
|
-
export { Retention as Retention, type RetentionChurnRateParams as RetentionChurnRateParams, type RetentionCohortsParams as RetentionCohortsParams,
|
|
224
|
+
export { Sessions as Sessions };
|
|
225
|
+
export { Users as Users };
|
|
226
|
+
export { Retention as Retention, type RetentionChurnRateParams as RetentionChurnRateParams, type RetentionCohortsParams as RetentionCohortsParams, };
|
|
227
|
+
export { Tiles as Tiles, type TileGetBounceRateResponse as TileGetBounceRateResponse, type TileGetDailyActiveUsersResponse as TileGetDailyActiveUsersResponse, type TileGetMonthlyActiveUsersResponse as TileGetMonthlyActiveUsersResponse, type TileGetPagesPerSessionResponse as TileGetPagesPerSessionResponse, type TileGetReturnRateResponse as TileGetReturnRateResponse, type TileGetSessionDurationResponse as TileGetSessionDurationResponse, type TileGetTimeBetweenVisitsResponse as TileGetTimeBetweenVisitsResponse, type TileGetTrafficByCountryResponse as TileGetTrafficByCountryResponse, type TileGetTrafficByRefererResponse as TileGetTrafficByRefererResponse, type TileGetTrafficByUtmResponse as TileGetTrafficByUtmResponse, type TileGetUniqueSessionsResponse as TileGetUniqueSessionsResponse, type TileGetUniqueVisitorsResponse as TileGetUniqueVisitorsResponse, type TileGetWeeklyActiveUsersResponse as TileGetWeeklyActiveUsersResponse, type TileGetBounceRateParams as TileGetBounceRateParams, type TileGetDailyActiveUsersParams as TileGetDailyActiveUsersParams, type TileGetMonthlyActiveUsersParams as TileGetMonthlyActiveUsersParams, type TileGetPagesPerSessionParams as TileGetPagesPerSessionParams, type TileGetReturnRateParams as TileGetReturnRateParams, type TileGetSessionDurationParams as TileGetSessionDurationParams, type TileGetTimeBetweenVisitsParams as TileGetTimeBetweenVisitsParams, type TileGetTrafficByCountryParams as TileGetTrafficByCountryParams, type TileGetTrafficByRefererParams as TileGetTrafficByRefererParams, type TileGetTrafficByUtmParams as TileGetTrafficByUtmParams, type TileGetUniqueSessionsParams as TileGetUniqueSessionsParams, type TileGetUniqueVisitorsParams as TileGetUniqueVisitorsParams, type TileGetWeeklyActiveUsersParams as TileGetWeeklyActiveUsersParams, };
|
|
275
228
|
}
|
|
276
229
|
//# sourceMappingURL=analytics.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"analytics.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/analytics.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,EAAE;OACvD,KAAK,YAAY;OACjB,
|
|
1
|
+
{"version":3,"file":"analytics.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/analytics.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,EAAE;OACvD,KAAK,YAAY;OACjB,EAAE,SAAS,EAAE,wBAAwB,EAAE,sBAAsB,EAAE;OAC/D,KAAK,WAAW;OAChB,EAAE,QAAQ,EAAE;OACZ,KAAK,QAAQ;OACb,EACL,uBAAuB,EACvB,yBAAyB,EACzB,6BAA6B,EAC7B,+BAA+B,EAC/B,+BAA+B,EAC/B,iCAAiC,EACjC,4BAA4B,EAC5B,8BAA8B,EAC9B,uBAAuB,EACvB,yBAAyB,EACzB,4BAA4B,EAC5B,8BAA8B,EAC9B,8BAA8B,EAC9B,gCAAgC,EAChC,6BAA6B,EAC7B,+BAA+B,EAC/B,6BAA6B,EAC7B,+BAA+B,EAC/B,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC7B,2BAA2B,EAC3B,6BAA6B,EAC7B,8BAA8B,EAC9B,gCAAgC,EAChC,KAAK,EACN;OACM,KAAK,QAAQ;OACb,EAAE,KAAK,EAAE;OACT,KAAK,WAAW;OAChB,EACL,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,EAChB,QAAQ,EACT;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,KAAK,EAAE,+BAA+B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;CAGjD;AAED,MAAM,WAAW,iBAAiB;IAChC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,UAAU;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;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,sBAAsB;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAE5B,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,8BAA8B,CAAC,EAAE,MAAM,CAAC;IAExC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,sBAAsB;IACrC,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE3C,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE7B,gBAAgB,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAElD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,CAAC,EAAE,KAAK,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC;IAErD,SAAS,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;IAElE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,yBAAiB,iCAAiC,CAAC;IACjD,UAAiB,IAAI;QACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,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;AASD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,CAAC;IAEhC,OAAO,EAAE,KAAK,IAAI,KAAK,EAAE,CAAC;IAE1B,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
|
|
@@ -2,13 +2,15 @@ import { APIResource } from "../../../core/resource.js";
|
|
|
2
2
|
import * as EventsAPI from "./events.js";
|
|
3
3
|
import { EventFilterOptionsParams, EventRecentParams, Events } from "./events.js";
|
|
4
4
|
import * as RetentionAPI from "./retention.js";
|
|
5
|
-
import { Retention, RetentionChurnRateParams, RetentionCohortsParams
|
|
5
|
+
import { Retention, RetentionChurnRateParams, RetentionCohortsParams } from "./retention.js";
|
|
6
6
|
import * as SessionsAPI from "./sessions.js";
|
|
7
|
-
import {
|
|
7
|
+
import { Sessions } from "./sessions.js";
|
|
8
|
+
import * as TilesAPI from "./tiles.js";
|
|
9
|
+
import { TileGetBounceRateParams, TileGetBounceRateResponse, TileGetDailyActiveUsersParams, TileGetDailyActiveUsersResponse, TileGetMonthlyActiveUsersParams, TileGetMonthlyActiveUsersResponse, TileGetPagesPerSessionParams, TileGetPagesPerSessionResponse, TileGetReturnRateParams, TileGetReturnRateResponse, TileGetSessionDurationParams, TileGetSessionDurationResponse, TileGetTimeBetweenVisitsParams, TileGetTimeBetweenVisitsResponse, TileGetTrafficByCountryParams, TileGetTrafficByCountryResponse, TileGetTrafficByRefererParams, TileGetTrafficByRefererResponse, TileGetTrafficByUtmParams, TileGetTrafficByUtmResponse, TileGetUniqueSessionsParams, TileGetUniqueSessionsResponse, TileGetUniqueVisitorsParams, TileGetUniqueVisitorsResponse, TileGetWeeklyActiveUsersParams, TileGetWeeklyActiveUsersResponse, Tiles } from "./tiles.js";
|
|
8
10
|
import * as UsersAPI from "./users.js";
|
|
9
|
-
import {
|
|
11
|
+
import { Users } from "./users.js";
|
|
10
12
|
import * as VisitorsAPI from "./visitors.js";
|
|
11
|
-
import {
|
|
13
|
+
import { VisitorByDeviceParams, VisitorIdentifyParams, VisitorProfileParams, VisitorTopParams, Visitors } from "./visitors.js";
|
|
12
14
|
import { APIPromise } from "../../../core/api-promise.js";
|
|
13
15
|
import { RequestOptions } from "../../../internal/request-options.js";
|
|
14
16
|
export declare class Analytics extends APIResource {
|
|
@@ -17,34 +19,19 @@ export declare class Analytics extends APIResource {
|
|
|
17
19
|
sessions: SessionsAPI.Sessions;
|
|
18
20
|
users: UsersAPI.Users;
|
|
19
21
|
retention: RetentionAPI.Retention;
|
|
22
|
+
tiles: TilesAPI.Tiles;
|
|
20
23
|
/**
|
|
21
|
-
* Get
|
|
22
|
-
*
|
|
24
|
+
* Get unique visitor counts over time, split by mobile and desktop devices for
|
|
25
|
+
* chart visualization
|
|
23
26
|
*
|
|
24
27
|
* @example
|
|
25
28
|
* ```ts
|
|
26
|
-
* const
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* time_range: 'last_hour',
|
|
30
|
-
* });
|
|
29
|
+
* const response = await client.v1.analytics.retrieveTimeline(
|
|
30
|
+
* { project_id: 'project_id', time_range: 'last_hour' },
|
|
31
|
+
* );
|
|
31
32
|
* ```
|
|
32
33
|
*/
|
|
33
|
-
|
|
34
|
-
}
|
|
35
|
-
export interface ActiveUsersResponse {
|
|
36
|
-
dau?: number;
|
|
37
|
-
mau?: number;
|
|
38
|
-
wau?: number;
|
|
39
|
-
}
|
|
40
|
-
export interface BounceRateByPageMetric {
|
|
41
|
-
bounce_rate?: number;
|
|
42
|
-
page?: string;
|
|
43
|
-
sessions?: number;
|
|
44
|
-
}
|
|
45
|
-
export interface BounceRateResponse {
|
|
46
|
-
by_page?: Array<BounceRateByPageMetric>;
|
|
47
|
-
overall_bounce_rate?: number;
|
|
34
|
+
retrieveTimeline(query: AnalyticsRetrieveTimelineParams, options?: RequestOptions): APIPromise<AnalyticsRetrieveTimelineResponse>;
|
|
48
35
|
}
|
|
49
36
|
export interface ChurnRateResponse {
|
|
50
37
|
churn_rate_percent?: number;
|
|
@@ -65,25 +52,6 @@ export interface CohortData {
|
|
|
65
52
|
week_2_retention?: number;
|
|
66
53
|
week_4_retention?: number;
|
|
67
54
|
}
|
|
68
|
-
export interface CountryDataPoint {
|
|
69
|
-
country_code?: string;
|
|
70
|
-
percentage?: number;
|
|
71
|
-
unique_visitors?: number;
|
|
72
|
-
}
|
|
73
|
-
export interface DashboardMetricsResponse {
|
|
74
|
-
avg_pages_per_session?: number;
|
|
75
|
-
avg_session_duration_seconds?: number;
|
|
76
|
-
bounce_rate?: number;
|
|
77
|
-
dau?: number;
|
|
78
|
-
mau?: number;
|
|
79
|
-
return_rate?: number;
|
|
80
|
-
sessions_today?: number;
|
|
81
|
-
total_events?: number;
|
|
82
|
-
total_sessions_in_period?: number;
|
|
83
|
-
unique_sessions?: number;
|
|
84
|
-
unique_visitors?: number;
|
|
85
|
-
wau?: number;
|
|
86
|
-
}
|
|
87
55
|
export interface EventFilterOptionsResponse {
|
|
88
56
|
event_names?: Array<string>;
|
|
89
57
|
pages?: Array<string>;
|
|
@@ -110,11 +78,6 @@ export interface ManualIdentifyResponse {
|
|
|
110
78
|
success?: boolean;
|
|
111
79
|
visitor_id?: string;
|
|
112
80
|
}
|
|
113
|
-
export interface OriginDataPoint {
|
|
114
|
-
origin?: string;
|
|
115
|
-
percentage?: number;
|
|
116
|
-
unique_visitors?: number;
|
|
117
|
-
}
|
|
118
81
|
export interface RecentEvent {
|
|
119
82
|
browser_name?: string;
|
|
120
83
|
click_element_category?: string;
|
|
@@ -151,17 +114,6 @@ export interface RecentEventsResponse {
|
|
|
151
114
|
offset?: number;
|
|
152
115
|
total?: number;
|
|
153
116
|
}
|
|
154
|
-
export interface ReturnRateResponse {
|
|
155
|
-
avg_time_between_sessions_hours?: number;
|
|
156
|
-
return_rate_percent?: number;
|
|
157
|
-
returning_users?: number;
|
|
158
|
-
total_users?: number;
|
|
159
|
-
}
|
|
160
|
-
export interface SessionMetricsResponse {
|
|
161
|
-
average_pages_per_session?: number;
|
|
162
|
-
average_session_duration_seconds?: number;
|
|
163
|
-
total_sessions?: number;
|
|
164
|
-
}
|
|
165
117
|
export interface TopVisitor {
|
|
166
118
|
browser_name?: string;
|
|
167
119
|
currency?: string;
|
|
@@ -186,14 +138,6 @@ export interface TopVisitorsResponse {
|
|
|
186
138
|
total?: number;
|
|
187
139
|
visitors?: Array<TopVisitor>;
|
|
188
140
|
}
|
|
189
|
-
export interface UniqueVisitorsDataPoint {
|
|
190
|
-
desktop?: number;
|
|
191
|
-
mobile?: number;
|
|
192
|
-
timestamp?: string;
|
|
193
|
-
}
|
|
194
|
-
export interface UniqueVisitorsTimelineResponse {
|
|
195
|
-
data?: Array<UniqueVisitorsDataPoint>;
|
|
196
|
-
}
|
|
197
141
|
export interface VisitorDataPoint {
|
|
198
142
|
desktop?: number;
|
|
199
143
|
mobile?: number;
|
|
@@ -245,16 +189,24 @@ export interface VisitorProfileResponse {
|
|
|
245
189
|
user_id?: string;
|
|
246
190
|
visitor_id?: string;
|
|
247
191
|
}
|
|
248
|
-
export interface VisitorsByCountryResponse {
|
|
249
|
-
data?: Array<CountryDataPoint>;
|
|
250
|
-
}
|
|
251
192
|
export interface VisitorsByDeviceResponse {
|
|
252
193
|
data?: Array<VisitorDataPoint>;
|
|
253
194
|
}
|
|
254
|
-
export interface
|
|
255
|
-
data?: Array<
|
|
256
|
-
|
|
257
|
-
|
|
195
|
+
export interface AnalyticsRetrieveTimelineResponse {
|
|
196
|
+
data?: Array<AnalyticsRetrieveTimelineResponse.Data>;
|
|
197
|
+
precision?: 'minutes' | 'hourly' | 'daily' | 'weekly' | 'monthly';
|
|
198
|
+
total_visits?: number;
|
|
199
|
+
}
|
|
200
|
+
export declare namespace AnalyticsRetrieveTimelineResponse {
|
|
201
|
+
interface Data {
|
|
202
|
+
num_desktop_visits?: number;
|
|
203
|
+
num_mobile_visits?: number;
|
|
204
|
+
num_revenue?: number;
|
|
205
|
+
num_unknown_visits?: number;
|
|
206
|
+
time_bucket?: string;
|
|
207
|
+
}
|
|
208
|
+
}
|
|
209
|
+
export interface AnalyticsRetrieveTimelineParams {
|
|
258
210
|
project_id: string;
|
|
259
211
|
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
260
212
|
customer_id?: string;
|
|
@@ -266,11 +218,12 @@ export interface AnalyticsDashboardParams {
|
|
|
266
218
|
visitor_id?: string;
|
|
267
219
|
}
|
|
268
220
|
export declare namespace Analytics {
|
|
269
|
-
export { type
|
|
270
|
-
export { Visitors as Visitors, type
|
|
221
|
+
export { type ChurnRateResponse as ChurnRateResponse, type CohortAnalysisResponse as CohortAnalysisResponse, type CohortData as CohortData, type EventFilterOptionsResponse as EventFilterOptionsResponse, type EventsOverTimeDataPoint as EventsOverTimeDataPoint, type ManualIdentifyRequest as ManualIdentifyRequest, type ManualIdentifyResponse as ManualIdentifyResponse, type RecentEvent as RecentEvent, type RecentEventsResponse as RecentEventsResponse, type TopVisitor as TopVisitor, type TopVisitorsResponse as TopVisitorsResponse, type VisitorDataPoint as VisitorDataPoint, type VisitorEvent as VisitorEvent, type VisitorProfileResponse as VisitorProfileResponse, type VisitorsByDeviceResponse as VisitorsByDeviceResponse, type AnalyticsRetrieveTimelineResponse as AnalyticsRetrieveTimelineResponse, type AnalyticsRetrieveTimelineParams as AnalyticsRetrieveTimelineParams, };
|
|
222
|
+
export { Visitors as Visitors, type VisitorByDeviceParams as VisitorByDeviceParams, type VisitorIdentifyParams as VisitorIdentifyParams, type VisitorProfileParams as VisitorProfileParams, type VisitorTopParams as VisitorTopParams, };
|
|
271
223
|
export { Events as Events, type EventFilterOptionsParams as EventFilterOptionsParams, type EventRecentParams as EventRecentParams, };
|
|
272
|
-
export { Sessions as Sessions
|
|
273
|
-
export { Users as Users
|
|
274
|
-
export { Retention as Retention, type RetentionChurnRateParams as RetentionChurnRateParams, type RetentionCohortsParams as RetentionCohortsParams,
|
|
224
|
+
export { Sessions as Sessions };
|
|
225
|
+
export { Users as Users };
|
|
226
|
+
export { Retention as Retention, type RetentionChurnRateParams as RetentionChurnRateParams, type RetentionCohortsParams as RetentionCohortsParams, };
|
|
227
|
+
export { Tiles as Tiles, type TileGetBounceRateResponse as TileGetBounceRateResponse, type TileGetDailyActiveUsersResponse as TileGetDailyActiveUsersResponse, type TileGetMonthlyActiveUsersResponse as TileGetMonthlyActiveUsersResponse, type TileGetPagesPerSessionResponse as TileGetPagesPerSessionResponse, type TileGetReturnRateResponse as TileGetReturnRateResponse, type TileGetSessionDurationResponse as TileGetSessionDurationResponse, type TileGetTimeBetweenVisitsResponse as TileGetTimeBetweenVisitsResponse, type TileGetTrafficByCountryResponse as TileGetTrafficByCountryResponse, type TileGetTrafficByRefererResponse as TileGetTrafficByRefererResponse, type TileGetTrafficByUtmResponse as TileGetTrafficByUtmResponse, type TileGetUniqueSessionsResponse as TileGetUniqueSessionsResponse, type TileGetUniqueVisitorsResponse as TileGetUniqueVisitorsResponse, type TileGetWeeklyActiveUsersResponse as TileGetWeeklyActiveUsersResponse, type TileGetBounceRateParams as TileGetBounceRateParams, type TileGetDailyActiveUsersParams as TileGetDailyActiveUsersParams, type TileGetMonthlyActiveUsersParams as TileGetMonthlyActiveUsersParams, type TileGetPagesPerSessionParams as TileGetPagesPerSessionParams, type TileGetReturnRateParams as TileGetReturnRateParams, type TileGetSessionDurationParams as TileGetSessionDurationParams, type TileGetTimeBetweenVisitsParams as TileGetTimeBetweenVisitsParams, type TileGetTrafficByCountryParams as TileGetTrafficByCountryParams, type TileGetTrafficByRefererParams as TileGetTrafficByRefererParams, type TileGetTrafficByUtmParams as TileGetTrafficByUtmParams, type TileGetUniqueSessionsParams as TileGetUniqueSessionsParams, type TileGetUniqueVisitorsParams as TileGetUniqueVisitorsParams, type TileGetWeeklyActiveUsersParams as TileGetWeeklyActiveUsersParams, };
|
|
275
228
|
}
|
|
276
229
|
//# sourceMappingURL=analytics.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/analytics.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,EAAE;OACvD,KAAK,YAAY;OACjB,
|
|
1
|
+
{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/analytics.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,EAAE;OACvD,KAAK,YAAY;OACjB,EAAE,SAAS,EAAE,wBAAwB,EAAE,sBAAsB,EAAE;OAC/D,KAAK,WAAW;OAChB,EAAE,QAAQ,EAAE;OACZ,KAAK,QAAQ;OACb,EACL,uBAAuB,EACvB,yBAAyB,EACzB,6BAA6B,EAC7B,+BAA+B,EAC/B,+BAA+B,EAC/B,iCAAiC,EACjC,4BAA4B,EAC5B,8BAA8B,EAC9B,uBAAuB,EACvB,yBAAyB,EACzB,4BAA4B,EAC5B,8BAA8B,EAC9B,8BAA8B,EAC9B,gCAAgC,EAChC,6BAA6B,EAC7B,+BAA+B,EAC/B,6BAA6B,EAC7B,+BAA+B,EAC/B,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC7B,2BAA2B,EAC3B,6BAA6B,EAC7B,8BAA8B,EAC9B,gCAAgC,EAChC,KAAK,EACN;OACM,KAAK,QAAQ;OACb,EAAE,KAAK,EAAE;OACT,KAAK,WAAW;OAChB,EACL,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,EAChB,QAAQ,EACT;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,KAAK,EAAE,+BAA+B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;CAGjD;AAED,MAAM,WAAW,iBAAiB;IAChC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,UAAU;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;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,sBAAsB;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAE5B,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,8BAA8B,CAAC,EAAE,MAAM,CAAC;IAExC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,sBAAsB;IACrC,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE3C,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE7B,gBAAgB,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAElD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,CAAC,EAAE,KAAK,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC;IAErD,SAAS,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;IAElE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,yBAAiB,iCAAiC,CAAC;IACjD,UAAiB,IAAI;QACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,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;AASD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,CAAC;IAEhC,OAAO,EAAE,KAAK,IAAI,KAAK,EAAE,CAAC;IAE1B,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
|
|
@@ -10,6 +10,8 @@ const RetentionAPI = tslib_1.__importStar(require("./retention.js"));
|
|
|
10
10
|
const retention_1 = require("./retention.js");
|
|
11
11
|
const SessionsAPI = tslib_1.__importStar(require("./sessions.js"));
|
|
12
12
|
const sessions_1 = require("./sessions.js");
|
|
13
|
+
const TilesAPI = tslib_1.__importStar(require("./tiles.js"));
|
|
14
|
+
const tiles_1 = require("./tiles.js");
|
|
13
15
|
const UsersAPI = tslib_1.__importStar(require("./users.js"));
|
|
14
16
|
const users_1 = require("./users.js");
|
|
15
17
|
const VisitorsAPI = tslib_1.__importStar(require("./visitors.js"));
|
|
@@ -22,22 +24,21 @@ class Analytics extends resource_1.APIResource {
|
|
|
22
24
|
this.sessions = new SessionsAPI.Sessions(this._client);
|
|
23
25
|
this.users = new UsersAPI.Users(this._client);
|
|
24
26
|
this.retention = new RetentionAPI.Retention(this._client);
|
|
27
|
+
this.tiles = new TilesAPI.Tiles(this._client);
|
|
25
28
|
}
|
|
26
29
|
/**
|
|
27
|
-
* Get
|
|
28
|
-
*
|
|
30
|
+
* Get unique visitor counts over time, split by mobile and desktop devices for
|
|
31
|
+
* chart visualization
|
|
29
32
|
*
|
|
30
33
|
* @example
|
|
31
34
|
* ```ts
|
|
32
|
-
* const
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
* time_range: 'last_hour',
|
|
36
|
-
* });
|
|
35
|
+
* const response = await client.v1.analytics.retrieveTimeline(
|
|
36
|
+
* { project_id: 'project_id', time_range: 'last_hour' },
|
|
37
|
+
* );
|
|
37
38
|
* ```
|
|
38
39
|
*/
|
|
39
|
-
|
|
40
|
-
return this._client.get('/api/v1/analytics/
|
|
40
|
+
retrieveTimeline(query, options) {
|
|
41
|
+
return this._client.get('/api/v1/analytics/timeline', { query, ...options });
|
|
41
42
|
}
|
|
42
43
|
}
|
|
43
44
|
exports.Analytics = Analytics;
|
|
@@ -46,4 +47,5 @@ Analytics.Events = events_1.Events;
|
|
|
46
47
|
Analytics.Sessions = sessions_1.Sessions;
|
|
47
48
|
Analytics.Users = users_1.Users;
|
|
48
49
|
Analytics.Retention = retention_1.Retention;
|
|
50
|
+
Analytics.Tiles = tiles_1.Tiles;
|
|
49
51
|
//# sourceMappingURL=analytics.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../../src/resources/v1/analytics/analytics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,+DAAsC;AACtC,wCAA+E;AAC/E,qEAA4C;AAC5C,
|
|
1
|
+
{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../../src/resources/v1/analytics/analytics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,+DAAsC;AACtC,wCAA+E;AAC/E,qEAA4C;AAC5C,8CAA0F;AAC1F,mEAA0C;AAC1C,4CAAsC;AACtC,6DAAoC;AACpC,sCA4BiB;AACjB,6DAAoC;AACpC,sCAAgC;AAChC,mEAA0C;AAC1C,4CAMoB;AAIpB,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmB3D,CAAC;IAjBC;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,KAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AAzBD,8BAyBC;AAoUD,SAAS,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC9B,SAAS,CAAC,MAAM,GAAG,eAAM,CAAC;AAC1B,SAAS,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC9B,SAAS,CAAC,KAAK,GAAG,aAAK,CAAC;AACxB,SAAS,CAAC,SAAS,GAAG,qBAAS,CAAC;AAChC,SAAS,CAAC,KAAK,GAAG,aAAK,CAAC"}
|
|
@@ -3,9 +3,11 @@ import { APIResource } from "../../../core/resource.mjs";
|
|
|
3
3
|
import * as EventsAPI from "./events.mjs";
|
|
4
4
|
import { Events } from "./events.mjs";
|
|
5
5
|
import * as RetentionAPI from "./retention.mjs";
|
|
6
|
-
import { Retention
|
|
6
|
+
import { Retention } from "./retention.mjs";
|
|
7
7
|
import * as SessionsAPI from "./sessions.mjs";
|
|
8
8
|
import { Sessions } from "./sessions.mjs";
|
|
9
|
+
import * as TilesAPI from "./tiles.mjs";
|
|
10
|
+
import { Tiles, } from "./tiles.mjs";
|
|
9
11
|
import * as UsersAPI from "./users.mjs";
|
|
10
12
|
import { Users } from "./users.mjs";
|
|
11
13
|
import * as VisitorsAPI from "./visitors.mjs";
|
|
@@ -18,22 +20,21 @@ export class Analytics extends APIResource {
|
|
|
18
20
|
this.sessions = new SessionsAPI.Sessions(this._client);
|
|
19
21
|
this.users = new UsersAPI.Users(this._client);
|
|
20
22
|
this.retention = new RetentionAPI.Retention(this._client);
|
|
23
|
+
this.tiles = new TilesAPI.Tiles(this._client);
|
|
21
24
|
}
|
|
22
25
|
/**
|
|
23
|
-
* Get
|
|
24
|
-
*
|
|
26
|
+
* Get unique visitor counts over time, split by mobile and desktop devices for
|
|
27
|
+
* chart visualization
|
|
25
28
|
*
|
|
26
29
|
* @example
|
|
27
30
|
* ```ts
|
|
28
|
-
* const
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* time_range: 'last_hour',
|
|
32
|
-
* });
|
|
31
|
+
* const response = await client.v1.analytics.retrieveTimeline(
|
|
32
|
+
* { project_id: 'project_id', time_range: 'last_hour' },
|
|
33
|
+
* );
|
|
33
34
|
* ```
|
|
34
35
|
*/
|
|
35
|
-
|
|
36
|
-
return this._client.get('/api/v1/analytics/
|
|
36
|
+
retrieveTimeline(query, options) {
|
|
37
|
+
return this._client.get('/api/v1/analytics/timeline', { query, ...options });
|
|
37
38
|
}
|
|
38
39
|
}
|
|
39
40
|
Analytics.Visitors = Visitors;
|
|
@@ -41,4 +42,5 @@ Analytics.Events = Events;
|
|
|
41
42
|
Analytics.Sessions = Sessions;
|
|
42
43
|
Analytics.Users = Users;
|
|
43
44
|
Analytics.Retention = Retention;
|
|
45
|
+
Analytics.Tiles = Tiles;
|
|
44
46
|
//# sourceMappingURL=analytics.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"analytics.mjs","sourceRoot":"","sources":["../../../src/resources/v1/analytics/analytics.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAA+C,MAAM,EAAE;OACvD,KAAK,YAAY;OACjB,
|
|
1
|
+
{"version":3,"file":"analytics.mjs","sourceRoot":"","sources":["../../../src/resources/v1/analytics/analytics.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAA+C,MAAM,EAAE;OACvD,KAAK,YAAY;OACjB,EAAE,SAAS,EAAoD;OAC/D,KAAK,WAAW;OAChB,EAAE,QAAQ,EAAE;OACZ,KAAK,QAAQ;OACb,EA2BL,KAAK,GACN;OACM,KAAK,QAAQ;OACb,EAAE,KAAK,EAAE;OACT,KAAK,WAAW;OAChB,EAKL,QAAQ,GACT;AAID,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmB3D,CAAC;IAjBC;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,KAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AAoUD,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC9B,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC;AAC1B,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC9B,SAAS,CAAC,KAAK,GAAG,KAAK,CAAC;AACxB,SAAS,CAAC,SAAS,GAAG,SAAS,CAAC;AAChC,SAAS,CAAC,KAAK,GAAG,KAAK,CAAC"}
|