zorihq 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/package.json +2 -2
  3. package/resources/v1/analytics/analytics.d.mts +110 -2
  4. package/resources/v1/analytics/analytics.d.mts.map +1 -1
  5. package/resources/v1/analytics/analytics.d.ts +110 -2
  6. package/resources/v1/analytics/analytics.d.ts.map +1 -1
  7. package/resources/v1/analytics/analytics.js +28 -0
  8. package/resources/v1/analytics/analytics.js.map +1 -1
  9. package/resources/v1/analytics/analytics.mjs +28 -0
  10. package/resources/v1/analytics/analytics.mjs.map +1 -1
  11. package/resources/v1/analytics/index.d.mts +4 -1
  12. package/resources/v1/analytics/index.d.mts.map +1 -1
  13. package/resources/v1/analytics/index.d.ts +4 -1
  14. package/resources/v1/analytics/index.d.ts.map +1 -1
  15. package/resources/v1/analytics/index.js +7 -1
  16. package/resources/v1/analytics/index.js.map +1 -1
  17. package/resources/v1/analytics/index.mjs +3 -0
  18. package/resources/v1/analytics/index.mjs.map +1 -1
  19. package/resources/v1/analytics/retention.d.mts +83 -0
  20. package/resources/v1/analytics/retention.d.mts.map +1 -0
  21. package/resources/v1/analytics/retention.d.ts +83 -0
  22. package/resources/v1/analytics/retention.d.ts.map +1 -0
  23. package/resources/v1/analytics/retention.js +54 -0
  24. package/resources/v1/analytics/retention.js.map +1 -0
  25. package/resources/v1/analytics/retention.mjs +50 -0
  26. package/resources/v1/analytics/retention.mjs.map +1 -0
  27. package/resources/v1/analytics/sessions.d.mts +60 -0
  28. package/resources/v1/analytics/sessions.d.mts.map +1 -0
  29. package/resources/v1/analytics/sessions.d.ts +60 -0
  30. package/resources/v1/analytics/sessions.d.ts.map +1 -0
  31. package/resources/v1/analytics/sessions.js +39 -0
  32. package/resources/v1/analytics/sessions.js.map +1 -0
  33. package/resources/v1/analytics/sessions.mjs +35 -0
  34. package/resources/v1/analytics/sessions.mjs.map +1 -0
  35. package/resources/v1/analytics/users.d.mts +28 -0
  36. package/resources/v1/analytics/users.d.mts.map +1 -0
  37. package/resources/v1/analytics/users.d.ts +28 -0
  38. package/resources/v1/analytics/users.d.ts.map +1 -0
  39. package/resources/v1/analytics/users.js +23 -0
  40. package/resources/v1/analytics/users.js.map +1 -0
  41. package/resources/v1/analytics/users.mjs +19 -0
  42. package/resources/v1/analytics/users.mjs.map +1 -0
  43. package/resources/v1/index.d.mts +1 -1
  44. package/resources/v1/index.d.mts.map +1 -1
  45. package/resources/v1/index.d.ts +1 -1
  46. package/resources/v1/index.d.ts.map +1 -1
  47. package/resources/v1/index.js.map +1 -1
  48. package/resources/v1/index.mjs.map +1 -1
  49. package/resources/v1/v1.d.mts +2 -2
  50. package/resources/v1/v1.d.mts.map +1 -1
  51. package/resources/v1/v1.d.ts +2 -2
  52. package/resources/v1/v1.d.ts.map +1 -1
  53. package/resources/v1/v1.js.map +1 -1
  54. package/resources/v1/v1.mjs.map +1 -1
  55. package/src/resources/v1/analytics/analytics.ts +185 -2
  56. package/src/resources/v1/analytics/index.ts +18 -0
  57. package/src/resources/v1/analytics/retention.ts +114 -0
  58. package/src/resources/v1/analytics/sessions.ts +82 -0
  59. package/src/resources/v1/analytics/users.ts +34 -0
  60. package/src/resources/v1/index.ts +10 -0
  61. package/src/resources/v1/v1.ts +20 -0
  62. package/src/version.ts +1 -1
  63. package/version.d.mts +1 -1
  64. package/version.d.ts +1 -1
  65. package/version.js +1 -1
  66. package/version.mjs +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/v1/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,EACL,IAAI,EACJ,KAAK,OAAO,EACZ,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,KAAK,iCAAiC,EACtC,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,iCAAiC,GACvC;OACM,EACL,QAAQ,EACR,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,OAAO,EACZ,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,GACzB;OACM,EAAE,EAAE,EAAE"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/v1/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,EACL,IAAI,EACJ,KAAK,OAAO,EACZ,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,KAAK,iCAAiC,EACtC,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,iCAAiC,GACvC;OACM,EACL,QAAQ,EACR,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,OAAO,EACZ,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,GACzB;OACM,EAAE,EAAE,EAAE"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/v1/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8CAiB2B;AAhBzB,kGAAA,SAAS,OAAA;AAiBX,kCAYgB;AAXd,4FAAA,IAAI,OAAA;AAYN,0CAUoB;AATlB,oGAAA,QAAQ,OAAA;AAUV,8BAA0B;AAAjB,wFAAA,EAAE,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/v1/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8CA2B2B;AA1BzB,kGAAA,SAAS,OAAA;AA2BX,kCAYgB;AAXd,4FAAA,IAAI,OAAA;AAYN,0CAUoB;AATlB,oGAAA,QAAQ,OAAA;AAUV,8BAA0B;AAAjB,wFAAA,EAAE,OAAA"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/v1/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,SAAS,GAgBV;OACM,EACL,IAAI,GAWL;OACM,EACL,QAAQ,GAST;OACM,EAAE,EAAE,EAAE"}
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/v1/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,SAAS,GA0BV;OACM,EACL,IAAI,GAWL;OACM,EACL,QAAQ,GAST;OACM,EAAE,EAAE,EAAE"}
@@ -4,14 +4,14 @@ import { Account, Auth, AuthConfirmPasswordRecoveryParams, AuthLoginParams, Auth
4
4
  import * as ProjectsAPI from "./projects.mjs";
5
5
  import { CreateProjectRequest, ListProjectsResponse, Project, ProjectCreateParams, ProjectDeleteResponse, ProjectResponse, ProjectUpdateParams, Projects, UpdateProjectRequest } from "./projects.mjs";
6
6
  import * as AnalyticsAPI from "./analytics/analytics.mjs";
7
- import { Analytics, CountryDataPoint, EventsOverTimeDataPoint, OriginDataPoint, RecentEvent, RecentEventsResponse, TopVisitor, TopVisitorsResponse, UniqueVisitorsDataPoint, UniqueVisitorsTimelineResponse, VisitorDataPoint, VisitorEvent, VisitorProfileResponse, VisitorsByCountryResponse, VisitorsByDeviceResponse, VisitorsByOriginResponse } from "./analytics/analytics.mjs";
7
+ import { ActiveUsersResponse, Analytics, AnalyticsDashboardParams, BounceRateByPageMetric, BounceRateResponse, ChurnRateResponse, CohortAnalysisResponse, CohortData, CountryDataPoint, DashboardMetricsResponse, EventsOverTimeDataPoint, OriginDataPoint, RecentEvent, RecentEventsResponse, ReturnRateResponse, SessionMetricsResponse, TopVisitor, TopVisitorsResponse, UniqueVisitorsDataPoint, UniqueVisitorsTimelineResponse, VisitorDataPoint, VisitorEvent, VisitorProfileResponse, VisitorsByCountryResponse, VisitorsByDeviceResponse, VisitorsByOriginResponse } from "./analytics/analytics.mjs";
8
8
  export declare class V1 extends APIResource {
9
9
  analytics: AnalyticsAPI.Analytics;
10
10
  projects: ProjectsAPI.Projects;
11
11
  auth: AuthAPI.Auth;
12
12
  }
13
13
  export declare namespace V1 {
14
- export { Analytics as Analytics, 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, };
14
+ export { Analytics as Analytics, 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, };
15
15
  export { Projects as Projects, type CreateProjectRequest as CreateProjectRequest, type ListProjectsResponse as ListProjectsResponse, type Project as Project, type ProjectResponse as ProjectResponse, type UpdateProjectRequest as UpdateProjectRequest, type ProjectDeleteResponse as ProjectDeleteResponse, type ProjectCreateParams as ProjectCreateParams, type ProjectUpdateParams as ProjectUpdateParams, };
16
16
  export { Auth as Auth, type Account as Account, type AuthResponse as AuthResponse, type MessageResponse as MessageResponse, type Organization as Organization, type AuthConfirmPasswordRecoveryParams as AuthConfirmPasswordRecoveryParams, type AuthLoginParams as AuthLoginParams, type AuthLogoutParams as AuthLogoutParams, type AuthRefreshAccessTokenParams as AuthRefreshAccessTokenParams, type AuthRegisterAccountParams as AuthRegisterAccountParams, type AuthRequestPasswordRecoveryParams as AuthRequestPasswordRecoveryParams, };
17
17
  }
@@ -1 +1 @@
1
- {"version":3,"file":"v1.d.mts","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,EACL,OAAO,EACP,IAAI,EACJ,iCAAiC,EACjC,eAAe,EACf,gBAAgB,EAChB,4BAA4B,EAC5B,yBAAyB,EACzB,iCAAiC,EACjC,YAAY,EACZ,eAAe,EACf,YAAY,EACb;OACM,KAAK,WAAW;OAChB,EACL,oBAAoB,EACpB,oBAAoB,EACpB,OAAO,EACP,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,EACf,mBAAmB,EACnB,QAAQ,EACR,oBAAoB,EACrB;OACM,KAAK,YAAY;OACjB,EACL,SAAS,EACT,gBAAgB,EAChB,uBAAuB,EACvB,eAAe,EACf,WAAW,EACX,oBAAoB,EACpB,UAAU,EACV,mBAAmB,EACnB,uBAAuB,EACvB,8BAA8B,EAC9B,gBAAgB,EAChB,YAAY,EACZ,sBAAsB,EACtB,yBAAyB,EACzB,wBAAwB,EACxB,wBAAwB,EACzB;AAED,qBAAa,EAAG,SAAQ,WAAW;IACjC,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;CACrD;AAMD,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,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,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
1
+ {"version":3,"file":"v1.d.mts","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,EACL,OAAO,EACP,IAAI,EACJ,iCAAiC,EACjC,eAAe,EACf,gBAAgB,EAChB,4BAA4B,EAC5B,yBAAyB,EACzB,iCAAiC,EACjC,YAAY,EACZ,eAAe,EACf,YAAY,EACb;OACM,KAAK,WAAW;OAChB,EACL,oBAAoB,EACpB,oBAAoB,EACpB,OAAO,EACP,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,EACf,mBAAmB,EACnB,QAAQ,EACR,oBAAoB,EACrB;OACM,KAAK,YAAY;OACjB,EACL,mBAAmB,EACnB,SAAS,EACT,wBAAwB,EACxB,sBAAsB,EACtB,kBAAkB,EAClB,iBAAiB,EACjB,sBAAsB,EACtB,UAAU,EACV,gBAAgB,EAChB,wBAAwB,EACxB,uBAAuB,EACvB,eAAe,EACf,WAAW,EACX,oBAAoB,EACpB,kBAAkB,EAClB,sBAAsB,EACtB,UAAU,EACV,mBAAmB,EACnB,uBAAuB,EACvB,8BAA8B,EAC9B,gBAAgB,EAChB,YAAY,EACZ,sBAAsB,EACtB,yBAAyB,EACzB,wBAAwB,EACxB,wBAAwB,EACzB;AAED,qBAAa,EAAG,SAAQ,WAAW;IACjC,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;CACrD;AAMD,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,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,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
@@ -4,14 +4,14 @@ import { Account, Auth, AuthConfirmPasswordRecoveryParams, AuthLoginParams, Auth
4
4
  import * as ProjectsAPI from "./projects.js";
5
5
  import { CreateProjectRequest, ListProjectsResponse, Project, ProjectCreateParams, ProjectDeleteResponse, ProjectResponse, ProjectUpdateParams, Projects, UpdateProjectRequest } from "./projects.js";
6
6
  import * as AnalyticsAPI from "./analytics/analytics.js";
7
- import { Analytics, CountryDataPoint, EventsOverTimeDataPoint, OriginDataPoint, RecentEvent, RecentEventsResponse, TopVisitor, TopVisitorsResponse, UniqueVisitorsDataPoint, UniqueVisitorsTimelineResponse, VisitorDataPoint, VisitorEvent, VisitorProfileResponse, VisitorsByCountryResponse, VisitorsByDeviceResponse, VisitorsByOriginResponse } from "./analytics/analytics.js";
7
+ import { ActiveUsersResponse, Analytics, AnalyticsDashboardParams, BounceRateByPageMetric, BounceRateResponse, ChurnRateResponse, CohortAnalysisResponse, CohortData, CountryDataPoint, DashboardMetricsResponse, EventsOverTimeDataPoint, OriginDataPoint, RecentEvent, RecentEventsResponse, ReturnRateResponse, SessionMetricsResponse, TopVisitor, TopVisitorsResponse, UniqueVisitorsDataPoint, UniqueVisitorsTimelineResponse, VisitorDataPoint, VisitorEvent, VisitorProfileResponse, VisitorsByCountryResponse, VisitorsByDeviceResponse, VisitorsByOriginResponse } from "./analytics/analytics.js";
8
8
  export declare class V1 extends APIResource {
9
9
  analytics: AnalyticsAPI.Analytics;
10
10
  projects: ProjectsAPI.Projects;
11
11
  auth: AuthAPI.Auth;
12
12
  }
13
13
  export declare namespace V1 {
14
- export { Analytics as Analytics, 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, };
14
+ export { Analytics as Analytics, 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, };
15
15
  export { Projects as Projects, type CreateProjectRequest as CreateProjectRequest, type ListProjectsResponse as ListProjectsResponse, type Project as Project, type ProjectResponse as ProjectResponse, type UpdateProjectRequest as UpdateProjectRequest, type ProjectDeleteResponse as ProjectDeleteResponse, type ProjectCreateParams as ProjectCreateParams, type ProjectUpdateParams as ProjectUpdateParams, };
16
16
  export { Auth as Auth, type Account as Account, type AuthResponse as AuthResponse, type MessageResponse as MessageResponse, type Organization as Organization, type AuthConfirmPasswordRecoveryParams as AuthConfirmPasswordRecoveryParams, type AuthLoginParams as AuthLoginParams, type AuthLogoutParams as AuthLogoutParams, type AuthRefreshAccessTokenParams as AuthRefreshAccessTokenParams, type AuthRegisterAccountParams as AuthRegisterAccountParams, type AuthRequestPasswordRecoveryParams as AuthRequestPasswordRecoveryParams, };
17
17
  }
@@ -1 +1 @@
1
- {"version":3,"file":"v1.d.ts","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,EACL,OAAO,EACP,IAAI,EACJ,iCAAiC,EACjC,eAAe,EACf,gBAAgB,EAChB,4BAA4B,EAC5B,yBAAyB,EACzB,iCAAiC,EACjC,YAAY,EACZ,eAAe,EACf,YAAY,EACb;OACM,KAAK,WAAW;OAChB,EACL,oBAAoB,EACpB,oBAAoB,EACpB,OAAO,EACP,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,EACf,mBAAmB,EACnB,QAAQ,EACR,oBAAoB,EACrB;OACM,KAAK,YAAY;OACjB,EACL,SAAS,EACT,gBAAgB,EAChB,uBAAuB,EACvB,eAAe,EACf,WAAW,EACX,oBAAoB,EACpB,UAAU,EACV,mBAAmB,EACnB,uBAAuB,EACvB,8BAA8B,EAC9B,gBAAgB,EAChB,YAAY,EACZ,sBAAsB,EACtB,yBAAyB,EACzB,wBAAwB,EACxB,wBAAwB,EACzB;AAED,qBAAa,EAAG,SAAQ,WAAW;IACjC,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;CACrD;AAMD,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,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,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
1
+ {"version":3,"file":"v1.d.ts","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,EACL,OAAO,EACP,IAAI,EACJ,iCAAiC,EACjC,eAAe,EACf,gBAAgB,EAChB,4BAA4B,EAC5B,yBAAyB,EACzB,iCAAiC,EACjC,YAAY,EACZ,eAAe,EACf,YAAY,EACb;OACM,KAAK,WAAW;OAChB,EACL,oBAAoB,EACpB,oBAAoB,EACpB,OAAO,EACP,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,EACf,mBAAmB,EACnB,QAAQ,EACR,oBAAoB,EACrB;OACM,KAAK,YAAY;OACjB,EACL,mBAAmB,EACnB,SAAS,EACT,wBAAwB,EACxB,sBAAsB,EACtB,kBAAkB,EAClB,iBAAiB,EACjB,sBAAsB,EACtB,UAAU,EACV,gBAAgB,EAChB,wBAAwB,EACxB,uBAAuB,EACvB,eAAe,EACf,WAAW,EACX,oBAAoB,EACpB,kBAAkB,EAClB,sBAAsB,EACtB,UAAU,EACV,mBAAmB,EACnB,uBAAuB,EACvB,8BAA8B,EAC9B,gBAAgB,EAChB,YAAY,EACZ,sBAAsB,EACtB,yBAAyB,EACzB,wBAAwB,EACxB,wBAAwB,EACzB;AAED,qBAAa,EAAG,SAAQ,WAAW;IACjC,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;CACrD;AAMD,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,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,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
@@ -1 +1 @@
1
- {"version":3,"file":"v1.js","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,2DAAkC;AAClC,oCAYgB;AAChB,mEAA0C;AAC1C,4CAUoB;AACpB,+EAAsD;AACtD,wDAiB+B;AAE/B,MAAa,EAAG,SAAQ,sBAAW;IAAnC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;CAAA;AAJD,gBAIC;AAED,EAAE,CAAC,SAAS,GAAG,qBAAS,CAAC;AACzB,EAAE,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACvB,EAAE,CAAC,IAAI,GAAG,WAAI,CAAC"}
1
+ {"version":3,"file":"v1.js","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,2DAAkC;AAClC,oCAYgB;AAChB,mEAA0C;AAC1C,4CAUoB;AACpB,+EAAsD;AACtD,wDA2B+B;AAE/B,MAAa,EAAG,SAAQ,sBAAW;IAAnC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;CAAA;AAJD,gBAIC;AAED,EAAE,CAAC,SAAS,GAAG,qBAAS,CAAC;AACzB,EAAE,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACvB,EAAE,CAAC,IAAI,GAAG,WAAI,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"v1.mjs","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,EAEL,IAAI,GAUL;OACM,KAAK,WAAW;OAChB,EAQL,QAAQ,GAET;OACM,KAAK,YAAY;OACjB,EACL,SAAS,GAgBV;AAED,MAAM,OAAO,EAAG,SAAQ,WAAW;IAAnC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;CAAA;AAED,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC;AACzB,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC"}
1
+ {"version":3,"file":"v1.mjs","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,EAEL,IAAI,GAUL;OACM,KAAK,WAAW;OAChB,EAQL,QAAQ,GAET;OACM,KAAK,YAAY;OACjB,EAEL,SAAS,GAyBV;AAED,MAAM,OAAO,EAAG,SAAQ,WAAW;IAAnC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;CAAA;AAED,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC;AACzB,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC"}
@@ -3,6 +3,17 @@
3
3
  import { APIResource } from '../../../core/resource';
4
4
  import * as EventsAPI from './events';
5
5
  import { EventRecentParams, Events } from './events';
6
+ import * as RetentionAPI from './retention';
7
+ import {
8
+ Retention,
9
+ RetentionChurnRateParams,
10
+ RetentionCohortsParams,
11
+ RetentionReturnRateParams,
12
+ } from './retention';
13
+ import * as SessionsAPI from './sessions';
14
+ import { SessionBounceRateParams, SessionMetricsParams, Sessions } from './sessions';
15
+ import * as UsersAPI from './users';
16
+ import { UserActiveParams, Users } from './users';
6
17
  import * as VisitorsAPI from './visitors';
7
18
  import {
8
19
  VisitorByCountryParams,
@@ -13,16 +24,130 @@ import {
13
24
  VisitorTopParams,
14
25
  Visitors,
15
26
  } from './visitors';
27
+ import { APIPromise } from '../../../core/api-promise';
28
+ import { RequestOptions } from '../../../internal/request-options';
16
29
 
17
30
  export class Analytics extends APIResource {
18
31
  visitors: VisitorsAPI.Visitors = new VisitorsAPI.Visitors(this._client);
19
32
  events: EventsAPI.Events = new EventsAPI.Events(this._client);
33
+ sessions: SessionsAPI.Sessions = new SessionsAPI.Sessions(this._client);
34
+ users: UsersAPI.Users = new UsersAPI.Users(this._client);
35
+ retention: RetentionAPI.Retention = new RetentionAPI.Retention(this._client);
36
+
37
+ /**
38
+ * Get combined key metrics including sessions, active users, bounce rate, and
39
+ * retention for dashboard display
40
+ *
41
+ * @example
42
+ * ```ts
43
+ * const dashboardMetricsResponse =
44
+ * await client.v1.analytics.dashboard({
45
+ * project_id: 'project_id',
46
+ * time_range: 'last_hour',
47
+ * });
48
+ * ```
49
+ */
50
+ dashboard(query: AnalyticsDashboardParams, options?: RequestOptions): APIPromise<DashboardMetricsResponse> {
51
+ return this._client.get('/api/v1/analytics/dashboard', { query, ...options });
52
+ }
53
+ }
54
+
55
+ export interface ActiveUsersResponse {
56
+ dau?: number;
57
+
58
+ mau?: number;
59
+
60
+ wau?: number;
61
+ }
62
+
63
+ export interface BounceRateByPageMetric {
64
+ bounce_rate?: number;
65
+
66
+ page?: string;
67
+
68
+ sessions?: number;
69
+ }
70
+
71
+ export interface BounceRateResponse {
72
+ by_page?: Array<BounceRateByPageMetric>;
73
+
74
+ overall_bounce_rate?: number;
75
+ }
76
+
77
+ export interface ChurnRateResponse {
78
+ churn_rate_percent?: number;
79
+
80
+ churn_threshold_days?: number;
81
+
82
+ churned_users?: number;
83
+
84
+ total_users?: number;
85
+ }
86
+
87
+ export interface CohortAnalysisResponse {
88
+ cohorts?: Array<CohortData>;
89
+ }
90
+
91
+ export interface CohortData {
92
+ cohort_period?: string;
93
+
94
+ cohort_size?: number;
95
+
96
+ month_1_retention?: number;
97
+
98
+ month_2_retention?: number;
99
+
100
+ month_3_retention?: number;
101
+
102
+ week_1_retention?: number;
103
+
104
+ week_2_retention?: number;
105
+
106
+ week_4_retention?: number;
20
107
  }
21
108
 
22
109
  export interface CountryDataPoint {
23
110
  country_code?: string;
24
111
 
112
+ percentage?: number;
113
+
114
+ unique_visitors?: number;
115
+ }
116
+
117
+ export interface DashboardMetricsResponse {
118
+ avg_pages_per_session?: number;
119
+
120
+ avg_session_duration_seconds?: number;
121
+
122
+ /**
123
+ * Engagement metrics
124
+ */
125
+ bounce_rate?: number;
126
+
127
+ /**
128
+ * Active users
129
+ */
130
+ dau?: number;
131
+
132
+ mau?: number;
133
+
134
+ return_rate?: number;
135
+
136
+ /**
137
+ * Sessions
138
+ */
139
+ sessions_today?: number;
140
+
141
+ /**
142
+ * Total metrics
143
+ */
144
+ total_events?: number;
145
+
146
+ total_sessions_in_period?: number;
147
+
25
148
  unique_visitors?: number;
149
+
150
+ wau?: number;
26
151
  }
27
152
 
28
153
  export interface EventsOverTimeDataPoint {
@@ -34,6 +159,8 @@ export interface EventsOverTimeDataPoint {
34
159
  export interface OriginDataPoint {
35
160
  origin?: string;
36
161
 
162
+ percentage?: number;
163
+
37
164
  unique_visitors?: number;
38
165
  }
39
166
 
@@ -65,6 +192,24 @@ export interface RecentEventsResponse {
65
192
  total?: number;
66
193
  }
67
194
 
195
+ export interface ReturnRateResponse {
196
+ avg_time_between_sessions_hours?: number;
197
+
198
+ return_rate_percent?: number;
199
+
200
+ returning_users?: number;
201
+
202
+ total_users?: number;
203
+ }
204
+
205
+ export interface SessionMetricsResponse {
206
+ average_pages_per_session?: number;
207
+
208
+ average_session_duration_seconds?: number;
209
+
210
+ total_sessions?: number;
211
+ }
212
+
68
213
  export interface TopVisitor {
69
214
  browser_name?: string;
70
215
 
@@ -106,8 +251,6 @@ export interface VisitorDataPoint {
106
251
 
107
252
  mobile?: number;
108
253
 
109
- tablet?: number;
110
-
111
254
  timestamp?: string;
112
255
 
113
256
  unknown?: number;
@@ -163,16 +306,40 @@ export interface VisitorsByOriginResponse {
163
306
  data?: Array<OriginDataPoint>;
164
307
  }
165
308
 
309
+ export interface AnalyticsDashboardParams {
310
+ /**
311
+ * Project ID
312
+ */
313
+ project_id: string;
314
+
315
+ /**
316
+ * Time range
317
+ */
318
+ time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
319
+ }
320
+
166
321
  Analytics.Visitors = Visitors;
167
322
  Analytics.Events = Events;
323
+ Analytics.Sessions = Sessions;
324
+ Analytics.Users = Users;
325
+ Analytics.Retention = Retention;
168
326
 
169
327
  export declare namespace Analytics {
170
328
  export {
329
+ type ActiveUsersResponse as ActiveUsersResponse,
330
+ type BounceRateByPageMetric as BounceRateByPageMetric,
331
+ type BounceRateResponse as BounceRateResponse,
332
+ type ChurnRateResponse as ChurnRateResponse,
333
+ type CohortAnalysisResponse as CohortAnalysisResponse,
334
+ type CohortData as CohortData,
171
335
  type CountryDataPoint as CountryDataPoint,
336
+ type DashboardMetricsResponse as DashboardMetricsResponse,
172
337
  type EventsOverTimeDataPoint as EventsOverTimeDataPoint,
173
338
  type OriginDataPoint as OriginDataPoint,
174
339
  type RecentEvent as RecentEvent,
175
340
  type RecentEventsResponse as RecentEventsResponse,
341
+ type ReturnRateResponse as ReturnRateResponse,
342
+ type SessionMetricsResponse as SessionMetricsResponse,
176
343
  type TopVisitor as TopVisitor,
177
344
  type TopVisitorsResponse as TopVisitorsResponse,
178
345
  type UniqueVisitorsDataPoint as UniqueVisitorsDataPoint,
@@ -183,6 +350,7 @@ export declare namespace Analytics {
183
350
  type VisitorsByCountryResponse as VisitorsByCountryResponse,
184
351
  type VisitorsByDeviceResponse as VisitorsByDeviceResponse,
185
352
  type VisitorsByOriginResponse as VisitorsByOriginResponse,
353
+ type AnalyticsDashboardParams as AnalyticsDashboardParams,
186
354
  };
187
355
 
188
356
  export {
@@ -196,4 +364,19 @@ export declare namespace Analytics {
196
364
  };
197
365
 
198
366
  export { Events as Events, type EventRecentParams as EventRecentParams };
367
+
368
+ export {
369
+ Sessions as Sessions,
370
+ type SessionBounceRateParams as SessionBounceRateParams,
371
+ type SessionMetricsParams as SessionMetricsParams,
372
+ };
373
+
374
+ export { Users as Users, type UserActiveParams as UserActiveParams };
375
+
376
+ export {
377
+ Retention as Retention,
378
+ type RetentionChurnRateParams as RetentionChurnRateParams,
379
+ type RetentionCohortsParams as RetentionCohortsParams,
380
+ type RetentionReturnRateParams as RetentionReturnRateParams,
381
+ };
199
382
  }
@@ -2,11 +2,20 @@
2
2
 
3
3
  export {
4
4
  Analytics,
5
+ type ActiveUsersResponse,
6
+ type BounceRateByPageMetric,
7
+ type BounceRateResponse,
8
+ type ChurnRateResponse,
9
+ type CohortAnalysisResponse,
10
+ type CohortData,
5
11
  type CountryDataPoint,
12
+ type DashboardMetricsResponse,
6
13
  type EventsOverTimeDataPoint,
7
14
  type OriginDataPoint,
8
15
  type RecentEvent,
9
16
  type RecentEventsResponse,
17
+ type ReturnRateResponse,
18
+ type SessionMetricsResponse,
10
19
  type TopVisitor,
11
20
  type TopVisitorsResponse,
12
21
  type UniqueVisitorsDataPoint,
@@ -17,8 +26,17 @@ export {
17
26
  type VisitorsByCountryResponse,
18
27
  type VisitorsByDeviceResponse,
19
28
  type VisitorsByOriginResponse,
29
+ type AnalyticsDashboardParams,
20
30
  } from './analytics';
21
31
  export { Events, type EventRecentParams } from './events';
32
+ export {
33
+ Retention,
34
+ type RetentionChurnRateParams,
35
+ type RetentionCohortsParams,
36
+ type RetentionReturnRateParams,
37
+ } from './retention';
38
+ export { Sessions, type SessionBounceRateParams, type SessionMetricsParams } from './sessions';
39
+ export { Users, type UserActiveParams } from './users';
22
40
  export {
23
41
  Visitors,
24
42
  type VisitorByCountryParams,
@@ -0,0 +1,114 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../../core/resource';
4
+ import * as AnalyticsAPI from './analytics';
5
+ import { APIPromise } from '../../../core/api-promise';
6
+ import { RequestOptions } from '../../../internal/request-options';
7
+
8
+ export class Retention extends APIResource {
9
+ /**
10
+ * Get metrics about user churn based on inactivity threshold
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const churnRateResponse =
15
+ * await client.v1.analytics.retention.churnRate({
16
+ * project_id: 'project_id',
17
+ * time_range: 'last_hour',
18
+ * });
19
+ * ```
20
+ */
21
+ churnRate(
22
+ query: RetentionChurnRateParams,
23
+ options?: RequestOptions,
24
+ ): APIPromise<AnalyticsAPI.ChurnRateResponse> {
25
+ return this._client.get('/api/v1/analytics/retention/churn-rate', { query, ...options });
26
+ }
27
+
28
+ /**
29
+ * Get cohort retention analysis showing how user groups retain over time
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * const cohortAnalysisResponse =
34
+ * await client.v1.analytics.retention.cohorts({
35
+ * project_id: 'project_id',
36
+ * time_range: 'last_hour',
37
+ * });
38
+ * ```
39
+ */
40
+ cohorts(
41
+ query: RetentionCohortsParams,
42
+ options?: RequestOptions,
43
+ ): APIPromise<AnalyticsAPI.CohortAnalysisResponse> {
44
+ return this._client.get('/api/v1/analytics/retention/cohorts', { query, ...options });
45
+ }
46
+
47
+ /**
48
+ * Get metrics about user return rate and time between sessions
49
+ *
50
+ * @example
51
+ * ```ts
52
+ * const returnRateResponse =
53
+ * await client.v1.analytics.retention.returnRate({
54
+ * project_id: 'project_id',
55
+ * time_range: 'last_hour',
56
+ * });
57
+ * ```
58
+ */
59
+ returnRate(
60
+ query: RetentionReturnRateParams,
61
+ options?: RequestOptions,
62
+ ): APIPromise<AnalyticsAPI.ReturnRateResponse> {
63
+ return this._client.get('/api/v1/analytics/retention/return-rate', { query, ...options });
64
+ }
65
+ }
66
+
67
+ export interface RetentionChurnRateParams {
68
+ /**
69
+ * Project ID
70
+ */
71
+ project_id: string;
72
+
73
+ /**
74
+ * Time range
75
+ */
76
+ time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
77
+
78
+ /**
79
+ * Days of inactivity to consider churned (default: 30)
80
+ */
81
+ churn_threshold_days?: number;
82
+ }
83
+
84
+ export interface RetentionCohortsParams {
85
+ /**
86
+ * Project ID
87
+ */
88
+ project_id: string;
89
+
90
+ /**
91
+ * Time range
92
+ */
93
+ time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
94
+ }
95
+
96
+ export interface RetentionReturnRateParams {
97
+ /**
98
+ * Project ID
99
+ */
100
+ project_id: string;
101
+
102
+ /**
103
+ * Time range
104
+ */
105
+ time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
106
+ }
107
+
108
+ export declare namespace Retention {
109
+ export {
110
+ type RetentionChurnRateParams as RetentionChurnRateParams,
111
+ type RetentionCohortsParams as RetentionCohortsParams,
112
+ type RetentionReturnRateParams as RetentionReturnRateParams,
113
+ };
114
+ }
@@ -0,0 +1,82 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../../core/resource';
4
+ import * as AnalyticsAPI from './analytics';
5
+ import { APIPromise } from '../../../core/api-promise';
6
+ import { RequestOptions } from '../../../internal/request-options';
7
+
8
+ export class Sessions extends APIResource {
9
+ /**
10
+ * Get bounce rate metrics including overall bounce rate and per-page breakdown
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const bounceRateResponse =
15
+ * await client.v1.analytics.sessions.bounceRate({
16
+ * project_id: 'project_id',
17
+ * time_range: 'last_hour',
18
+ * });
19
+ * ```
20
+ */
21
+ bounceRate(
22
+ query: SessionBounceRateParams,
23
+ options?: RequestOptions,
24
+ ): APIPromise<AnalyticsAPI.BounceRateResponse> {
25
+ return this._client.get('/api/v1/analytics/sessions/bounce-rate', { query, ...options });
26
+ }
27
+
28
+ /**
29
+ * Get session metrics including average duration and pages per session
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * const sessionMetricsResponse =
34
+ * await client.v1.analytics.sessions.metrics({
35
+ * project_id: 'project_id',
36
+ * time_range: 'last_hour',
37
+ * });
38
+ * ```
39
+ */
40
+ metrics(
41
+ query: SessionMetricsParams,
42
+ options?: RequestOptions,
43
+ ): APIPromise<AnalyticsAPI.SessionMetricsResponse> {
44
+ return this._client.get('/api/v1/analytics/sessions/metrics', { query, ...options });
45
+ }
46
+ }
47
+
48
+ export interface SessionBounceRateParams {
49
+ /**
50
+ * Project ID
51
+ */
52
+ project_id: string;
53
+
54
+ /**
55
+ * Time range
56
+ */
57
+ time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
58
+
59
+ /**
60
+ * Limit for per-page breakdown (default: 20)
61
+ */
62
+ limit?: number;
63
+ }
64
+
65
+ export interface SessionMetricsParams {
66
+ /**
67
+ * Project ID
68
+ */
69
+ project_id: string;
70
+
71
+ /**
72
+ * Time range
73
+ */
74
+ time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
75
+ }
76
+
77
+ export declare namespace Sessions {
78
+ export {
79
+ type SessionBounceRateParams as SessionBounceRateParams,
80
+ type SessionMetricsParams as SessionMetricsParams,
81
+ };
82
+ }
@@ -0,0 +1,34 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../../core/resource';
4
+ import * as AnalyticsAPI from './analytics';
5
+ import { APIPromise } from '../../../core/api-promise';
6
+ import { RequestOptions } from '../../../internal/request-options';
7
+
8
+ export class Users extends APIResource {
9
+ /**
10
+ * Get daily, weekly, and monthly active user counts
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const activeUsersResponse =
15
+ * await client.v1.analytics.users.active({
16
+ * project_id: 'project_id',
17
+ * });
18
+ * ```
19
+ */
20
+ active(query: UserActiveParams, options?: RequestOptions): APIPromise<AnalyticsAPI.ActiveUsersResponse> {
21
+ return this._client.get('/api/v1/analytics/users/active', { query, ...options });
22
+ }
23
+ }
24
+
25
+ export interface UserActiveParams {
26
+ /**
27
+ * Project ID
28
+ */
29
+ project_id: string;
30
+ }
31
+
32
+ export declare namespace Users {
33
+ export { type UserActiveParams as UserActiveParams };
34
+ }
@@ -2,11 +2,20 @@
2
2
 
3
3
  export {
4
4
  Analytics,
5
+ type ActiveUsersResponse,
6
+ type BounceRateByPageMetric,
7
+ type BounceRateResponse,
8
+ type ChurnRateResponse,
9
+ type CohortAnalysisResponse,
10
+ type CohortData,
5
11
  type CountryDataPoint,
12
+ type DashboardMetricsResponse,
6
13
  type EventsOverTimeDataPoint,
7
14
  type OriginDataPoint,
8
15
  type RecentEvent,
9
16
  type RecentEventsResponse,
17
+ type ReturnRateResponse,
18
+ type SessionMetricsResponse,
10
19
  type TopVisitor,
11
20
  type TopVisitorsResponse,
12
21
  type UniqueVisitorsDataPoint,
@@ -17,6 +26,7 @@ export {
17
26
  type VisitorsByCountryResponse,
18
27
  type VisitorsByDeviceResponse,
19
28
  type VisitorsByOriginResponse,
29
+ type AnalyticsDashboardParams,
20
30
  } from './analytics/index';
21
31
  export {
22
32
  Auth,