zorihq 0.12.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/package.json +1 -1
- package/resources/v1/analytics/analytics.d.mts +18 -11
- package/resources/v1/analytics/analytics.d.mts.map +1 -1
- package/resources/v1/analytics/analytics.d.ts +18 -11
- package/resources/v1/analytics/analytics.d.ts.map +1 -1
- package/resources/v1/analytics/analytics.js +2 -4
- package/resources/v1/analytics/analytics.js.map +1 -1
- package/resources/v1/analytics/analytics.mjs +2 -4
- package/resources/v1/analytics/analytics.mjs.map +1 -1
- package/resources/v1/analytics/events.d.mts +24 -26
- package/resources/v1/analytics/events.d.mts.map +1 -1
- package/resources/v1/analytics/events.d.ts +24 -26
- package/resources/v1/analytics/events.d.ts.map +1 -1
- package/resources/v1/analytics/events.js +7 -10
- package/resources/v1/analytics/events.js.map +1 -1
- package/resources/v1/analytics/events.mjs +7 -10
- package/resources/v1/analytics/events.mjs.map +1 -1
- package/resources/v1/analytics/retention.d.mts +24 -30
- package/resources/v1/analytics/retention.d.mts.map +1 -1
- package/resources/v1/analytics/retention.d.ts +24 -30
- package/resources/v1/analytics/retention.d.ts.map +1 -1
- package/resources/v1/analytics/retention.js +6 -12
- package/resources/v1/analytics/retention.js.map +1 -1
- package/resources/v1/analytics/retention.mjs +6 -12
- package/resources/v1/analytics/retention.mjs.map +1 -1
- package/resources/v1/analytics/sessions.d.mts +16 -20
- package/resources/v1/analytics/sessions.d.mts.map +1 -1
- package/resources/v1/analytics/sessions.d.ts +16 -20
- package/resources/v1/analytics/sessions.d.ts.map +1 -1
- package/resources/v1/analytics/sessions.js +4 -8
- package/resources/v1/analytics/sessions.js.map +1 -1
- package/resources/v1/analytics/sessions.mjs +4 -8
- package/resources/v1/analytics/sessions.mjs.map +1 -1
- package/resources/v1/analytics/users.d.mts +8 -10
- package/resources/v1/analytics/users.d.mts.map +1 -1
- package/resources/v1/analytics/users.d.ts +8 -10
- package/resources/v1/analytics/users.d.ts.map +1 -1
- package/resources/v1/analytics/users.js +2 -4
- package/resources/v1/analytics/users.js.map +1 -1
- package/resources/v1/analytics/users.mjs +2 -4
- package/resources/v1/analytics/users.mjs.map +1 -1
- package/resources/v1/analytics/visitors.d.mts +47 -64
- package/resources/v1/analytics/visitors.d.mts.map +1 -1
- package/resources/v1/analytics/visitors.d.ts +47 -64
- package/resources/v1/analytics/visitors.d.ts.map +1 -1
- package/resources/v1/analytics/visitors.js +14 -25
- package/resources/v1/analytics/visitors.js.map +1 -1
- package/resources/v1/analytics/visitors.mjs +14 -25
- package/resources/v1/analytics/visitors.mjs.map +1 -1
- package/src/resources/v1/analytics/analytics.ts +27 -11
- package/src/resources/v1/analytics/events.ts +25 -26
- package/src/resources/v1/analytics/retention.ts +24 -30
- package/src/resources/v1/analytics/sessions.ts +16 -20
- package/src/resources/v1/analytics/users.ts +8 -10
- package/src/resources/v1/analytics/visitors.ts +47 -70
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.14.0 (2025-11-11)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.13.0...v0.14.0](https://github.com/ZoriHQ/typescript-api-sdk/compare/v0.13.0...v0.14.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* Feature/top visitors ([1c0abfc](https://github.com/ZoriHQ/typescript-api-sdk/commit/1c0abfc5efba9789fdd7d7d1c20d3f9aa7c11270))
|
|
10
|
+
|
|
11
|
+
## 0.13.0 (2025-11-04)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v0.12.0...v0.13.0](https://github.com/ZoriHQ/typescript-api-sdk/compare/v0.12.0...v0.13.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* **api:** manual updates ([19cdf8f](https://github.com/ZoriHQ/typescript-api-sdk/commit/19cdf8f554a7d456450849f331023a5fcf4028ab))
|
|
18
|
+
|
|
3
19
|
## 0.12.0 (2025-11-04)
|
|
4
20
|
|
|
5
21
|
Full Changelog: [v0.11.1...v0.12.0](https://github.com/ZoriHQ/typescript-api-sdk/compare/v0.11.1...v0.12.0)
|
package/package.json
CHANGED
|
@@ -25,10 +25,8 @@ export declare class Analytics extends APIResource {
|
|
|
25
25
|
* ```ts
|
|
26
26
|
* const dashboardMetricsResponse =
|
|
27
27
|
* await client.v1.analytics.dashboard({
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
* projectID: 'projectID',
|
|
31
|
-
* timeBoundaries: 'last_hour',
|
|
28
|
+
* project_id: 'project_id',
|
|
29
|
+
* time_range: 'last_hour',
|
|
32
30
|
* });
|
|
33
31
|
* ```
|
|
34
32
|
*/
|
|
@@ -87,6 +85,7 @@ export interface DashboardMetricsResponse {
|
|
|
87
85
|
wau?: number;
|
|
88
86
|
}
|
|
89
87
|
export interface EventFilterOptionsResponse {
|
|
88
|
+
event_names?: Array<string>;
|
|
90
89
|
pages?: Array<string>;
|
|
91
90
|
traffic_origins?: Array<string>;
|
|
92
91
|
}
|
|
@@ -165,15 +164,23 @@ export interface SessionMetricsResponse {
|
|
|
165
164
|
}
|
|
166
165
|
export interface TopVisitor {
|
|
167
166
|
browser_name?: string;
|
|
167
|
+
currency?: string;
|
|
168
168
|
device_type?: string;
|
|
169
|
+
distinct_payments?: number;
|
|
170
|
+
email?: string;
|
|
169
171
|
event_count?: number;
|
|
170
172
|
external_id?: string;
|
|
173
|
+
first_payment_date?: string;
|
|
171
174
|
first_seen?: string;
|
|
175
|
+
is_grouped?: boolean;
|
|
172
176
|
last_seen?: string;
|
|
173
177
|
location_city?: string;
|
|
174
178
|
location_country_iso?: string;
|
|
179
|
+
name?: string;
|
|
180
|
+
time_to_first_purchase_seconds?: number;
|
|
181
|
+
total_revenue?: number;
|
|
175
182
|
user_id?: string;
|
|
176
|
-
|
|
183
|
+
visitor_ids?: Array<string>;
|
|
177
184
|
}
|
|
178
185
|
export interface TopVisitorsResponse {
|
|
179
186
|
total?: number;
|
|
@@ -248,15 +255,15 @@ export interface VisitorsByOriginResponse {
|
|
|
248
255
|
data?: Array<OriginDataPoint>;
|
|
249
256
|
}
|
|
250
257
|
export interface AnalyticsDashboardParams {
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
258
|
+
project_id: string;
|
|
259
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
260
|
+
customer_id?: string;
|
|
261
|
+
limit?: number;
|
|
262
|
+
offset?: number;
|
|
256
263
|
referrer?: string;
|
|
257
264
|
utmtag?: string;
|
|
258
265
|
utmtagValue?: string;
|
|
259
|
-
|
|
266
|
+
visitor_id?: string;
|
|
260
267
|
}
|
|
261
268
|
export declare namespace Analytics {
|
|
262
269
|
export { type ActiveUsersResponse as ActiveUsersResponse, type BounceRateByPageMetric as BounceRateByPageMetric, type BounceRateResponse as BounceRateResponse, type ChurnRateResponse as ChurnRateResponse, type CohortAnalysisResponse as CohortAnalysisResponse, type CohortData as CohortData, type CountryDataPoint as CountryDataPoint, type DashboardMetricsResponse as DashboardMetricsResponse, type EventFilterOptionsResponse as EventFilterOptionsResponse, type EventsOverTimeDataPoint as EventsOverTimeDataPoint, type ManualIdentifyRequest as ManualIdentifyRequest, type ManualIdentifyResponse as ManualIdentifyResponse, type OriginDataPoint as OriginDataPoint, type RecentEvent as RecentEvent, type RecentEventsResponse as RecentEventsResponse, type ReturnRateResponse as ReturnRateResponse, type SessionMetricsResponse as SessionMetricsResponse, type TopVisitor as TopVisitor, type TopVisitorsResponse as TopVisitorsResponse, type UniqueVisitorsDataPoint as UniqueVisitorsDataPoint, type UniqueVisitorsTimelineResponse as UniqueVisitorsTimelineResponse, type VisitorDataPoint as VisitorDataPoint, type VisitorEvent as VisitorEvent, type VisitorProfileResponse as VisitorProfileResponse, type VisitorsByCountryResponse as VisitorsByCountryResponse, type VisitorsByDeviceResponse as VisitorsByDeviceResponse, type VisitorsByOriginResponse as VisitorsByOriginResponse, type AnalyticsDashboardParams as AnalyticsDashboardParams, };
|
|
@@ -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,EACL,SAAS,EACT,wBAAwB,EACxB,sBAAsB,EACtB,yBAAyB,EAC1B;OACM,KAAK,WAAW;OAChB,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,QAAQ,EAAE;OAC3D,KAAK,QAAQ;OACb,EAAE,gBAAgB,EAAE,KAAK,EAAE;OAC3B,KAAK,WAAW;OAChB,EACL,sBAAsB,EACtB,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,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;IAE7E
|
|
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,EACL,SAAS,EACT,wBAAwB,EACxB,sBAAsB,EACtB,yBAAyB,EAC1B;OACM,KAAK,WAAW;OAChB,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,QAAQ,EAAE;OAC3D,KAAK,QAAQ;OACb,EAAE,gBAAgB,EAAE,KAAK,EAAE;OAC3B,KAAK,WAAW;OAChB,EACL,sBAAsB,EACtB,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,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;IAE7E;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,KAAK,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG3G;AAED,MAAM,WAAW,mBAAmB;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAExC,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;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,gBAAgB;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACvC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,4BAA4B,CAAC,EAAE,MAAM,CAAC;IAEtC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;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,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;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,kBAAkB;IACjC,+BAA+B,CAAC,EAAE,MAAM,CAAC;IAEzC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAE1C,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;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,uBAAuB;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,8BAA8B;IAC7C,IAAI,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;CACvC;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,yBAAyB;IACxC,IAAI,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAC/B;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;AAQD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EAAE,KAAK,IAAI,KAAK,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;IAErE,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
|
|
@@ -25,10 +25,8 @@ export declare class Analytics extends APIResource {
|
|
|
25
25
|
* ```ts
|
|
26
26
|
* const dashboardMetricsResponse =
|
|
27
27
|
* await client.v1.analytics.dashboard({
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
* projectID: 'projectID',
|
|
31
|
-
* timeBoundaries: 'last_hour',
|
|
28
|
+
* project_id: 'project_id',
|
|
29
|
+
* time_range: 'last_hour',
|
|
32
30
|
* });
|
|
33
31
|
* ```
|
|
34
32
|
*/
|
|
@@ -87,6 +85,7 @@ export interface DashboardMetricsResponse {
|
|
|
87
85
|
wau?: number;
|
|
88
86
|
}
|
|
89
87
|
export interface EventFilterOptionsResponse {
|
|
88
|
+
event_names?: Array<string>;
|
|
90
89
|
pages?: Array<string>;
|
|
91
90
|
traffic_origins?: Array<string>;
|
|
92
91
|
}
|
|
@@ -165,15 +164,23 @@ export interface SessionMetricsResponse {
|
|
|
165
164
|
}
|
|
166
165
|
export interface TopVisitor {
|
|
167
166
|
browser_name?: string;
|
|
167
|
+
currency?: string;
|
|
168
168
|
device_type?: string;
|
|
169
|
+
distinct_payments?: number;
|
|
170
|
+
email?: string;
|
|
169
171
|
event_count?: number;
|
|
170
172
|
external_id?: string;
|
|
173
|
+
first_payment_date?: string;
|
|
171
174
|
first_seen?: string;
|
|
175
|
+
is_grouped?: boolean;
|
|
172
176
|
last_seen?: string;
|
|
173
177
|
location_city?: string;
|
|
174
178
|
location_country_iso?: string;
|
|
179
|
+
name?: string;
|
|
180
|
+
time_to_first_purchase_seconds?: number;
|
|
181
|
+
total_revenue?: number;
|
|
175
182
|
user_id?: string;
|
|
176
|
-
|
|
183
|
+
visitor_ids?: Array<string>;
|
|
177
184
|
}
|
|
178
185
|
export interface TopVisitorsResponse {
|
|
179
186
|
total?: number;
|
|
@@ -248,15 +255,15 @@ export interface VisitorsByOriginResponse {
|
|
|
248
255
|
data?: Array<OriginDataPoint>;
|
|
249
256
|
}
|
|
250
257
|
export interface AnalyticsDashboardParams {
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
258
|
+
project_id: string;
|
|
259
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
260
|
+
customer_id?: string;
|
|
261
|
+
limit?: number;
|
|
262
|
+
offset?: number;
|
|
256
263
|
referrer?: string;
|
|
257
264
|
utmtag?: string;
|
|
258
265
|
utmtagValue?: string;
|
|
259
|
-
|
|
266
|
+
visitor_id?: string;
|
|
260
267
|
}
|
|
261
268
|
export declare namespace Analytics {
|
|
262
269
|
export { type ActiveUsersResponse as ActiveUsersResponse, type BounceRateByPageMetric as BounceRateByPageMetric, type BounceRateResponse as BounceRateResponse, type ChurnRateResponse as ChurnRateResponse, type CohortAnalysisResponse as CohortAnalysisResponse, type CohortData as CohortData, type CountryDataPoint as CountryDataPoint, type DashboardMetricsResponse as DashboardMetricsResponse, type EventFilterOptionsResponse as EventFilterOptionsResponse, type EventsOverTimeDataPoint as EventsOverTimeDataPoint, type ManualIdentifyRequest as ManualIdentifyRequest, type ManualIdentifyResponse as ManualIdentifyResponse, type OriginDataPoint as OriginDataPoint, type RecentEvent as RecentEvent, type RecentEventsResponse as RecentEventsResponse, type ReturnRateResponse as ReturnRateResponse, type SessionMetricsResponse as SessionMetricsResponse, type TopVisitor as TopVisitor, type TopVisitorsResponse as TopVisitorsResponse, type UniqueVisitorsDataPoint as UniqueVisitorsDataPoint, type UniqueVisitorsTimelineResponse as UniqueVisitorsTimelineResponse, type VisitorDataPoint as VisitorDataPoint, type VisitorEvent as VisitorEvent, type VisitorProfileResponse as VisitorProfileResponse, type VisitorsByCountryResponse as VisitorsByCountryResponse, type VisitorsByDeviceResponse as VisitorsByDeviceResponse, type VisitorsByOriginResponse as VisitorsByOriginResponse, type AnalyticsDashboardParams as AnalyticsDashboardParams, };
|
|
@@ -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,EACL,SAAS,EACT,wBAAwB,EACxB,sBAAsB,EACtB,yBAAyB,EAC1B;OACM,KAAK,WAAW;OAChB,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,QAAQ,EAAE;OAC3D,KAAK,QAAQ;OACb,EAAE,gBAAgB,EAAE,KAAK,EAAE;OAC3B,KAAK,WAAW;OAChB,EACL,sBAAsB,EACtB,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,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;IAE7E
|
|
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,EACL,SAAS,EACT,wBAAwB,EACxB,sBAAsB,EACtB,yBAAyB,EAC1B;OACM,KAAK,WAAW;OAChB,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,QAAQ,EAAE;OAC3D,KAAK,QAAQ;OACb,EAAE,gBAAgB,EAAE,KAAK,EAAE;OAC3B,KAAK,WAAW;OAChB,EACL,sBAAsB,EACtB,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,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;IAE7E;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,KAAK,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG3G;AAED,MAAM,WAAW,mBAAmB;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAExC,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;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,gBAAgB;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACvC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,4BAA4B,CAAC,EAAE,MAAM,CAAC;IAEtC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;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,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;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,kBAAkB;IACjC,+BAA+B,CAAC,EAAE,MAAM,CAAC;IAEzC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAE1C,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;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,uBAAuB;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,8BAA8B;IAC7C,IAAI,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;CACvC;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,yBAAyB;IACxC,IAAI,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAC/B;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;AAQD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EAAE,KAAK,IAAI,KAAK,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;IAErE,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
|
|
@@ -31,10 +31,8 @@ class Analytics extends resource_1.APIResource {
|
|
|
31
31
|
* ```ts
|
|
32
32
|
* const dashboardMetricsResponse =
|
|
33
33
|
* await client.v1.analytics.dashboard({
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
* projectID: 'projectID',
|
|
37
|
-
* timeBoundaries: 'last_hour',
|
|
34
|
+
* project_id: 'project_id',
|
|
35
|
+
* time_range: 'last_hour',
|
|
38
36
|
* });
|
|
39
37
|
* ```
|
|
40
38
|
*/
|
|
@@ -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,8CAKqB;AACrB,mEAA0C;AAC1C,4CAAqF;AACrF,6DAAoC;AACpC,sCAAkD;AAClD,mEAA0C;AAC1C,4CASoB;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;
|
|
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,8CAKqB;AACrB,mEAA0C;AAC1C,4CAAqF;AACrF,6DAAoC;AACpC,sCAAkD;AAClD,mEAA0C;AAC1C,4CASoB;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;IAkB/E,CAAC;IAhBC;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,KAA+B,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAvBD,8BAuBC;AAoZD,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"}
|
|
@@ -27,10 +27,8 @@ export class Analytics extends APIResource {
|
|
|
27
27
|
* ```ts
|
|
28
28
|
* const dashboardMetricsResponse =
|
|
29
29
|
* await client.v1.analytics.dashboard({
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* projectID: 'projectID',
|
|
33
|
-
* timeBoundaries: 'last_hour',
|
|
30
|
+
* project_id: 'project_id',
|
|
31
|
+
* time_range: 'last_hour',
|
|
34
32
|
* });
|
|
35
33
|
* ```
|
|
36
34
|
*/
|
|
@@ -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,EACL,SAAS,GAIV;OACM,KAAK,WAAW;OAChB,EAAiD,QAAQ,EAAE;OAC3D,KAAK,QAAQ;OACb,EAAoB,KAAK,EAAE;OAC3B,KAAK,WAAW;OAChB,EAQL,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;
|
|
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,EACL,SAAS,GAIV;OACM,KAAK,WAAW;OAChB,EAAiD,QAAQ,EAAE;OAC3D,KAAK,QAAQ;OACb,EAAoB,KAAK,EAAE;OAC3B,KAAK,WAAW;OAChB,EAQL,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;IAkB/E,CAAC;IAhBC;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,KAA+B,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAoZD,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"}
|
|
@@ -4,62 +4,60 @@ 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
|
|
11
12
|
* const eventFilterOptionsResponse =
|
|
12
13
|
* await client.v1.analytics.events.filterOptions({
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* projectID: 'projectID',
|
|
16
|
-
* timeBoundaries: 'last_hour',
|
|
14
|
+
* project_id: 'project_id',
|
|
15
|
+
* time_range: 'last_hour',
|
|
17
16
|
* });
|
|
18
17
|
* ```
|
|
19
18
|
*/
|
|
20
19
|
filterOptions(query: EventFilterOptionsParams, options?: RequestOptions): APIPromise<AnalyticsAPI.EventFilterOptionsResponse>;
|
|
21
20
|
/**
|
|
22
21
|
* Get a list of recent events with optional filters (visitor_id, user_id,
|
|
23
|
-
* external_id, traffic_origin, page_path)
|
|
22
|
+
* external_id, traffic_origin, page_path, event_name)
|
|
24
23
|
*
|
|
25
24
|
* @example
|
|
26
25
|
* ```ts
|
|
27
26
|
* const recentEventsResponse =
|
|
28
27
|
* await client.v1.analytics.events.recent({
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* projectID: 'projectID',
|
|
32
|
-
* timeBoundaries: 'last_hour',
|
|
28
|
+
* project_id: 'project_id',
|
|
29
|
+
* time_range: 'last_hour',
|
|
33
30
|
* });
|
|
34
31
|
* ```
|
|
35
32
|
*/
|
|
36
33
|
recent(query: EventRecentParams, options?: RequestOptions): APIPromise<AnalyticsAPI.RecentEventsResponse>;
|
|
37
34
|
}
|
|
38
35
|
export interface EventFilterOptionsParams {
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
36
|
+
project_id: string;
|
|
37
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
38
|
+
customer_id?: string;
|
|
39
|
+
limit?: number;
|
|
40
|
+
offset?: number;
|
|
44
41
|
referrer?: string;
|
|
45
42
|
utmtag?: string;
|
|
46
43
|
utmtagValue?: string;
|
|
47
|
-
|
|
44
|
+
visitor_id?: string;
|
|
48
45
|
}
|
|
49
46
|
export interface EventRecentParams {
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
47
|
+
project_id: string;
|
|
48
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
49
|
+
customer_id?: string;
|
|
50
|
+
event_name?: string;
|
|
51
|
+
external_id?: string;
|
|
52
|
+
limit?: number;
|
|
53
|
+
offset?: number;
|
|
54
|
+
page_path?: string;
|
|
57
55
|
referrer?: string;
|
|
58
|
-
|
|
59
|
-
|
|
56
|
+
traffic_origin?: string;
|
|
57
|
+
user_id?: string;
|
|
60
58
|
utmtag?: string;
|
|
61
59
|
utmtagValue?: string;
|
|
62
|
-
|
|
60
|
+
visitor_id?: string;
|
|
63
61
|
}
|
|
64
62
|
export declare namespace Events {
|
|
65
63
|
export { type EventFilterOptionsParams as EventFilterOptionsParams, type EventRecentParams as EventRecentParams, };
|
|
@@ -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,62 +4,60 @@ 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
|
|
11
12
|
* const eventFilterOptionsResponse =
|
|
12
13
|
* await client.v1.analytics.events.filterOptions({
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* projectID: 'projectID',
|
|
16
|
-
* timeBoundaries: 'last_hour',
|
|
14
|
+
* project_id: 'project_id',
|
|
15
|
+
* time_range: 'last_hour',
|
|
17
16
|
* });
|
|
18
17
|
* ```
|
|
19
18
|
*/
|
|
20
19
|
filterOptions(query: EventFilterOptionsParams, options?: RequestOptions): APIPromise<AnalyticsAPI.EventFilterOptionsResponse>;
|
|
21
20
|
/**
|
|
22
21
|
* Get a list of recent events with optional filters (visitor_id, user_id,
|
|
23
|
-
* external_id, traffic_origin, page_path)
|
|
22
|
+
* external_id, traffic_origin, page_path, event_name)
|
|
24
23
|
*
|
|
25
24
|
* @example
|
|
26
25
|
* ```ts
|
|
27
26
|
* const recentEventsResponse =
|
|
28
27
|
* await client.v1.analytics.events.recent({
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* projectID: 'projectID',
|
|
32
|
-
* timeBoundaries: 'last_hour',
|
|
28
|
+
* project_id: 'project_id',
|
|
29
|
+
* time_range: 'last_hour',
|
|
33
30
|
* });
|
|
34
31
|
* ```
|
|
35
32
|
*/
|
|
36
33
|
recent(query: EventRecentParams, options?: RequestOptions): APIPromise<AnalyticsAPI.RecentEventsResponse>;
|
|
37
34
|
}
|
|
38
35
|
export interface EventFilterOptionsParams {
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
36
|
+
project_id: string;
|
|
37
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
38
|
+
customer_id?: string;
|
|
39
|
+
limit?: number;
|
|
40
|
+
offset?: number;
|
|
44
41
|
referrer?: string;
|
|
45
42
|
utmtag?: string;
|
|
46
43
|
utmtagValue?: string;
|
|
47
|
-
|
|
44
|
+
visitor_id?: string;
|
|
48
45
|
}
|
|
49
46
|
export interface EventRecentParams {
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
47
|
+
project_id: string;
|
|
48
|
+
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
49
|
+
customer_id?: string;
|
|
50
|
+
event_name?: string;
|
|
51
|
+
external_id?: string;
|
|
52
|
+
limit?: number;
|
|
53
|
+
offset?: number;
|
|
54
|
+
page_path?: string;
|
|
57
55
|
referrer?: string;
|
|
58
|
-
|
|
59
|
-
|
|
56
|
+
traffic_origin?: string;
|
|
57
|
+
user_id?: string;
|
|
60
58
|
utmtag?: string;
|
|
61
59
|
utmtagValue?: string;
|
|
62
|
-
|
|
60
|
+
visitor_id?: string;
|
|
63
61
|
}
|
|
64
62
|
export declare namespace Events {
|
|
65
63
|
export { type EventFilterOptionsParams as EventFilterOptionsParams, type EventRecentParams as EventRecentParams, };
|
|
@@ -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,16 +5,15 @@ 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
|
|
12
13
|
* const eventFilterOptionsResponse =
|
|
13
14
|
* await client.v1.analytics.events.filterOptions({
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* projectID: 'projectID',
|
|
17
|
-
* timeBoundaries: 'last_hour',
|
|
15
|
+
* project_id: 'project_id',
|
|
16
|
+
* time_range: 'last_hour',
|
|
18
17
|
* });
|
|
19
18
|
* ```
|
|
20
19
|
*/
|
|
@@ -23,16 +22,14 @@ class Events extends resource_1.APIResource {
|
|
|
23
22
|
}
|
|
24
23
|
/**
|
|
25
24
|
* Get a list of recent events with optional filters (visitor_id, user_id,
|
|
26
|
-
* external_id, traffic_origin, page_path)
|
|
25
|
+
* external_id, traffic_origin, page_path, event_name)
|
|
27
26
|
*
|
|
28
27
|
* @example
|
|
29
28
|
* ```ts
|
|
30
29
|
* const recentEventsResponse =
|
|
31
30
|
* await client.v1.analytics.events.recent({
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
* projectID: 'projectID',
|
|
35
|
-
* timeBoundaries: 'last_hour',
|
|
31
|
+
* project_id: 'project_id',
|
|
32
|
+
* time_range: 'last_hour',
|
|
36
33
|
* });
|
|
37
34
|
* ```
|
|
38
35
|
*/
|
|
@@ -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,16 +2,15 @@
|
|
|
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
|
|
9
10
|
* const eventFilterOptionsResponse =
|
|
10
11
|
* await client.v1.analytics.events.filterOptions({
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* projectID: 'projectID',
|
|
14
|
-
* timeBoundaries: 'last_hour',
|
|
12
|
+
* project_id: 'project_id',
|
|
13
|
+
* time_range: 'last_hour',
|
|
15
14
|
* });
|
|
16
15
|
* ```
|
|
17
16
|
*/
|
|
@@ -20,16 +19,14 @@ export class Events extends APIResource {
|
|
|
20
19
|
}
|
|
21
20
|
/**
|
|
22
21
|
* Get a list of recent events with optional filters (visitor_id, user_id,
|
|
23
|
-
* external_id, traffic_origin, page_path)
|
|
22
|
+
* external_id, traffic_origin, page_path, event_name)
|
|
24
23
|
*
|
|
25
24
|
* @example
|
|
26
25
|
* ```ts
|
|
27
26
|
* const recentEventsResponse =
|
|
28
27
|
* await client.v1.analytics.events.recent({
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* projectID: 'projectID',
|
|
32
|
-
* timeBoundaries: 'last_hour',
|
|
28
|
+
* project_id: 'project_id',
|
|
29
|
+
* time_range: 'last_hour',
|
|
33
30
|
* });
|
|
34
31
|
* ```
|
|
35
32
|
*/
|
|
@@ -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"}
|