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

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:

Standalone usage #

Install the package using pip: 

pip install git+https://github.com/brooklyn-data/tap-gorgias.git

For additional instructions, refer to the README in the repository.

Usage with Meltano #

Meltano helps you manage your configuration, incremental replication, and scheduled pipelines.

View the Meltano-specific tap-gorgias instructions to learn more.

Capabilities #

These capabilities can also be overriden by specifying the capabilities key in your meltano.yml file.

Settings #

The settings for tap 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.

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 tap.

Subdomain (subdomain) #

Subdomain (.gorgias.com) - required

Email Address (email_address) #

Email address to authenticate with - required

API Key (api_key) #

API key generated by the user - required

Start Date (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.

Ticket View Page Size (ticket_view_page_size) #

The page size for each list view items call. Default is 100, the maximum.

Looking for help? #

If you're having trouble getting the tap-gorgias tap 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!