ingestr 0.13.87__tar.gz → 0.13.89__tar.gz

{ingestr-0.13.87 → ingestr-0.13.89}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ingestr
-Version: 0.13.87
+Version: 0.13.89
 Summary: ingestr is a command-line application that ingests data from various sources and stores them in any database.
 Project-URL: Homepage, https://github.com/bruin-data/ingestr
 Project-URL: Issues, https://github.com/bruin-data/ingestr/issues
@@ -42,7 +42,7 @@ Requires-Dist: confluent-kafka==2.8.0
 Requires-Dist: crate==2.0.0
 Requires-Dist: cryptography==44.0.2
 Requires-Dist: curlify==2.2.1
-Requires-Dist: databricks-sql-connector==2.9.3
+Requires-Dist: databricks-sql-connector==4.0.5
 Requires-Dist: databricks-sqlalchemy==1.0.2
 Requires-Dist: dataclasses-json==0.6.7
 Requires-Dist: decorator==5.2.1

{ingestr-0.13.87 → ingestr-0.13.89}/docs/.vitepress/config.mjs

@@ -43,6 +43,7 @@ export default defineConfig({
             text: "Incremental Loading",
             link: "/getting-started/incremental-loading.md",
           },
+          { text: "Data Masking", link: "/getting-started/data-masking.md" },
           { text: "Telemetry", link: "/getting-started/telemetry.md" },
         ],
       },

{ingestr-0.13.87 → ingestr-0.13.89}/docs/commands/ingest.md

@@ -28,6 +28,7 @@ ingestr ingest \
 - `--interval-end`: Sets the end of the interval for the incremental key. Defaults to `None`.
 - `--primary-key TEXT`: Specifies the primary key for the merge operation. Defaults to `None`.
 - `--columns <column_name>:<column_type>`: Specifies the columns to be ingested. Defaults to `None`.
+- `--mask <column_name>:<algorithm>[:param]`: Applies data masking to specified columns. Can be used multiple times for different columns. See the [Data Masking](../getting-started/data-masking.md) documentation for available algorithms and usage examples. Defaults to `None`.
 
 The `interval-start` and `interval-end` options support various datetime formats, here are some examples:
 - `%Y-%m-%d`: `2023-01-31`
