forked from airbytehq/airbyte
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Source Twitter: certify to beta (airbytehq#23749)
Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>
- Loading branch information
1 parent
0c8f8c8
commit 2c7cab5
Showing
7 changed files
with
44 additions
and
37 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
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
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 |
|---|---|---|
| @@ -1,41 +1,43 @@ | ||
| # Twitter API | ||
| API Documentation link [here](https://developer.twitter.com/en/docs/twitter-api) | ||
| ## Overview | ||
|
|
||
| The Twitter API source supports full refresh syncs | ||
| This page contains the setup guide and reference information for the Twitter source connector. | ||
|
|
||
| ### Output schema | ||
| ## Prerequisites | ||
|
|
||
| Below output stream is available from this source: | ||
| To set up the Twitter source connector, you'll need the [App only Bearer Token](https://developer.twitter.com/en/docs/authentication/oauth-2-0/bearer-tokens). | ||
|
|
||
| [recent_search_tweets](https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-recent). | ||
| ## Set up the Twitter connector in Airbyte | ||
|
|
||
| 1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account or navigate to the Airbyte Open Source dashboard. | ||
| 2. Click **Sources** and then click **+ New source**. | ||
| 3. On the Set up the source page, select **Twitter** from the Source type dropdown. | ||
| 4. Enter the name for the Twitter connector. | ||
| 5. For **Access Token**, enter the [App only Bearer Token](https://developer.twitter.com/en/docs/authentication/oauth-2-0/bearer-tokens). | ||
| 6. For **Search Query**, enter the query for matching Tweets. You can learn how to build this query by reading [build a query guide](https://developer.twitter.com/en/docs/twitter-api/tweets/search/integrate/build-a-query). | ||
| 7. For **Start Date (Optional)**, enter the date in `YYYY-MM-DDTHH:mm:ssZ` format. The start date for retrieving tweets cannot be more than 7 days in the past. | ||
| 8. For **End Date (Optional)**, enter the date in `YYYY-MM-DDTHH:mm:ssZ` format. The end date for retrieving tweets must be a minimum of 10 seconds prior to the request time. | ||
| 9. Click **Set up source**. | ||
|
|
||
| ### Features | ||
| ## Supported sync modes | ||
|
|
||
| | Feature | Supported? | | ||
| |:------------------|:-----------| | ||
| | Full Refresh Sync | Yes | | ||
| | Incremental Sync | No | | ||
| The Twitter source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes): | ||
|
|
||
| ### Performance considerations | ||
| * [Full Refresh - Overwrite](https://docs.airbyte.com/understanding-airbyte/glossary#full-refresh-sync) | ||
| * [Full Refresh - Append](https://docs.airbyte.com/understanding-airbyte/connections/full-refresh-append) | ||
| * [Incremental - Append](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append) | ||
|
|
||
| Rate limiting is mentioned in the API [docuemntation](https://developer.twitter.com/en/docs/twitter-api/rate-limits) | ||
|
|
||
| ## Getting started | ||
| ## Supported Streams | ||
|
|
||
| ### Requirements | ||
| * [Tweets](https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-recent) | ||
|
|
||
| * Twitter API Key. | ||
| ## Performance considerations | ||
|
|
||
| ### Connect using `API Key`: | ||
|
|
||
| 1. Generate an API Key as described [here](https://developer.twitter.com/en/docs/authentication/oauth-2-0/bearer-tokens). | ||
| 2. Use the generated `API Key` in the Airbyte connection. | ||
| Rate limiting is mentioned in the API [docuemntation](https://developer.twitter.com/en/docs/twitter-api/rate-limits) | ||
|
|
||
| ## Changelog | ||
|
|
||
| | Version | Date | Pull Request | Subject | | ||
| |:--------|:-----------|:---------------------------------------------------------|:------------------------------------------------| | ||
| | 0.1.1 | 2023-03-03 | [23661](https://github.com/airbytehq/airbyte/pull/23661) | Incremental added for the "tweets" stream | | ||
| | 0.1.0 | 2022-11-01 | [18883](https://github.com/airbytehq/airbyte/pull/18858) | 🎉 New Source: Twitter | | ||
| | Version | Date | Pull Request | Subject | | ||
| |:--------|:-----------|:---------------------------------------------------------|:--------------------------------------------------| | ||
| | 0.1.2 | 2023-03-06 | [23749](https://github.com/airbytehq/airbyte/pull/23749) | Spec and docs are improved for beta certification | | ||
| | 0.1.1 | 2023-03-03 | [23661](https://github.com/airbytehq/airbyte/pull/23661) | Incremental added for the "tweets" stream | | ||
| | 0.1.0 | 2022-11-01 | [18883](https://github.com/airbytehq/airbyte/pull/18858) | 🎉 New Source: Twitter | |