Skip to content

Commit 0e137bf

Browse files
author
Oliver Meyer
committed
Update documentation
1 parent e50c89d commit 0e137bf

File tree

4 files changed

+63
-2
lines changed

4 files changed

+63
-2
lines changed

airbyte-integrations/builds.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313

1414
AWS CloudTrail [![source-aws-cloudtrail](https://img.shields.io/endpoint?url=https%3A%2F%2Fstatus-api.airbyte.io%2Ftests%2Fsummary%2Fsource-aws-cloudtrail%2Fbadge.json)](https://status-api.airbyte.io/tests/summary/source-aws-cloudtrail)
1515

16-
Braintree [![source-braintree-singer](https://img.shields.io/endpoint?url=https%3A%2F%2Fstatus-api.airbyte.io%2Ftests%2Fsummary%2Fsource-braintree-singer%2Fbadge.json)](https://status-api.airbyte.io/tests/summary/source-braintree-singer)
16+
Braintree [![source-braintree-singer](https://img.shields.io/endpoint?url=https%3A%2F%2Fstatus-api.airbyte.io%2Ftests%2Fsummary%2Fsource-braintree-singer%2Fbadge.json)](https://status-api.airbyte.io/tests/summary/source-braintree-singer)
17+
18+
Dixa [![source-dixa](https://img.shields.io/endpoint?url=https%3A%2F%2Fstatus-api.airbyte.io%2Ftests%2Fsummary%2Fsource-dixa%2Fbadge.json)](https://status-api.airbyte.io/tests/summary/source-dixa)
1719

1820
Drift [![source-drift](https://img.shields.io/endpoint?url=https%3A%2F%2Fstatus-api.airbyte.io%2Ftests%2Fsummary%2Fsource-drift%2Fbadge.json)](https://status-api.airbyte.io/tests/summary/source-drift)
1921

docs/SUMMARY.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@
3838
* [AWS CloudTrail](integrations/sources/aws-cloudtrail.md)
3939
* [Braintree](integrations/sources/braintree.md)
4040
* [ClickHouse](integrations/sources/clickhouse.md)
41-
* [Db2](integrations/sources/db2.md)
41+
* [Db2](integrations/sources/db2.md)
42+
* [Dixa](integrations/sources/dixa.md)
4243
* [Drift](integrations/sources/drift.md)
4344
* [Exchange Rates API](integrations/sources/exchangeratesapi.md)
4445
* [Facebook Marketing](integrations/sources/facebook-marketing.md)

docs/integrations/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Airbyte uses a grading system for connectors to help users understand what to ex
2020
|[Braintree](./sources/braintree.md)| Alpha |
2121
|[ClickHouse](./sources/clickhouse.md)| Beta |
2222
|[Db2](./sources/db2.md)| Beta |
23+
|[Dixa](./sources/dixa.md) | Alpha |
2324
|[Drift](./sources/drift.md)| Beta |
2425
|[Exchange Rates API](./sources/exchangeratesapi.md)| Certified |
2526
|[Facebook Marketing](./sources/facebook-marketing.md)| Beta |

docs/integrations/sources/dixa.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Dixa
2+
3+
## Sync overview
4+
5+
This source can sync data for the [Dixa conversation_export API](https://support.dixa.help/en/articles/174-export-conversations-via-api).
6+
It supports both Full Refresh and Incremental syncs.
7+
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.
8+
9+
### Output schema
10+
11+
This Source is capable of syncing the following Streams:
12+
13+
* [Conversation export](https://support.dixa.help/en/articles/174-export-conversations-via-api)
14+
15+
### Data type mapping
16+
17+
| Integration Type | Airbyte Type | Notes |
18+
| :--- | :--- | :--- |
19+
| `string` | `string` | |
20+
| `int` | `integer` | |
21+
| `timestamp` | `integer` | |
22+
| `array` | `array` | |
23+
24+
### Features
25+
26+
| Feature | Supported?\(Yes/No\) | Notes |
27+
| :--- | :--- | :--- |
28+
| Full Refresh Sync | Yes | |
29+
| Incremental Sync | Yes | |
30+
| Namespaces | No | |
31+
32+
### Performance considerations
33+
34+
The connector is limited by standard Dixa conversation_export API [limits](https://support.dixa.help/en/articles/174-export-conversations-via-api).
35+
It should not run into limitations under normal usage.
36+
Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.
37+
38+
When using the connector, keep in mind that increasing the `batch_size` parameter will
39+
decrease the number of requests sent to the API, but increase the response and processing time.
40+
41+
## Getting started
42+
43+
### Requirements
44+
45+
* Dixa API token
46+
47+
### Setup guide
48+
49+
1. Generate an API token using the [Dixa documentation](https://support.dixa.help/en/articles/259-how-to-generate-an-api-token).
50+
1. Define a `start_timestamp`: the connector will pull records with `updated_at >= start_timestamp`
51+
1. Define a `batch_size`: this represents the number of days which will be batched in a single request.
52+
Keep the performance consideration above in mind
53+
54+
## Changelog
55+
| Version | Date | Pull Request | Subject |
56+
| :------ | :-------- | :----- | :------ |
57+
| 0.1.0 | 2021-07-07 | [4358](https://github.com/airbytehq/airbyte/pull/4358) | New source |

0 commit comments

Comments
 (0)