@jackdbd/plausible-client

makeClient

• makeClient(credentials: Credentials, options?: Options): { stats: { aggregate: ((...args: [options?: AggregateOptions]) => Promise<{ bounce_rate: { value: number }; pageviews: { value: number }; visit_duration: { value: number }; visitors: { value: number } }>); breakdown: ((...args: [options?: BreakdownOptions]) => Promise<BreakdownResult[]>); timeseries: ((...args: [options?: TimeseriesOptions]) => Promise<TimeseriesResult[]>) } }

• Parameters

  • credentials: Credentials

  • Optional options: Options

  Returns { stats: { aggregate: ((...args: [options?: AggregateOptions]) => Promise<{ bounce_rate: { value: number }; pageviews: { value: number }; visit_duration: { value: number }; visitors: { value: number } }>); breakdown: ((...args: [options?: BreakdownOptions]) => Promise<BreakdownResult[]>); timeseries: ((...args: [options?: TimeseriesOptions]) => Promise<TimeseriesResult[]>) } }

  • stats: { aggregate: ((...args: [options?: AggregateOptions]) => Promise<{ bounce_rate: { value: number }; pageviews: { value: number }; visit_duration: { value: number }; visitors: { value: number } }>); breakdown: ((...args: [options?: BreakdownOptions]) => Promise<BreakdownResult[]>); timeseries: ((...args: [options?: TimeseriesOptions]) => Promise<TimeseriesResult[]>) }

    • aggregate: ((...args: [options?: AggregateOptions]) => Promise<{ bounce_rate: { value: number }; pageviews: { value: number }; visit_duration: { value: number }; visitors: { value: number } }>)

      • • (...args: [options?: AggregateOptions]): Promise<{ bounce_rate: { value: number }; pageviews: { value: number }; visit_duration: { value: number }; visitors: { value: number } }>

        • Parameters

          • Rest ...args: [options?: AggregateOptions]

          Returns Promise<{ bounce_rate: { value: number }; pageviews: { value: number }; visit_duration: { value: number }; visitors: { value: number } }>

    • breakdown: ((...args: [options?: BreakdownOptions]) => Promise<BreakdownResult[]>)

      • • (...args: [options?: BreakdownOptions]): Promise<BreakdownResult[]>

        • Parameters

          • Rest ...args: [options?: BreakdownOptions]

          Returns Promise<BreakdownResult[]>

    • timeseries: ((...args: [options?: TimeseriesOptions]) => Promise<TimeseriesResult[]>)

      • • (...args: [options?: TimeseriesOptions]): Promise<TimeseriesResult[]>

        • Parameters

          • Rest ...args: [options?: TimeseriesOptions]

          Returns Promise<TimeseriesResult[]>