Singer tap for Checkly, built with the Meltano SDK for Singer Taps.
Project description
Capabilities
catalogstatediscoveraboutstream-mapsschema-flattening
Settings
| Setting | Required | Default | Description |
|---|---|---|---|
| account_id | True | None | Checkly Account ID |
| token | True | None | API Token for Checkly |
| start_date | False | None | Earliest datetime to get data from |
| include_paid_streams | False | 0 | Include streams that require a paid Checkly plan |
| stream_maps | False | None | Config object for stream maps capability. For more information check out Stream Maps. |
| stream_map_config | False | None | User-defined config values to be used within map expressions. |
| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
| flattening_max_depth | False | None | The max depth to flatten schemas. |
A full list of supported settings and capabilities is available by running: tap-checkly --about
API Coverage
| API Endpoint | Supported | Notes |
|---|---|---|
/v1/alert-channels |
✅ | |
/v1/alert-notifications |
✅ | Payment required |
/v1/checks |
✅ | |
/v1/check-alerts |
✅ | |
/v1/check-groups |
✅ | |
/v1/check-results/{checkId} |
N/A | Heavily rate-limited |
/v1/dashboards |
✅ | |
/v1/locations |
✅ | |
/v1/maintenance-windows |
✅ | |
/v1/private-locations |
✅ | |
/v1/runtimes |
✅ | |
/v1/snippets |
✅ | |
/v1/variables |
✅ |
A full list of supported settings and capabilities is available by running: tap-checkly --about
Source Authentication and Authorization
Usage
You can easily run tap-checkly by itself or in a pipeline using Meltano.
Executing the Tap Directly
tap-checkly --version
tap-checkly --help
tap-checkly --config CONFIG --discover > ./catalog.json
Developer Resources
Initialize your Development Environment
pipx install hatch
Create and Run Tests
Run integration tests:
hatch run test:integration
You can also test the tap-checkly CLI interface directly:
hatch run sync:console -- --about --format=json
Testing with Meltano
Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.
Your project comes with a custom meltano.yml project file already created. Go ahead and install Meltano if you haven't already.
-
Install all plugins
meltano install -
Check that the extractor is working properly
meltano invoke tap-checkly --version
-
Execute an ELT pipeline
meltano run tap-checkly target-jsonl
SDK Dev Guide
See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tap_checkly-0.2.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | db7f79298a1823a27db214f276b9da342067c07a0b9f5ebfdee6e7894a1aa35d |
|
| MD5 | 69a928f78c9547aa8e61d4dd2907a8d1 |
|
| BLAKE2b-256 | 55246599c7665e2125d25fe7f4a12eeef8c1b8d2650f9c6a449c9953fb2cd247 |
