tap-saasoptics - Meltano Hub

SaasOptics

tap-saasoptics (datarts-tech variant)🥈

SaaS Metrics and Analytics Platform

The tap-saasoptics extractor pulls data from SaasOptics that can then be sent to a destination using a loader.

Alternate Implementations

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

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

meltano add tap-saasoptics

Configure the tap-saasoptics settings using

meltano config

:

meltano config tap-saasoptics set --interactive

Test that extractor settings are valid using

meltano config

:

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

account_name
api_token
custom_fields
server_subdomain
start_date
user_agent

Expand To Show SDK Settings

batch_config.encoding.compression
batch_config.encoding.format
batch_config.storage.prefix
batch_config.storage.root
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-saasoptics 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.

Account Name (account_name)

Environment variable: TAP_SAASOPTICS_ACCOUNT_NAME

The account_name is everything between .saasoptics.com. and api in the SaaSOptics URL.

Configure this setting directly using the following Meltano command:

meltano config tap-saasoptics set account_name [value]

API Token (api_token)

Environment variable: TAP_SAASOPTICS_API_TOKEN

Your API token.

Configure this setting directly using the following Meltano command:

meltano config tap-saasoptics set api_token [value]

Custom Fields (custom_fields)

Environment variable: TAP_SAASOPTICS_CUSTOM_FIELDS

All listed fields are included into specific stream.

Configure this setting directly using the following Meltano command:

meltano config tap-saasoptics set custom_fields [value]

Server Subdomain (server_subdomain)

Environment variable: TAP_SAASOPTICS_SERVER_SUBDOMAIN

The server_subdomain is everything before .saasoptics.com..

Configure this setting directly using the following Meltano command:

meltano config tap-saasoptics set server_subdomain [value]

Start Date (start_date)

Environment variable: TAP_SAASOPTICS_START_DATE

Start date for date-filtered endpoints.

Configure this setting directly using the following Meltano command:

meltano config tap-saasoptics set start_date [value]

User Agent (user_agent)

Environment variable: TAP_SAASOPTICS_USER_AGENT

tap-saasoptics <api_user_email@your_company.com>.

Configure this setting directly using the following Meltano command:

meltano config tap-saasoptics set user_agent [value]

Expand To Show SDK Settings

Batch Config Encoding Compression (batch_config.encoding.compression)

Environment variable: TAP_SAASOPTICS_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-saasoptics set batch_config encoding.compression [value]

Batch Config Encoding Format (batch_config.encoding.format)

Environment variable: TAP_SAASOPTICS_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-saasoptics set batch_config encoding.format [value]

Batch Config Storage Prefix (batch_config.storage.prefix)

Environment variable: TAP_SAASOPTICS_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-saasoptics set batch_config storage.prefix [value]

Batch Config Storage Root (batch_config.storage.root)

Environment variable: TAP_SAASOPTICS_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-saasoptics set batch_config storage.root [value]

Flattening Enabled (flattening_enabled)

Environment variable: TAP_SAASOPTICS_FLATTENING_ENABLED

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

Configure this setting directly using the following Meltano command:

meltano config tap-saasoptics set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_SAASOPTICS_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-saasoptics set flattening_max_depth [value]

Stream Map Config (stream_map_config)

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

Stream Maps (stream_maps)

Environment variable: TAP_SAASOPTICS_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-saasoptics 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-saasoptics 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
              tap-saasoptics

Maintenance Status

Repo

https://github.com/datarts-tech/tap-saasoptics

Maintainer

Meltano Stats

Keywords