tap-gorgias - Meltano Hub

Gorgias

tap-gorgias (brooklyn-data variant)🥇

Ecommerce Helpdesk

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

Alternate Implementations

Brooklyn Data Co (default)🥇
Pathlight

Getting Started

Prerequisites

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

Installation and configuration

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

meltano add tap-gorgias

Configure the tap-gorgias settings using

meltano config

:

meltano config tap-gorgias set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-gorgias 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-gorgias 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-gorgias 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
email_address
page_size
start_date
subdomain

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-gorgias 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_GORGIAS_API_KEY

API key generated by the user

Configure this setting directly using the following Meltano command:

meltano config tap-gorgias set api_key [value]

Email Address (email_address)

Environment variable: TAP_GORGIAS_EMAIL_ADDRESS

Email address to authenticate with

Configure this setting directly using the following Meltano command:

meltano config tap-gorgias set email_address [value]

Page Size (page_size)

Environment variable: TAP_GORGIAS_PAGE_SIZE
Default Value: 100

The page size for each list endpoint call

Configure this setting directly using the following Meltano command:

meltano config tap-gorgias set page_size [value]

Start Date (start_date)

Environment variable: TAP_GORGIAS_START_DATE

The earliest record date to sync

Configure this setting directly using the following Meltano command:

meltano config tap-gorgias set start_date [value]

Subdomain (subdomain)

Environment variable: TAP_GORGIAS_SUBDOMAIN

Subdomain (.gorgias.com)

Configure this setting directly using the following Meltano command:

meltano config tap-gorgias set subdomain [value]

Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

Environment variable: TAP_GORGIAS_FLATTENING_ENABLED

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

Configure this setting directly using the following Meltano command:

meltano config tap-gorgias set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_GORGIAS_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-gorgias set flattening_max_depth [value]

Stream Map Config (stream_map_config)

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

Stream Maps (stream_maps)

Environment variable: TAP_GORGIAS_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-gorgias 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-gorgias 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-gorgias

Maintenance Status

Repo

https://github.com/brooklyn-data/tap-gorgias

Maintainer

Meltano Stats

Keywords