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

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:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

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

    meltano add extractor tap-gorgias
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline
If you run into any issues, learn how to get help.

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) #

Subdomain (.gorgias.com) - required

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) #

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) #

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) #

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) #

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!