zorihq 0.4.1 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.5.0 (2025-10-20)
+
+Full Changelog: [v0.4.1...v0.5.0](https://github.com/ZoriHQ/typescript-api-sdk/compare/v0.4.1...v0.5.0)
+
+### Features
+
+* **api/analytics:** added bounce,churn,etc. ([9dffd54](https://github.com/ZoriHQ/typescript-api-sdk/commit/9dffd54ca1fef42615b7d69da3050c65f387883c))
+
 ## 0.4.1 (2025-10-19)
 
 Full Changelog: [v0.4.0...v0.4.1](https://github.com/ZoriHQ/typescript-api-sdk/compare/v0.4.0...v0.4.1)

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "zorihq",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "The official TypeScript library for the Zoriapi API",
-  "author": "Zoriapi <supportsdk@zorihq.com>",
+  "author": "Zoriapi <support@zorihq.com>",
   "types": "./index.d.ts",
   "main": "./index.js",
   "type": "commonjs",

package/resources/v1/analytics/analytics.d.mts

@@ -1,17 +1,100 @@
 import { APIResource } from "../../../core/resource.mjs";
 import * as EventsAPI from "./events.mjs";
 import { EventRecentParams, Events } from "./events.mjs";
+import * as RetentionAPI from "./retention.mjs";
+import { Retention, RetentionChurnRateParams, RetentionCohortsParams, RetentionReturnRateParams } from "./retention.mjs";
+import * as SessionsAPI from "./sessions.mjs";
+import { SessionBounceRateParams, SessionMetricsParams, Sessions } from "./sessions.mjs";
+import * as UsersAPI from "./users.mjs";
+import { UserActiveParams, Users } from "./users.mjs";
 import * as VisitorsAPI from "./visitors.mjs";
 import { VisitorByCountryParams, VisitorByDeviceParams, VisitorByOriginParams, VisitorProfileParams, VisitorTimelineParams, VisitorTopParams, Visitors } from "./visitors.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
 export declare class Analytics extends APIResource {
     visitors: VisitorsAPI.Visitors;
     events: EventsAPI.Events;
+    sessions: SessionsAPI.Sessions;
+    users: UsersAPI.Users;
+    retention: RetentionAPI.Retention;
+    /**
+     * Get combined key metrics including sessions, active users, bounce rate, and
+     * retention for dashboard display
+     *
+     * @example
+     * ```ts
+     * const dashboardMetricsResponse =
+     *   await client.v1.analytics.dashboard({
+     *     project_id: 'project_id',
+     *     time_range: 'last_hour',
+     *   });
+     * ```
+     */
+    dashboard(query: AnalyticsDashboardParams, options?: RequestOptions): APIPromise<DashboardMetricsResponse>;
+}
+export interface ActiveUsersResponse {
+    dau?: number;
+    mau?: number;
+    wau?: number;
+}
+export interface BounceRateByPageMetric {
+    bounce_rate?: number;
+    page?: string;
+    sessions?: number;
+}
+export interface BounceRateResponse {
+    by_page?: Array<BounceRateByPageMetric>;
+    overall_bounce_rate?: number;
+}
+export interface ChurnRateResponse {
+    churn_rate_percent?: number;
+    churn_threshold_days?: number;
+    churned_users?: number;
+    total_users?: number;
+}
+export interface CohortAnalysisResponse {
+    cohorts?: Array<CohortData>;
+}
+export interface CohortData {
+    cohort_period?: string;
+    cohort_size?: number;
+    month_1_retention?: number;
+    month_2_retention?: number;
+    month_3_retention?: number;
+    week_1_retention?: number;
+    week_2_retention?: number;
+    week_4_retention?: number;
 }
 export interface CountryDataPoint {
     country_code?: string;
     percentage?: number;
     unique_visitors?: number;
 }
+export interface DashboardMetricsResponse {
+    avg_pages_per_session?: number;
+    avg_session_duration_seconds?: number;
+    /**
+     * Engagement metrics
+     */
+    bounce_rate?: number;
+    /**
+     * Active users
+     */
+    dau?: number;
+    mau?: number;
+    return_rate?: number;
+    /**
+     * Sessions
+     */
+    sessions_today?: number;
+    /**
+     * Total metrics
+     */
+    total_events?: number;
+    total_sessions_in_period?: number;
+    unique_visitors?: number;
+    wau?: number;
+}
 export interface EventsOverTimeDataPoint {
     event_count?: number;
     timestamp?: string;
@@ -37,6 +120,17 @@ export interface RecentEventsResponse {
     events?: Array<RecentEvent>;
     total?: number;
 }
+export interface ReturnRateResponse {
+    avg_time_between_sessions_hours?: number;
+    return_rate_percent?: number;
+    returning_users?: number;
+    total_users?: number;
+}
+export interface SessionMetricsResponse {
+    average_pages_per_session?: number;
+    average_session_duration_seconds?: number;
+    total_sessions?: number;
+}
 export interface TopVisitor {
     browser_name?: string;
     device_type?: string;
@@ -95,9 +189,22 @@ export interface VisitorsByDeviceResponse {
 export interface VisitorsByOriginResponse {
     data?: Array<OriginDataPoint>;
 }
+export interface AnalyticsDashboardParams {
+    /**
+     * Project ID
+     */
+    project_id: string;
+    /**
+     * Time range
+     */
+    time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+}
 export declare namespace Analytics {
-    export { type CountryDataPoint as CountryDataPoint, type EventsOverTimeDataPoint as EventsOverTimeDataPoint, type OriginDataPoint as OriginDataPoint, type RecentEvent as RecentEvent, type RecentEventsResponse as RecentEventsResponse, 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, };
+    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 EventsOverTimeDataPoint as EventsOverTimeDataPoint, 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, };
     export { Visitors as Visitors, type VisitorByCountryParams as VisitorByCountryParams, type VisitorByDeviceParams as VisitorByDeviceParams, type VisitorByOriginParams as VisitorByOriginParams, type VisitorProfileParams as VisitorProfileParams, type VisitorTimelineParams as VisitorTimelineParams, type VisitorTopParams as VisitorTopParams, };
     export { Events as Events, type EventRecentParams as EventRecentParams };
+    export { Sessions as Sessions, type SessionBounceRateParams as SessionBounceRateParams, type SessionMetricsParams as SessionMetricsParams, };
+    export { Users as Users, type UserActiveParams as UserActiveParams };
+    export { Retention as Retention, type RetentionChurnRateParams as RetentionChurnRateParams, type RetentionCohortsParams as RetentionCohortsParams, type RetentionReturnRateParams as RetentionReturnRateParams, };
 }
 //# sourceMappingURL=analytics.d.mts.map

package/resources/v1/analytics/analytics.d.mts.map

@@ -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,iBAAiB,EAAE,MAAM,EAAE;OAC7B,KAAK,WAAW;OAChB,EACL,sBAAsB,EACtB,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,QAAQ,EACT;AAED,qBAAa,SAAU,SAAQ,WAAW;IACxC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;CAC/D;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,uBAAuB;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;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,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,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;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;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,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE7B,gBAAgB,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAElD,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,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;AAKD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,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,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,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CAC1E"}
+{"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,iBAAiB,EAAE,MAAM,EAAE;OAC7B,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,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;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;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,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,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;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,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;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,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE7B,gBAAgB,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAElD,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,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;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;CACrF;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,uBAAuB,IAAI,uBAAuB,EACvD,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,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;IAEzE,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"}

package/resources/v1/analytics/analytics.d.ts

@@ -1,17 +1,100 @@
 import { APIResource } from "../../../core/resource.js";
 import * as EventsAPI from "./events.js";
 import { EventRecentParams, Events } from "./events.js";
+import * as RetentionAPI from "./retention.js";
+import { Retention, RetentionChurnRateParams, RetentionCohortsParams, RetentionReturnRateParams } from "./retention.js";
+import * as SessionsAPI from "./sessions.js";
+import { SessionBounceRateParams, SessionMetricsParams, Sessions } from "./sessions.js";
+import * as UsersAPI from "./users.js";
+import { UserActiveParams, Users } from "./users.js";
 import * as VisitorsAPI from "./visitors.js";
 import { VisitorByCountryParams, VisitorByDeviceParams, VisitorByOriginParams, VisitorProfileParams, VisitorTimelineParams, VisitorTopParams, Visitors } from "./visitors.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
 export declare class Analytics extends APIResource {
     visitors: VisitorsAPI.Visitors;
     events: EventsAPI.Events;
+    sessions: SessionsAPI.Sessions;
+    users: UsersAPI.Users;
+    retention: RetentionAPI.Retention;
+    /**
+     * Get combined key metrics including sessions, active users, bounce rate, and
+     * retention for dashboard display
+     *
+     * @example
+     * ```ts
+     * const dashboardMetricsResponse =
+     *   await client.v1.analytics.dashboard({
+     *     project_id: 'project_id',
+     *     time_range: 'last_hour',
+     *   });
+     * ```
+     */
+    dashboard(query: AnalyticsDashboardParams, options?: RequestOptions): APIPromise<DashboardMetricsResponse>;
+}
+export interface ActiveUsersResponse {
+    dau?: number;
+    mau?: number;
+    wau?: number;
+}
+export interface BounceRateByPageMetric {
+    bounce_rate?: number;
+    page?: string;
+    sessions?: number;
+}
+export interface BounceRateResponse {
+    by_page?: Array<BounceRateByPageMetric>;
+    overall_bounce_rate?: number;
+}
+export interface ChurnRateResponse {
+    churn_rate_percent?: number;
+    churn_threshold_days?: number;
+    churned_users?: number;
+    total_users?: number;
+}
+export interface CohortAnalysisResponse {
+    cohorts?: Array<CohortData>;
+}
+export interface CohortData {
+    cohort_period?: string;
+    cohort_size?: number;
+    month_1_retention?: number;
+    month_2_retention?: number;
+    month_3_retention?: number;
+    week_1_retention?: number;
+    week_2_retention?: number;
+    week_4_retention?: number;
 }
 export interface CountryDataPoint {
     country_code?: string;
     percentage?: number;
     unique_visitors?: number;
 }
+export interface DashboardMetricsResponse {
+    avg_pages_per_session?: number;
+    avg_session_duration_seconds?: number;
+    /**
+     * Engagement metrics
+     */
+    bounce_rate?: number;
+    /**
+     * Active users
+     */
+    dau?: number;
+    mau?: number;
+    return_rate?: number;
+    /**
+     * Sessions
+     */
+    sessions_today?: number;
+    /**
+     * Total metrics
+     */
+    total_events?: number;
+    total_sessions_in_period?: number;
+    unique_visitors?: number;
+    wau?: number;
+}
 export interface EventsOverTimeDataPoint {
     event_count?: number;
     timestamp?: string;
@@ -37,6 +120,17 @@ export interface RecentEventsResponse {
     events?: Array<RecentEvent>;
     total?: number;
 }
+export interface ReturnRateResponse {
+    avg_time_between_sessions_hours?: number;
+    return_rate_percent?: number;
+    returning_users?: number;
+    total_users?: number;
+}
+export interface SessionMetricsResponse {
+    average_pages_per_session?: number;
+    average_session_duration_seconds?: number;
+    total_sessions?: number;
+}
 export interface TopVisitor {
     browser_name?: string;
     device_type?: string;
@@ -95,9 +189,22 @@ export interface VisitorsByDeviceResponse {
 export interface VisitorsByOriginResponse {
     data?: Array<OriginDataPoint>;
 }
+export interface AnalyticsDashboardParams {
+    /**
+     * Project ID
+     */
+    project_id: string;
+    /**
+     * Time range
+     */
+    time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+}
 export declare namespace Analytics {
-    export { type CountryDataPoint as CountryDataPoint, type EventsOverTimeDataPoint as EventsOverTimeDataPoint, type OriginDataPoint as OriginDataPoint, type RecentEvent as RecentEvent, type RecentEventsResponse as RecentEventsResponse, 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, };
+    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 EventsOverTimeDataPoint as EventsOverTimeDataPoint, 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, };
     export { Visitors as Visitors, type VisitorByCountryParams as VisitorByCountryParams, type VisitorByDeviceParams as VisitorByDeviceParams, type VisitorByOriginParams as VisitorByOriginParams, type VisitorProfileParams as VisitorProfileParams, type VisitorTimelineParams as VisitorTimelineParams, type VisitorTopParams as VisitorTopParams, };
     export { Events as Events, type EventRecentParams as EventRecentParams };
+    export { Sessions as Sessions, type SessionBounceRateParams as SessionBounceRateParams, type SessionMetricsParams as SessionMetricsParams, };
+    export { Users as Users, type UserActiveParams as UserActiveParams };
+    export { Retention as Retention, type RetentionChurnRateParams as RetentionChurnRateParams, type RetentionCohortsParams as RetentionCohortsParams, type RetentionReturnRateParams as RetentionReturnRateParams, };
 }
 //# sourceMappingURL=analytics.d.ts.map

package/resources/v1/analytics/analytics.d.ts.map

@@ -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,iBAAiB,EAAE,MAAM,EAAE;OAC7B,KAAK,WAAW;OAChB,EACL,sBAAsB,EACtB,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,QAAQ,EACT;AAED,qBAAa,SAAU,SAAQ,WAAW;IACxC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;CAC/D;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,uBAAuB;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;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,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,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;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;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,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE7B,gBAAgB,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAElD,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,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;AAKD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,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,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,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CAC1E"}
+{"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,iBAAiB,EAAE,MAAM,EAAE;OAC7B,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,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;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;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,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,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;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,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;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,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE7B,gBAAgB,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAElD,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,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;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;CACrF;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,uBAAuB,IAAI,uBAAuB,EACvD,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,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;IAEzE,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"}

package/resources/v1/analytics/analytics.js

@@ -6,6 +6,12 @@ const tslib_1 = require("../../../internal/tslib.js");
 const resource_1 = require("../../../core/resource.js");
 const EventsAPI = tslib_1.__importStar(require("./events.js"));
 const events_1 = require("./events.js");
+const RetentionAPI = tslib_1.__importStar(require("./retention.js"));
+const retention_1 = require("./retention.js");
+const SessionsAPI = tslib_1.__importStar(require("./sessions.js"));
+const sessions_1 = require("./sessions.js");
+const UsersAPI = tslib_1.__importStar(require("./users.js"));
+const users_1 = require("./users.js");
 const VisitorsAPI = tslib_1.__importStar(require("./visitors.js"));
 const visitors_1 = require("./visitors.js");
 class Analytics extends resource_1.APIResource {
@@ -13,9 +19,31 @@ class Analytics extends resource_1.APIResource {
         super(...arguments);
         this.visitors = new VisitorsAPI.Visitors(this._client);
         this.events = new EventsAPI.Events(this._client);
+        this.sessions = new SessionsAPI.Sessions(this._client);
+        this.users = new UsersAPI.Users(this._client);
+        this.retention = new RetentionAPI.Retention(this._client);
+    }
+    /**
+     * Get combined key metrics including sessions, active users, bounce rate, and
+     * retention for dashboard display
+     *
+     * @example
+     * ```ts
+     * const dashboardMetricsResponse =
+     *   await client.v1.analytics.dashboard({
+     *     project_id: 'project_id',
+     *     time_range: 'last_hour',
+     *   });
+     * ```
+     */
+    dashboard(query, options) {
+        return this._client.get('/api/v1/analytics/dashboard', { query, ...options });
     }
 }
 exports.Analytics = Analytics;
 Analytics.Visitors = visitors_1.Visitors;
 Analytics.Events = events_1.Events;
+Analytics.Sessions = sessions_1.Sessions;
+Analytics.Users = users_1.Users;
+Analytics.Retention = retention_1.Retention;
 //# sourceMappingURL=analytics.js.map

package/resources/v1/analytics/analytics.js.map

@@ -1 +1 @@
-{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../../src/resources/v1/analytics/analytics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,+DAAsC;AACtC,wCAAqD;AACrD,mEAA0C;AAC1C,4CAQoB;AAEpB,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;IAChE,CAAC;CAAA;AAHD,8BAGC;AAoJD,SAAS,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC9B,SAAS,CAAC,MAAM,GAAG,eAAM,CAAC"}
+{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../../src/resources/v1/analytics/analytics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,+DAAsC;AACtC,wCAAqD;AACrD,qEAA4C;AAC5C,8CAKqB;AACrB,mEAA0C;AAC1C,4CAAqF;AACrF,6DAAoC;AACpC,sCAAkD;AAClD,mEAA0C;AAC1C,4CAQoB;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;AA4QD,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"}

package/resources/v1/analytics/analytics.mjs

@@ -2,6 +2,12 @@
 import { APIResource } from "../../../core/resource.mjs";
 import * as EventsAPI from "./events.mjs";
 import { Events } from "./events.mjs";
+import * as RetentionAPI from "./retention.mjs";
+import { Retention, } from "./retention.mjs";
+import * as SessionsAPI from "./sessions.mjs";
+import { Sessions } from "./sessions.mjs";
+import * as UsersAPI from "./users.mjs";
+import { Users } from "./users.mjs";
 import * as VisitorsAPI from "./visitors.mjs";
 import { Visitors, } from "./visitors.mjs";
 export class Analytics extends APIResource {
@@ -9,8 +15,30 @@ export class Analytics extends APIResource {
         super(...arguments);
         this.visitors = new VisitorsAPI.Visitors(this._client);
         this.events = new EventsAPI.Events(this._client);
+        this.sessions = new SessionsAPI.Sessions(this._client);
+        this.users = new UsersAPI.Users(this._client);
+        this.retention = new RetentionAPI.Retention(this._client);
+    }
+    /**
+     * Get combined key metrics including sessions, active users, bounce rate, and
+     * retention for dashboard display
+     *
+     * @example
+     * ```ts
+     * const dashboardMetricsResponse =
+     *   await client.v1.analytics.dashboard({
+     *     project_id: 'project_id',
+     *     time_range: 'last_hour',
+     *   });
+     * ```
+     */
+    dashboard(query, options) {
+        return this._client.get('/api/v1/analytics/dashboard', { query, ...options });
     }
 }
 Analytics.Visitors = Visitors;
 Analytics.Events = Events;
+Analytics.Sessions = Sessions;
+Analytics.Users = Users;
+Analytics.Retention = Retention;
 //# sourceMappingURL=analytics.mjs.map

package/resources/v1/analytics/analytics.mjs.map

@@ -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,EAAqB,MAAM,EAAE;OAC7B,KAAK,WAAW;OAChB,EAOL,QAAQ,GACT;AAED,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;IAChE,CAAC;CAAA;AAoJD,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC9B,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC"}
+{"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,EAAqB,MAAM,EAAE;OAC7B,KAAK,YAAY;OACjB,EACL,SAAS,GAIV;OACM,KAAK,WAAW;OAChB,EAAiD,QAAQ,EAAE;OAC3D,KAAK,QAAQ;OACb,EAAoB,KAAK,EAAE;OAC3B,KAAK,WAAW;OAChB,EAOL,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;AA4QD,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"}

package/resources/v1/analytics/index.d.mts

@@ -1,4 +1,7 @@
-export { Analytics, type CountryDataPoint, type EventsOverTimeDataPoint, type OriginDataPoint, type RecentEvent, type RecentEventsResponse, type TopVisitor, type TopVisitorsResponse, type UniqueVisitorsDataPoint, type UniqueVisitorsTimelineResponse, type VisitorDataPoint, type VisitorEvent, type VisitorProfileResponse, type VisitorsByCountryResponse, type VisitorsByDeviceResponse, type VisitorsByOriginResponse, } from "./analytics.mjs";
+export { Analytics, type ActiveUsersResponse, type BounceRateByPageMetric, type BounceRateResponse, type ChurnRateResponse, type CohortAnalysisResponse, type CohortData, type CountryDataPoint, type DashboardMetricsResponse, type EventsOverTimeDataPoint, type OriginDataPoint, type RecentEvent, type RecentEventsResponse, type ReturnRateResponse, type SessionMetricsResponse, type TopVisitor, type TopVisitorsResponse, type UniqueVisitorsDataPoint, type UniqueVisitorsTimelineResponse, type VisitorDataPoint, type VisitorEvent, type VisitorProfileResponse, type VisitorsByCountryResponse, type VisitorsByDeviceResponse, type VisitorsByOriginResponse, type AnalyticsDashboardParams, } from "./analytics.mjs";
 export { Events, type EventRecentParams } from "./events.mjs";
+export { Retention, type RetentionChurnRateParams, type RetentionCohortsParams, type RetentionReturnRateParams, } from "./retention.mjs";
+export { Sessions, type SessionBounceRateParams, type SessionMetricsParams } from "./sessions.mjs";
+export { Users, type UserActiveParams } from "./users.mjs";
 export { Visitors, type VisitorByCountryParams, type VisitorByDeviceParams, type VisitorByOriginParams, type VisitorProfileParams, type VisitorTimelineParams, type VisitorTopParams, } from "./visitors.mjs";
 //# sourceMappingURL=index.d.mts.map

package/resources/v1/analytics/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,UAAU,EACf,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,GAC9B;OACM,EAAE,MAAM,EAAE,KAAK,iBAAiB,EAAE;OAClC,EACL,QAAQ,EACR,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,GACtB"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,UAAU,EACf,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,EAC5B,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,UAAU,EACf,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,GAC9B;OACM,EAAE,MAAM,EAAE,KAAK,iBAAiB,EAAE;OAClC,EACL,SAAS,EACT,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,GAC/B;OACM,EAAE,QAAQ,EAAE,KAAK,uBAAuB,EAAE,KAAK,oBAAoB,EAAE;OACrE,EAAE,KAAK,EAAE,KAAK,gBAAgB,EAAE;OAChC,EACL,QAAQ,EACR,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,GACtB"}

package/resources/v1/analytics/index.d.ts

@@ -1,4 +1,7 @@
-export { Analytics, type CountryDataPoint, type EventsOverTimeDataPoint, type OriginDataPoint, type RecentEvent, type RecentEventsResponse, type TopVisitor, type TopVisitorsResponse, type UniqueVisitorsDataPoint, type UniqueVisitorsTimelineResponse, type VisitorDataPoint, type VisitorEvent, type VisitorProfileResponse, type VisitorsByCountryResponse, type VisitorsByDeviceResponse, type VisitorsByOriginResponse, } from "./analytics.js";
+export { Analytics, type ActiveUsersResponse, type BounceRateByPageMetric, type BounceRateResponse, type ChurnRateResponse, type CohortAnalysisResponse, type CohortData, type CountryDataPoint, type DashboardMetricsResponse, type EventsOverTimeDataPoint, type OriginDataPoint, type RecentEvent, type RecentEventsResponse, type ReturnRateResponse, type SessionMetricsResponse, type TopVisitor, type TopVisitorsResponse, type UniqueVisitorsDataPoint, type UniqueVisitorsTimelineResponse, type VisitorDataPoint, type VisitorEvent, type VisitorProfileResponse, type VisitorsByCountryResponse, type VisitorsByDeviceResponse, type VisitorsByOriginResponse, type AnalyticsDashboardParams, } from "./analytics.js";
 export { Events, type EventRecentParams } from "./events.js";
+export { Retention, type RetentionChurnRateParams, type RetentionCohortsParams, type RetentionReturnRateParams, } from "./retention.js";
+export { Sessions, type SessionBounceRateParams, type SessionMetricsParams } from "./sessions.js";
+export { Users, type UserActiveParams } from "./users.js";
 export { Visitors, type VisitorByCountryParams, type VisitorByDeviceParams, type VisitorByOriginParams, type VisitorProfileParams, type VisitorTimelineParams, type VisitorTopParams, } from "./visitors.js";
 //# sourceMappingURL=index.d.ts.map

package/resources/v1/analytics/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,UAAU,EACf,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,GAC9B;OACM,EAAE,MAAM,EAAE,KAAK,iBAAiB,EAAE;OAClC,EACL,QAAQ,EACR,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,GACtB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,UAAU,EACf,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,EAC5B,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,UAAU,EACf,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,GAC9B;OACM,EAAE,MAAM,EAAE,KAAK,iBAAiB,EAAE;OAClC,EACL,SAAS,EACT,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,GAC/B;OACM,EAAE,QAAQ,EAAE,KAAK,uBAAuB,EAAE,KAAK,oBAAoB,EAAE;OACrE,EAAE,KAAK,EAAE,KAAK,gBAAgB,EAAE;OAChC,EACL,QAAQ,EACR,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,GACtB"}

package/resources/v1/analytics/index.js

@@ -1,11 +1,17 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Visitors = exports.Events = exports.Analytics = void 0;
+exports.Visitors = exports.Users = exports.Sessions = exports.Retention = exports.Events = exports.Analytics = void 0;
 var analytics_1 = require("./analytics.js");
 Object.defineProperty(exports, "Analytics", { enumerable: true, get: function () { return analytics_1.Analytics; } });
 var events_1 = require("./events.js");
 Object.defineProperty(exports, "Events", { enumerable: true, get: function () { return events_1.Events; } });
+var retention_1 = require("./retention.js");
+Object.defineProperty(exports, "Retention", { enumerable: true, get: function () { return retention_1.Retention; } });
+var sessions_1 = require("./sessions.js");
+Object.defineProperty(exports, "Sessions", { enumerable: true, get: function () { return sessions_1.Sessions; } });
+var users_1 = require("./users.js");
+Object.defineProperty(exports, "Users", { enumerable: true, get: function () { return users_1.Users; } });
 var visitors_1 = require("./visitors.js");
 Object.defineProperty(exports, "Visitors", { enumerable: true, get: function () { return visitors_1.Visitors; } });
 //# sourceMappingURL=index.js.map

package/resources/v1/analytics/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4CAiBqB;AAhBnB,sGAAA,SAAS,OAAA;AAiBX,sCAA0D;AAAjD,gGAAA,MAAM,OAAA;AACf,0CAQoB;AAPlB,oGAAA,QAAQ,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4CA2BqB;AA1BnB,sGAAA,SAAS,OAAA;AA2BX,sCAA0D;AAAjD,gGAAA,MAAM,OAAA;AACf,4CAKqB;AAJnB,sGAAA,SAAS,OAAA;AAKX,0CAA+F;AAAtF,oGAAA,QAAQ,OAAA;AACjB,oCAAuD;AAA9C,8FAAA,KAAK,OAAA;AACd,0CAQoB;AAPlB,oGAAA,QAAQ,OAAA"}

package/resources/v1/analytics/index.mjs

@@ -1,5 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 export { Analytics, } from "./analytics.mjs";
 export { Events } from "./events.mjs";
+export { Retention, } from "./retention.mjs";
+export { Sessions } from "./sessions.mjs";
+export { Users } from "./users.mjs";
 export { Visitors, } from "./visitors.mjs";
 //# sourceMappingURL=index.mjs.map

package/resources/v1/analytics/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,SAAS,GAgBV;OACM,EAAE,MAAM,EAA0B;OAClC,EACL,QAAQ,GAOT"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/analytics/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,SAAS,GA0BV;OACM,EAAE,MAAM,EAA0B;OAClC,EACL,SAAS,GAIV;OACM,EAAE,QAAQ,EAA2D;OACrE,EAAE,KAAK,EAAyB;OAChC,EACL,QAAQ,GAOT"}

package/resources/v1/analytics/retention.d.mts

@@ -0,0 +1,83 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as AnalyticsAPI from "./analytics.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+export declare class Retention extends APIResource {
+    /**
+     * Get metrics about user churn based on inactivity threshold
+     *
+     * @example
+     * ```ts
+     * const churnRateResponse =
+     *   await client.v1.analytics.retention.churnRate({
+     *     project_id: 'project_id',
+     *     time_range: 'last_hour',
+     *   });
+     * ```
+     */
+    churnRate(query: RetentionChurnRateParams, options?: RequestOptions): APIPromise<AnalyticsAPI.ChurnRateResponse>;
+    /**
+     * Get cohort retention analysis showing how user groups retain over time
+     *
+     * @example
+     * ```ts
+     * const cohortAnalysisResponse =
+     *   await client.v1.analytics.retention.cohorts({
+     *     project_id: 'project_id',
+     *     time_range: 'last_hour',
+     *   });
+     * ```
+     */
+    cohorts(query: RetentionCohortsParams, options?: RequestOptions): APIPromise<AnalyticsAPI.CohortAnalysisResponse>;
+    /**
+     * Get metrics about user return rate and time between sessions
+     *
+     * @example
+     * ```ts
+     * const returnRateResponse =
+     *   await client.v1.analytics.retention.returnRate({
+     *     project_id: 'project_id',
+     *     time_range: 'last_hour',
+     *   });
+     * ```
+     */
+    returnRate(query: RetentionReturnRateParams, options?: RequestOptions): APIPromise<AnalyticsAPI.ReturnRateResponse>;
+}
+export interface RetentionChurnRateParams {
+    /**
+     * Project ID
+     */
+    project_id: string;
+    /**
+     * Time range
+     */
+    time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+    /**
+     * Days of inactivity to consider churned (default: 30)
+     */
+    churn_threshold_days?: number;
+}
+export interface RetentionCohortsParams {
+    /**
+     * Project ID
+     */
+    project_id: string;
+    /**
+     * Time range
+     */
+    time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+}
+export interface RetentionReturnRateParams {
+    /**
+     * Project ID
+     */
+    project_id: string;
+    /**
+     * Time range
+     */
+    time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+}
+export declare namespace Retention {
+    export { type RetentionChurnRateParams as RetentionChurnRateParams, type RetentionCohortsParams as RetentionCohortsParams, type RetentionReturnRateParams as RetentionReturnRateParams, };
+}
+//# sourceMappingURL=retention.d.mts.map

package/resources/v1/analytics/retention.d.mts.map

@@ -0,0 +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;IAIlD;;;;;;;;;;;OAWG;IACH,UAAU,CACR,KAAK,EAAE,yBAAyB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,kBAAkB,CAAC;CAG/C;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;IAEpF;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;CACrF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;CACrF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}