@@ -106,5 +107,25 @@ ingestr ingest
    --columns 'dt:date'
 ```
 
+### Ingesting with Data Masking
+
+```bash
+ingestr ingest \
+   --source-uri 'postgresql://user:pass@localhost/customers' \
+   --source-table 'customer_data' \
+   --dest-uri 'duckdb:///masked_customers.db' \
+   --dest-table 'masked_customers' \
+   --mask 'email:hash' \
+   --mask 'phone:partial:3' \
+   --mask 'ssn:redact' \
+   --mask 'salary:round:5000'
+```
+
+This example demonstrates masking sensitive customer data:
+- Email addresses are hashed for consistent anonymization
+- Phone numbers show only first and last 3 digits
+- SSNs are completely redacted
+- Salaries are rounded to nearest $5000
+
 > [!INFO]
 > For more examples, please refer to the specific platforms' documentation on the sidebar.

ingestr-0.13.89/docs/getting-started/data-masking.md

@@ -0,0 +1,377 @@
+# Data Masking
+
+Data masking is a critical security feature that allows you to protect sensitive information while maintaining data utility for development, testing, and analytics purposes. ingestr provides comprehensive masking capabilities that can be applied to any column during the ingestion process.
+
+## Overview
+
+Data masking transforms sensitive data into a protected format while preserving the structure and type of the original data. This is essential for:
+
+- **Compliance** with regulations like GDPR, CCPA, HIPAA
+- **Security** in development and testing environments
+- **Privacy** protection in analytics and reporting
+- **Data sharing** with third parties or external systems
+
+## Usage
+
+Apply masking to specific columns using the `--mask` parameter:
+
+```bash
+ingestr ingest \
+  --source-uri "postgres://user:pass@localhost/db" \
+  --source-table "users" \
+  --dest-uri "duckdb:///masked_data.db" \
+  --dest-table "masked_users" \
+  --mask "email:hash" \
+  --mask "ssn:partial:4" \
+  --mask "salary:round:1000"
+```
+
+### Format
+
+```
+--mask <column_name>:<algorithm>[:<parameter>]
+```
+
+- `column_name`: The name of the column to mask
+- `algorithm`: The masking algorithm to apply
+- `parameter`: Optional parameter for algorithms that require configuration
+
+## Masking Algorithms
+
+### Irreversible Masking
+
+These algorithms permanently transform data in a way that cannot be reversed.
+
+#### `hash` / `sha256`
+Creates a SHA-256 hash of the value. Consistent across runs - the same input always produces the same output.
+
+**Use cases:** Creating anonymous identifiers, consistent tokenization
+```bash
+--mask "user_id:hash"
+# john.doe@example.com → a94a8fe5ccb19ba61c4c0873d391e987982fbbd3
+```
+
+#### `md5`
+Creates an MD5 hash. Faster than SHA-256 but less secure (adequate for non-security purposes).
+
+**Use cases:** Quick checksums, non-security tokenization
+```bash
+--mask "session_id:md5"
+```
+
+#### `hmac`
+Hash-based message authentication code with a secret key. Provides consistent hashing across systems when using the same key.
+
+**Use cases:** Cross-system consistency with shared secret
+```bash
+--mask "customer_id:hmac:my-secret-key"
+```
+
+#### `redact`
+Replaces the entire value with "REDACTED".
+
+**Use cases:** Complete removal of sensitive data
+```bash
+--mask "comments:redact"
+# "Customer complaint about..." → "REDACTED"
+```
+
+### Format-Preserving Masking
+
+These algorithms maintain the format and structure of the original data.
+
+#### `email`
+Masks email addresses while preserving the domain.
+
+**Use cases:** Protecting email addresses while maintaining domain analysis
+```bash
+--mask "email:email"
+# john.doe@example.com → j******e@example.com
+```
+
+#### `phone`
+Masks phone numbers while preserving country and area codes.
+
+**Use cases:** Geographic analysis without exposing full numbers
+```bash
+--mask "phone:phone"
+# +1-555-123-4567 → +1-555-***-****
+```
+
+#### `credit_card`
+Shows only the last 4 digits of credit card numbers.
+
+**Use cases:** Payment processing logs, transaction records
+```bash
+--mask "card_number:credit_card"
+# 4111-1111-1111-1111 → ****-****-****-1111
+```
+
+#### `ssn`
+Masks Social Security Numbers showing only last 4 digits.
+
+**Use cases:** Identity verification systems
+```bash
+--mask "ssn:ssn"
+# 123-45-6789 → ***-**-6789
+```
+
+### Partial Masking
+
+These algorithms show only portions of the original data.
+
+#### `partial`
+Shows first and last N characters, masking the middle.
+
+**Use cases:** Names, addresses, partial visibility
+```bash
+--mask "name:partial:2"
+# "Jonathan" → "Jo****an"
+```
+
+#### `first_letter`
+Shows only the first character.
+
+**Use cases:** Initials, abbreviated names
+```bash
+--mask "first_name:first_letter"
+# "Alice" → "A****"
+```
+
+#### `stars`
+Replaces entire value with asterisks of the same length.
+
+**Use cases:** Password fields, complete obfuscation
+```bash
+--mask "password:stars"
+# "secret123" → "*********"
+```
+
+#### `fixed`
+Replaces with a fixed value.
+
+**Use cases:** Standardized replacement values
+```bash
+--mask "api_key:fixed:MASKED_KEY"
+# "sk_live_abc123" → "MASKED_KEY"
+```
+
+### Tokenization
+
+These algorithms replace values with tokens or identifiers.
+
+#### `uuid`
+Replaces with a UUID token. Same values get the same UUID (consistent).
+
+**Use cases:** Creating surrogate keys, maintaining referential integrity
+```bash
+--mask "customer_id:uuid"
+# "CUST001" → "550e8400-e29b-41d4-a716-446655440000"
+```
+
+#### `sequential`
+Replaces with sequential integers starting from 1.
+
+**Use cases:** Simple anonymization, reducing data size
+```bash
+--mask "account_number:sequential"
+# "ACC-2024-001" → 1
+# "ACC-2024-002" → 2
+```
+
+#### `random`
+Replaces with random data of the same type.
+
+**Use cases:** Test data generation, complete randomization
+```bash
+--mask "age:random"
+# 35 → 67 (random number)
+```
+
+### Numeric Masking
+
+These algorithms transform numeric values while preserving their general magnitude.
+
+#### `round`
+Rounds numbers to the nearest specified value.
+
+**Use cases:** Salary bands, age groups, reducing precision
+```bash
+--mask "salary:round:5000"
+# 52300 → 50000
+
+--mask "age:round:10"
+# 34 → 30
+```
+
+#### `range`
+Replaces with a range bracket.
+
+**Use cases:** Bucketing, categorical analysis
+```bash
+--mask "income:range:10000"
+# 45000 → "40000-50000"
+
+--mask "score:range:100"
+# 234 → "200-300"
+```
+
+#### `noise`
+Adds random noise to numeric values.
+
+**Use cases:** Statistical privacy, differential privacy
+```bash
+--mask "revenue:noise:0.1"
+# 100000 → 91234 (±10% random noise)
+
+--mask "temperature:noise:0.05"
+# 98.6 → 97.2 (±5% random noise)
+```
+
+### Date Masking
+
+These algorithms transform date and datetime values.
+
+#### `date_shift`
+Adds or subtracts random days within a specified range.
+
+**Use cases:** Preserving date relationships while obscuring exact dates
+```bash
+--mask "birth_date:date_shift:30"
+# 1990-05-15 → 1990-06-02 (shifted ±30 days randomly)
+```
+
+#### `year_only`
+Keeps only the year portion of dates.
+
+**Use cases:** Age analysis, cohort studies
+```bash
+--mask "registration_date:year_only"
+# 2024-03-15 → 2024
+```
+
+#### `month_year`
+Keeps only month and year.
+
+**Use cases:** Seasonal analysis, monthly aggregations
+```bash
+--mask "purchase_date:month_year"
+# 2024-03-15 → "2024-03"
+```
+
+## Use Case Examples
+
+### GDPR Compliance for Development Environment
+
+```bash
+ingestr ingest \
+  --source-uri "postgres://prod_user:pass@prod.db/customers" \
+  --source-table "customer_data" \
+  --dest-uri "postgres://dev_user:pass@dev.db/customers" \
+  --dest-table "customer_data" \
+  --mask "email:hash" \
+  --mask "phone:phone" \
+  --mask "name:partial:1" \
+  --mask "address:redact" \
+  --mask "ip_address:hash" \
+  --mask "birth_date:year_only"
+```
+
+### Healthcare Data for Analytics
+
+```bash
+ingestr ingest \
+  --source-uri "mysql://user:pass@hospital.db/patients" \
+  --source-table "patient_records" \
+  --dest-uri "bigquery://project/dataset" \
+  --dest-table "patient_analytics" \
+  --mask "patient_id:uuid" \
+  --mask "ssn:redact" \
+  --mask "diagnosis_notes:redact" \
+  --mask "admission_date:date_shift:7" \
+  --mask "age:round:5"
+```
+
+### Financial Data for Testing
+
+```bash
+ingestr ingest \
+  --source-uri "snowflake://account/database/schema" \
+  --source-table "transactions" \
+  --dest-uri "duckdb:///test_data.db" \
+  --dest-table "test_transactions" \
+  --mask "account_number:sequential" \
+  --mask "card_number:credit_card" \
+  --mask "amount:noise:0.2" \
+  --mask "merchant_name:fixed:TEST_MERCHANT"
+```
+
+### E-commerce Data Sharing
+
+```bash
+ingestr ingest \
+  --source-uri "postgres://internal.db/ecommerce" \
+  --source-table "orders" \
+  --dest-uri "s3://partner-bucket/data.parquet" \
+  --dest-table "shared_orders" \
+  --mask "customer_email:email" \
+  --mask "shipping_address:first_letter" \
+  --mask "order_value:round:10" \
+  --mask "customer_name:partial:2"
+```
+
+## Best Practices
+
+### Choosing the Right Algorithm
+
+1. **For PII (Personally Identifiable Information)**
+   - Use `hash` for consistent anonymization
+   - Use `redact` for complete removal
+   - Use format-preserving masks (`email`, `phone`, `ssn`) for maintaining data structure
+
+2. **For Development/Testing**
+   - Use `uuid` or `sequential` for maintaining relationships
+   - Use `random` for generating test data
+   - Use `partial` for semi-realistic data
+
+3. **For Analytics**
+   - Use `round` or `range` for numerical aggregations
+   - Use `date_shift` for time-series analysis
+   - Use `year_only` or `month_year` for temporal grouping
+
+4. **For Compliance**
+   - GDPR: Consider `hash`, `redact`, or `uuid` for personal data
+   - HIPAA: Use `redact` for medical records, `date_shift` for dates
+   - PCI DSS: Use `credit_card` for card numbers
+
+### Performance Considerations
+
+- **Hash-based algorithms** are fast and consistent
+- **Random algorithms** have minimal overhead but don't preserve consistency
+- **Format-preserving masks** have moderate performance impact
+- **Multiple masks** can be applied efficiently in a single pass
+
+### Security Notes
+
+1. **Hashed values** are one-way transformations but may be vulnerable to rainbow table attacks for common values
+2. **Partial masking** may not provide sufficient protection for highly sensitive data
+3. **Date shifting** preserves intervals between dates, which may leak information
+4. **Consistent tokenization** (uuid, hash) maintains relationships which could be exploited
+5. Always validate that your masking strategy meets your compliance requirements
+
+## Environment Variables
+
+You can also set masking configurations via environment variables:
+
+```bash
+export INGESTR_MASK="email:hash,phone:partial:3,ssn:redact"
+```
+
+Multiple masks should be comma-separated when using environment variables.
+
+## Limitations
+
+- Masking is applied in-memory during the ingestion process
+- The original source data remains unchanged
+- Some algorithms require additional dependencies (e.g., `date_shift` requires `python-dateutil`)
+- Masking adds processing overhead proportional to the data volume and number of masks applied

{ingestr-0.13.87 → ingestr-0.13.89}/docs/supported-sources/adjust.md

@@ -32,12 +32,7 @@ Adjust data may change going back, which means you'll need to change your start
 ## Tables
 Adjust source allows ingesting data from various sources:
 
-- `campaigns`: Retrieves data for a campaign, showing the app's revenue and network costs over multiple days.
-- `creatives`: Retrieves data for a creative assets, detailing the app's revenue and network costs across multiple days.
-- `events`: Retrieves data for [events](https://dev.adjust.com/en/api/rs-api/events/) and event slugs.
-- `custom`: Retrieves custom data based on the dimensions and metrics specified.
-
-### Custom reports: `custom:<dimensions>:<metrics>[:<filters>]`
+#### Custom reports: `custom:<dimensions>:<metrics>[:<filters>]`
 
 The custom table allows you to retrieve data based on specific dimensions and metrics, and apply filters to the data.
 
@@ -55,7 +50,14 @@ Parameters:
 > [!WARNING]
 > Custom tables require a time-based dimension for efficient operation, such as `hour`, `day`, `week`, `month`, or `year`.
 
-## Examples
+| Table           | PK/Merge Key | Inc Key | Inc Strategy | Details                                                                                                                                        |
+| --------------- | ----------- | --------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| [Events](https://dev.adjust.com/en/api/rs-api/events)        | id | –  |        replace     | Retrieves data for [events](https://dev.adjust.com/en/api/rs-api/events/) and event slugs.              |                                        |
+| [campaigns](https://dev.adjust.com/en/api/rs-api/reports) | day | –                | merge            | Retrieves data for a campaign, showing the app's revenue and network costs over multiple days. `Columns:` campaign, day, app, store_type, channel, country, network_cost, all_revenue_total_d0, ad_revenue_total_d0, revenue_total_d0, all_revenue_total_d1, ad_revenue_total_d1, revenue_total_d1, all_revenue_total_d3, ad_revenue_total_d3, revenue_total_d3, all_revenue_total_d7, ad_revenue_total_d7, revenue_total_d7, all_revenue_total_d14, ad_revenue_total_d14, revenue_total_d14, all_revenue_total_d21 |
+| [creatives](https://dev.adjust.com/en/api/rs-api/reports)   | day | -     | merge  | Retrieves data for a creative assets, detailing the app's revenue and network costs across multiple days. `Columns:` campaign, day, app, store_type, channel, country, adgroup, creative, network_cost, all_revenue_total_d0, ad_revenue_total_d0, revenue_total_d0, all_revenue_total_d1, ad_revenue_total_d1, revenue_total_d1, all_revenue_total_d3, ad_revenue_total_d3, revenue_total_d3, all_revenue_total_d7, ad_revenue_total_d7, revenue_total_d7, all_revenue_total_d14, ad_revenue_total_d14, revenue_total_d14, all_revenue_total_d21 |
+| `custom`   | `configurable` | -     | merge  | Retrieves custom data based on the dimensions and metrics specified.
+
+ ## Examples
 
 Copy campaigns data from Adjust into a DuckDB database:
 ```sh
