Plausible

tap-plausible (airbyte variant)🥉

Open source analytics tool

The tap-plausible extractor pulls data from Plausible that can then be sent to a destination using a loader.

Airbyte Usage Notice

This connector uses tap-airbyte-wrapper to call the underlying Airbyte source Docker container. This means you must have Docker installed and running prior to usage. We also recommend using Meltano version 2.13.0 or later.

Container-based connectors can introduce deployment challenges including the potential need to run Docker-in-Docker (not currently supported by services like AWS ECS, Meltano Cloud, etc. see FAQ and Airbyte's ECS deployment docs for more details). Before using this variant we recommend considering if/how you will be able to deploy container-based connectors to production.

For more context on how this Airbyte integration works please checkout out the FAQ in the Meltano Docs.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-plausible extractor to your project using 
    meltano add
     : 
    2. meltano add extractor tap-plausible
  2. Configure the tap-plausible settings using 
    meltano config
     : 
    3. meltano config tap-plausible set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-plausible test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-plausible may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • about
  • catalog
  • discover
  • schema-flattening
  • state
  • stream-maps

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-plausible settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using 

meltano config
with the list subcommand: 

meltano config tap-plausible list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Airbyte Config API Key (airbyte_config.api_key)

  • Environment variable: TAP_PLAUSIBLE_AIRBYTE_CONFIG_API_KEY

Plausible API Key. See the docs for information on how to generate this key.


Configure this setting directly using the following Meltano command:

meltano config tap-plausible set airbyte_config api_key [value]

Airbyte Config API URL (airbyte_config.api_url)

  • Environment variable: TAP_PLAUSIBLE_AIRBYTE_CONFIG_API_URL
  • Default Value: https://plausible.io/api/v1/stats

Plausible API URL. The API URL of your plausible instance. Change this if you self-host plausible. The default is https://plausible.io/api/v1/stats


Configure this setting directly using the following Meltano command:

meltano config tap-plausible set airbyte_config api_url [value]

Airbyte Config Site Id (airbyte_config.site_id)

  • Environment variable: TAP_PLAUSIBLE_AIRBYTE_CONFIG_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.


Configure this setting directly using the following Meltano command:

meltano config tap-plausible set airbyte_config site_id [value]

Airbyte Config Start Date (airbyte_config.start_date)

  • Environment variable: TAP_PLAUSIBLE_AIRBYTE_CONFIG_START_DATE

Start date for data to retrieve, in ISO-8601 format.


Configure this setting directly using the following Meltano command:

meltano config tap-plausible set airbyte_config start_date [value]

Airbyte Spec Image (airbyte_spec.image)

  • Environment variable: TAP_PLAUSIBLE_AIRBYTE_SPEC_IMAGE
  • Default Value: airbyte/source-plausible

Airbyte image to run


Configure this setting directly using the following Meltano command:

meltano config tap-plausible set airbyte_spec image [value]

Airbyte Spec Tag (airbyte_spec.tag)

  • Environment variable: TAP_PLAUSIBLE_AIRBYTE_SPEC_TAG
  • Default Value: latest

Airbyte image tag


Configure this setting directly using the following Meltano command:

meltano config tap-plausible set airbyte_spec tag [value]

Docker Mounts (docker_mounts)

  • Environment variable: TAP_PLAUSIBLE_DOCKER_MOUNTS

Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation


Configure this setting directly using the following Meltano command:

meltano config tap-plausible set docker_mounts [value]
Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_PLAUSIBLE_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.


Configure this setting directly using the following Meltano command:

meltano config tap-plausible set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_PLAUSIBLE_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-plausible set flattening_max_depth [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_PLAUSIBLE_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.


Configure this setting directly using the following Meltano command:

meltano config tap-plausible set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_PLAUSIBLE_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.


Configure this setting directly using the following Meltano command:

meltano config tap-plausible set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-plausible extractor to work, read the Airbyte connector FAQ, look for an existing issue in the Airbyte repository, file a new issue, or join the Meltano Slack community and ask for help in the 
#plugins-general
channel.

Install

meltano add extractor tap-plausible

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK
  • Based on an Airbyte Connector

Repo

https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-plausible
  • Last Commit Date
  • License

Maintainer

  • Airbyte

Keywords

  • airbyte_protocolmeltano_sdk