umami-api-js
    Preparing search index...

    Function getReportsFunnel

    • Understand the conversion and drop-off rate of users: https://umami.is/docs/api/reports-api#post-apireportsfunnel (TODO UNTESTED)

      Parameters

      • this: API
      • websiteId: string
      • parameters: ReportType & Filters & Timestamps & {
            steps: { type: "path" | "event"; value: string }[];
            window: number;
        }
        • steps: { type: "path" | "event"; value: string }[]

          Type of event and conversion step

        • window: number

          Window of days between funnel steps to be considered a conversion

      Returns Promise<
          {
              dropoff: number
              | null;
              dropped: number;
              previous: number;
              remaining: number;
              type: string;
              value: string;
              visitors: number;
          }[],
      >