The tap-dixa extractor pulls data from dixa that can then be sent to a destination using a loader.
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-dixa extractor to your
project using
:meltano add
-
Configure the tap-dixa
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-dixa
meltano config tap-dixa set --interactive
meltano config tap-dixa 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-dixa
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-dixa
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-dixa 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_DIXA_API_TOKEN
Your dixa API token, see the docs https://docs.dixa.io/docs/tutorial-create-an-api-token/.
Configure this setting directly using the following Meltano command:
meltano config tap-dixa set api_token [value]
Interval (interval)
-
Environment variable:
TAP_DIXA_INTERVAL
One of the following: "HOUR", "DAY", "WEEK", "MONTH". Default is "MONTH". Interval is used for determing the time interval for the created_after and created_before query string parameters for the conversations and messages streams.
Configure this setting directly using the following Meltano command:
meltano config tap-dixa set interval [value]
Start Date (start_date)
-
Environment variable:
TAP_DIXA_START_DATE
Determines how much historical data will be extracted. Please be aware
Configure this setting directly using the following Meltano command:
meltano config tap-dixa set start_date [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.