-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Oliver Meyer
committed
Jul 7, 2021
1 parent
e50c89d
commit 0e137bf
Showing
4 changed files
with
63 additions
and
2 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# Dixa | ||
|
||
## Sync overview | ||
|
||
This source can sync data for the [Dixa conversation_export API](https://support.dixa.help/en/articles/174-export-conversations-via-api). | ||
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 Streams: | ||
|
||
* [Conversation export](https://support.dixa.help/en/articles/174-export-conversations-via-api) | ||
|
||
### Data type mapping | ||
|
||
| Integration Type | Airbyte Type | Notes | | ||
| :--- | :--- | :--- | | ||
| `string` | `string` | | | ||
| `int` | `integer` | | | ||
| `timestamp` | `integer` | | | ||
| `array` | `array` | | | ||
|
||
### Features | ||
|
||
| Feature | Supported?\(Yes/No\) | Notes | | ||
| :--- | :--- | :--- | | ||
| Full Refresh Sync | Yes | | | ||
| Incremental Sync | Yes | | | ||
| Namespaces | No | | | ||
|
||
### Performance considerations | ||
|
||
The connector is limited by standard Dixa conversation_export API [limits](https://support.dixa.help/en/articles/174-export-conversations-via-api). | ||
It should not run into 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. | ||
|
||
When using the connector, keep in mind that increasing the `batch_size` parameter will | ||
decrease the number of requests sent to the API, but increase the response and processing time. | ||
|
||
## Getting started | ||
|
||
### Requirements | ||
|
||
* Dixa API token | ||
|
||
### Setup guide | ||
|
||
1. Generate an API token using the [Dixa documentation](https://support.dixa.help/en/articles/259-how-to-generate-an-api-token). | ||
1. Define a `start_timestamp`: the connector will pull records with `updated_at >= start_timestamp` | ||
1. Define a `batch_size`: this represents the number of days which will be batched in a single request. | ||
Keep the performance consideration above in mind | ||
|
||
## Changelog | ||
| Version | Date | Pull Request | Subject | | ||
| :------ | :-------- | :----- | :------ | | ||
| 0.1.0 | 2021-07-07 | [4358](https://github.com/airbytehq/airbyte/pull/4358) | New source | |