Partnerize

tap-partnerize (voxmedia variant)🥈

Partnerize API

The tap-partnerize extractor pulls data from Partnerize 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

  1. Add the tap-partnerize extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-partnerize
  3. Configure the tap-partnerize settings using
    meltano config
    :
  4. meltano config tap-partnerize set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-partnerize test

Next steps

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

Capabilities

The current capabilities for tap-partnerize 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-partnerize 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

meltano config
with the list subcommand:

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

Password (password)

  • Environment variable: TAP_PARTNERIZE_PASSWORD

The password to authenticate the Partnerize account


Configure this setting directly using the following Meltano command:

meltano config tap-partnerize set password [value]

Publisher ID (publisher_id)

  • Environment variable: TAP_PARTNERIZE_PUBLISHER_ID

The partner id


Configure this setting directly using the following Meltano command:

meltano config tap-partnerize set publisher_id [value]

Start Date (start_date)

  • Environment variable: TAP_PARTNERIZE_START_DATE

The earliest record date to retrieve


Configure this setting directly using the following Meltano command:

meltano config tap-partnerize set start_date [value]

Username (username)

  • Environment variable: TAP_PARTNERIZE_USERNAME

The username to authenticate the Partnerize account


Configure this setting directly using the following Meltano command:

meltano config tap-partnerize set username [value]
Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_PARTNERIZE_FLATTENING_ENABLED

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


Configure this setting directly using the following Meltano command:

meltano config tap-partnerize set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_PARTNERIZE_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-partnerize set flattening_max_depth [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_PARTNERIZE_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-partnerize set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_PARTNERIZE_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-partnerize 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-partnerize 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-partnerize

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/voxmedia/tap-partnerize
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • voxmedia

Keywords

  • apimeltano_sdk