zorihq 0.13.0 → 0.15.0

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

@@ -4,24 +4,46 @@ 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,
-  RetentionReturnRateParams,
-} from './retention';
+import { Retention, RetentionChurnRateParams, RetentionCohortsParams } from './retention';
 import * as SessionsAPI from './sessions';
-import { SessionBounceRateParams, SessionMetricsParams, Sessions } from './sessions';
+import { Sessions } from './sessions';
+import * as TilesAPI from './tiles';
+import {
+  TileGetBounceRateParams,
+  TileGetBounceRateResponse,
+  TileGetDailyActiveUsersParams,
+  TileGetDailyActiveUsersResponse,
+  TileGetMonthlyActiveUsersParams,
+  TileGetMonthlyActiveUsersResponse,
+  TileGetPagesPerSessionParams,
+  TileGetPagesPerSessionResponse,
+  TileGetReturnRateParams,
+  TileGetReturnRateResponse,
+  TileGetSessionDurationParams,
+  TileGetSessionDurationResponse,
+  TileGetTimeBetweenVisitsParams,
+  TileGetTimeBetweenVisitsResponse,
+  TileGetTrafficByCountryParams,
+  TileGetTrafficByCountryResponse,
+  TileGetTrafficByRefererParams,
+  TileGetTrafficByRefererResponse,
+  TileGetTrafficByUtmParams,
+  TileGetTrafficByUtmResponse,
+  TileGetUniqueSessionsParams,
+  TileGetUniqueSessionsResponse,
+  TileGetUniqueVisitorsParams,
+  TileGetUniqueVisitorsResponse,
+  TileGetWeeklyActiveUsersParams,
+  TileGetWeeklyActiveUsersResponse,
+  Tiles,
+} from './tiles';
 import * as UsersAPI from './users';
-import { UserActiveParams, Users } from './users';
+import { Users } from './users';
 import * as VisitorsAPI from './visitors';
 import {
-  VisitorByCountryParams,
   VisitorByDeviceParams,
-  VisitorByOriginParams,
   VisitorIdentifyParams,
   VisitorProfileParams,
-  VisitorTimelineParams,
   VisitorTopParams,
   Visitors,
 } from './visitors';
