The tap-feefo extractor pulls data from Feefo that can then be sent to a destination using a loader.
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-feefo extractor to your
project using
:meltano add
-
Configure the tap-feefo
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-feefo
meltano config tap-feefo set --interactive
meltano config tap-feefo test
Next steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-feefo
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
- batch
- 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-feefo
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
with the meltano config
list
subcommand:
meltano config tap-feefo 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.
Client ID (client_id)
-
Environment variable:
TAP_FEEFO_CLIENT_ID
Feefo app client ID
reviews
: set along with client_secret
to include additional data
only returned by the API in an authenticated context (more info)
Configure this setting directly using the following Meltano command:
meltano config tap-feefo set client_id [value]
Client secret (client_secret)
-
Environment variable:
TAP_FEEFO_CLIENT_SECRET
Feefo app client secret
reviews
: set along with client_id
to include additional data only returned by
the API in an authenticated context (more info)
Configure this setting directly using the following Meltano command:
meltano config tap-feefo set client_secret [value]
Merchant ID (merchant_id)
-
Environment variable:
TAP_FEEFO_MERCHANT_ID
Feefo merchant ID (e.g. example-retail-merchant
)
Configure this setting directly using the following Meltano command:
meltano config tap-feefo set merchant_id [value]
Start date (start_date)
-
Environment variable:
TAP_FEEFO_START_DATE
Timestamp in ISO 8601 format to get data from (inclusive)
Defaults to the first day/month of the current year (e.g. 2025-01-1
)
reviews
: resolves to an updated period of month
, year
or all
understood by
the API (more info)
Configure this setting directly using the following Meltano command:
meltano config tap-feefo set start_date [value]
Expand To Show SDK Settings
Batch Compression Format (batch_config.encoding.compression)
-
Environment variable:
TAP_FEEFO_BATCH_CONFIG_ENCODING_COMPRESSION
Compression format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-feefo set batch_config encoding.compression [value]
Batch Encoding Format (batch_config.encoding.format)
-
Environment variable:
TAP_FEEFO_BATCH_CONFIG_ENCODING_FORMAT
Format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-feefo set batch_config encoding.format [value]
Batch Storage Prefix (batch_config.storage.prefix)
-
Environment variable:
TAP_FEEFO_BATCH_CONFIG_STORAGE_PREFIX
Prefix to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-feefo set batch_config storage.prefix [value]
Batch Storage Root (batch_config.storage.root)
-
Environment variable:
TAP_FEEFO_BATCH_CONFIG_STORAGE_ROOT
Root path to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-feefo set batch_config storage.root [value]
Faker Locale (faker_config.locale)
-
Environment variable:
TAP_FEEFO_FAKER_CONFIG_LOCALE
One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization
Configure this setting directly using the following Meltano command:
meltano config tap-feefo set faker_config locale [value]
Faker Seed (faker_config.seed)
-
Environment variable:
TAP_FEEFO_FAKER_CONFIG_SEED
Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator
Configure this setting directly using the following Meltano command:
meltano config tap-feefo set faker_config seed [value]
Enable Schema Flattening (flattening_enabled)
-
Environment variable:
TAP_FEEFO_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-feefo set flattening_enabled [value]
Max Flattening Depth (flattening_max_depth)
-
Environment variable:
TAP_FEEFO_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-feefo set flattening_max_depth [value]
User Stream Map Configuration (stream_map_config)
-
Environment variable:
TAP_FEEFO_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-feefo set stream_map_config [value]
Stream Maps (stream_maps)
-
Environment variable:
TAP_FEEFO_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-feefo 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?
#plugins-general
channel.