Gorgias
Table of Contents
The tap-gorgias
Meltano extractor pulls data from Gorgias that can then be sent to a destination using a loader.
-
- Repository: https://github.com/brooklyn-data/tap-gorgias
-
-
-
-
-
-
-
- Maintainer: Brooklyn Data Co
- Meltano Stats:
-
-
- Built with Meltano SDK: ✔
Alternative variants #
Multiple
variants
of tap-gorgias
are available.
This document describes the default brooklyn-data
variant,
which is recommended for new users.
Alternative variants are:
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 usingmeltano add
:meltano add extractor tap-gorgias
-
Configure the settings below using
meltano config
.
Next steps #
Follow the remaining steps of the Getting Started guide:
- Select entities and attributes to extract
- Add a loader to send data to a destination
- Run a data integration (EL) pipeline
Capabilities #
Settings #
The settings for extractor tap-gorgias
that are known to Meltano are documented below.
To quickly find the
setting you're looking for, use the Table of Contents at
the top of the page.
Subdomain (subdomain
)
#
-
Environment variable:
TAP_GORGIAS_SUBDOMAIN
Subdomain (
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-gorgias set subdomain <subdomain>
export TAP_GORGIAS_SUBDOMAIN=<subdomain>
Email Address (email_address
)
#
-
Environment variable:
TAP_GORGIAS_EMAIL_ADDRESS
Email address to authenticate with - required
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-gorgias set email_address <email_address>
export TAP_GORGIAS_EMAIL_ADDRESS=<email_address>
API Key (api_key
)
#
-
Environment variable:
TAP_GORGIAS_API_KEY
API key generated by the user - required
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-gorgias set api_key <api_key>
export TAP_GORGIAS_API_KEY=<api_key>
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.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-gorgias set start_date YYYY-MM-DDTHH:MM:SSZ
export TAP_GORGIAS_START_DATE=YYYY-MM-DDTHH:MM:SSZ
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.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-gorgias set ticket_view_page_size 1234
export TAP_GORGIAS_TICKET_VIEW_PAGE_SIZE=1234
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.
Found an issue on this page? #
This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!