-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add additional docs per connector checklist
- Loading branch information
1 parent
0b7edb8
commit c37bd63
Showing
6 changed files
with
53 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,8 +19,8 @@ | |
setup( | ||
name="source_qualaroo", | ||
description="Source implementation for Qualaroo.", | ||
author="Airbyte", | ||
author_email="[email protected]", | ||
author="Daniel Diamond", | ||
author_email="[email protected]", | ||
packages=find_packages(), | ||
install_requires=MAIN_REQUIREMENTS, | ||
package_data={"": ["*.json", "schemas/*.json", "schemas/shared/*.json"]}, | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Qualaroo | ||
|
||
## Overview | ||
|
||
The Qualaroo source supports Full Refresh syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run. | ||
|
||
This Source Connector is based on a [Airbyte CDK](https://docs.airbyte.io/connector-development/cdk-python). | ||
|
||
### Output schema | ||
|
||
Several output streams are available from this source: | ||
|
||
* [Surveys](https://help.qualaroo.com/hc/en-us/articles/201969438-The-REST-Reporting-API) \(Full table\) | ||
* [Responses](https://help.qualaroo.com/hc/en-us/articles/201969438-The-REST-Reporting-API) \(Full table\) | ||
|
||
If there are more endpoints you'd like Airbyte to support, please [create an issue.](https://github.com/airbytehq/airbyte/issues/new/choose) | ||
|
||
### Features | ||
|
||
| Feature | Supported? | | ||
| :--- | :--- | | ||
| Full Refresh Sync | Yes | | ||
| Incremental - Append Sync | NO | | ||
| SSL connection | Yes | | ||
| Namespaces | No | | ||
|
||
### Performance considerations | ||
|
||
The connector is **not** yet restricted by normal requests limitation. As a result, the Qualaroo connector might run into API limitations under normal usage. Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully. | ||
|
||
## Getting started | ||
|
||
### Requirements | ||
|
||
* Qualaroo API Key | ||
* Qualaroo API Token | ||
|
||
### Setup guide | ||
<!-- markdown-link-check-disable-next-line --> | ||
Please read [How to get your APIs Token and Key](https://help.qualaroo.com/hc/en-us/articles/201969438-The-REST-Reporting-API) or you can log in to Qualaroo and visit [Reporting API](https://app.qualaroo.com/account). | ||
|
||
## Changelog | ||
|
||
| Version | Date | Pull Request | Subject | | ||
| :--- | :--- | :--- | :--- | | ||
| 0.1.0 | 2021-08-18 | [8623](https://github.com/airbytehq/airbyte/pull/8623) | New source: Qualaroo | | ||
|