Gorgias

tap-gorgias from brooklyn-data

Ecommerce Helpdesk

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

Available Variants

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
    :
  2. meltano add extractor tap-gorgias
  3. Configure the tap-gorgias settings using
    meltano config
    :
  4. meltano config tap-gorgias set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-gorgias test

Next steps

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 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 (.gorgias.com) - required

Email Address (email_address)

  • Environment variable: TAP_GORGIAS_EMAIL_ADDRESS

Email address to authenticate with - required

API Key (api_key)

  • Environment variable: TAP_GORGIAS_API_KEY

API key generated by the user - required

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.

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.

Commands

The tap-gorgias extractor supports the following commands that can be used with
meltano invoke
:

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 extractor tap-gorgias

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Brooklyn Data Co

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)
  • Built with the Meltano SDK

Keywords

  • apimeltano_sdk