Skip to content

Commit

Permalink
add source-definitions (#4601)
Browse files Browse the repository at this point in the history
* add source-definitions

* tmp: add docs

* upd docs

* add changelog

* changes

* upd docs/integrations/readme
  • Loading branch information
vovavovavovavova committed Jul 7, 2021
1 parent b8b205a commit 4774edf
Show file tree
Hide file tree
Showing 6 changed files with 80 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"sourceDefinitionId": "badc5925-0485-42be-8caa-b34096cb71b5",
"name": "Survey Monkey",
"dockerRepository": "airbyte/source-surveymonkey",
"dockerImageTag": "0.1.0",
"documentationUrl": "https://docs.airbyte.io/integrations/sources/surveymonkey"
}
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,11 @@
dockerRepository: airbyte/source-okta
dockerImageTag: 0.1.2
documentationUrl: https://docs.airbyte.io/integrations/sources/okta
- sourceDefinitionId: badc5925-0485-42be-8caa-b34096cb71b5
name: Survey Monkey
dockerRepository: airbyte/source-surveymonkey
dockerImageTag: 0.1.0
documentationUrl: https://docs.airbyte.io/integrations/sources/surveymonkey
- sourceDefinitionId: 77225a51-cd15-4a13-af02-65816bd0ecf4
name: Square
dockerRepository: airbyte/source-square
Expand Down
6 changes: 6 additions & 0 deletions airbyte-integrations/connectors/source-surveymonkey/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,3 +129,9 @@ You've checked out the repo, implemented a million dollar feature, and you're re
1. Create a Pull Request.
1. Pat yourself on the back for being an awesome contributor.
1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.

### Performance considerations

The SurveyMonkey API applies heavy API quotas for default private apps, which have the following limits:
* 125 requests per minute
* 500 requests per day
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@
* [Snowflake](integrations/sources/snowflake.md)
* [Square](integrations/sources/square.md)
* [Stripe](integrations/sources/stripe.md)
* [Surveymonkey](integrations/sources/surveymonkey.md)
* [Tempo](integrations/sources/tempo.md)
* [Twilio](integrations/sources/twilio.md)
* [Zendesk Chat](integrations/sources/zendesk-chat.md)
Expand Down
1 change: 1 addition & 0 deletions docs/integrations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ Airbyte uses a grading system for connectors to help users understand what to ex
|[Smartsheets](./sources/smartsheets.md)| Beta |
|[Snowflake](./sources/snowflake.md)| Beta |
|[Stripe](./sources/stripe.md)| Certified |
|[SurveyMonkey](./sources/surveymonkey.md)| Beta |
|[Tempo](./sources/tempo.md)| Beta |
|[Twilio](./sources/twilio.md)| Beta |
|[Zendesk Chat](./sources/zendesk-chat.md)| Certified |
Expand Down
60 changes: 60 additions & 0 deletions docs/integrations/sources/surveymonkey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Surveymonkey

## Sync overview

This source can sync data for the [SurveyMonkey API](https://developer.surveymonkey.com/api/v3/). It supports both Full Refresh and Incremental 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.

### Output schema

This Source is capable of syncing the following core Streams:

* [Surveys](https://developer.surveymonkey.com/api/v3/#surveys) (Incremental)
* [SurveyPages](https://developer.surveymonkey.com/api/v3/#surveys-id-pages)
* [SurveyQuestions](https://developer.surveymonkey.com/api/v3/#surveys-id-pages-id-questions)
* [SurveyResponses](https://developer.surveymonkey.com/api/v3/#survey-responses)

### Data type mapping

| Integration Type | Airbyte Type | Notes |
| :--- | :--- | :--- |
| `string` | `string` | |
| `number` | `number` | |
| `array` | `array` | |
| `object` | `object` | |

### Features

| Feature | Supported?\(Yes/No\) | Notes |
| :--- | :--- | :--- |
| Full Refresh Sync | Yes | |
| Incremental Sync | Yes | |
| Namespaces | No | |

### Performance considerations

The SurveyMonkey API applies heavy API quotas for default private apps, which have the following limits:
* 125 requests per minute
* 500 requests per day

To cover more data from this source we use caching.

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

* SurveyMonkey API Key

### Setup guide

Please read this [docs](https://developer.surveymonkey.com/api/v3/#getting-started).
Register your application [here](https://developer.surveymonkey.com/apps/)
Then go to Settings and copy your access token

## Changelog

| Version | Date | Pull Request | Subject |
| :------ | :-------- | :----- | :------ |
| 0.1.0 | 2021-07-06 | [4097](https://github.com/airbytehq/airbyte/pull/4097) | Initial Release |

0 comments on commit 4774edf

Please sign in to comment.