The tap-gorgias extractor pulls data from Gorgias that can then be sent to a destination using a loader.
Available Variants
- brooklyn-data (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
-
Configure the tap-gorgias
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-gorgias
meltano config tap-gorgias set --interactive
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:
- catalog
- discover
- state
- about
- 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:
You can also list these settings using
with the meltano config
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.
Subdomain (subdomain)
-
Environment variable:
TAP_GORGIAS_SUBDOMAIN
Subdomain (
Configure this setting directly using the following Meltano command:
meltano config tap-gorgias set subdomain [value]
Email Address (email_address)
-
Environment variable:
TAP_GORGIAS_EMAIL_ADDRESS
Email address to authenticate with - required
Configure this setting directly using the following Meltano command:
meltano config tap-gorgias set email_address [value]
API Key (api_key)
-
Environment variable:
TAP_GORGIAS_API_KEY
API key generated by the user - required
Configure this setting directly using the following Meltano command:
meltano config tap-gorgias set api_key [value]
Start Date (start_date)
-
Environment variable:
TAP_GORGIAS_START_DATE
Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
Configure this setting directly using the following Meltano command:
meltano config tap-gorgias set start_date [value]
Ticket View Page Size (ticket_view_page_size)
-
Environment variable:
TAP_GORGIAS_TICKET_VIEW_PAGE_SIZE
The page size for each list view items call. Default is 100, the maximum.
Configure this setting directly using the following Meltano command:
meltano config tap-gorgias set ticket_view_page_size [value]
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general
channel.