The tap-pendo Meltano extractor pulls data from the Pendo API 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-pendo extractor to your project using meltano add :

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

Using Meltano UI

  1. Start Meltano UI using meltano ui:

    meltano ui
  2. Open the Extractors interface at http://localhost:5000/extractors.
  3. Click the “Add to project” button for “Pendo”.
  4. Configure the settings below in the “Configuration” interface that opens automatically.

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.

Settings

tap-pendo 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.

Integration Key (x_pendo_integration_key)

This is the integration key generated via the Pendo website: Settings -> Integrations -> Integration Keys.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-pendo set x_pendo_integration_key <x_pendo_integration_key>

export TAP_PENDO_INTEGRATION_KEY=<x_pendo_integration_key>

Period (period)

This defines how data is aggregated, either on a daily or hourly basis.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-pendo set period dayRange

export TAP_PENDO_PERIOD=dayRange

Lookback Window (lookback_window)

The number of days to use as the lookback window.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-pendo set lookback_window 0

export TAP_PENDO_LOOKBACK_WINDOW=0

Include Anonymous Visitors (include_anonymous_visitors)

Defines whether or not to include anonymous visitors in the results.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-pendo set include_anonymous_visitors true

export TAP_PENDO_INCLUDE_ANONYMOUS_VISITORS=true

Start Date (start_date)

This is the default start date value to use if no bookmark is present.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-pendo set start_date YYYY-MM-DDTHH:MM:SSZ

export TAP_PENDO_START_DATE=YYYY-MM-DDTHH:MM:SSZ

Looking for help?

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