Authentication #

Example Configuration #

kind: source
spec:
  name: plausible
  path: cloudquery/plausible
  registry: cloudquery
  version: "v3.10.4"
  tables: ["*"]
  destinations: ["postgresql"]
  # Learn more about the configuration options at https://cql.ink/plausible_source
  spec:
    site_id: "YOUR_SITE_ID"
    api_key: "${API_KEY}"

Configuration Reference #

• site_id (string) (required)

  This is the value of your domain where plausible is deployed. If you're unsure, navigate to your site settings in Plausible and grab the value of the domain field.
• api_key (string) (required)

  This is your secret API key which you can obtain for your account by going to your user settings page plausible.io/settings.
• period (string) (optional) (default: 30d)

  Time period to fetch data.
• filters (string) (optional) (default: empty)

  Filter results, see Plausible Analytics Filters.
• metrics ([]string) (optional) (default: ["visitors", "pageviews", "bounce_rate", "visit_duration", "visits"])

  Metrics to sync. By default, the plugin will sync all metrics.
• interval (string) (optional) (default: date)

  Reporting interval. Valid options are date (always) and month (when specified period is longer than one calendar month).
• base_url (string) (optional) (default: https://plausible.io)

  Base URL for the Plausible API. If you are using self-hosted version this should be changed to the domain where plausible is hosted.
• concurrency (integer) (optional) (default: 10000)

  A best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
• scheduler (string) (optional) (default: dfs) The scheduler to use when determining the priority of resources to sync. Supported values are dfs (depth-first search), round-robin, shuffle and shuffle-queue.

  For more information about this, see performance tuning.

Example Queries #

Sum all visitors since date #

select sum(visitors) from plausible_stats_timeseries where date >= '2021-01-01';

Select all dates where bounce rate was above 50% #

select date, bounce_rate from plausible_stats_timeseries where bounce_rate > 50;