Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Oliver Meyer committed Jul 7, 2021
1 parent e50c89d commit 0e137bf
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 2 deletions.
4 changes: 3 additions & 1 deletion airbyte-integrations/builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@

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)

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)
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)

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)

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)

Expand Down
3 changes: 2 additions & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@
* [AWS CloudTrail](integrations/sources/aws-cloudtrail.md)
* [Braintree](integrations/sources/braintree.md)
* [ClickHouse](integrations/sources/clickhouse.md)
* [Db2](integrations/sources/db2.md)
* [Db2](integrations/sources/db2.md)
* [Dixa](integrations/sources/dixa.md)
* [Drift](integrations/sources/drift.md)
* [Exchange Rates API](integrations/sources/exchangeratesapi.md)
* [Facebook Marketing](integrations/sources/facebook-marketing.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 @@ -20,6 +20,7 @@ Airbyte uses a grading system for connectors to help users understand what to ex
|[Braintree](./sources/braintree.md)| Alpha |
|[ClickHouse](./sources/clickhouse.md)| Beta |
|[Db2](./sources/db2.md)| Beta |
|[Dixa](./sources/dixa.md) | Alpha |
|[Drift](./sources/drift.md)| Beta |
|[Exchange Rates API](./sources/exchangeratesapi.md)| Certified |
|[Facebook Marketing](./sources/facebook-marketing.md)| Beta |
Expand Down
57 changes: 57 additions & 0 deletions docs/integrations/sources/dixa.md
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 |

0 comments on commit 0e137bf

Please sign in to comment.