The tap-mode Meltano extractor pulls data from Mode 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:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

Using the Command Line Interface #

  1. Add the tap-mode extractor to your project using meltano add : 

    meltano add extractor tap-mode
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline

If you run into any issues, learn how to get help.

Capabilities #

Settings #

tap-mode requires the configuration of the following settings:

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

Auth Token (auth_token) #

API access token. See how to obtain it from Mode here

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-mode set auth_token <auth_token>

export TAP_MODE_AUTH_TOKEN=<auth_token>

Workspace (workspace) #

Name of the Mode workspace

See https://asknicely.asknice.ly/help/apidocs/auth.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-mode set workspace <workspace>

export TAP_MODE_WORKSPACE=<workspace>

User Agent (user_agent) #

The name of your app and a contact email address should the API provider need to contact you for any reason.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-mode set user_agent <user_agent>

export TAP_MODE_USER_AGENT=<user_agent>

Looking for help? #

If you're having trouble getting the tap-mode 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.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!