tap-gainsightpx - Meltano Hub

GainsightPX

tap-gainsightpx (widen variant)🥈

User tracking in web apps

The tap-gainsightpx extractor pulls data from GainsightPX 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:

Installation and configuration

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

meltano add extractor tap-gainsightpx

Configure the tap-gainsightpx settings using

meltano config

:

meltano config tap-gainsightpx set --interactive

Test that extractor settings are valid using

meltano config

:

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

api_key
api_url
end_date
page_size
start_date

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-gainsightpx 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.

API Key (api_key)

Environment variable: TAP_GAINSIGHTPX_API_KEY

The api key to authenticate against the GainsightPX service

Configure this setting directly using the following Meltano command:

meltano config tap-gainsightpx set api_key [value]

API URL (api_url)

Environment variable: TAP_GAINSIGHTPX_API_URL
Default Value: https://api.aptrinsic.com/v1

The base url for GainsightPX service. See GainsightPX docs.

Configure this setting directly using the following Meltano command:

meltano config tap-gainsightpx set api_url [value]

End Date (end_date)

Environment variable: TAP_GAINSIGHTPX_END_DATE

The latest record date to sync (inclusive '<='). ISO format.

Configure this setting directly using the following Meltano command:

meltano config tap-gainsightpx set end_date [value]

Page Size (page_size)

Environment variable: TAP_GAINSIGHTPX_PAGE_SIZE
Default Value: 500

The number of records to return from the API in single page. Default and max varies based on the endpoint.

Configure this setting directly using the following Meltano command:

meltano config tap-gainsightpx set page_size [value]

Start Date (start_date)

Environment variable: TAP_GAINSIGHTPX_START_DATE

The earliest record date to sync (inclusive '>='). ISO Format

Configure this setting directly using the following Meltano command:

meltano config tap-gainsightpx set start_date [value]

Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

Environment variable: TAP_GAINSIGHTPX_FLATTENING_ENABLED

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

Configure this setting directly using the following Meltano command:

meltano config tap-gainsightpx set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_GAINSIGHTPX_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-gainsightpx set flattening_max_depth [value]

Stream Map Config (stream_map_config)

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

Stream Maps (stream_maps)

Environment variable: TAP_GAINSIGHTPX_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-gainsightpx 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-gainsightpx 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-gainsightpx

Maintenance Status

Repo

https://github.com/Widen/tap-gainsightpx

Maintainer

Meltano Stats

Keywords