zorihq 0.14.0 → 0.17.0

package/src/resources/v1/analytics/analytics.ts

@@ -4,24 +4,31 @@ import { APIResource } from '../../../core/resource';
 import * as EventsAPI from './events';
 import { EventFilterOptionsParams, EventRecentParams, Events } from './events';
 import * as RetentionAPI from './retention';
+import { Retention, RetentionChurnRateParams, RetentionCohortsParams } from './retention';
+import * as TilesAPI from './tiles';
 import {
-  Retention,
-  RetentionChurnRateParams,
-  RetentionCohortsParams,
-  RetentionReturnRateParams,
-} from './retention';
-import * as SessionsAPI from './sessions';
-import { SessionBounceRateParams, SessionMetricsParams, Sessions } from './sessions';
-import * as UsersAPI from './users';
-import { UserActiveParams, Users } from './users';
+  TileBounceRateParams,
+  TileDauParams,
+  TileMauParams,
+  TilePagesPerSessionParams,
+  TileReturnRateParams,
+  TileSessionDurationParams,
+  TileTimeBetweenVisitsParams,
+  TileTrafficByCountryParams,
+  TileTrafficByRefererParams,
+  TileTrafficByUtmParams,
+  TileUniqueSessionsParams,
+  TileUniqueVisitorsParams,
+  TileVisitorsByBrowserParams,
+  TileVisitorsByOsParams,
+  TileWauParams,
+  Tiles,
+} from './tiles';
 import * as VisitorsAPI from './visitors';
 import {
-  VisitorByCountryParams,
   VisitorByDeviceParams,
-  VisitorByOriginParams,
   VisitorIdentifyParams,
   VisitorProfileParams,
-  VisitorTimelineParams,
   VisitorTopParams,
   Visitors,
 } from './visitors';
@@ -31,50 +38,35 @@ import { RequestOptions } from '../../../internal/request-options';
 export class Analytics extends APIResource {
   visitors: VisitorsAPI.Visitors = new VisitorsAPI.Visitors(this._client);
   events: EventsAPI.Events = new EventsAPI.Events(this._client);
-  sessions: SessionsAPI.Sessions = new SessionsAPI.Sessions(this._client);
-  users: UsersAPI.Users = new UsersAPI.Users(this._client);
+  tiles: TilesAPI.Tiles = new TilesAPI.Tiles(this._client);
   retention: RetentionAPI.Retention = new RetentionAPI.Retention(this._client);
 
   /**
-   * Get combined key metrics including sessions, active users, bounce rate, and
-   * retention for dashboard display
+   * Get unique visitor counts over time, split by mobile and desktop devices for
+   * chart visualization
    *
    * @example
    * ```ts
-   * const dashboardMetricsResponse =
-   *   await client.v1.analytics.dashboard({
+   * const timelineTileResponse =
+   *   await client.v1.analytics.timeline({
    *     project_id: 'project_id',
    *     time_range: 'last_hour',
    *   });
    * ```
    */
-  dashboard(query: AnalyticsDashboardParams, options?: RequestOptions): APIPromise<DashboardMetricsResponse> {
-    return this._client.get('/api/v1/analytics/dashboard', { query, ...options });
+  timeline(query: AnalyticsTimelineParams, options?: RequestOptions): APIPromise<TimelineTileResponse> {
+    return this._client.get('/api/v1/analytics/timeline', { query, ...options });
   }
 }
 
-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>;
+  previous_rate?: number;
 
-  overall_bounce_rate?: number;
+  rate?: number;
 }
 
