zorihq 0.13.0 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/package.json +1 -1
- package/resources/v1/analytics/analytics.d.mts +44 -82
- package/resources/v1/analytics/analytics.d.mts.map +1 -1
- package/resources/v1/analytics/analytics.d.ts +44 -82
- package/resources/v1/analytics/analytics.d.ts.map +1 -1
- package/resources/v1/analytics/analytics.js +11 -9
- package/resources/v1/analytics/analytics.js.map +1 -1
- package/resources/v1/analytics/analytics.mjs +12 -10
- package/resources/v1/analytics/analytics.mjs.map +1 -1
- package/resources/v1/analytics/events.d.mts +8 -6
- package/resources/v1/analytics/events.d.mts.map +1 -1
- package/resources/v1/analytics/events.d.ts +8 -6
- package/resources/v1/analytics/events.d.ts.map +1 -1
- package/resources/v1/analytics/events.js +3 -2
- package/resources/v1/analytics/events.js.map +1 -1
- package/resources/v1/analytics/events.mjs +3 -2
- package/resources/v1/analytics/events.mjs.map +1 -1
- package/resources/v1/analytics/index.d.mts +6 -5
- package/resources/v1/analytics/index.d.mts.map +1 -1
- package/resources/v1/analytics/index.d.ts +6 -5
- package/resources/v1/analytics/index.d.ts.map +1 -1
- package/resources/v1/analytics/index.js +3 -1
- package/resources/v1/analytics/index.js.map +1 -1
- package/resources/v1/analytics/index.mjs +2 -1
- package/resources/v1/analytics/index.mjs.map +1 -1
- package/resources/v1/analytics/retention.d.mts +1 -25
- package/resources/v1/analytics/retention.d.mts.map +1 -1
- package/resources/v1/analytics/retention.d.ts +1 -25
- package/resources/v1/analytics/retention.d.ts.map +1 -1
- package/resources/v1/analytics/retention.js +0 -15
- package/resources/v1/analytics/retention.js.map +1 -1
- package/resources/v1/analytics/retention.mjs +0 -15
- package/resources/v1/analytics/retention.mjs.map +1 -1
- package/resources/v1/analytics/sessions.d.mts +0 -54
- package/resources/v1/analytics/sessions.d.mts.map +1 -1
- package/resources/v1/analytics/sessions.d.ts +0 -54
- package/resources/v1/analytics/sessions.d.ts.map +1 -1
- package/resources/v1/analytics/sessions.js +0 -30
- package/resources/v1/analytics/sessions.js.map +1 -1
- package/resources/v1/analytics/sessions.mjs +0 -30
- package/resources/v1/analytics/sessions.mjs.map +1 -1
- package/resources/v1/analytics/tiles.d.mts +401 -0
- package/resources/v1/analytics/tiles.d.mts.map +1 -0
- package/resources/v1/analytics/tiles.d.ts +401 -0
- package/resources/v1/analytics/tiles.d.ts.map +1 -0
- package/resources/v1/analytics/tiles.js +208 -0
- package/resources/v1/analytics/tiles.js.map +1 -0
- package/resources/v1/analytics/tiles.mjs +204 -0
- package/resources/v1/analytics/tiles.mjs.map +1 -0
- package/resources/v1/analytics/users.d.mts +0 -30
- package/resources/v1/analytics/users.d.mts.map +1 -1
- package/resources/v1/analytics/users.d.ts +0 -30
- package/resources/v1/analytics/users.d.ts.map +1 -1
- package/resources/v1/analytics/users.js +0 -15
- package/resources/v1/analytics/users.js.map +1 -1
- package/resources/v1/analytics/users.mjs +0 -15
- package/resources/v1/analytics/users.mjs.map +1 -1
- package/resources/v1/analytics/visitors.d.mts +4 -75
- package/resources/v1/analytics/visitors.d.mts.map +1 -1
- package/resources/v1/analytics/visitors.d.ts +4 -75
- package/resources/v1/analytics/visitors.d.ts.map +1 -1
- package/resources/v1/analytics/visitors.js +3 -47
- package/resources/v1/analytics/visitors.js.map +1 -1
- package/resources/v1/analytics/visitors.mjs +3 -47
- package/resources/v1/analytics/visitors.mjs.map +1 -1
- package/resources/v1/index.d.mts +1 -1
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +1 -1
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/v1.d.mts +2 -2
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +2 -2
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs.map +1 -1
- package/src/resources/v1/analytics/analytics.ts +119 -145
- package/src/resources/v1/analytics/events.ts +9 -6
- package/src/resources/v1/analytics/index.ts +33 -23
- package/src/resources/v1/analytics/retention.ts +0 -40
- package/src/resources/v1/analytics/sessions.ts +1 -89
- package/src/resources/v1/analytics/tiles.ts +663 -0
- package/src/resources/v1/analytics/users.ts +1 -44
- package/src/resources/v1/analytics/visitors.ts +3 -122
- package/src/resources/v1/index.ts +2 -13
- package/src/resources/v1/v1.ts +4 -26
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -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"}
|
|
@@ -4,7 +4,8 @@ import { APIPromise } from "../../../core/api-promise.mjs";
|
|
|
4
4
|
import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
5
5
|
export declare class Events extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Get unique traffic origins
|
|
7
|
+
* Get unique traffic origins, page paths, and event names to populate filter
|
|
8
|
+
* dropdowns
|
|
8
9
|
*
|
|
9
10
|
* @example
|
|
10
11
|
* ```ts
|
|
@@ -18,7 +19,7 @@ export declare class Events extends APIResource {
|
|
|
18
19
|
filterOptions(query: EventFilterOptionsParams, options?: RequestOptions): APIPromise<AnalyticsAPI.EventFilterOptionsResponse>;
|
|
19
20
|
/**
|
|
20
21
|
* Get a list of recent events with optional filters (visitor_id, user_id,
|
|
21
|
-
* external_id, traffic_origin, page_path)
|
|
22
|
+
* external_id, traffic_origin, page_path, event_name)
|
|
22
23
|
*
|
|
23
24
|
* @example
|
|
24
25
|
* ```ts
|
|
@@ -46,13 +47,14 @@ export interface EventRecentParams {
|
|
|
46
47
|
project_id: string;
|
|
47
48
|
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
48
49
|
customer_id?: string;
|
|
49
|
-
|
|
50
|
+
event_name?: string;
|
|
51
|
+
external_id?: string;
|
|
50
52
|
limit?: number;
|
|
51
53
|
offset?: number;
|
|
52
|
-
|
|
54
|
+
page_path?: string;
|
|
53
55
|
referrer?: string;
|
|
54
|
-
|
|
55
|
-
|
|
56
|
+
traffic_origin?: string;
|
|
57
|
+
user_id?: string;
|
|
56
58
|
utmtag?: string;
|
|
57
59
|
utmtagValue?: string;
|
|
58
60
|
visitor_id?: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/events.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC
|
|
1
|
+
{"version":3,"file":"events.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/events.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,0BAA0B,CAAC;IAItD;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,oBAAoB,CAAC;CAG1G;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,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,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
|
@@ -4,7 +4,8 @@ import { APIPromise } from "../../../core/api-promise.js";
|
|
|
4
4
|
import { RequestOptions } from "../../../internal/request-options.js";
|
|
5
5
|
export declare class Events extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Get unique traffic origins
|
|
7
|
+
* Get unique traffic origins, page paths, and event names to populate filter
|
|
8
|
+
* dropdowns
|
|
8
9
|
*
|
|
9
10
|
* @example
|
|
10
11
|
* ```ts
|
|
@@ -18,7 +19,7 @@ export declare class Events extends APIResource {
|
|
|
18
19
|
filterOptions(query: EventFilterOptionsParams, options?: RequestOptions): APIPromise<AnalyticsAPI.EventFilterOptionsResponse>;
|
|
19
20
|
/**
|
|
20
21
|
* Get a list of recent events with optional filters (visitor_id, user_id,
|
|
21
|
-
* external_id, traffic_origin, page_path)
|
|
22
|
+
* external_id, traffic_origin, page_path, event_name)
|
|
22
23
|
*
|
|
23
24
|
* @example
|
|
24
25
|
* ```ts
|
|
@@ -46,13 +47,14 @@ export interface EventRecentParams {
|
|
|
46
47
|
project_id: string;
|
|
47
48
|
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
48
49
|
customer_id?: string;
|
|
49
|
-
|
|
50
|
+
event_name?: string;
|
|
51
|
+
external_id?: string;
|
|
50
52
|
limit?: number;
|
|
51
53
|
offset?: number;
|
|
52
|
-
|
|
54
|
+
page_path?: string;
|
|
53
55
|
referrer?: string;
|
|
54
|
-
|
|
55
|
-
|
|
56
|
+
traffic_origin?: string;
|
|
57
|
+
user_id?: string;
|
|
56
58
|
utmtag?: string;
|
|
57
59
|
utmtagValue?: string;
|
|
58
60
|
visitor_id?: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/events.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC
|
|
1
|
+
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/events.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,0BAA0B,CAAC;IAItD;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,oBAAoB,CAAC;CAG1G;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,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,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
|
@@ -5,7 +5,8 @@ exports.Events = void 0;
|
|
|
5
5
|
const resource_1 = require("../../../core/resource.js");
|
|
6
6
|
class Events extends resource_1.APIResource {
|
|
7
7
|
/**
|
|
8
|
-
* Get unique traffic origins
|
|
8
|
+
* Get unique traffic origins, page paths, and event names to populate filter
|
|
9
|
+
* dropdowns
|
|
9
10
|
*
|
|
10
11
|
* @example
|
|
11
12
|
* ```ts
|
|
@@ -21,7 +22,7 @@ class Events extends resource_1.APIResource {
|
|
|
21
22
|
}
|
|
22
23
|
/**
|
|
23
24
|
* Get a list of recent events with optional filters (visitor_id, user_id,
|
|
24
|
-
* external_id, traffic_origin, page_path)
|
|
25
|
+
* external_id, traffic_origin, page_path, event_name)
|
|
25
26
|
*
|
|
26
27
|
* @example
|
|
27
28
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/resources/v1/analytics/events.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,MAAa,MAAO,SAAQ,sBAAW;IACrC
|
|
1
|
+
{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/resources/v1/analytics/events.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,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,MAAM,CAAC,KAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iCAAiC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF;AArCD,wBAqCC"}
|
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
import { APIResource } from "../../../core/resource.mjs";
|
|
3
3
|
export class Events extends APIResource {
|
|
4
4
|
/**
|
|
5
|
-
* Get unique traffic origins
|
|
5
|
+
* Get unique traffic origins, page paths, and event names to populate filter
|
|
6
|
+
* dropdowns
|
|
6
7
|
*
|
|
7
8
|
* @example
|
|
8
9
|
* ```ts
|
|
@@ -18,7 +19,7 @@ export class Events extends APIResource {
|
|
|
18
19
|
}
|
|
19
20
|
/**
|
|
20
21
|
* Get a list of recent events with optional filters (visitor_id, user_id,
|
|
21
|
-
* external_id, traffic_origin, page_path)
|
|
22
|
+
* external_id, traffic_origin, page_path, event_name)
|
|
22
23
|
*
|
|
23
24
|
* @example
|
|
24
25
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.mjs","sourceRoot":"","sources":["../../../src/resources/v1/analytics/events.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC
|
|
1
|
+
{"version":3,"file":"events.mjs","sourceRoot":"","sources":["../../../src/resources/v1/analytics/events.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,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,MAAM,CAAC,KAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iCAAiC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF"}
|
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
export { Analytics, type
|
|
1
|
+
export { Analytics, type ChurnRateResponse, type CohortAnalysisResponse, type CohortData, type EventFilterOptionsResponse, type EventsOverTimeDataPoint, type ManualIdentifyRequest, type ManualIdentifyResponse, type RecentEvent, type RecentEventsResponse, type TopVisitor, type TopVisitorsResponse, type VisitorDataPoint, type VisitorEvent, type VisitorProfileResponse, type VisitorsByDeviceResponse, type AnalyticsRetrieveTimelineResponse, type AnalyticsRetrieveTimelineParams, } from "./analytics.mjs";
|
|
2
2
|
export { Events, type EventFilterOptionsParams, type EventRecentParams } from "./events.mjs";
|
|
3
|
-
export { Retention, type RetentionChurnRateParams, type RetentionCohortsParams
|
|
4
|
-
export { Sessions
|
|
5
|
-
export {
|
|
6
|
-
export {
|
|
3
|
+
export { Retention, type RetentionChurnRateParams, type RetentionCohortsParams } from "./retention.mjs";
|
|
4
|
+
export { Sessions } from "./sessions.mjs";
|
|
5
|
+
export { Tiles, type TileGetBounceRateResponse, type TileGetDailyActiveUsersResponse, type TileGetMonthlyActiveUsersResponse, type TileGetPagesPerSessionResponse, type TileGetReturnRateResponse, type TileGetSessionDurationResponse, type TileGetTimeBetweenVisitsResponse, type TileGetTrafficByCountryResponse, type TileGetTrafficByRefererResponse, type TileGetTrafficByUtmResponse, type TileGetUniqueSessionsResponse, type TileGetUniqueVisitorsResponse, type TileGetWeeklyActiveUsersResponse, type TileGetBounceRateParams, type TileGetDailyActiveUsersParams, type TileGetMonthlyActiveUsersParams, type TileGetPagesPerSessionParams, type TileGetReturnRateParams, type TileGetSessionDurationParams, type TileGetTimeBetweenVisitsParams, type TileGetTrafficByCountryParams, type TileGetTrafficByRefererParams, type TileGetTrafficByUtmParams, type TileGetUniqueSessionsParams, type TileGetUniqueVisitorsParams, type TileGetWeeklyActiveUsersParams, } from "./tiles.mjs";
|
|
6
|
+
export { Users } from "./users.mjs";
|
|
7
|
+
export { Visitors, type VisitorByDeviceParams, type VisitorIdentifyParams, type VisitorProfileParams, type VisitorTopParams, } from "./visitors.mjs";
|
|
7
8
|
//# sourceMappingURL=index.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,UAAU,EACf,KAAK,0BAA0B,EAC/B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,UAAU,EACf,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,iCAAiC,EACtC,KAAK,+BAA+B,GACrC;OACM,EAAE,MAAM,EAAE,KAAK,wBAAwB,EAAE,KAAK,iBAAiB,EAAE;OACjE,EAAE,SAAS,EAAE,KAAK,wBAAwB,EAAE,KAAK,sBAAsB,EAAE;OACzE,EAAE,QAAQ,EAAE;OACZ,EACL,KAAK,EACL,KAAK,yBAAyB,EAC9B,KAAK,+BAA+B,EACpC,KAAK,iCAAiC,EACtC,KAAK,8BAA8B,EACnC,KAAK,yBAAyB,EAC9B,KAAK,8BAA8B,EACnC,KAAK,gCAAgC,EACrC,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EACpC,KAAK,2BAA2B,EAChC,KAAK,6BAA6B,EAClC,KAAK,6BAA6B,EAClC,KAAK,gCAAgC,EACrC,KAAK,uBAAuB,EAC5B,KAAK,6BAA6B,EAClC,KAAK,+BAA+B,EACpC,KAAK,4BAA4B,EACjC,KAAK,uBAAuB,EAC5B,KAAK,4BAA4B,EACjC,KAAK,8BAA8B,EACnC,KAAK,6BAA6B,EAClC,KAAK,6BAA6B,EAClC,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,GACpC;OACM,EAAE,KAAK,EAAE;OACT,EACL,QAAQ,EACR,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,GACtB"}
|
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
export { Analytics, type
|
|
1
|
+
export { Analytics, type ChurnRateResponse, type CohortAnalysisResponse, type CohortData, type EventFilterOptionsResponse, type EventsOverTimeDataPoint, type ManualIdentifyRequest, type ManualIdentifyResponse, type RecentEvent, type RecentEventsResponse, type TopVisitor, type TopVisitorsResponse, type VisitorDataPoint, type VisitorEvent, type VisitorProfileResponse, type VisitorsByDeviceResponse, type AnalyticsRetrieveTimelineResponse, type AnalyticsRetrieveTimelineParams, } from "./analytics.js";
|
|
2
2
|
export { Events, type EventFilterOptionsParams, type EventRecentParams } from "./events.js";
|
|
3
|
-
export { Retention, type RetentionChurnRateParams, type RetentionCohortsParams
|
|
4
|
-
export { Sessions
|
|
5
|
-
export {
|
|
6
|
-
export {
|
|
3
|
+
export { Retention, type RetentionChurnRateParams, type RetentionCohortsParams } from "./retention.js";
|
|
4
|
+
export { Sessions } from "./sessions.js";
|
|
5
|
+
export { Tiles, type TileGetBounceRateResponse, type TileGetDailyActiveUsersResponse, type TileGetMonthlyActiveUsersResponse, type TileGetPagesPerSessionResponse, type TileGetReturnRateResponse, type TileGetSessionDurationResponse, type TileGetTimeBetweenVisitsResponse, type TileGetTrafficByCountryResponse, type TileGetTrafficByRefererResponse, type TileGetTrafficByUtmResponse, type TileGetUniqueSessionsResponse, type TileGetUniqueVisitorsResponse, type TileGetWeeklyActiveUsersResponse, type TileGetBounceRateParams, type TileGetDailyActiveUsersParams, type TileGetMonthlyActiveUsersParams, type TileGetPagesPerSessionParams, type TileGetReturnRateParams, type TileGetSessionDurationParams, type TileGetTimeBetweenVisitsParams, type TileGetTrafficByCountryParams, type TileGetTrafficByRefererParams, type TileGetTrafficByUtmParams, type TileGetUniqueSessionsParams, type TileGetUniqueVisitorsParams, type TileGetWeeklyActiveUsersParams, } from "./tiles.js";
|
|
6
|
+
export { Users } from "./users.js";
|
|
7
|
+
export { Visitors, type VisitorByDeviceParams, type VisitorIdentifyParams, type VisitorProfileParams, type VisitorTopParams, } from "./visitors.js";
|
|
7
8
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,UAAU,EACf,KAAK,0BAA0B,EAC/B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,UAAU,EACf,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,iCAAiC,EACtC,KAAK,+BAA+B,GACrC;OACM,EAAE,MAAM,EAAE,KAAK,wBAAwB,EAAE,KAAK,iBAAiB,EAAE;OACjE,EAAE,SAAS,EAAE,KAAK,wBAAwB,EAAE,KAAK,sBAAsB,EAAE;OACzE,EAAE,QAAQ,EAAE;OACZ,EACL,KAAK,EACL,KAAK,yBAAyB,EAC9B,KAAK,+BAA+B,EACpC,KAAK,iCAAiC,EACtC,KAAK,8BAA8B,EACnC,KAAK,yBAAyB,EAC9B,KAAK,8BAA8B,EACnC,KAAK,gCAAgC,EACrC,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EACpC,KAAK,2BAA2B,EAChC,KAAK,6BAA6B,EAClC,KAAK,6BAA6B,EAClC,KAAK,gCAAgC,EACrC,KAAK,uBAAuB,EAC5B,KAAK,6BAA6B,EAClC,KAAK,+BAA+B,EACpC,KAAK,4BAA4B,EACjC,KAAK,uBAAuB,EAC5B,KAAK,4BAA4B,EACjC,KAAK,8BAA8B,EACnC,KAAK,6BAA6B,EAClC,KAAK,6BAA6B,EAClC,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,GACpC;OACM,EAAE,KAAK,EAAE;OACT,EACL,QAAQ,EACR,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,GACtB"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.Visitors = exports.Users = exports.Sessions = exports.Retention = exports.Events = exports.Analytics = void 0;
|
|
4
|
+
exports.Visitors = exports.Users = exports.Tiles = exports.Sessions = exports.Retention = exports.Events = exports.Analytics = void 0;
|
|
5
5
|
var analytics_1 = require("./analytics.js");
|
|
6
6
|
Object.defineProperty(exports, "Analytics", { enumerable: true, get: function () { return analytics_1.Analytics; } });
|
|
7
7
|
var events_1 = require("./events.js");
|
|
@@ -10,6 +10,8 @@ var retention_1 = require("./retention.js");
|
|
|
10
10
|
Object.defineProperty(exports, "Retention", { enumerable: true, get: function () { return retention_1.Retention; } });
|
|
11
11
|
var sessions_1 = require("./sessions.js");
|
|
12
12
|
Object.defineProperty(exports, "Sessions", { enumerable: true, get: function () { return sessions_1.Sessions; } });
|
|
13
|
+
var tiles_1 = require("./tiles.js");
|
|
14
|
+
Object.defineProperty(exports, "Tiles", { enumerable: true, get: function () { return tiles_1.Tiles; } });
|
|
13
15
|
var users_1 = require("./users.js");
|
|
14
16
|
Object.defineProperty(exports, "Users", { enumerable: true, get: function () { return users_1.Users; } });
|
|
15
17
|
var visitors_1 = require("./visitors.js");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4CAmBqB;AAlBnB,sGAAA,SAAS,OAAA;AAmBX,sCAAyF;AAAhF,gGAAA,MAAM,OAAA;AACf,4CAAoG;AAA3F,sGAAA,SAAS,OAAA;AAClB,0CAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,oCA4BiB;AA3Bf,8FAAA,KAAK,OAAA;AA4BP,oCAAgC;AAAvB,8FAAA,KAAK,OAAA;AACd,0CAMoB;AALlB,oGAAA,QAAQ,OAAA"}
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
export { Analytics, } from "./analytics.mjs";
|
|
3
3
|
export { Events } from "./events.mjs";
|
|
4
|
-
export { Retention
|
|
4
|
+
export { Retention } from "./retention.mjs";
|
|
5
5
|
export { Sessions } from "./sessions.mjs";
|
|
6
|
+
export { Tiles, } from "./tiles.mjs";
|
|
6
7
|
export { Users } from "./users.mjs";
|
|
7
8
|
export { Visitors, } from "./visitors.mjs";
|
|
8
9
|
//# sourceMappingURL=index.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,SAAS,
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,SAAS,GAkBV;OACM,EAAE,MAAM,EAAyD;OACjE,EAAE,SAAS,EAA8D;OACzE,EAAE,QAAQ,EAAE;OACZ,EACL,KAAK,GA2BN;OACM,EAAE,KAAK,EAAE;OACT,EACL,QAAQ,GAKT"}
|
|
@@ -29,19 +29,6 @@ export declare class Retention extends APIResource {
|
|
|
29
29
|
* ```
|
|
30
30
|
*/
|
|
31
31
|
cohorts(query: RetentionCohortsParams, options?: RequestOptions): APIPromise<AnalyticsAPI.CohortAnalysisResponse>;
|
|
32
|
-
/**
|
|
33
|
-
* Get metrics about user return rate and time between sessions
|
|
34
|
-
*
|
|
35
|
-
* @example
|
|
36
|
-
* ```ts
|
|
37
|
-
* const returnRateResponse =
|
|
38
|
-
* await client.v1.analytics.retention.returnRate({
|
|
39
|
-
* project_id: 'project_id',
|
|
40
|
-
* time_range: 'last_hour',
|
|
41
|
-
* });
|
|
42
|
-
* ```
|
|
43
|
-
*/
|
|
44
|
-
returnRate(query: RetentionReturnRateParams, options?: RequestOptions): APIPromise<AnalyticsAPI.ReturnRateResponse>;
|
|
45
32
|
}
|
|
46
33
|
export interface RetentionChurnRateParams {
|
|
47
34
|
project_id: string;
|
|
@@ -65,18 +52,7 @@ export interface RetentionCohortsParams {
|
|
|
65
52
|
utmtagValue?: string;
|
|
66
53
|
visitor_id?: string;
|
|
67
54
|
}
|
|
68
|
-
export interface RetentionReturnRateParams {
|
|
69
|
-
project_id: string;
|
|
70
|
-
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
71
|
-
customer_id?: string;
|
|
72
|
-
limit?: number;
|
|
73
|
-
offset?: number;
|
|
74
|
-
referrer?: string;
|
|
75
|
-
utmtag?: string;
|
|
76
|
-
utmtagValue?: string;
|
|
77
|
-
visitor_id?: string;
|
|
78
|
-
}
|
|
79
55
|
export declare namespace Retention {
|
|
80
|
-
export { type RetentionChurnRateParams as RetentionChurnRateParams, type RetentionCohortsParams as RetentionCohortsParams,
|
|
56
|
+
export { type RetentionChurnRateParams as RetentionChurnRateParams, type RetentionCohortsParams as RetentionCohortsParams, };
|
|
81
57
|
}
|
|
82
58
|
//# sourceMappingURL=retention.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"retention.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/retention.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;OAWG;IACH,SAAS,CACP,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,iBAAiB,CAAC;IAI7C;;;;;;;;;;;OAWG;IACH,OAAO,CACL,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"retention.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/retention.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;OAWG;IACH,SAAS,CACP,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,iBAAiB,CAAC;IAI7C;;;;;;;;;;;OAWG;IACH,OAAO,CACL,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,sBAAsB,CAAC;CAGnD;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,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,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -29,19 +29,6 @@ export declare class Retention extends APIResource {
|
|
|
29
29
|
* ```
|
|
30
30
|
*/
|
|
31
31
|
cohorts(query: RetentionCohortsParams, options?: RequestOptions): APIPromise<AnalyticsAPI.CohortAnalysisResponse>;
|
|
32
|
-
/**
|
|
33
|
-
* Get metrics about user return rate and time between sessions
|
|
34
|
-
*
|
|
35
|
-
* @example
|
|
36
|
-
* ```ts
|
|
37
|
-
* const returnRateResponse =
|
|
38
|
-
* await client.v1.analytics.retention.returnRate({
|
|
39
|
-
* project_id: 'project_id',
|
|
40
|
-
* time_range: 'last_hour',
|
|
41
|
-
* });
|
|
42
|
-
* ```
|
|
43
|
-
*/
|
|
44
|
-
returnRate(query: RetentionReturnRateParams, options?: RequestOptions): APIPromise<AnalyticsAPI.ReturnRateResponse>;
|
|
45
32
|
}
|
|
46
33
|
export interface RetentionChurnRateParams {
|
|
47
34
|
project_id: string;
|
|
@@ -65,18 +52,7 @@ export interface RetentionCohortsParams {
|
|
|
65
52
|
utmtagValue?: string;
|
|
66
53
|
visitor_id?: string;
|
|
67
54
|
}
|
|
68
|
-
export interface RetentionReturnRateParams {
|
|
69
|
-
project_id: string;
|
|
70
|
-
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
71
|
-
customer_id?: string;
|
|
72
|
-
limit?: number;
|
|
73
|
-
offset?: number;
|
|
74
|
-
referrer?: string;
|
|
75
|
-
utmtag?: string;
|
|
76
|
-
utmtagValue?: string;
|
|
77
|
-
visitor_id?: string;
|
|
78
|
-
}
|
|
79
55
|
export declare namespace Retention {
|
|
80
|
-
export { type RetentionChurnRateParams as RetentionChurnRateParams, type RetentionCohortsParams as RetentionCohortsParams,
|
|
56
|
+
export { type RetentionChurnRateParams as RetentionChurnRateParams, type RetentionCohortsParams as RetentionCohortsParams, };
|
|
81
57
|
}
|
|
82
58
|
//# sourceMappingURL=retention.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"retention.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/retention.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;OAWG;IACH,SAAS,CACP,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,iBAAiB,CAAC;IAI7C;;;;;;;;;;;OAWG;IACH,OAAO,CACL,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"retention.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/retention.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;OAWG;IACH,SAAS,CACP,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,iBAAiB,CAAC;IAI7C;;;;;;;;;;;OAWG;IACH,OAAO,CACL,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,sBAAsB,CAAC;CAGnD;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAElG,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,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,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -34,21 +34,6 @@ class Retention extends resource_1.APIResource {
|
|
|
34
34
|
cohorts(query, options) {
|
|
35
35
|
return this._client.get('/api/v1/analytics/retention/cohorts', { query, ...options });
|
|
36
36
|
}
|
|
37
|
-
/**
|
|
38
|
-
* Get metrics about user return rate and time between sessions
|
|
39
|
-
*
|
|
40
|
-
* @example
|
|
41
|
-
* ```ts
|
|
42
|
-
* const returnRateResponse =
|
|
43
|
-
* await client.v1.analytics.retention.returnRate({
|
|
44
|
-
* project_id: 'project_id',
|
|
45
|
-
* time_range: 'last_hour',
|
|
46
|
-
* });
|
|
47
|
-
* ```
|
|
48
|
-
*/
|
|
49
|
-
returnRate(query, options) {
|
|
50
|
-
return this._client.get('/api/v1/analytics/retention/return-rate', { query, ...options });
|
|
51
|
-
}
|
|
52
37
|
}
|
|
53
38
|
exports.Retention = Retention;
|
|
54
39
|
//# sourceMappingURL=retention.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"retention.js","sourceRoot":"","sources":["../../../src/resources/v1/analytics/retention.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;OAWG;IACH,SAAS,CACP,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wCAAwC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CACL,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;
|
|
1
|
+
{"version":3,"file":"retention.js","sourceRoot":"","sources":["../../../src/resources/v1/analytics/retention.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;OAWG;IACH,SAAS,CACP,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wCAAwC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CACL,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;CACF;AAtCD,8BAsCC"}
|
|
@@ -31,20 +31,5 @@ export class Retention extends APIResource {
|
|
|
31
31
|
cohorts(query, options) {
|
|
32
32
|
return this._client.get('/api/v1/analytics/retention/cohorts', { query, ...options });
|
|
33
33
|
}
|
|
34
|
-
/**
|
|
35
|
-
* Get metrics about user return rate and time between sessions
|
|
36
|
-
*
|
|
37
|
-
* @example
|
|
38
|
-
* ```ts
|
|
39
|
-
* const returnRateResponse =
|
|
40
|
-
* await client.v1.analytics.retention.returnRate({
|
|
41
|
-
* project_id: 'project_id',
|
|
42
|
-
* time_range: 'last_hour',
|
|
43
|
-
* });
|
|
44
|
-
* ```
|
|
45
|
-
*/
|
|
46
|
-
returnRate(query, options) {
|
|
47
|
-
return this._client.get('/api/v1/analytics/retention/return-rate', { query, ...options });
|
|
48
|
-
}
|
|
49
34
|
}
|
|
50
35
|
//# sourceMappingURL=retention.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"retention.mjs","sourceRoot":"","sources":["../../../src/resources/v1/analytics/retention.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;OAWG;IACH,SAAS,CACP,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wCAAwC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CACL,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;
|
|
1
|
+
{"version":3,"file":"retention.mjs","sourceRoot":"","sources":["../../../src/resources/v1/analytics/retention.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;OAWG;IACH,SAAS,CACP,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wCAAwC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CACL,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;CACF"}
|
|
@@ -1,58 +1,4 @@
|
|
|
1
1
|
import { APIResource } from "../../../core/resource.mjs";
|
|
2
|
-
import * as AnalyticsAPI from "./analytics.mjs";
|
|
3
|
-
import { APIPromise } from "../../../core/api-promise.mjs";
|
|
4
|
-
import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
5
2
|
export declare class Sessions extends APIResource {
|
|
6
|
-
/**
|
|
7
|
-
* Get bounce rate metrics including overall bounce rate and per-page breakdown
|
|
8
|
-
*
|
|
9
|
-
* @example
|
|
10
|
-
* ```ts
|
|
11
|
-
* const bounceRateResponse =
|
|
12
|
-
* await client.v1.analytics.sessions.bounceRate({
|
|
13
|
-
* project_id: 'project_id',
|
|
14
|
-
* time_range: 'last_hour',
|
|
15
|
-
* });
|
|
16
|
-
* ```
|
|
17
|
-
*/
|
|
18
|
-
bounceRate(query: SessionBounceRateParams, options?: RequestOptions): APIPromise<AnalyticsAPI.BounceRateResponse>;
|
|
19
|
-
/**
|
|
20
|
-
* Get session metrics including average duration and pages per session
|
|
21
|
-
*
|
|
22
|
-
* @example
|
|
23
|
-
* ```ts
|
|
24
|
-
* const sessionMetricsResponse =
|
|
25
|
-
* await client.v1.analytics.sessions.metrics({
|
|
26
|
-
* project_id: 'project_id',
|
|
27
|
-
* time_range: 'last_hour',
|
|
28
|
-
* });
|
|
29
|
-
* ```
|
|
30
|
-
*/
|
|
31
|
-
metrics(query: SessionMetricsParams, options?: RequestOptions): APIPromise<AnalyticsAPI.SessionMetricsResponse>;
|
|
32
|
-
}
|
|
33
|
-
export interface SessionBounceRateParams {
|
|
34
|
-
project_id: string;
|
|
35
|
-
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
36
|
-
customer_id?: string;
|
|
37
|
-
limit?: number;
|
|
38
|
-
offset?: number;
|
|
39
|
-
referrer?: string;
|
|
40
|
-
utmtag?: string;
|
|
41
|
-
utmtagValue?: string;
|
|
42
|
-
visitor_id?: string;
|
|
43
|
-
}
|
|
44
|
-
export interface SessionMetricsParams {
|
|
45
|
-
project_id: string;
|
|
46
|
-
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
47
|
-
customer_id?: string;
|
|
48
|
-
limit?: number;
|
|
49
|
-
offset?: number;
|
|
50
|
-
referrer?: string;
|
|
51
|
-
utmtag?: string;
|
|
52
|
-
utmtagValue?: string;
|
|
53
|
-
visitor_id?: string;
|
|
54
|
-
}
|
|
55
|
-
export declare namespace Sessions {
|
|
56
|
-
export { type SessionBounceRateParams as SessionBounceRateParams, type SessionMetricsParams as SessionMetricsParams, };
|
|
57
3
|
}
|
|
58
4
|
//# sourceMappingURL=sessions.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sessions.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/sessions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;
|
|
1
|
+
{"version":3,"file":"sessions.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/sessions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;AAEtB,qBAAa,QAAS,SAAQ,WAAW;CAAG"}
|
|
@@ -1,58 +1,4 @@
|
|
|
1
1
|
import { APIResource } from "../../../core/resource.js";
|
|
2
|
-
import * as AnalyticsAPI from "./analytics.js";
|
|
3
|
-
import { APIPromise } from "../../../core/api-promise.js";
|
|
4
|
-
import { RequestOptions } from "../../../internal/request-options.js";
|
|
5
2
|
export declare class Sessions extends APIResource {
|
|
6
|
-
/**
|
|
7
|
-
* Get bounce rate metrics including overall bounce rate and per-page breakdown
|
|
8
|
-
*
|
|
9
|
-
* @example
|
|
10
|
-
* ```ts
|
|
11
|
-
* const bounceRateResponse =
|
|
12
|
-
* await client.v1.analytics.sessions.bounceRate({
|
|
13
|
-
* project_id: 'project_id',
|
|
14
|
-
* time_range: 'last_hour',
|
|
15
|
-
* });
|
|
16
|
-
* ```
|
|
17
|
-
*/
|
|
18
|
-
bounceRate(query: SessionBounceRateParams, options?: RequestOptions): APIPromise<AnalyticsAPI.BounceRateResponse>;
|
|
19
|
-
/**
|
|
20
|
-
* Get session metrics including average duration and pages per session
|
|
21
|
-
*
|
|
22
|
-
* @example
|
|
23
|
-
* ```ts
|
|
24
|
-
* const sessionMetricsResponse =
|
|
25
|
-
* await client.v1.analytics.sessions.metrics({
|
|
26
|
-
* project_id: 'project_id',
|
|
27
|
-
* time_range: 'last_hour',
|
|
28
|
-
* });
|
|
29
|
-
* ```
|
|
30
|
-
*/
|
|
31
|
-
metrics(query: SessionMetricsParams, options?: RequestOptions): APIPromise<AnalyticsAPI.SessionMetricsResponse>;
|
|
32
|
-
}
|
|
33
|
-
export interface SessionBounceRateParams {
|
|
34
|
-
project_id: string;
|
|
35
|
-
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
36
|
-
customer_id?: string;
|
|
37
|
-
limit?: number;
|
|
38
|
-
offset?: number;
|
|
39
|
-
referrer?: string;
|
|
40
|
-
utmtag?: string;
|
|
41
|
-
utmtagValue?: string;
|
|
42
|
-
visitor_id?: string;
|
|
43
|
-
}
|
|
44
|
-
export interface SessionMetricsParams {
|
|
45
|
-
project_id: string;
|
|
46
|
-
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
47
|
-
customer_id?: string;
|
|
48
|
-
limit?: number;
|
|
49
|
-
offset?: number;
|
|
50
|
-
referrer?: string;
|
|
51
|
-
utmtag?: string;
|
|
52
|
-
utmtagValue?: string;
|
|
53
|
-
visitor_id?: string;
|
|
54
|
-
}
|
|
55
|
-
export declare namespace Sessions {
|
|
56
|
-
export { type SessionBounceRateParams as SessionBounceRateParams, type SessionMetricsParams as SessionMetricsParams, };
|
|
57
3
|
}
|
|
58
4
|
//# sourceMappingURL=sessions.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sessions.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/sessions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;
|
|
1
|
+
{"version":3,"file":"sessions.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/sessions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;AAEtB,qBAAa,QAAS,SAAQ,WAAW;CAAG"}
|