api.md

V1

Auth

Types:

• LoginRequest
• LoginResponse

Methods:

• client.v1.auth.login({ ...params }) -> LoginResponse

Analytics

Types:

• BounceRateResponse
• CardPrecision
• ChurnRateResponse
• CohortAnalysisResponse
• CohortData
• CountryTrafficSourceData
• CountryTrafficSourceResponse
• DauResponse
• EntryPagesData
• EntryPagesResponse
• EventFilterOptionsResponse
• EventsOverTimeDataPoint
• ExitPagesData
• ExitPagesResponse
• LlmCostResponse
• LlmModelCostData
• LlmTopModelsCostResponse
• LlmTraceFilterOptionsResponse
• LlmTraceItem
• LlmTracesListResponse
• 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

Methods:

• client.v1.analytics.timeline({ ...params }) -> TimelineTileResponse

Visitors

Methods:

• client.v1.analytics.visitors.byDevice({ ...params }) -> VisitorsByDeviceResponse
• client.v1.analytics.visitors.identify({ ...params }) -> ManualIdentifyResponse
• client.v1.analytics.visitors.profile({ ...params }) -> VisitorProfileResponse
• client.v1.analytics.visitors.top({ ...params }) -> TopVisitorsResponse

Events

Methods:

• client.v1.analytics.events.filterOptions({ ...params }) -> EventFilterOptionsResponse
• client.v1.analytics.events.recent({ ...params }) -> RecentEventsResponse

Llm

Methods:

• client.v1.analytics.llm.traces({ ...params }) -> LlmTracesListResponse
• client.v1.analytics.llm.tracesFilterOptions({ ...params }) -> LlmTraceFilterOptionsResponse

Tiles

Methods:

• client.v1.analytics.tiles.bounceRate({ ...params }) -> BounceRateResponse
• client.v1.analytics.tiles.dau({ ...params }) -> DauResponse
• client.v1.analytics.tiles.entryPages({ ...params }) -> EntryPagesResponse
• client.v1.analytics.tiles.exitPages({ ...params }) -> ExitPagesResponse
• client.v1.analytics.tiles.llmCost({ ...params }) -> LlmCostResponse
• client.v1.analytics.tiles.llmTopModelsCost({ ...params }) -> LlmTopModelsCostResponse
• client.v1.analytics.tiles.mau({ ...params }) -> MauResponse
• client.v1.analytics.tiles.pagesPerSession({ ...params }) -> PagesPerSessionResponse
• client.v1.analytics.tiles.returnRate({ ...params }) -> ReturnRateResponse
• client.v1.analytics.tiles.sessionDuration({ ...params }) -> SessionDurationResponse
• client.v1.analytics.tiles.timeBetweenVisits({ ...params }) -> TimeBetweenVisitsResponse
• client.v1.analytics.tiles.trafficByCountry({ ...params }) -> CountryTrafficSourceResponse
• client.v1.analytics.tiles.trafficByReferer({ ...params }) -> RefererTrafficSourceResponse
• client.v1.analytics.tiles.trafficByUtm({ ...params }) -> UtmTrafficSourceResponse
• client.v1.analytics.tiles.uniqueSessions({ ...params }) -> UniqueSessionsResponse
• client.v1.analytics.tiles.uniqueVisitors({ ...params }) -> UniqueVisitorsResponse
• client.v1.analytics.tiles.visitorsByBrowser({ ...params }) -> VisitorsByBrowserResponse
• client.v1.analytics.tiles.visitorsByOs({ ...params }) -> VisitorsByOsResponse
• client.v1.analytics.tiles.wau({ ...params }) -> WauResponse

Retention

Methods:

• client.v1.analytics.retention.churnRate({ ...params }) -> ChurnRateResponse
• client.v1.analytics.retention.cohorts({ ...params }) -> CohortAnalysisResponse

Revenue

Types:

• AttributionByOriginResponse
• AttributionByUtmResponse
• ConversionMetricsResponse
• CustomerProfileResponse
• DashboardResponse
• OriginAttributionDataPoint
• Payment
• RevenueOverTimeDataPoint
• TimelineDataPoint
• TimelineResponse
• TopCustomer
• TopCustomersResponse
• UtmAttributionDataPoint

Methods:

• client.v1.revenue.dashboard({ ...params }) -> DashboardResponse
• client.v1.revenue.timeline({ ...params }) -> TimelineResponse

Attribution

Methods:

• client.v1.revenue.attribution.byOrigin({ ...params }) -> AttributionByOriginResponse
• client.v1.revenue.attribution.byUtm({ ...params }) -> AttributionByUtmResponse

Customers

Methods:

• client.v1.revenue.customers.profile({ ...params }) -> CustomerProfileResponse
• client.v1.revenue.customers.top({ ...params }) -> TopCustomersResponse

Conversion

Methods:

• client.v1.revenue.conversion.metrics({ ...params }) -> ConversionMetricsResponse

Cohort

Types:

• CohortGetMetricsResponse

Methods:

• client.v1.revenue.cohort.getMetrics({ ...params }) -> CohortGetMetricsResponse

Projects

Types:

• CreateProjectRequest
• ListProjectsResponse
• Project
• ProjectResponse
• UpdateProjectRequest
• ProjectCreateResponse
• ProjectDeleteResponse

Methods:

• client.v1.projects.create({ ...params }) -> ProjectCreateResponse
• client.v1.projects.update(id, { ...params }) -> ProjectResponse
• client.v1.projects.list() -> ListProjectsResponse
• client.v1.projects.delete(id) -> ProjectDeleteResponse
• client.v1.projects.get(id) -> ProjectResponse

PaymentProviders

Types:

• CreatePaymentProviderRequest
• ListPaymentProvidersResponse
• PaymentProviderResponse
• ProviderField
• ProviderInstructionsResponse
• UpdatePaymentProviderRequest
• PaymentProviderDeleteResponse

Methods:

• client.v1.paymentProviders.create({ ...params }) -> PaymentProviderResponse
• client.v1.paymentProviders.update(id, { ...params }) -> PaymentProviderResponse
• client.v1.paymentProviders.list({ ...params }) -> ListPaymentProvidersResponse
• client.v1.paymentProviders.delete(id) -> PaymentProviderDeleteResponse
• client.v1.paymentProviders.get(id) -> PaymentProviderResponse
• client.v1.paymentProviders.instructions({ ...params }) -> ProviderInstructionsResponse

Stripe

App

Types:

• AppHandleCallbackResponse

Methods:

• client.v1.paymentProviders.stripe.app.handleCallback({ ...params }) -> AppHandleCallbackResponse