The tap-kustomer extractor pulls data from Kustomer that can then be sent to a destination using a loader.
Alternate Implementations
- Beam Technologies
- Bytecode IO
- cdolan-summersalt
- drueffect
- emrom1008
- isabella232
- Jeff Huth
- Meltano (default)🥇
- Pathlight
- Ross Berger
- Stitch Data🥈
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-kustomer extractor to your
project using
:meltano add
-
Configure the tap-kustomer
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-kustomer --variant singer-io
meltano config tap-kustomer set --interactive
meltano config tap-kustomer 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-kustomer
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:
- catalog
- discover
- state
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
tap-kustomer
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-kustomer 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.
API Token (api_token)
-
Environment variable:
TAP_KUSTOMER_API_TOKEN
Your API token. See the docs on how to obtain this.
Configure this setting directly using the following Meltano command:
meltano config tap-kustomer set api_token [value]
Date Window Size (date_window_size)
-
Environment variable:
TAP_KUSTOMER_DATE_WINDOW_SIZE
The number of days (between the from and to dates) for date-windowing through the date-filtered endpoints (default = 60).
Configure this setting directly using the following Meltano command:
meltano config tap-kustomer set date_window_size [value]
Page Size Limit (page_size_limit)
-
Environment variable:
TAP_KUSTOMER_PAGE_SIZE_LIMIT
The number of records to return per API request. Default, 100.
Configure this setting directly using the following Meltano command:
meltano config tap-kustomer set page_size_limit [value]
Start Date (start_date)
-
Environment variable:
TAP_KUSTOMER_START_DATE
Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
Configure this setting directly using the following Meltano command:
meltano config tap-kustomer set start_date [value]
User Agent (user_agent)
-
Environment variable:
TAP_KUSTOMER_USER_AGENT
The user agent to send with requests.
Configure this setting directly using the following Meltano command:
meltano config tap-kustomer set user_agent [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.