Skip to main content

Plausible

Requirements

Supported sync modes

FeatureSupported?(Yes/No)Notes
Full Refresh SyncYesOverwrite
Incremental SyncNo

Supported Streams

Setup steps

  1. Log into your Airbyte Cloud account or navigate to the Airbyte Open Source dashboard.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Plausible from the Source type dropdown.
  4. Enter a name for the connector
  5. Enter the following configurations:
    • API Key: Plausible API Key. See the docs for information on how to generate this key.
    • Site ID: The domain of the site you want to retrieve data for. Enter the name of your site as configured on Plausible, i.e., excluding "https://" and "www". Can be retrieved from the 'domain' field in your Plausible site settings.
    • API URL: The API URL of your plausible instance. Change this if you self-host plausible. Otherwise it will default to https://plausible.io/api/v1/stats
    • start_date: Data start date Start date for data to retrieve, in ISO-8601 format.

Notes

Plausible is a privacy-first analytics service, and the data available from its API is intentionally 1) less granular and 2) less comprehensive than those available from Google Analytics. As such:

  1. when retrieving multi-day data, metrics are aggregated to a daily grain; and
  2. non-metric properties (e.g., referrer, entry page, exit page) cannot be directly exported, only grouped on.

Thus, this source connector retrieves all possible metrics on a daily grain, for all days with nonzero website activity.

Performance Considerations

The stated rate limit is 600 requests per hour per API key, with higher capacities potentially available upon request.

Reference

Config fields reference

Field
Type
Property name
string
api_key
string
site_id
string
api_url
string
start_date

Changelog

Expand to review
VersionDatePull RequestSubject
0.1.132024-08-1043680Update dependencies
0.1.122024-08-0642793new API URL config option available
0.1.112024-08-0343252Update dependencies
0.1.102024-07-2742793Update dependencies
0.1.92024-07-2041918Update dependencies
0.1.82024-07-1041403Update dependencies
0.1.72024-07-0941120Update dependencies
0.1.62024-07-0640992Update dependencies
0.1.52024-06-2540502Update dependencies
0.1.42024-06-2240185Update dependencies
0.1.32024-06-0438974[autopull] Upgrade base image to v1.2.1
0.1.22024-05-2838660Make connector compatible with Builder
0.1.12024-05-2138494[autopull] base image + poetry + up_to_date
0.1.02022-10-3018657Initial commit