@@ -82,4 +84,4 @@ ingestr ingest \
     --source-table "custom:hour,app,store_id,channel,os_name,country_code,campaign_network,campaign_id_network,adgroup_network, adgroup_id_network,creative_network,creative_id_network:impressions,clicks,cost,network_cost,installs,ad_revenue,all_revenue" \
     --dest-uri duckdb:///adjust.db \
     --dest-table "mat.example"
-```
+```

{ingestr-0.13.87 → ingestr-0.13.89}/docs/supported-sources/applovin.md

@@ -101,12 +101,12 @@ $ duckdb report.db 'select day from public.publisher_report group by 1'
 
 ## Tables
 
-| Name | Description |
-| --- | --- |
-| `publisher-report` | Provides daily metrics from the `report` end point using the report_type `publisher` |
-| `advertiser-report` | Provides daily metrics from the `report` end point using the report_type `advertiser`|
-| `advertiser-probabilistic-report` | Provides daily metrics from the `probabilisticReport` end point using the report_type `advertiser` |
-| `advertiser-ska-report` | Provides daily metrics from the `skaReport` end point using the report_type `advertiser` |
+| Name | Merge Key | Inc Key | Inc Strategy |  Details |
+| --------------- | ----------- | --------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| `publisher-report` | day | day | merge| Provides daily metrics from the `report` end point using the report_type `publisher` |
+| `advertiser-report` | day | day | merge| Provides daily metrics from the `report` end point using the report_type `advertiser`|
+| `advertiser-probabilistic-report` | day | day | merge| Provides daily metrics from the `probabilisticReport` end point using the report_type `advertiser` |
+| `advertiser-ska-report` | day | day | merge| Provides daily metrics from the `skaReport` end point using the report_type `advertiser` |
 
 ## Custom Reports
 

