Gladly Singer Tap

0.4.1 · active · verified Tue Apr 14

`tap-gladly` is an open-source Singer tap designed to extract data from the Gladly customer service platform. Built using the Meltano SDK for Singer Taps, it adheres to the Singer Specification, providing a standardized JSON-based output for integration into various ELT pipelines. The current version is `0.4.1`, and releases typically align with updates to the underlying Gladly API or improvements in the Meltano SDK, rather than a fixed cadence.

Warnings

breaking Major version updates to the Gladly API or changes in the underlying Singer schema (e.g., modifying primary keys, making schemas more restrictive) can introduce breaking changes. Always review release notes for `tap-gladly` and the Gladly API before upgrading.
Fix: Consult the `tap-gladly` release notes and the Gladly API documentation. Update your `catalog.json` if schemas have changed and adjust downstream consumers as necessary.
gotcha API rate limits are common for external services like Gladly. Excessive requests without proper backoff or concurrency management can lead to temporary blocks or errors. `tap-gladly` relies on the Meltano SDK's handling, but aggressive syncs may still hit limits.
Fix: Ensure your `tap-gladly` configuration respects API rate limits if available. If running within Meltano, consider configuring `Meltano`'s `max_workers` or `concurrency` settings. Review Gladly's API documentation for specific rate limit details.
gotcha All date and time values, especially `start_date` in the configuration, should strictly adhere to the RFC3339 format, preferably in UTC (e.g., `2023-01-01T00:00:00Z`). Incorrect formats can lead to parsing errors or unexpected data extraction ranges.
Fix: Always use ISO 8601 / RFC3339 compliant date-time strings, including timezone information (e.g., 'Z' for UTC or an offset like '+00:00').
gotcha The tap has a strict Python version requirement, supporting Python 3.7.1 up to, but not including, Python 3.11. Using unsupported Python versions may lead to installation failures or runtime errors.
Fix: Ensure your environment uses a compatible Python version (e.g., 3.8, 3.9, 3.10). Consider using a virtual environment to manage Python versions.

Install

pip install tap-gladly Install latest version

Imports

Tap
```
from singer_sdk import Tap
```
While `tap-gladly` is primarily a command-line utility, `singer_sdk.Tap` is the base class it extends. This import is relevant for developers extending or inspecting the tap's internal structure, not for typical end-user execution.

Quickstart

This quickstart demonstrates how to run `tap-gladly` as a standalone Singer tap. It first sets up a basic `config.json` with a placeholder API token and a `start_date` for historical data extraction. Then, it uses the `--discover` flag to generate a `catalog.json` detailing available data streams and their schemas. Finally, it executes a data sync using the generated catalog, an empty `state.json` (for the initial run), and outputs the extracted data in JSONL format to `data.jsonl`. Replace `your_gladly_api_token` and `https://your-gladly-instance.gladly.com` with your actual Gladly API credentials and instance URL.

export GLADLY_API_TOKEN="your_gladly_api_token"

# 1. Create a minimal configuration file (config.json)
cat <<EOF > config.json
{
  "api_url": "https://your-gladly-instance.gladly.com",
  "api_token": "$GLADLY_API_TOKEN",
  "start_date": "2023-01-01T00:00:00Z"
}
EOF

# 2. Discover available streams and their schemas
tap-gladly --config config.json --discover > catalog.json

# 3. Perform a data sync (extract data)
tap-gladly --config config.json --catalog catalog.json --state state.json > data.jsonl

# (Optional) View the first few lines of extracted data
head data.jsonl

view raw JSON →