 | GainsightPX
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 -
Configure the tap-gainsightpx settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-gainsightpxmeltano config tap-gainsightpx set --interactivemeltano config tap-gainsightpx testNext 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:
- catalog
- state
- discover
- about
- stream-maps
- schema-flattening
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_urlapi_keypage_sizestart_dateend_datestream_mapsstream_map_configflattening_enabledflattening_max_depth
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 URI (api_url)
-
Environment variable:
TAP_GAINSIGHTPX_API_URL
The base url for GainsightPX service. See GainsightPX docs.
API Key (api_key)
-
Environment variable:
TAP_GAINSIGHTPX_API_KEY
The api key to authenticate against the GainsightPX service.
Page Size (page_size)
-
Environment variable:
TAP_GAINSIGHTPX_PAGE_SIZE
The number of records to return from the API in single page.Default and max varies based on the endpoint
Start Date (start_date)
-
Environment variable:
TAP_GAINSIGHTPX_START_DATE
The earliest record date to sync (inclusive '>='). ISO Format.
End Date (end_date)
-
Environment variable:
TAP_GAINSIGHTPX_END_DATE
The latest record date to sync (inclusive '<='). ISO format.
Stream Maps (stream_maps)
-
Environment variable:
TAP_GAINSIGHTPX_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Stream Map Config (stream_map_config)
-
Environment variable:
TAP_GAINSIGHTPX_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_GAINSIGHTPX_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_GAINSIGHTPX_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-generalInstall
meltano add extractor tap-gainsightpx
Maintenance Status
-brightgreen){kind=icon}
Maintainer
Meltano Stats
Keywords
