5ed632ac45
* initial commit * Add authentication * Add stats stream and schema * Change overwrite to append, add primary key * Make acceptance test executable * Revert to overwrite * Add documentation * Update documentation * Add titles to spec properties, update documentationUrl, remove EOF newlines * Add bootstrap.md * Update BOOTSTRAP.md * Remove incremental sync to-dos * fix: add source definition for plausible * fix: format python files with flake8 * auto-bump connector version Co-authored-by: Sajarin <sajarindider@gmail.com> Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
31 lines
1.7 KiB
Markdown
31 lines
1.7 KiB
Markdown
# Plausible
|
|
|
|
## Requirements
|
|
* [Plausible account](https://plausible.io/)
|
|
* Plausible [API key](https://plausible.io/docs/stats-api)
|
|
|
|
## Supported sync modes
|
|
| Feature | Supported?\(Yes/No\) | Notes |
|
|
| :--- | :--- | :--- |
|
|
| Full Refresh Sync | Yes | [Overwrite](https://docs.airbyte.com/understanding-airbyte/connections/full-refresh-overwrite) |
|
|
| Incremental Sync | No | |
|
|
|
|
## Supported Streams
|
|
* [Stats - Time Series](https://plausible.io/docs/stats-api#get-apiv1statstimeseries)
|
|
|
|
### 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](https://plausible.io/docs/stats-api#metrics) are aggregated to a daily grain; and
|
|
2. [non-metric properties](https://plausible.io/docs/stats-api#properties) (e.g., referrer, entry page, exit page) cannot be directly exported, only [grouped on](https://plausible.io/docs/stats-api#get-apiv1statsbreakdown).
|
|
|
|
Thus, this source connector retrieves [all possible metrics](https://plausible.io/docs/stats-api#metrics) on a daily grain, for all days with nonzero website activity.
|
|
|
|
## Performance Considerations
|
|
The [stated rate limit](https://plausible.io/docs/stats-api) is 600 requests per hour per API key, with higher capacities potentially available [upon request](https://plausible.io/contact).
|
|
|
|
## Changelog
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
|:--------|:-----------| :----------- |:-----------------------------------------------------------|
|
|
| 0.1.0 | 2022-10-30 | [18657](https://github.com/airbytehq/airbyte/pull/18657) | Initial commit | |