zorihq 0.15.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/client.d.mts +4 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +4 -4
- package/client.d.ts.map +1 -1
- package/client.js +15 -9
- package/client.js.map +1 -1
- package/client.mjs +15 -9
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/v1/analytics/analytics.d.mts +112 -27
- package/resources/v1/analytics/analytics.d.mts.map +1 -1
- package/resources/v1/analytics/analytics.d.ts +112 -27
- package/resources/v1/analytics/analytics.d.ts.map +1 -1
- package/resources/v1/analytics/analytics.js +8 -14
- package/resources/v1/analytics/analytics.js.map +1 -1
- package/resources/v1/analytics/analytics.mjs +8 -14
- package/resources/v1/analytics/analytics.mjs.map +1 -1
- package/resources/v1/analytics/index.d.mts +2 -4
- package/resources/v1/analytics/index.d.mts.map +1 -1
- package/resources/v1/analytics/index.d.ts +2 -4
- package/resources/v1/analytics/index.d.ts.map +1 -1
- package/resources/v1/analytics/index.js +1 -5
- package/resources/v1/analytics/index.js.map +1 -1
- package/resources/v1/analytics/index.mjs +0 -2
- package/resources/v1/analytics/index.mjs.map +1 -1
- package/resources/v1/analytics/tiles.d.mts +105 -134
- package/resources/v1/analytics/tiles.d.mts.map +1 -1
- package/resources/v1/analytics/tiles.d.ts +105 -134
- package/resources/v1/analytics/tiles.d.ts.map +1 -1
- package/resources/v1/analytics/tiles.js +74 -46
- package/resources/v1/analytics/tiles.js.map +1 -1
- package/resources/v1/analytics/tiles.mjs +74 -46
- package/resources/v1/analytics/tiles.mjs.map +1 -1
- package/resources/v1/index.d.mts +1 -1
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +1 -1
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/v1.d.mts +2 -2
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +2 -2
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs.map +1 -1
- package/src/client.ts +20 -14
- package/src/resources/v1/analytics/analytics.ts +214 -92
- package/src/resources/v1/analytics/index.ts +36 -30
- package/src/resources/v1/analytics/tiles.ts +149 -206
- package/src/resources/v1/index.ts +21 -2
- package/src/resources/v1/v1.ts +42 -4
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/v1/analytics/sessions.d.mts +0 -4
- package/resources/v1/analytics/sessions.d.mts.map +0 -1
- package/resources/v1/analytics/sessions.d.ts +0 -4
- package/resources/v1/analytics/sessions.d.ts.map +0 -1
- package/resources/v1/analytics/sessions.js +0 -9
- package/resources/v1/analytics/sessions.js.map +0 -1
- package/resources/v1/analytics/sessions.mjs +0 -5
- package/resources/v1/analytics/sessions.mjs.map +0 -1
- package/resources/v1/analytics/users.d.mts +0 -4
- package/resources/v1/analytics/users.d.mts.map +0 -1
- package/resources/v1/analytics/users.d.ts +0 -4
- package/resources/v1/analytics/users.d.ts.map +0 -1
- package/resources/v1/analytics/users.js +0 -9
- package/resources/v1/analytics/users.js.map +0 -1
- package/resources/v1/analytics/users.mjs +0 -5
- package/resources/v1/analytics/users.mjs.map +0 -1
- package/src/resources/v1/analytics/sessions.ts +0 -5
- package/src/resources/v1/analytics/users.ts +0 -5
|
@@ -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,EAAE,IAAI,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE;OACtD,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
|
|
1
|
+
{"version":3,"file":"v1.d.mts","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE;OACtD,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,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,EACb,iBAAiB,EACjB,sBAAsB,EACtB,UAAU,EACV,wBAAwB,EACxB,4BAA4B,EAC5B,WAAW,EACX,0BAA0B,EAC1B,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,WAAW,EACX,uBAAuB,EACvB,WAAW,EACX,oBAAoB,EACpB,wBAAwB,EACxB,4BAA4B,EAC5B,kBAAkB,EAClB,uBAAuB,EACvB,yBAAyB,EACzB,gBAAgB,EAChB,oBAAoB,EACpB,UAAU,EACV,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,gBAAgB,EAChB,YAAY,EACZ,sBAAsB,EACtB,yBAAyB,EACzB,wBAAwB,EACxB,oBAAoB,EACpB,WAAW,EACZ;OACM,KAAK,mBAAmB;OACxB,EACL,4BAA4B,EAC5B,4BAA4B,EAC5B,2BAA2B,EAC3B,6BAA6B,EAC7B,iCAAiC,EACjC,yBAAyB,EACzB,uBAAuB,EACvB,2BAA2B,EAC3B,gBAAgB,EAChB,aAAa,EACb,4BAA4B,EAC5B,4BAA4B,EAC7B;OACM,KAAK,UAAU;OACf,EACL,2BAA2B,EAC3B,wBAAwB,EACxB,yBAAyB,EACzB,uBAAuB,EACvB,iBAAiB,EACjB,0BAA0B,EAC1B,OAAO,EACP,OAAO,EACP,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,EACX,oBAAoB,EACpB,uBAAuB,EACxB;AAED,qBAAa,EAAG,SAAQ,WAAW;IACjC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IACpD,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,gBAAgB,EAAE,mBAAmB,CAAC,gBAAgB,CAEpD;CACH;AAQD,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,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,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,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,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
|
package/resources/v1/v1.d.ts
CHANGED
|
@@ -4,7 +4,7 @@ import { Auth, AuthLoginParams, LoginRequest, LoginResponse } from "./auth.js";
|
|
|
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,
|
|
7
|
+
import { Analytics, AnalyticsTimelineParams, BounceRateResponse, CardPrecision, ChurnRateResponse, CohortAnalysisResponse, CohortData, CountryTrafficSourceData, CountryTrafficSourceResponse, DauResponse, EventFilterOptionsResponse, EventsOverTimeDataPoint, ManualIdentifyRequest, ManualIdentifyResponse, MauResponse, PagesPerSessionResponse, RecentEvent, RecentEventsResponse, RefererTrafficSourceData, RefererTrafficSourceResponse, ReturnRateResponse, SessionDurationResponse, TimeBetweenVisitsResponse, TimelineTileData, TimelineTileResponse, TopVisitor, TopVisitorsResponse, UniqueSessionsResponse, UniqueVisitorsResponse, UtmTrafficSourceResponse, VisitorDataPoint, VisitorEvent, VisitorProfileResponse, VisitorsByBrowserResponse, VisitorsByDeviceResponse, VisitorsByOsResponse, WauResponse } from "./analytics/analytics.js";
|
|
8
8
|
import * as PaymentProvidersAPI from "./payment-providers/payment-providers.js";
|
|
9
9
|
import { CreatePaymentProviderRequest, ListPaymentProvidersResponse, PaymentProviderCreateParams, PaymentProviderDeleteResponse, PaymentProviderInstructionsParams, PaymentProviderListParams, PaymentProviderResponse, PaymentProviderUpdateParams, PaymentProviders, ProviderField, ProviderInstructionsResponse, UpdatePaymentProviderRequest } from "./payment-providers/payment-providers.js";
|
|
10
10
|
import * as RevenueAPI from "./revenue/revenue.js";
|
|
@@ -18,7 +18,7 @@ export declare class V1 extends APIResource {
|
|
|
18
18
|
}
|
|
19
19
|
export declare namespace V1 {
|
|
20
20
|
export { Auth as Auth, type LoginRequest as LoginRequest, type LoginResponse as LoginResponse, type AuthLoginParams as AuthLoginParams, };
|
|
21
|
-
export { Analytics as Analytics, type ChurnRateResponse as ChurnRateResponse, type CohortAnalysisResponse as CohortAnalysisResponse, type CohortData as CohortData, type EventFilterOptionsResponse as EventFilterOptionsResponse, type EventsOverTimeDataPoint as EventsOverTimeDataPoint, type ManualIdentifyRequest as ManualIdentifyRequest, type ManualIdentifyResponse as ManualIdentifyResponse, type RecentEvent as RecentEvent, type RecentEventsResponse as RecentEventsResponse, type TopVisitor as TopVisitor, type TopVisitorsResponse as TopVisitorsResponse, type VisitorDataPoint as VisitorDataPoint, type VisitorEvent as VisitorEvent, type VisitorProfileResponse as VisitorProfileResponse, type VisitorsByDeviceResponse as VisitorsByDeviceResponse, type
|
|
21
|
+
export { Analytics as Analytics, type BounceRateResponse as BounceRateResponse, type CardPrecision as CardPrecision, type ChurnRateResponse as ChurnRateResponse, type CohortAnalysisResponse as CohortAnalysisResponse, type CohortData as CohortData, 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 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 SessionDurationResponse as SessionDurationResponse, type TimeBetweenVisitsResponse as TimeBetweenVisitsResponse, type TimelineTileData as TimelineTileData, type TimelineTileResponse as TimelineTileResponse, type TopVisitor as TopVisitor, type TopVisitorsResponse as TopVisitorsResponse, 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 VisitorsByBrowserResponse as VisitorsByBrowserResponse, type VisitorsByDeviceResponse as VisitorsByDeviceResponse, type VisitorsByOsResponse as VisitorsByOsResponse, type WauResponse as WauResponse, type AnalyticsTimelineParams as AnalyticsTimelineParams, };
|
|
22
22
|
export { Revenue as Revenue, type AttributionByOriginResponse as AttributionByOriginResponse, type AttributionByUtmResponse as AttributionByUtmResponse, type ConversionMetricsResponse as ConversionMetricsResponse, type CustomerProfileResponse as CustomerProfileResponse, type DashboardResponse as DashboardResponse, type OriginAttributionDataPoint as OriginAttributionDataPoint, type Payment as Payment, type RevenueOverTimeDataPoint as RevenueOverTimeDataPoint, type TimelineDataPoint as TimelineDataPoint, type TimelineResponse as TimelineResponse, type TopCustomer as TopCustomer, type TopCustomersResponse as TopCustomersResponse, type UtmAttributionDataPoint as UtmAttributionDataPoint, type RevenueDashboardParams as RevenueDashboardParams, type RevenueTimelineParams as RevenueTimelineParams, };
|
|
23
23
|
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, };
|
|
24
24
|
export { PaymentProviders as PaymentProviders, type CreatePaymentProviderRequest as CreatePaymentProviderRequest, type ListPaymentProvidersResponse as ListPaymentProvidersResponse, type PaymentProviderResponse as PaymentProviderResponse, type ProviderField as ProviderField, type ProviderInstructionsResponse as ProviderInstructionsResponse, type UpdatePaymentProviderRequest as UpdatePaymentProviderRequest, type PaymentProviderDeleteResponse as PaymentProviderDeleteResponse, type PaymentProviderCreateParams as PaymentProviderCreateParams, type PaymentProviderUpdateParams as PaymentProviderUpdateParams, type PaymentProviderListParams as PaymentProviderListParams, type PaymentProviderInstructionsParams as PaymentProviderInstructionsParams, };
|
package/resources/v1/v1.d.ts.map
CHANGED
|
@@ -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,EAAE,IAAI,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE;OACtD,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
|
|
1
|
+
{"version":3,"file":"v1.d.ts","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE;OACtD,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,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,EACb,iBAAiB,EACjB,sBAAsB,EACtB,UAAU,EACV,wBAAwB,EACxB,4BAA4B,EAC5B,WAAW,EACX,0BAA0B,EAC1B,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,WAAW,EACX,uBAAuB,EACvB,WAAW,EACX,oBAAoB,EACpB,wBAAwB,EACxB,4BAA4B,EAC5B,kBAAkB,EAClB,uBAAuB,EACvB,yBAAyB,EACzB,gBAAgB,EAChB,oBAAoB,EACpB,UAAU,EACV,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,gBAAgB,EAChB,YAAY,EACZ,sBAAsB,EACtB,yBAAyB,EACzB,wBAAwB,EACxB,oBAAoB,EACpB,WAAW,EACZ;OACM,KAAK,mBAAmB;OACxB,EACL,4BAA4B,EAC5B,4BAA4B,EAC5B,2BAA2B,EAC3B,6BAA6B,EAC7B,iCAAiC,EACjC,yBAAyB,EACzB,uBAAuB,EACvB,2BAA2B,EAC3B,gBAAgB,EAChB,aAAa,EACb,4BAA4B,EAC5B,4BAA4B,EAC7B;OACM,KAAK,UAAU;OACf,EACL,2BAA2B,EAC3B,wBAAwB,EACxB,yBAAyB,EACzB,uBAAuB,EACvB,iBAAiB,EACjB,0BAA0B,EAC1B,OAAO,EACP,OAAO,EACP,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,EACX,oBAAoB,EACpB,uBAAuB,EACxB;AAED,qBAAa,EAAG,SAAQ,WAAW;IACjC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IACpD,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,gBAAgB,EAAE,mBAAmB,CAAC,gBAAgB,CAEpD;CACH;AAQD,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,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,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,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,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
|
package/resources/v1/v1.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"v1.js","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,2DAAkC;AAClC,oCAA4E;AAC5E,mEAA0C;AAC1C,4CAUoB;AACpB,+EAAsD;AACtD,
|
|
1
|
+
{"version":3,"file":"v1.js","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,2DAAkC;AAClC,oCAA4E;AAC5E,mEAA0C;AAC1C,4CAUoB;AACpB,+EAAsD;AACtD,wDAsC+B;AAC/B,sGAA6E;AAC7E,gFAa+C;AAC/C,yEAAgD;AAChD,kDAiB2B;AAE3B,MAAa,EAAG,SAAQ,sBAAW;IAAnC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IACJ,CAAC;CAAA;AARD,gBAQC;AAED,EAAE,CAAC,IAAI,GAAG,WAAI,CAAC;AACf,EAAE,CAAC,SAAS,GAAG,qBAAS,CAAC;AACzB,EAAE,CAAC,OAAO,GAAG,iBAAO,CAAC;AACrB,EAAE,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACvB,EAAE,CAAC,gBAAgB,GAAG,oCAAgB,CAAC"}
|
package/resources/v1/v1.mjs.map
CHANGED
|
@@ -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,EAAE,IAAI,EAAgD;OACtD,KAAK,WAAW;OAChB,EAQL,QAAQ,GAET;OACM,KAAK,YAAY;OACjB,EACL,SAAS,
|
|
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,EAAE,IAAI,EAAgD;OACtD,KAAK,WAAW;OAChB,EAQL,QAAQ,GAET;OACM,KAAK,YAAY;OACjB,EACL,SAAS,GAqCV;OACM,KAAK,mBAAmB;OACxB,EASL,gBAAgB,GAIjB;OACM,KAAK,UAAU;OACf,EAQL,OAAO,GASR;AAED,MAAM,OAAO,EAAG,SAAQ,WAAW;IAAnC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IACJ,CAAC;CAAA;AAED,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC;AACf,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC;AACzB,EAAE,CAAC,OAAO,GAAG,OAAO,CAAC;AACrB,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,gBAAgB,GAAG,gBAAgB,CAAC"}
|
package/src/client.ts
CHANGED
|
@@ -34,7 +34,7 @@ export interface ClientOptions {
|
|
|
34
34
|
/**
|
|
35
35
|
* Defaults to process.env['ZORIAPI_API_KEY'].
|
|
36
36
|
*/
|
|
37
|
-
apiKey?: string | undefined;
|
|
37
|
+
apiKey?: string | null | undefined;
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Override the default base URL for the API, e.g., "https://api.example.com/v2/"
|
|
@@ -109,7 +109,7 @@ export interface ClientOptions {
|
|
|
109
109
|
* API Client for interfacing with the Zoriapi API.
|
|
110
110
|
*/
|
|
111
111
|
export class Zoriapi {
|
|
112
|
-
apiKey: string;
|
|
112
|
+
apiKey: string | null;
|
|
113
113
|
|
|
114
114
|
baseURL: string;
|
|
115
115
|
maxRetries: number;
|
|
@@ -126,8 +126,8 @@ export class Zoriapi {
|
|
|
126
126
|
/**
|
|
127
127
|
* API Client for interfacing with the Zoriapi API.
|
|
128
128
|
*
|
|
129
|
-
* @param {string | undefined} [opts.apiKey=process.env['ZORIAPI_API_KEY'] ??
|
|
130
|
-
* @param {string} [opts.baseURL=process.env['ZORIAPI_BASE_URL'] ?? /api/v1] - Override the default base URL for the API.
|
|
129
|
+
* @param {string | null | undefined} [opts.apiKey=process.env['ZORIAPI_API_KEY'] ?? null]
|
|
130
|
+
* @param {string} [opts.baseURL=process.env['ZORIAPI_BASE_URL'] ?? https://api.zorihq.com/api/v1] - Override the default base URL for the API.
|
|
131
131
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
132
132
|
* @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
|
|
133
133
|
* @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
|
|
@@ -137,19 +137,13 @@ export class Zoriapi {
|
|
|
137
137
|
*/
|
|
138
138
|
constructor({
|
|
139
139
|
baseURL = readEnv('ZORIAPI_BASE_URL'),
|
|
140
|
-
apiKey = readEnv('ZORIAPI_API_KEY'),
|
|
140
|
+
apiKey = readEnv('ZORIAPI_API_KEY') ?? null,
|
|
141
141
|
...opts
|
|
142
142
|
}: ClientOptions = {}) {
|
|
143
|
-
if (apiKey === undefined) {
|
|
144
|
-
throw new Errors.ZoriapiError(
|
|
145
|
-
"The ZORIAPI_API_KEY environment variable is missing or empty; either provide it, or instantiate the Zoriapi client with an apiKey option, like new Zoriapi({ apiKey: 'My API Key' }).",
|
|
146
|
-
);
|
|
147
|
-
}
|
|
148
|
-
|
|
149
143
|
const options: ClientOptions = {
|
|
150
144
|
apiKey,
|
|
151
145
|
...opts,
|
|
152
|
-
baseURL: baseURL ||
|
|
146
|
+
baseURL: baseURL || `https://api.zorihq.com/api/v1`,
|
|
153
147
|
};
|
|
154
148
|
|
|
155
149
|
this.baseURL = options.baseURL!;
|
|
@@ -195,7 +189,7 @@ export class Zoriapi {
|
|
|
195
189
|
* Check whether the base URL is set to its default.
|
|
196
190
|
*/
|
|
197
191
|
#baseURLOverridden(): boolean {
|
|
198
|
-
return this.baseURL !== '/api/v1';
|
|
192
|
+
return this.baseURL !== 'https://api.zorihq.com/api/v1';
|
|
199
193
|
}
|
|
200
194
|
|
|
201
195
|
protected defaultQuery(): Record<string, string | undefined> | undefined {
|
|
@@ -203,10 +197,22 @@ export class Zoriapi {
|
|
|
203
197
|
}
|
|
204
198
|
|
|
205
199
|
protected validateHeaders({ values, nulls }: NullableHeaders) {
|
|
206
|
-
|
|
200
|
+
if (this.apiKey && values.get('authorization')) {
|
|
201
|
+
return;
|
|
202
|
+
}
|
|
203
|
+
if (nulls.has('authorization')) {
|
|
204
|
+
return;
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
throw new Error(
|
|
208
|
+
'Could not resolve authentication method. Expected the apiKey to be set. Or for the "Authorization" headers to be explicitly omitted',
|
|
209
|
+
);
|
|
207
210
|
}
|
|
208
211
|
|
|
209
212
|
protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
|
|
213
|
+
if (this.apiKey == null) {
|
|
214
|
+
return undefined;
|
|
215
|
+
}
|
|
210
216
|
return buildHeaders([{ Authorization: this.apiKey }]);
|
|
211
217
|
}
|
|
212
218
|
|
|
@@ -5,40 +5,25 @@ import * as EventsAPI from './events';
|
|
|
5
5
|
import { EventFilterOptionsParams, EventRecentParams, Events } from './events';
|
|
6
6
|
import * as RetentionAPI from './retention';
|
|
7
7
|
import { Retention, RetentionChurnRateParams, RetentionCohortsParams } from './retention';
|
|
8
|
-
import * as SessionsAPI from './sessions';
|
|
9
|
-
import { Sessions } from './sessions';
|
|
10
8
|
import * as TilesAPI from './tiles';
|
|
11
9
|
import {
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
TileGetTrafficByCountryResponse,
|
|
28
|
-
TileGetTrafficByRefererParams,
|
|
29
|
-
TileGetTrafficByRefererResponse,
|
|
30
|
-
TileGetTrafficByUtmParams,
|
|
31
|
-
TileGetTrafficByUtmResponse,
|
|
32
|
-
TileGetUniqueSessionsParams,
|
|
33
|
-
TileGetUniqueSessionsResponse,
|
|
34
|
-
TileGetUniqueVisitorsParams,
|
|
35
|
-
TileGetUniqueVisitorsResponse,
|
|
36
|
-
TileGetWeeklyActiveUsersParams,
|
|
37
|
-
TileGetWeeklyActiveUsersResponse,
|
|
10
|
+
TileBounceRateParams,
|
|
11
|
+
TileDauParams,
|
|
12
|
+
TileMauParams,
|
|
13
|
+
TilePagesPerSessionParams,
|
|
14
|
+
TileReturnRateParams,
|
|
15
|
+
TileSessionDurationParams,
|
|
16
|
+
TileTimeBetweenVisitsParams,
|
|
17
|
+
TileTrafficByCountryParams,
|
|
18
|
+
TileTrafficByRefererParams,
|
|
19
|
+
TileTrafficByUtmParams,
|
|
20
|
+
TileUniqueSessionsParams,
|
|
21
|
+
TileUniqueVisitorsParams,
|
|
22
|
+
TileVisitorsByBrowserParams,
|
|
23
|
+
TileVisitorsByOsParams,
|
|
24
|
+
TileWauParams,
|
|
38
25
|
Tiles,
|
|
39
26
|
} from './tiles';
|
|
40
|
-
import * as UsersAPI from './users';
|
|
41
|
-
import { Users } from './users';
|
|
42
27
|
import * as VisitorsAPI from './visitors';
|
|
43
28
|
import {
|
|
44
29
|
VisitorByDeviceParams,
|
|
@@ -53,10 +38,8 @@ import { RequestOptions } from '../../../internal/request-options';
|
|
|
53
38
|
export class Analytics extends APIResource {
|
|
54
39
|
visitors: VisitorsAPI.Visitors = new VisitorsAPI.Visitors(this._client);
|
|
55
40
|
events: EventsAPI.Events = new EventsAPI.Events(this._client);
|
|
56
|
-
sessions: SessionsAPI.Sessions = new SessionsAPI.Sessions(this._client);
|
|
57
|
-
users: UsersAPI.Users = new UsersAPI.Users(this._client);
|
|
58
|
-
retention: RetentionAPI.Retention = new RetentionAPI.Retention(this._client);
|
|
59
41
|
tiles: TilesAPI.Tiles = new TilesAPI.Tiles(this._client);
|
|
42
|
+
retention: RetentionAPI.Retention = new RetentionAPI.Retention(this._client);
|
|
60
43
|
|
|
61
44
|
/**
|
|
62
45
|
* Get unique visitor counts over time, split by mobile and desktop devices for
|
|
@@ -64,19 +47,26 @@ export class Analytics extends APIResource {
|
|
|
64
47
|
*
|
|
65
48
|
* @example
|
|
66
49
|
* ```ts
|
|
67
|
-
* const
|
|
68
|
-
* {
|
|
69
|
-
*
|
|
50
|
+
* const timelineTileResponse =
|
|
51
|
+
* await client.v1.analytics.timeline({
|
|
52
|
+
* project_id: 'project_id',
|
|
53
|
+
* time_range: 'last_hour',
|
|
54
|
+
* });
|
|
70
55
|
* ```
|
|
71
56
|
*/
|
|
72
|
-
|
|
73
|
-
query: AnalyticsRetrieveTimelineParams,
|
|
74
|
-
options?: RequestOptions,
|
|
75
|
-
): APIPromise<AnalyticsRetrieveTimelineResponse> {
|
|
57
|
+
timeline(query: AnalyticsTimelineParams, options?: RequestOptions): APIPromise<TimelineTileResponse> {
|
|
76
58
|
return this._client.get('/api/v1/analytics/timeline', { query, ...options });
|
|
77
59
|
}
|
|
78
60
|
}
|
|
79
61
|
|
|
62
|
+
export interface BounceRateResponse {
|
|
63
|
+
previous_rate?: number;
|
|
64
|
+
|
|
65
|
+
rate?: number;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export type CardPrecision = 'minutes' | 'hourly' | 'daily' | 'weekly' | 'monthly';
|
|
69
|
+
|
|
80
70
|
export interface ChurnRateResponse {
|
|
81
71
|
churn_rate_percent?: number;
|
|
82
72
|
|
|
@@ -109,6 +99,24 @@ export interface CohortData {
|
|
|
109
99
|
week_4_retention?: number;
|
|
110
100
|
}
|
|
111
101
|
|
|
102
|
+
export interface CountryTrafficSourceData {
|
|
103
|
+
count?: number;
|
|
104
|
+
|
|
105
|
+
country?: string;
|
|
106
|
+
|
|
107
|
+
previous_count?: number;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
export interface CountryTrafficSourceResponse {
|
|
111
|
+
data?: Array<CountryTrafficSourceData>;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
export interface DauResponse {
|
|
115
|
+
count?: number;
|
|
116
|
+
|
|
117
|
+
previous_count?: number;
|
|
118
|
+
}
|
|
119
|
+
|
|
112
120
|
export interface EventFilterOptionsResponse {
|
|
113
121
|
event_names?: Array<string>;
|
|
114
122
|
|
|
@@ -149,6 +157,18 @@ export interface ManualIdentifyResponse {
|
|
|
149
157
|
visitor_id?: string;
|
|
150
158
|
}
|
|
151
159
|
|
|
160
|
+
export interface MauResponse {
|
|
161
|
+
count?: number;
|
|
162
|
+
|
|
163
|
+
previous_count?: number;
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
export interface PagesPerSessionResponse {
|
|
167
|
+
avg_pages?: number;
|
|
168
|
+
|
|
169
|
+
previous_avg_pages?: number;
|
|
170
|
+
}
|
|
171
|
+
|
|
152
172
|
export interface RecentEvent {
|
|
153
173
|
browser_name?: string;
|
|
154
174
|
|
|
@@ -217,6 +237,60 @@ export interface RecentEventsResponse {
|
|
|
217
237
|
total?: number;
|
|
218
238
|
}
|
|
219
239
|
|
|
240
|
+
export interface RefererTrafficSourceData {
|
|
241
|
+
count?: number;
|
|
242
|
+
|
|
243
|
+
previous_count?: number;
|
|
244
|
+
|
|
245
|
+
previous_revenue?: number;
|
|
246
|
+
|
|
247
|
+
referer_url?: string;
|
|
248
|
+
|
|
249
|
+
revenue?: number;
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
export interface RefererTrafficSourceResponse {
|
|
253
|
+
data?: Array<RefererTrafficSourceData>;
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
export interface ReturnRateResponse {
|
|
257
|
+
previous_rate?: number;
|
|
258
|
+
|
|
259
|
+
rate?: number;
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
export interface SessionDurationResponse {
|
|
263
|
+
avg_duration?: number;
|
|
264
|
+
|
|
265
|
+
previous_avg_duration?: number;
|
|
266
|
+
}
|
|
267
|
+
|
|
268
|
+
export interface TimeBetweenVisitsResponse {
|
|
269
|
+
avg_hours?: number;
|
|
270
|
+
|
|
271
|
+
previous_avg_hours?: number;
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
export interface TimelineTileData {
|
|
275
|
+
num_desktop_visits?: number;
|
|
276
|
+
|
|
277
|
+
num_mobile_visits?: number;
|
|
278
|
+
|
|
279
|
+
num_revenue?: number;
|
|
280
|
+
|
|
281
|
+
num_unknown_visits?: number;
|
|
282
|
+
|
|
283
|
+
time_bucket?: string;
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
export interface TimelineTileResponse {
|
|
287
|
+
data?: Array<TimelineTileData>;
|
|
288
|
+
|
|
289
|
+
precision?: CardPrecision;
|
|
290
|
+
|
|
291
|
+
total_visits?: number;
|
|
292
|
+
}
|
|
293
|
+
|
|
220
294
|
export interface TopVisitor {
|
|
221
295
|
browser_name?: string;
|
|
222
296
|
|
|
@@ -261,6 +335,40 @@ export interface TopVisitorsResponse {
|
|
|
261
335
|
visitors?: Array<TopVisitor>;
|
|
262
336
|
}
|
|
263
337
|
|
|
338
|
+
export interface UniqueSessionsResponse {
|
|
339
|
+
count?: number;
|
|
340
|
+
|
|
341
|
+
previous_count?: number;
|
|
342
|
+
}
|
|
343
|
+
|
|
344
|
+
export interface UniqueVisitorsResponse {
|
|
345
|
+
count?: number;
|
|
346
|
+
|
|
347
|
+
previous_count?: number;
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
export interface UtmTrafficSourceResponse {
|
|
351
|
+
data?: Array<UtmTrafficSourceResponse.Data>;
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
export namespace UtmTrafficSourceResponse {
|
|
355
|
+
export interface Data {
|
|
356
|
+
count?: number;
|
|
357
|
+
|
|
358
|
+
previous_count?: number;
|
|
359
|
+
|
|
360
|
+
previous_revenue?: number;
|
|
361
|
+
|
|
362
|
+
revenue?: number;
|
|
363
|
+
|
|
364
|
+
utm_campaign?: string;
|
|
365
|
+
|
|
366
|
+
utm_medium?: string;
|
|
367
|
+
|
|
368
|
+
utm_source?: string;
|
|
369
|
+
}
|
|
370
|
+
}
|
|
371
|
+
|
|
264
372
|
export interface VisitorDataPoint {
|
|
265
373
|
desktop?: number;
|
|
266
374
|
|
|
@@ -353,33 +461,45 @@ export interface VisitorProfileResponse {
|
|
|
353
461
|
visitor_id?: string;
|
|
354
462
|
}
|
|
355
463
|
|
|
356
|
-
export interface
|
|
357
|
-
data?: Array<
|
|
464
|
+
export interface VisitorsByBrowserResponse {
|
|
465
|
+
data?: Array<VisitorsByBrowserResponse.Data>;
|
|
358
466
|
}
|
|
359
467
|
|
|
360
|
-
export
|
|
361
|
-
|
|
468
|
+
export namespace VisitorsByBrowserResponse {
|
|
469
|
+
export interface Data {
|
|
470
|
+
browser_name?: string;
|
|
362
471
|
|
|
363
|
-
|
|
472
|
+
count?: number;
|
|
364
473
|
|
|
365
|
-
|
|
474
|
+
previous_count?: number;
|
|
475
|
+
}
|
|
366
476
|
}
|
|
367
477
|
|
|
368
|
-
export
|
|
369
|
-
|
|
370
|
-
|
|
478
|
+
export interface VisitorsByDeviceResponse {
|
|
479
|
+
data?: Array<VisitorDataPoint>;
|
|
480
|
+
}
|
|
371
481
|
|
|
372
|
-
|
|
482
|
+
export interface VisitorsByOsResponse {
|
|
483
|
+
data?: Array<VisitorsByOsResponse.Data>;
|
|
484
|
+
}
|
|
373
485
|
|
|
374
|
-
|
|
486
|
+
export namespace VisitorsByOsResponse {
|
|
487
|
+
export interface Data {
|
|
488
|
+
browser_name?: string;
|
|
375
489
|
|
|
376
|
-
|
|
490
|
+
count?: number;
|
|
377
491
|
|
|
378
|
-
|
|
492
|
+
previous_count?: number;
|
|
379
493
|
}
|
|
380
494
|
}
|
|
381
495
|
|
|
382
|
-
export interface
|
|
496
|
+
export interface WauResponse {
|
|
497
|
+
count?: number;
|
|
498
|
+
|
|
499
|
+
previous_count?: number;
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
export interface AnalyticsTimelineParams {
|
|
383
503
|
project_id: string;
|
|
384
504
|
|
|
385
505
|
time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
@@ -401,30 +521,47 @@ export interface AnalyticsRetrieveTimelineParams {
|
|
|
401
521
|
|
|
402
522
|
Analytics.Visitors = Visitors;
|
|
403
523
|
Analytics.Events = Events;
|
|
404
|
-
Analytics.Sessions = Sessions;
|
|
405
|
-
Analytics.Users = Users;
|
|
406
|
-
Analytics.Retention = Retention;
|
|
407
524
|
Analytics.Tiles = Tiles;
|
|
525
|
+
Analytics.Retention = Retention;
|
|
408
526
|
|
|
409
527
|
export declare namespace Analytics {
|
|
410
528
|
export {
|
|
529
|
+
type BounceRateResponse as BounceRateResponse,
|
|
530
|
+
type CardPrecision as CardPrecision,
|
|
411
531
|
type ChurnRateResponse as ChurnRateResponse,
|
|
412
532
|
type CohortAnalysisResponse as CohortAnalysisResponse,
|
|
413
533
|
type CohortData as CohortData,
|
|
534
|
+
type CountryTrafficSourceData as CountryTrafficSourceData,
|
|
535
|
+
type CountryTrafficSourceResponse as CountryTrafficSourceResponse,
|
|
536
|
+
type DauResponse as DauResponse,
|
|
414
537
|
type EventFilterOptionsResponse as EventFilterOptionsResponse,
|
|
415
538
|
type EventsOverTimeDataPoint as EventsOverTimeDataPoint,
|
|
416
539
|
type ManualIdentifyRequest as ManualIdentifyRequest,
|
|
417
540
|
type ManualIdentifyResponse as ManualIdentifyResponse,
|
|
541
|
+
type MauResponse as MauResponse,
|
|
542
|
+
type PagesPerSessionResponse as PagesPerSessionResponse,
|
|
418
543
|
type RecentEvent as RecentEvent,
|
|
419
544
|
type RecentEventsResponse as RecentEventsResponse,
|
|
545
|
+
type RefererTrafficSourceData as RefererTrafficSourceData,
|
|
546
|
+
type RefererTrafficSourceResponse as RefererTrafficSourceResponse,
|
|
547
|
+
type ReturnRateResponse as ReturnRateResponse,
|
|
548
|
+
type SessionDurationResponse as SessionDurationResponse,
|
|
549
|
+
type TimeBetweenVisitsResponse as TimeBetweenVisitsResponse,
|
|
550
|
+
type TimelineTileData as TimelineTileData,
|
|
551
|
+
type TimelineTileResponse as TimelineTileResponse,
|
|
420
552
|
type TopVisitor as TopVisitor,
|
|
421
553
|
type TopVisitorsResponse as TopVisitorsResponse,
|
|
554
|
+
type UniqueSessionsResponse as UniqueSessionsResponse,
|
|
555
|
+
type UniqueVisitorsResponse as UniqueVisitorsResponse,
|
|
556
|
+
type UtmTrafficSourceResponse as UtmTrafficSourceResponse,
|
|
422
557
|
type VisitorDataPoint as VisitorDataPoint,
|
|
423
558
|
type VisitorEvent as VisitorEvent,
|
|
424
559
|
type VisitorProfileResponse as VisitorProfileResponse,
|
|
560
|
+
type VisitorsByBrowserResponse as VisitorsByBrowserResponse,
|
|
425
561
|
type VisitorsByDeviceResponse as VisitorsByDeviceResponse,
|
|
426
|
-
type
|
|
427
|
-
type
|
|
562
|
+
type VisitorsByOsResponse as VisitorsByOsResponse,
|
|
563
|
+
type WauResponse as WauResponse,
|
|
564
|
+
type AnalyticsTimelineParams as AnalyticsTimelineParams,
|
|
428
565
|
};
|
|
429
566
|
|
|
430
567
|
export {
|
|
@@ -441,43 +578,28 @@ export declare namespace Analytics {
|
|
|
441
578
|
type EventRecentParams as EventRecentParams,
|
|
442
579
|
};
|
|
443
580
|
|
|
444
|
-
export {
|
|
445
|
-
|
|
446
|
-
|
|
581
|
+
export {
|
|
582
|
+
Tiles as Tiles,
|
|
583
|
+
type TileBounceRateParams as TileBounceRateParams,
|
|
584
|
+
type TileDauParams as TileDauParams,
|
|
585
|
+
type TileMauParams as TileMauParams,
|
|
586
|
+
type TilePagesPerSessionParams as TilePagesPerSessionParams,
|
|
587
|
+
type TileReturnRateParams as TileReturnRateParams,
|
|
588
|
+
type TileSessionDurationParams as TileSessionDurationParams,
|
|
589
|
+
type TileTimeBetweenVisitsParams as TileTimeBetweenVisitsParams,
|
|
590
|
+
type TileTrafficByCountryParams as TileTrafficByCountryParams,
|
|
591
|
+
type TileTrafficByRefererParams as TileTrafficByRefererParams,
|
|
592
|
+
type TileTrafficByUtmParams as TileTrafficByUtmParams,
|
|
593
|
+
type TileUniqueSessionsParams as TileUniqueSessionsParams,
|
|
594
|
+
type TileUniqueVisitorsParams as TileUniqueVisitorsParams,
|
|
595
|
+
type TileVisitorsByBrowserParams as TileVisitorsByBrowserParams,
|
|
596
|
+
type TileVisitorsByOsParams as TileVisitorsByOsParams,
|
|
597
|
+
type TileWauParams as TileWauParams,
|
|
598
|
+
};
|
|
447
599
|
|
|
448
600
|
export {
|
|
449
601
|
Retention as Retention,
|
|
450
602
|
type RetentionChurnRateParams as RetentionChurnRateParams,
|
|
451
603
|
type RetentionCohortsParams as RetentionCohortsParams,
|
|
452
604
|
};
|
|
453
|
-
|
|
454
|
-
export {
|
|
455
|
-
Tiles as Tiles,
|
|
456
|
-
type TileGetBounceRateResponse as TileGetBounceRateResponse,
|
|
457
|
-
type TileGetDailyActiveUsersResponse as TileGetDailyActiveUsersResponse,
|
|
458
|
-
type TileGetMonthlyActiveUsersResponse as TileGetMonthlyActiveUsersResponse,
|
|
459
|
-
type TileGetPagesPerSessionResponse as TileGetPagesPerSessionResponse,
|
|
460
|
-
type TileGetReturnRateResponse as TileGetReturnRateResponse,
|
|
461
|
-
type TileGetSessionDurationResponse as TileGetSessionDurationResponse,
|
|
462
|
-
type TileGetTimeBetweenVisitsResponse as TileGetTimeBetweenVisitsResponse,
|
|
463
|
-
type TileGetTrafficByCountryResponse as TileGetTrafficByCountryResponse,
|
|
464
|
-
type TileGetTrafficByRefererResponse as TileGetTrafficByRefererResponse,
|
|
465
|
-
type TileGetTrafficByUtmResponse as TileGetTrafficByUtmResponse,
|
|
466
|
-
type TileGetUniqueSessionsResponse as TileGetUniqueSessionsResponse,
|
|
467
|
-
type TileGetUniqueVisitorsResponse as TileGetUniqueVisitorsResponse,
|
|
468
|
-
type TileGetWeeklyActiveUsersResponse as TileGetWeeklyActiveUsersResponse,
|
|
469
|
-
type TileGetBounceRateParams as TileGetBounceRateParams,
|
|
470
|
-
type TileGetDailyActiveUsersParams as TileGetDailyActiveUsersParams,
|
|
471
|
-
type TileGetMonthlyActiveUsersParams as TileGetMonthlyActiveUsersParams,
|
|
472
|
-
type TileGetPagesPerSessionParams as TileGetPagesPerSessionParams,
|
|
473
|
-
type TileGetReturnRateParams as TileGetReturnRateParams,
|
|
474
|
-
type TileGetSessionDurationParams as TileGetSessionDurationParams,
|
|
475
|
-
type TileGetTimeBetweenVisitsParams as TileGetTimeBetweenVisitsParams,
|
|
476
|
-
type TileGetTrafficByCountryParams as TileGetTrafficByCountryParams,
|
|
477
|
-
type TileGetTrafficByRefererParams as TileGetTrafficByRefererParams,
|
|
478
|
-
type TileGetTrafficByUtmParams as TileGetTrafficByUtmParams,
|
|
479
|
-
type TileGetUniqueSessionsParams as TileGetUniqueSessionsParams,
|
|
480
|
-
type TileGetUniqueVisitorsParams as TileGetUniqueVisitorsParams,
|
|
481
|
-
type TileGetWeeklyActiveUsersParams as TileGetWeeklyActiveUsersParams,
|
|
482
|
-
};
|
|
483
605
|
}
|