tap-sailthru - Meltano Hub

Sailthru

tap-sailthru (voxmedia variant)🥈

Marketing Automation Software

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

Alternate Implementations

Bytecode IO
Stitch Data
(default)🥉
voxmedia🥈

Getting Started

Prerequisites

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

Installation and configuration

Add the tap-sailthru extractor to your project using
```
meltano add
```
:

meltano add extractor tap-sailthru --variant voxmedia

Configure the tap-sailthru settings using

meltano config

:

meltano config tap-sailthru set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-sailthru 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-sailthru 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-sailthru 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:

account_name
api_key
api_secret
chunk_number
num_chunks
request_timeout
start_date
table_id
user_agent

Expand To Show SDK Settings

flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-sailthru 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.

Account Name (account_name)

Environment variable: TAP_SAILTHRU_ACCOUNT_NAME

Name of the sailthru account

Configure this setting directly using the following Meltano command:

meltano config tap-sailthru set account_name [value]

API Key (api_key)

Environment variable: TAP_SAILTHRU_API_KEY

API key for the sailthru account

Configure this setting directly using the following Meltano command:

meltano config tap-sailthru set api_key [value]

API Secret (api_secret)

Environment variable: TAP_SAILTHRU_API_SECRET

API secret for the sailthru account

Configure this setting directly using the following Meltano command:

meltano config tap-sailthru set api_secret [value]

Chunk Number (chunk_number)

Environment variable: TAP_SAILTHRU_CHUNK_NUMBER
Default Value: 0

Which chunk to feed into List Members

Configure this setting directly using the following Meltano command:

meltano config tap-sailthru set chunk_number [value]

Num Chunks (num_chunks)

Environment variable: TAP_SAILTHRU_NUM_CHUNKS
Default Value: 1

How many chunks to split List Members into

Configure this setting directly using the following Meltano command:

meltano config tap-sailthru set num_chunks [value]

Request Timeout (request_timeout)

Environment variable: TAP_SAILTHRU_REQUEST_TIMEOUT
Default Value: 300

The url for the API service

Configure this setting directly using the following Meltano command:

meltano config tap-sailthru set request_timeout [value]

Start Date (start_date)

Environment variable: TAP_SAILTHRU_START_DATE

The earliest record date to sync

Configure this setting directly using the following Meltano command:

meltano config tap-sailthru set start_date [value]

Table ID (table_id)

Environment variable: TAP_SAILTHRU_TABLE_ID

Table ID for List Members parent stream

Configure this setting directly using the following Meltano command:

meltano config tap-sailthru set table_id [value]

User Agent (user_agent)

Environment variable: TAP_SAILTHRU_USER_AGENT

User agent for http requests

Configure this setting directly using the following Meltano command:

meltano config tap-sailthru set user_agent [value]

Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

Environment variable: TAP_SAILTHRU_FLATTENING_ENABLED

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

Configure this setting directly using the following Meltano command:

meltano config tap-sailthru set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_SAILTHRU_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-sailthru set flattening_max_depth [value]

Stream Map Config (stream_map_config)

Environment variable: TAP_SAILTHRU_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-sailthru set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_SAILTHRU_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-sailthru 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-sailthru extractor to work, look for an existing issue in its 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-sailthru --variant voxmedia

Maintenance Status

Repo

https://github.com/voxmedia/tap-sailthru

Maintainer

Meltano Stats

Keywords