@@ -34,47 +56,27 @@ export class Analytics extends APIResource {
   sessions: SessionsAPI.Sessions = new SessionsAPI.Sessions(this._client);
   users: UsersAPI.Users = new UsersAPI.Users(this._client);
   retention: RetentionAPI.Retention = new RetentionAPI.Retention(this._client);
+  tiles: TilesAPI.Tiles = new TilesAPI.Tiles(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({
-   *     project_id: 'project_id',
-   *     time_range: 'last_hour',
-   *   });
+   * const response = await client.v1.analytics.retrieveTimeline(
+   *   { 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 });
+  retrieveTimeline(
+    query: AnalyticsRetrieveTimelineParams,
+    options?: RequestOptions,
+  ): APIPromise<AnalyticsRetrieveTimelineResponse> {
+    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>;
-
-  overall_bounce_rate?: number;
-}
-
 export interface ChurnRateResponse {
   churn_rate_percent?: number;
 
@@ -107,41 +109,9 @@ export interface CohortData {
   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;
-
-  bounce_rate?: number;
-
-  dau?: number;
-
-  mau?: number;
-
-  return_rate?: number;
-
-  sessions_today?: number;
-
-  total_events?: number;
-
-  total_sessions_in_period?: number;
-
-  unique_sessions?: number;
-
-  unique_visitors?: number;
-
-  wau?: number;
-}
-
 export interface EventFilterOptionsResponse {
+  event_names?: Array<string>;
+
   pages?: Array<string>;
 
   traffic_origins?: Array<string>;
@@ -179,14 +149,6 @@ export interface ManualIdentifyResponse {
   visitor_id?: string;
 }
 
-export interface OriginDataPoint {
-  origin?: string;
-
-  percentage?: number;
-
-  unique_visitors?: number;
-}
-
 export interface RecentEvent {
   browser_name?: string;
 
@@ -255,44 +217,42 @@ export interface RecentEventsResponse {
   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;
 
+  currency?: string;
+
   device_type?: string;
 
+  distinct_payments?: number;
+
+  email?: string;
+
   event_count?: number;
 
   external_id?: string;
 
+  first_payment_date?: string;
+
   first_seen?: string;
 
+  is_grouped?: boolean;
+
   last_seen?: string;
 
   location_city?: string;
 
   location_country_iso?: string;
 
+  name?: string;
+
+  time_to_first_purchase_seconds?: number;
+
+  total_revenue?: number;
+
   user_id?: string;
 
-  visitor_id?: string;
+  visitor_ids?: Array<string>;
 }
 
 export interface TopVisitorsResponse {
@@ -301,18 +261,6 @@ export interface TopVisitorsResponse {
   visitors?: Array<TopVisitor>;
 }
 
-export interface UniqueVisitorsDataPoint {
-  desktop?: number;
-
-  mobile?: number;
-
-  timestamp?: string;
-}
-
-export interface UniqueVisitorsTimelineResponse {
-  data?: Array<UniqueVisitorsDataPoint>;
-}
-
 export interface VisitorDataPoint {
   desktop?: number;
 
@@ -405,19 +353,33 @@ export interface VisitorProfileResponse {
   visitor_id?: string;
 }
 
-export interface VisitorsByCountryResponse {
-  data?: Array<CountryDataPoint>;
-}
-
 export interface VisitorsByDeviceResponse {
   data?: Array<VisitorDataPoint>;
 }
 
-export interface VisitorsByOriginResponse {
-  data?: Array<OriginDataPoint>;
+export interface AnalyticsRetrieveTimelineResponse {
+  data?: Array<AnalyticsRetrieveTimelineResponse.Data>;
+
+  precision?: 'minutes' | 'hourly' | 'daily' | 'weekly' | 'monthly';
+
+  total_visits?: number;
+}
+
+export namespace AnalyticsRetrieveTimelineResponse {
+  export interface Data {
+    num_desktop_visits?: number;
+
+    num_mobile_visits?: number;
+
+    num_revenue?: number;
+
+    num_unknown_visits?: number;
+
+    time_bucket?: string;
+  }
 }
 
-export interface AnalyticsDashboardParams {
+export interface AnalyticsRetrieveTimelineParams {
   project_id: string;
 
   time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
@@ -442,47 +404,34 @@ Analytics.Events = Events;
 Analytics.Sessions = Sessions;
 Analytics.Users = Users;
 Analytics.Retention = Retention;
+Analytics.Tiles = Tiles;
 
 export declare namespace Analytics {
   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,
+    type AnalyticsRetrieveTimelineResponse as AnalyticsRetrieveTimelineResponse,
+    type AnalyticsRetrieveTimelineParams as AnalyticsRetrieveTimelineParams,
   };
 
   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,
   };
 
@@ -492,18 +441,43 @@ export declare namespace Analytics {
     type EventRecentParams as EventRecentParams,
   };
 
-  export {
-    Sessions as Sessions,
-    type SessionBounceRateParams as SessionBounceRateParams,
-    type SessionMetricsParams as SessionMetricsParams,
-  };
+  export { Sessions as Sessions };
 
-  export { Users as Users, type UserActiveParams as UserActiveParams };
+  export { Users as Users };
 
   export {
     Retention as Retention,
     type RetentionChurnRateParams as RetentionChurnRateParams,
     type RetentionCohortsParams as RetentionCohortsParams,
-    type RetentionReturnRateParams as RetentionReturnRateParams,
+  };
+
+  export {
+    Tiles as Tiles,
+    type TileGetBounceRateResponse as TileGetBounceRateResponse,
+    type TileGetDailyActiveUsersResponse as TileGetDailyActiveUsersResponse,
+    type TileGetMonthlyActiveUsersResponse as TileGetMonthlyActiveUsersResponse,
+    type TileGetPagesPerSessionResponse as TileGetPagesPerSessionResponse,
+    type TileGetReturnRateResponse as TileGetReturnRateResponse,
+    type TileGetSessionDurationResponse as TileGetSessionDurationResponse,
+    type TileGetTimeBetweenVisitsResponse as TileGetTimeBetweenVisitsResponse,
+    type TileGetTrafficByCountryResponse as TileGetTrafficByCountryResponse,
+    type TileGetTrafficByRefererResponse as TileGetTrafficByRefererResponse,
+    type TileGetTrafficByUtmResponse as TileGetTrafficByUtmResponse,
+    type TileGetUniqueSessionsResponse as TileGetUniqueSessionsResponse,
+    type TileGetUniqueVisitorsResponse as TileGetUniqueVisitorsResponse,
+    type TileGetWeeklyActiveUsersResponse as TileGetWeeklyActiveUsersResponse,
+    type TileGetBounceRateParams as TileGetBounceRateParams,
+    type TileGetDailyActiveUsersParams as TileGetDailyActiveUsersParams,
+    type TileGetMonthlyActiveUsersParams as TileGetMonthlyActiveUsersParams,
+    type TileGetPagesPerSessionParams as TileGetPagesPerSessionParams,
+    type TileGetReturnRateParams as TileGetReturnRateParams,
+    type TileGetSessionDurationParams as TileGetSessionDurationParams,
+    type TileGetTimeBetweenVisitsParams as TileGetTimeBetweenVisitsParams,
+    type TileGetTrafficByCountryParams as TileGetTrafficByCountryParams,
+    type TileGetTrafficByRefererParams as TileGetTrafficByRefererParams,
+    type TileGetTrafficByUtmParams as TileGetTrafficByUtmParams,
+    type TileGetUniqueSessionsParams as TileGetUniqueSessionsParams,
+    type TileGetUniqueVisitorsParams as TileGetUniqueVisitorsParams,
+    type TileGetWeeklyActiveUsersParams as TileGetWeeklyActiveUsersParams,
   };
 }

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

@@ -7,7 +7,8 @@ import { RequestOptions } from '../../../internal/request-options';
 
 export class Events extends APIResource {
   /**
-   * Get unique traffic origins and page paths to populate filter dropdowns
+   * Get unique traffic origins, page paths, and event names to populate filter
+   * dropdowns
    *
    * @example
    * ```ts
@@ -27,7 +28,7 @@ export class Events extends APIResource {
 
   /**
    * Get a list of recent events with optional filters (visitor_id, user_id,
-   * external_id, traffic_origin, page_path)
+   * external_id, traffic_origin, page_path, event_name)
    *
    * @example
    * ```ts
@@ -70,19 +71,21 @@ export interface EventRecentParams {
 
   customer_id?: string;
 
-  externalID?: string;
+  event_name?: string;
+
+  external_id?: string;
 
   limit?: number;
 
   offset?: number;
 
-  pagePath?: string;
+  page_path?: string;
 
   referrer?: string;
 
-  trafficOrigin?: string;
+  traffic_origin?: string;
 
-  userID?: string;
+  user_id?: string;
 
   utmtag?: string;
 

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

@@ -2,51 +2,61 @@
 
 export {
   Analytics,
-  type ActiveUsersResponse,
-  type BounceRateByPageMetric,
-  type BounceRateResponse,
   type ChurnRateResponse,
   type CohortAnalysisResponse,
   type CohortData,
-  type CountryDataPoint,
-  type DashboardMetricsResponse,
   type EventFilterOptionsResponse,
   type EventsOverTimeDataPoint,
   type ManualIdentifyRequest,
   type ManualIdentifyResponse,
-  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,
+  type AnalyticsRetrieveTimelineResponse,
+  type AnalyticsRetrieveTimelineParams,
 } from './analytics';
 export { Events, type EventFilterOptionsParams, type EventRecentParams } from './events';
+export { Retention, type RetentionChurnRateParams, type RetentionCohortsParams } from './retention';
+export { Sessions } from './sessions';
 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 TileGetBounceRateResponse,
+  type TileGetDailyActiveUsersResponse,
+  type TileGetMonthlyActiveUsersResponse,
+  type TileGetPagesPerSessionResponse,
+  type TileGetReturnRateResponse,
+  type TileGetSessionDurationResponse,
+  type TileGetTimeBetweenVisitsResponse,
+  type TileGetTrafficByCountryResponse,
+  type TileGetTrafficByRefererResponse,
+  type TileGetTrafficByUtmResponse,
+  type TileGetUniqueSessionsResponse,
+  type TileGetUniqueVisitorsResponse,
+  type TileGetWeeklyActiveUsersResponse,
+  type TileGetBounceRateParams,
+  type TileGetDailyActiveUsersParams,
+  type TileGetMonthlyActiveUsersParams,
+  type TileGetPagesPerSessionParams,
+  type TileGetReturnRateParams,
+  type TileGetSessionDurationParams,
+  type TileGetTimeBetweenVisitsParams,
+  type TileGetTrafficByCountryParams,
+  type TileGetTrafficByRefererParams,
+  type TileGetTrafficByUtmParams,
+  type TileGetUniqueSessionsParams,
+  type TileGetUniqueVisitorsParams,
+  type TileGetWeeklyActiveUsersParams,
+} from './tiles';
+export { Users } from './users';
 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,
   };
 }

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

@@ -1,93 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import * as AnalyticsAPI from './analytics';
-import { APIPromise } from '../../../core/api-promise';
-import { RequestOptions } from '../../../internal/request-options';
 
-export class Sessions extends APIResource {
-  /**
-   * Get bounce rate metrics including overall bounce rate and per-page breakdown
-   *
-   * @example
-   * ```ts
-   * const bounceRateResponse =
-   *   await client.v1.analytics.sessions.bounceRate({
-   *     project_id: 'project_id',
-   *     time_range: 'last_hour',
-   *   });
-   * ```
-   */
-  bounceRate(
-    query: SessionBounceRateParams,
-    options?: RequestOptions,
-  ): APIPromise<AnalyticsAPI.BounceRateResponse> {
-    return this._client.get('/api/v1/analytics/sessions/bounce-rate', { query, ...options });
-  }
-
-  /**
-   * Get session metrics including average duration and pages per session
-   *
-   * @example
-   * ```ts
-   * const sessionMetricsResponse =
-   *   await client.v1.analytics.sessions.metrics({
-   *     project_id: 'project_id',
-   *     time_range: 'last_hour',
-   *   });
-   * ```
-   */
-  metrics(
-    query: SessionMetricsParams,
-    options?: RequestOptions,
-  ): APIPromise<AnalyticsAPI.SessionMetricsResponse> {
-    return this._client.get('/api/v1/analytics/sessions/metrics', { query, ...options });
-  }
-}
-
-export interface SessionBounceRateParams {
-  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 interface SessionMetricsParams {
-  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 Sessions {
-  export {
-    type SessionBounceRateParams as SessionBounceRateParams,
-    type SessionMetricsParams as SessionMetricsParams,
-  };
-}
+export class Sessions extends APIResource {}