+export type CardPrecision = 'minutes' | 'hourly' | 'daily' | 'weekly' | 'monthly';
+
 export interface ChurnRateResponse {
   churn_rate_percent?: number;
 
@@ -107,38 +99,22 @@ export interface CohortData {
   week_4_retention?: number;
 }
 
-export interface CountryDataPoint {
-  country_code?: string;
+export interface CountryTrafficSourceData {
+  count?: number;
 
-  percentage?: number;
+  country?: string;
 
-  unique_visitors?: number;
+  previous_count?: number;
 }
 
-export interface DashboardMetricsResponse {
-  avg_pages_per_session?: number;
-
-  avg_session_duration_seconds?: number;
-
-  bounce_rate?: number;
-
-  dau?: number;
-
-  mau?: number;
-
-  return_rate?: number;
-
-  sessions_today?: number;
-
-  total_events?: number;
-
-  total_sessions_in_period?: number;
-
-  unique_sessions?: number;
+export interface CountryTrafficSourceResponse {
+  data?: Array<CountryTrafficSourceData>;
+}
 
-  unique_visitors?: number;
+export interface DauResponse {
+  count?: number;
 
-  wau?: number;
+  previous_count?: number;
 }
 
 export interface EventFilterOptionsResponse {
@@ -181,12 +157,16 @@ export interface ManualIdentifyResponse {
   visitor_id?: string;
 }
 
-export interface OriginDataPoint {
-  origin?: string;
+export interface MauResponse {
+  count?: number;
 
-  percentage?: number;
+  previous_count?: number;
+}
 
-  unique_visitors?: number;
+export interface PagesPerSessionResponse {
+  avg_pages?: number;
+
+  previous_avg_pages?: number;
 }
 
 export interface RecentEvent {
@@ -257,22 +237,58 @@ export interface RecentEventsResponse {
   total?: number;
 }
 
+export interface RefererTrafficSourceData {
+  count?: number;
+
+  previous_count?: number;
+
+  previous_revenue?: number;
+
+  referer_url?: string;
+
+  revenue?: number;
+}
+
+export interface RefererTrafficSourceResponse {
+  data?: Array<RefererTrafficSourceData>;
+}
+
 export interface ReturnRateResponse {
-  avg_time_between_sessions_hours?: number;
+  previous_rate?: number;
+
+  rate?: number;
+}
+
+export interface SessionDurationResponse {
+  avg_duration?: number;
 
-  return_rate_percent?: number;
+  previous_avg_duration?: number;
+}
 
-  returning_users?: number;
+export interface TimeBetweenVisitsResponse {
+  avg_hours?: number;
 
-  total_users?: number;
+  previous_avg_hours?: number;
 }
 
-export interface SessionMetricsResponse {
-  average_pages_per_session?: number;
+export interface TimelineTileData {
+  num_desktop_visits?: number;
 
-  average_session_duration_seconds?: number;
+  num_mobile_visits?: number;
 
-  total_sessions?: number;
+  num_revenue?: number;
+
+  num_unknown_visits?: number;
+
+  time_bucket?: string;
+}
+
+export interface TimelineTileResponse {
+  data?: Array<TimelineTileData>;
+
+  precision?: CardPrecision;
+
+  total_visits?: number;
 }
 
 export interface TopVisitor {
@@ -319,16 +335,38 @@ export interface TopVisitorsResponse {
   visitors?: Array<TopVisitor>;
 }
 
-export interface UniqueVisitorsDataPoint {
-  desktop?: number;
+export interface UniqueSessionsResponse {
+  count?: number;
 
-  mobile?: number;
+  previous_count?: number;
+}
 
-  timestamp?: string;
+export interface UniqueVisitorsResponse {
+  count?: number;
+
+  previous_count?: number;
+}
+
+export interface UtmTrafficSourceResponse {
+  data?: Array<UtmTrafficSourceResponse.Data>;
 }
 
-export interface UniqueVisitorsTimelineResponse {
-  data?: Array<UniqueVisitorsDataPoint>;
+export namespace UtmTrafficSourceResponse {
+  export interface Data {
+    count?: number;
+
+    previous_count?: number;
+
+    previous_revenue?: number;
+
+    revenue?: number;
+
+    utm_campaign?: string;
+
+    utm_medium?: string;
+
+    utm_source?: string;
+  }
 }
 
 export interface VisitorDataPoint {
@@ -423,19 +461,45 @@ export interface VisitorProfileResponse {
   visitor_id?: string;
 }
 
-export interface VisitorsByCountryResponse {
-  data?: Array<CountryDataPoint>;
+export interface VisitorsByBrowserResponse {
+  data?: Array<VisitorsByBrowserResponse.Data>;
+}
+
+export namespace VisitorsByBrowserResponse {
+  export interface Data {
+    browser_name?: string;
+
+    count?: number;
+
+    previous_count?: number;
+  }
 }
 
 export interface VisitorsByDeviceResponse {
   data?: Array<VisitorDataPoint>;
 }
 
-export interface VisitorsByOriginResponse {
-  data?: Array<OriginDataPoint>;
+export interface VisitorsByOsResponse {
+  data?: Array<VisitorsByOsResponse.Data>;
 }
 
-export interface AnalyticsDashboardParams {
+export namespace VisitorsByOsResponse {
+  export interface Data {
+    browser_name?: string;
+
+    count?: number;
+
+    previous_count?: number;
+  }
+}
+
+export interface WauResponse {
+  count?: number;
+
+  previous_count?: number;
+}
+
+export interface AnalyticsTimelineParams {
   project_id: string;
 
   time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
@@ -457,50 +521,54 @@ export interface AnalyticsDashboardParams {
 
 Analytics.Visitors = Visitors;
 Analytics.Events = Events;
-Analytics.Sessions = Sessions;
-Analytics.Users = Users;
+Analytics.Tiles = Tiles;
 Analytics.Retention = Retention;
 
 export declare namespace Analytics {
   export {
-    type ActiveUsersResponse as ActiveUsersResponse,
-    type BounceRateByPageMetric as BounceRateByPageMetric,
     type BounceRateResponse as BounceRateResponse,
+    type CardPrecision as CardPrecision,
     type ChurnRateResponse as ChurnRateResponse,
     type CohortAnalysisResponse as CohortAnalysisResponse,
     type CohortData as CohortData,
-    type CountryDataPoint as CountryDataPoint,
-    type DashboardMetricsResponse as DashboardMetricsResponse,
+    type CountryTrafficSourceData as CountryTrafficSourceData,
+    type CountryTrafficSourceResponse as CountryTrafficSourceResponse,
+    type DauResponse as DauResponse,
     type EventFilterOptionsResponse as EventFilterOptionsResponse,
     type EventsOverTimeDataPoint as EventsOverTimeDataPoint,
     type ManualIdentifyRequest as ManualIdentifyRequest,
     type ManualIdentifyResponse as ManualIdentifyResponse,
-    type OriginDataPoint as OriginDataPoint,
+    type MauResponse as MauResponse,
+    type PagesPerSessionResponse as PagesPerSessionResponse,
     type RecentEvent as RecentEvent,
     type RecentEventsResponse as RecentEventsResponse,
+    type RefererTrafficSourceData as RefererTrafficSourceData,
+    type RefererTrafficSourceResponse as RefererTrafficSourceResponse,
     type ReturnRateResponse as ReturnRateResponse,
-    type SessionMetricsResponse as SessionMetricsResponse,
+    type SessionDurationResponse as SessionDurationResponse,
+    type TimeBetweenVisitsResponse as TimeBetweenVisitsResponse,
+    type TimelineTileData as TimelineTileData,
+    type TimelineTileResponse as TimelineTileResponse,
     type TopVisitor as TopVisitor,
     type TopVisitorsResponse as TopVisitorsResponse,
-    type UniqueVisitorsDataPoint as UniqueVisitorsDataPoint,
-    type UniqueVisitorsTimelineResponse as UniqueVisitorsTimelineResponse,
+    type UniqueSessionsResponse as UniqueSessionsResponse,
+    type UniqueVisitorsResponse as UniqueVisitorsResponse,
+    type UtmTrafficSourceResponse as UtmTrafficSourceResponse,
     type VisitorDataPoint as VisitorDataPoint,
     type VisitorEvent as VisitorEvent,
     type VisitorProfileResponse as VisitorProfileResponse,
-    type VisitorsByCountryResponse as VisitorsByCountryResponse,
+    type VisitorsByBrowserResponse as VisitorsByBrowserResponse,
     type VisitorsByDeviceResponse as VisitorsByDeviceResponse,
-    type VisitorsByOriginResponse as VisitorsByOriginResponse,
-    type AnalyticsDashboardParams as AnalyticsDashboardParams,
+    type VisitorsByOsResponse as VisitorsByOsResponse,
+    type WauResponse as WauResponse,
+    type AnalyticsTimelineParams as AnalyticsTimelineParams,
   };
 
   export {
     Visitors as Visitors,
-    type VisitorByCountryParams as VisitorByCountryParams,
     type VisitorByDeviceParams as VisitorByDeviceParams,
-    type VisitorByOriginParams as VisitorByOriginParams,
     type VisitorIdentifyParams as VisitorIdentifyParams,
     type VisitorProfileParams as VisitorProfileParams,
-    type VisitorTimelineParams as VisitorTimelineParams,
     type VisitorTopParams as VisitorTopParams,
   };
 
@@ -511,17 +579,27 @@ export declare namespace Analytics {
   };
 
   export {
-    Sessions as Sessions,
-    type SessionBounceRateParams as SessionBounceRateParams,
-    type SessionMetricsParams as SessionMetricsParams,
+    Tiles as Tiles,
+    type TileBounceRateParams as TileBounceRateParams,
+    type TileDauParams as TileDauParams,
+    type TileMauParams as TileMauParams,
+    type TilePagesPerSessionParams as TilePagesPerSessionParams,
+    type TileReturnRateParams as TileReturnRateParams,
+    type TileSessionDurationParams as TileSessionDurationParams,
+    type TileTimeBetweenVisitsParams as TileTimeBetweenVisitsParams,
+    type TileTrafficByCountryParams as TileTrafficByCountryParams,
+    type TileTrafficByRefererParams as TileTrafficByRefererParams,
+    type TileTrafficByUtmParams as TileTrafficByUtmParams,
+    type TileUniqueSessionsParams as TileUniqueSessionsParams,
+    type TileUniqueVisitorsParams as TileUniqueVisitorsParams,
+    type TileVisitorsByBrowserParams as TileVisitorsByBrowserParams,
+    type TileVisitorsByOsParams as TileVisitorsByOsParams,
+    type TileWauParams as TileWauParams,
   };
 
-  export { Users as Users, type UserActiveParams as UserActiveParams };
-
   export {
     Retention as Retention,
     type RetentionChurnRateParams as RetentionChurnRateParams,
     type RetentionCohortsParams as RetentionCohortsParams,
-    type RetentionReturnRateParams as RetentionReturnRateParams,
   };
 }

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

@@ -2,51 +2,67 @@
 
 export {
   Analytics,
-  type ActiveUsersResponse,
-  type BounceRateByPageMetric,
   type BounceRateResponse,
+  type CardPrecision,
   type ChurnRateResponse,
   type CohortAnalysisResponse,
   type CohortData,
-  type CountryDataPoint,
-  type DashboardMetricsResponse,
+  type CountryTrafficSourceData,
+  type CountryTrafficSourceResponse,
+  type DauResponse,
   type EventFilterOptionsResponse,
   type EventsOverTimeDataPoint,
   type ManualIdentifyRequest,
   type ManualIdentifyResponse,
-  type OriginDataPoint,
+  type MauResponse,
+  type PagesPerSessionResponse,
   type RecentEvent,
   type RecentEventsResponse,
+  type RefererTrafficSourceData,
+  type RefererTrafficSourceResponse,
   type ReturnRateResponse,
-  type SessionMetricsResponse,
+  type SessionDurationResponse,
+  type TimeBetweenVisitsResponse,
+  type TimelineTileData,
+  type TimelineTileResponse,
   type TopVisitor,
   type TopVisitorsResponse,
-  type UniqueVisitorsDataPoint,
-  type UniqueVisitorsTimelineResponse,
+  type UniqueSessionsResponse,
+  type UniqueVisitorsResponse,
+  type UtmTrafficSourceResponse,
   type VisitorDataPoint,
   type VisitorEvent,
   type VisitorProfileResponse,
-  type VisitorsByCountryResponse,
+  type VisitorsByBrowserResponse,
   type VisitorsByDeviceResponse,
-  type VisitorsByOriginResponse,
-  type AnalyticsDashboardParams,
+  type VisitorsByOsResponse,
+  type WauResponse,
+  type AnalyticsTimelineParams,
 } from './analytics';
 export { Events, type EventFilterOptionsParams, type EventRecentParams } from './events';
+export { Retention, type RetentionChurnRateParams, type RetentionCohortsParams } from './retention';
 export {
-  Retention,
-  type RetentionChurnRateParams,
-  type RetentionCohortsParams,
-  type RetentionReturnRateParams,
-} from './retention';
-export { Sessions, type SessionBounceRateParams, type SessionMetricsParams } from './sessions';
-export { Users, type UserActiveParams } from './users';
+  Tiles,
+  type TileBounceRateParams,
+  type TileDauParams,
+  type TileMauParams,
+  type TilePagesPerSessionParams,
+  type TileReturnRateParams,
+  type TileSessionDurationParams,
+  type TileTimeBetweenVisitsParams,
+  type TileTrafficByCountryParams,
+  type TileTrafficByRefererParams,
+  type TileTrafficByUtmParams,
+  type TileUniqueSessionsParams,
+  type TileUniqueVisitorsParams,
+  type TileVisitorsByBrowserParams,
+  type TileVisitorsByOsParams,
+  type TileWauParams,
+} from './tiles';
 export {
   Visitors,
-  type VisitorByCountryParams,
   type VisitorByDeviceParams,
-  type VisitorByOriginParams,
   type VisitorIdentifyParams,
   type VisitorProfileParams,
-  type VisitorTimelineParams,
   type VisitorTopParams,
 } from './visitors';

package/src/resources/v1/analytics/retention.ts

@@ -43,25 +43,6 @@ export class Retention extends APIResource {
   ): APIPromise<AnalyticsAPI.CohortAnalysisResponse> {
     return this._client.get('/api/v1/analytics/retention/cohorts', { query, ...options });
   }
-
-  /**
-   * 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> {
-    return this._client.get('/api/v1/analytics/retention/return-rate', { query, ...options });
-  }
 }
 
 export interface RetentionChurnRateParams {
@@ -104,30 +85,9 @@ export interface RetentionCohortsParams {
   visitor_id?: string;
 }
 
-export interface RetentionReturnRateParams {
-  project_id: string;
-
-  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
-
-  customer_id?: string;
-
-  limit?: number;
-
-  offset?: number;
-
-  referrer?: string;
-
-  utmtag?: string;
-
-  utmtagValue?: string;
-
-  visitor_id?: string;
-}
-
 export declare namespace Retention {
   export {
     type RetentionChurnRateParams as RetentionChurnRateParams,
     type RetentionCohortsParams as RetentionCohortsParams,
-    type RetentionReturnRateParams as RetentionReturnRateParams,
   };
 }