1
0
mirror of synced 2025-12-30 21:02:43 -05:00
Files
airbyte/docs/integrations/sources/captain-data.md
Elliot T 9e1e198e18 🎉 New Source: Captain Data [Configuration based CDK] (#25230)
* initiate connector

* add doc

* fix schema

* add docs

* fix comments

* add logo

* add finished job filter

* suggested changes

* add metadata.yml

* add definition id

* update schemas

---------

Co-authored-by: Sajarin <sajarindider@gmail.com>
2023-07-25 08:03:09 -05:00

2.2 KiB

Captain Data

This page contains the setup guide and reference information for the Captain Data source connector.

Prerequisites

Api key and project UID are mandate for this connector to work, It could be generated from the dashboard settings (ref - https://app.captaindata.co/settings).

Setup guide

Step 1: Set up Captain Data connection

  • Available params
    • api_key: The api_key
    • project_uid: The project UID

Step 2: Set up the Captain Data connector in Airbyte

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click +new source.
  3. On the Set up the source page, enter the name for the Captain Data connector and select Captain Data from the Source type dropdown.
  4. Enter your api_key and project_uid.
  5. Click Set up source.

For Airbyte OSS:

  1. Navigate to the Airbyte Open Source dashboard.
  2. Set the name for your source.
  3. Enter your api_key and project_uid.
  4. Click Set up source.

Supported sync modes

The Captain Data source connector supports the following sync modes:

Feature Supported?
Full Refresh Sync Yes
Incremental Sync No
Replicate Incremental Deletes No
SSL connection Yes
Namespaces No

Supported Streams

  • workspace
  • workflows
  • jobs
  • job_results

API method example

GET https://api.captaindata.co/v3/

Performance considerations

Captain Data API reference has v3 at present. The connector as default uses v3.

Changelog

Version Date Pull Request Subject
0.1.0 2023-04-15 Init Initial commit