{ingestr-0.13.87 → ingestr-0.13.89}/docs/supported-sources/applovin_max.md

@@ -45,4 +45,8 @@ By default, `ingestr` retrieves data for the last 30 days. For a custom date ran
 <img alt="applovin_max_img" src="../media/applovin_max.png"/>
 
 ## Table
-[user_ad_revenue](https://developers.applovin.com/en/max/reporting-apis/user-level-ad-revenue-api/): Provides daily metrics from the user level ad revenue API.User-level revenue data is available eight hours after UTC day end. So, for example, data for UTC 2025-01-01 is available on UTC 2025-01-02 after 08:00.
+
+Applovin Max source allows ingesting the following sources into separate tables:
+| Table           | PK | Inc Key | Inc Strategy | Details                                                                                                                                        |
+| --------------- | ----------- | --------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| [user_ad_revenue](https://developers.applovin.com/en/max/reporting-apis/user-level-ad-revenue-api/)       | `partition_date` (extracts date-only portion from the timestamp-based date column) |        partition_date      | merge              |  Provides daily metrics from the user level ad revenue API. User-level revenue data is available eight hours after UTC day end. So, for example, data for UTC 2025-01-01 is available on UTC 2025-01-02 after 08:00.

{ingestr-0.13.87 → ingestr-0.13.89}/docs/supported-sources/appsflyer.md

@@ -34,9 +34,13 @@ The result of this command will be a table in the `appsflyer.duckdb` database.
 
 ingestr integrates with the [Master Report API](https://dev.appsflyer.com/hc/reference/master_api_get) of AppsFlyer, which allows you to retrieve data for the following tables:
 
-- `campaigns`: Retrieves data for campaigns, detailing the app's costs, loyal users, total installs, and revenue over multiple days.
-- `creatives`: Retrieves data for a creative asset, including revenue and cost.
-- `custom:<dimensions>:<metrics>`: Retrieves data for custom tables, which can be specified by the user.
+## Tables
+
+| Name | PK/Merge Key | Inc Key | Inc Strategy |  Details |
+| --------------- | ----------- | --------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| [campaigns](https://dev.appsflyer.com/hc/reference/master_api_get) | install_time | install_time | merge| Retrieves data for campaigns, detailing the app's costs, loyal users, total installs, and revenue over multiple days.`columns:`  app_id, campaign, geo, install_time, average_ecpi, clicks, cohort_day_1_revenue_per_user, cohort_day_1_total_revenue_per_user, cohort_day_14_revenue_per_user, cohort_day_14_total_revenue_per_user, cohort_day_21_revenue_per_user, cohort_day_21_total_revenue_per_user, cohort_day_3_revenue_per_user, cohort_day_3_total_revenue_per_user, cohort_day_7_revenue_per_user, cohort_day_7_total_revenue_per_user, cost, impressions, installs, loyal_users, retention_day_7, revenue, roi, uninstalls |
+| [creatives](https://dev.appsflyer.com/hc/reference/master_api_get) | install_time | install_time | merge| Retrieves data for a creative asset, including revenue and cost. `columns:` geo, app_id, install_time, campaign, adset_id, adset, ad_id, impressions, clicks, installs, cost, revenue, average_ecpi, loyal_users, uninstalls, roi  |
+| `custom:<dimensions>:<metrics>` | Dynamic (dimensions + install_time) | install_time | merge| Retrieves data for custom tables, which can be specified by the user.|
 
 Use these as `--source-table` parameter in the `ingestr ingest` command.
 

{ingestr-0.13.87 → ingestr-0.13.89}/docs/supported-sources/asana.md

@@ -41,16 +41,17 @@ ingestr ingest \
 
 Asana source allows ingesting the following sources into separate tables:
 
-| **Table**    | **Description**                                                                 |
-|---------------|---------------------------------------------------------------------------------|
-| `workspaces`  | Information about people, materials, or assets required to complete a task or project successfully. |
-| `projects`    | Collections of tasks and related information.                                   |
-| `tasks`    | Tasks within a project. Only tasks that belong to a project can be ingested. Users private tasks are not ingested, for example.      |
-| `projects`    | Collections of tasks and related information.                                   |
-| `tags`        | Labels that can be attached to tasks, projects, or conversations to help categorize and organize them. |
-| `stories`     | Updates or comments that team members can add to a task or project.             |
-| `teams`       | Groups of individuals who work together to complete projects and tasks.         |
-| `users`       | Individuals who have access to the Asana platform.                              |
+| Table | Primary/Merge Key | Inc Key | Inc Strategy | Details |
+|-------|----|----------|--------------|---------|
+| `workspaces` | - | - | replace | Information about people, materials, or assets required to complete a task or project successfully. Full reload on each run. |
+| `projects` | - | - | replace | Collections of tasks and related information. Full reload on each run. |
+| `sections` | - | - | replace | Project sections and organization. Full reload on each run. |
+| `tags` | - | - | replace | Labels that can be attached to tasks, projects, or conversations. Full reload on each run. |
+| `tasks` | gid | modified_at | merge | Tasks within a project. Only tasks that belong to a project can be ingested. Uses modified_since API parameter for incremental loading. |
+| `stories` | - | - | replace | Updates or comments that team members can add to a task or project. |
+| `teams` | - | - | replace | Groups of individuals who work together to complete projects and tasks. Full reload on each run. |
+| `users` | - | - | replace | Individuals who have access to the Asana platform. Full reload on each run. |
+
 
 Use these as `--source-table` parameter in the `ingestr ingest` command.
 

ingestr-0.13.89/docs/supported-sources/attio.md

@@ -0,0 +1,47 @@
+# Attio
+[Attio](https://attio.com/) is an AI-native CRM platform that helps companies build, scale, and grow their business.
+
+ingestr supports Attio as a source.
+
+## URI format
+
+The URI format for Attio is as follows:
+
+```plaintext
+attio://?api_key=<api_key>
+```
+
+URI parameters:
+- `api_key`: the API key used for authentication with the Attio API
+
+## Setting up a Attio Integration
+
+You can find your Attio API key by following the guide [here](https://attio.com/help/apps/other-apps/generating-an-api-key).
+
+Let's say your `api_key` is key_123, here's a sample command that will copy the data from Attio into a DuckDB database:
+
+
+```bash
+ingestr ingest \
+--source-uri 'Attio://?api_key=key_123' \
+--source-table 'objects' \
+--dest-uri duckdb:///attio.duckdb \
+--dest-table 'dest.objects'
+```
+
+## Tables
+
+Attio source supports ingesting the following sources into separate tables:
+
+| Table | PK | Inc Key | Inc Strategy | Details |
+|-------|----|----------|--------------|---------|
+| [objects](https://docs.attio.com/rest-api/endpoint-reference/objects/list-objects) | - | - | replace | Objects are the data types used to store facts about your customers. Fetches all objects. Full reload on each run. |
+| [records:{object_api_slug}](https://docs.attio.com/rest-api/endpoint-reference/records/list-records) | - | - | replace | Fetches all records of an object. For example: `records:companies`. Full reload on each run. |
+| [lists](https://docs.attio.com/rest-api/endpoint-reference/lists/list-all-lists) | - | - | replace | Fetches all lists. Full reload on each run. |
+| [list_entries:{list_id}](https://docs.attio.com/rest-api/endpoint-reference/entries/list-entries) | - | - | replace | Lists all items in a specific list. For example: `list_entries:8abc-123-456-789d-123`. Full reload on each run. |
+| [all_list_entries:{object_api_slug}](https://docs.attio.com/rest-api/endpoint-reference/entries/list-entries) | - | - | replace | Fetches all the lists for an object, and then fetches all the entries from that list. For example: `all_list_entries:companies`. Full reload on each run. |
+
+Use this as `--source-table` parameter in the `ingestr ingest` command.
+
+> [!WARNING]
+> Attio does not support incremental loading, which means ingestr will do a full-refresh.