Orb
Setting up the Orb connector
| No | Item | Required | Example | Notes |
|---|---|---|---|---|
| 1 | Orb API Key | Yes | Orb API Key, issued from the Orb admin console. | |
| 2 | Start Date | Yes | 2022-03-01T00:00:00Z | UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at before this data will not be synced. For Subscription Usage, this becomes the timeframe_start API parameter. |
| 3 | Lookback Window (in days) | No | When set to N, the connector will always refresh resources created within the past N days. By default, updated objects that are not newly created are not incrementally synced. | |
| 4 | Event properties keys (string values) | No | Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction. | |
| 5 | Event properties keys (numeric values) | No | Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction. |
Tables in the Orb connector
| No | Table Name | Columns | Primary Keys | Read Mode | Inc. Sync Keys | API Info |
|---|---|---|---|---|---|---|
| 1 | credits_ledger_entries | 12 | id | Full Refresh, Incremental | created_at | |
| 2 | subscriptions | 8 | id | Full Refresh, Incremental | created_at | API Reference |
| 3 | plans | 6 | id | Full Refresh, Incremental | created_at | API Reference |
| 4 | subscription_usage | 6 | subscription_id, billable_metric_id, timeframe_start | Full Refresh, Incremental | timeframe_start | |
| 5 | customers | 10 | id | Full Refresh, Incremental | created_at | API Reference |
Table: credits_ledger_entries
| No | Column Name | Type | Notes |
|---|---|---|---|
| 1 | amount | DOUBLE | |
| 2 | credit_block_id | VARCHAR | |
| 3 | credit_block_per_unit_cost_basis | VARCHAR | |
| 4 | created_at | VARCHAR | Incremental sync key |
| 5 | new_block_expiry_date | VARCHAR | |
| 6 | description | VARCHAR | |
| 7 | ending_balance | DOUBLE | |
| 8 | id | VARCHAR | Primary Key |
| 9 | entry_type | VARCHAR | |
| 10 | customer_id | VARCHAR | |
| 11 | starting_balance | DOUBLE | |
| 12 | block_expiry_date | VARCHAR |
Table: subscriptions
| No | Column Name | Type | Notes |
|---|---|---|---|
| 1 | end_date | VARCHAR | |
| 2 | external_customer_id | VARCHAR | |
| 3 | created_at | VARCHAR | Incremental sync key |
| 4 | id | VARCHAR | Primary Key |
| 5 | customer_id | VARCHAR | |
| 6 | plan_id | VARCHAR | |
| 7 | start_date | VARCHAR | |
| 8 | status | VARCHAR |
Table: plans
| No | Column Name | Type | Notes |
|---|---|---|---|
| 1 | product | VARCHAR | |
| 2 | name | VARCHAR | |
| 3 | created_at | VARCHAR | Incremental sync key |
| 4 | description | VARCHAR | |
| 5 | id | VARCHAR | Primary Key |
| 6 | prices | VARCHAR |
Table: subscription_usage
| No | Column Name | Type | Notes |
|---|---|---|---|
| 1 | billable_metric_name | VARCHAR | |
| 2 | subscription_id | VARCHAR | Primary Key |
| 3 | timeframe_start | VARCHAR | Incremental sync key, Primary Key |
| 4 | quantity | DOUBLE | |
| 5 | timeframe_end | VARCHAR | |
| 6 | billable_metric_id | VARCHAR | Primary Key |
Table: customers
| No | Column Name | Type | Notes |
|---|---|---|---|
| 1 | payment_provider_id | VARCHAR | |
| 2 | timezone | VARCHAR | |
| 3 | external_customer_id | VARCHAR | |
| 4 | payment_provider | VARCHAR | |
| 5 | name | VARCHAR | |
| 6 | created_at | VARCHAR | Incremental sync key |
| 7 | billing_address | VARCHAR | |
| 8 | id | VARCHAR | Primary Key |
| 9 | shipping_address | VARCHAR | |
| 10 | email | VARCHAR |
External Resources
Zipstack Cloud features a powerful SQL querying engine on top of many types of connectors, including those from Trino, some custom connectors and connectors from the open source Airbyte project. Some Zipstack cloud connectors are designed to utilize and expand upon Airbyte's connector protocol, but they do not use Airbyte's EL core. Additionally, some parts of the documentation for these connectors have been adapted from the connector documentation found in Airbyte's open source project.