SDK Reference

    @proveanything/smartlinks

    npm install @proveanything/smartlinks
    View on npm →

    Namespaces

    Other

    journeysAnalytics

    Functions for journeysAnalytics operations

    3 functions6 types

    stats

    POST /admin/collection/:collectionId/journeys.analytics/:journeyId/stats Computes journey stats over a time window; outcome defaults to 'success'. If finalStepId is provided, includes currentlyActive and completed fields.

    public
    stats(collectionId: string,
    journeyId: string,
    body:  = {}) → Promise<>

    recipients

    POST /admin/collection/:collectionId/journeys.analytics/:journeyId/steps/:stepId/recipients Returns recipient IDs for a given journey step. For completed/pending, interactionId is required; outcome defaults to 'success'.

    public
    recipients(collectionId: string,
    journeyId: string,
    stepId: string,
    body:  = {}) → Promise<>

    funnelReport

    POST /admin/collection/:collectionId/journeys.analytics/:journeyId/funnel-report Computes conversion, counts, and avg time across mapped steps in a period.

    public
    funnelReport(collectionId: string,
    journeyId: string,
    body: ) → Promise<>