The tap-outreach Meltano extractor pulls data from Outreach that can then be sent to a destination using a loader.
Other Available Variants
- singer-io (default)
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-outreach extractor to your project
using
:meltano add
-
Configure the tap-outreach settings using
:meltano config
-
Test that extractor settings are valid using
:meltano test
meltano add extractor tap-outreach
meltano config tap-outreach set --interactive
meltano test tap-outreach
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 fortap-outreach
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-outreach
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
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.
Start Date (start_date)
-
Environment variable:
TAP_OUTREACH_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.
Client ID (client_id)
-
Environment variable:
TAP_OUTREACH_CLIENT_ID
Your Outreach client ID.
Client Secret (client_secret)
-
Environment variable:
TAP_OUTREACH_CLIENT_SECRET
Your Outreach client secret.
Redirect URI (redirect_uri)
-
Environment variable:
TAP_OUTREACH_REDIRECT_URI
The Outreach redirect URI.
Refresh Token (refresh_token)
-
Environment variable:
TAP_OUTREACH_REFRESH_TOKEN
Your Outreach refresh token.
Quota Limit (quota_limit)
-
Environment variable:
TAP_OUTREACH_QUOTA_LIMIT
The request quota limit.
Page Size (page_size)
-
Environment variable:
TAP_OUTREACH_PAGE_SIZE
The page size of request responses.
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.
Install
meltano add extractor tap-outreach
Maintenance Status
Meltano Stats
Keywords