source-plausible new config setting for self hosted plausible instanc…

…e. (airbytehq#43048)
Teradata · Aug 6, 2024 · bc01248 · bc01248
1 parent 4bcf36c
commit bc01248
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 4 deletions.
diff --git a/airbyte-integrations/connectors/source-plausible/metadata.yaml b/airbyte-integrations/connectors/source-plausible/metadata.yaml
@@ -16,7 +16,7 @@ data:
   connectorSubtype: api
   connectorType: source
   definitionId: 603ba446-3d75-41d7-92f3-aba901f8b897
-  dockerImageTag: 0.1.11
+  dockerImageTag: 0.1.12
   dockerRepository: airbyte/source-plausible
   githubIssueLabel: source-plausible
   icon: plausible.svg

diff --git a/airbyte-integrations/connectors/source-plausible/pyproject.toml b/airbyte-integrations/connectors/source-plausible/pyproject.toml
@@ -3,7 +3,7 @@ requires = [ "poetry-core>=1.0.0",]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-version = "0.1.11"
+version = "0.1.12"
 name = "source-plausible"
 description = "Source implementation for Plausible."
 authors = [ "Airbyte <[email protected]>",]

diff --git a/airbyte-integrations/connectors/source-plausible/source_plausible/manifest.yaml b/airbyte-integrations/connectors/source-plausible/source_plausible/manifest.yaml
@@ -40,7 +40,7 @@ definitions:
           $ref: "#/schemas/stats"
   base_requester:
     type: HttpRequester
-    url_base: https://plausible.io/api/v1/stats
+    url_base: "{{ config['api_url'] or 'https://plausible.io/api/v1/stats' }}"
     authenticator:
       type: BearerAuthenticator
       api_token: "{{ config['api_key'] }}"
@@ -79,14 +79,24 @@ spec:
           - airbyte.com
           - docs.airbyte.com
         order: 1
+      api_url:
+        type: string
+        title: API URL
+        description: >-
+          The API URL of your plausible instance.
+          Change this if you self-host plausible. The default is https://plausible.io/api/v1/stats
+        pattern: ^[A-Za-z0-9-.]+\.[A-Z-a-z0-9-.]+
+        examples:
+          - https://plausible.example.com/api/v1/stats
+        order: 2
       start_date:
         type: string
         title: Data start date
         description: Start date for data to retrieve, in ISO-8601 format.
         pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
         examples:
           - YYYY-MM-DD
-        order: 2
+        order: 3
     additionalProperties: true
 
 metadata:

diff --git a/docs/integrations/sources/plausible.md b/docs/integrations/sources/plausible.md
@@ -16,6 +16,18 @@
 
 - [Stats - Time Series](https://plausible.io/docs/stats-api#get-apiv1statstimeseries)
 
+## Setup steps
+1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) 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 <a href="https://plausible.io/docs/stats-api">docs</a> 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:
@@ -36,6 +48,7 @@ The [stated rate limit](https://plausible.io/docs/stats-api) is 600 requests per
 
 | Version | Date       | Pull Request                                             | Subject        |
 |:--------|:-----------| :------------------------------------------------------- | :------------- |
+| 0.1.12 | 2024-08-06 | [42793](https://github.com/airbytehq/airbyte/pull/43048) | new API URL config option available |
 | 0.1.11 | 2024-08-03 | [43252](https://github.com/airbytehq/airbyte/pull/43252) | Update dependencies |
 | 0.1.10 | 2024-07-27 | [42793](https://github.com/airbytehq/airbyte/pull/42793) | Update dependencies |
 | 0.1.9 | 2024-07-20 | [41918](https://github.com/airbytehq/airbyte/pull/41918) | Update dependencies |