- About Hevo
- Hevo Features
- Hevo System Architecture
- Core Concepts
- Free Trials
- Regulatory Compliance
- Scheduling a Demo
- Hevo Support
- General FAQs
- Getting Started
- Creating an Account in Hevo
- Connecting Through SSH
- Connecting Through Reverse SSH Tunnel
- Using Google Account Authentication
- How Hevo Authenticates Sources and Destinations using OAuth
- Reauthorizing an OAuth Account
- Familiarizing with the UI
- Creating your First Pipeline
- Data Loss Prevention and Recovery
- Data Ingestion
- Types of Data Synchronization
- Ingestion Modes and Query Modes for Database Sources
- Ingestion and Loading Frequency
- Data Ingestion Statuses
- Deferred Data Ingestion
- Handling of Primary Keys
- Handling of Updates
- Handling of Deletes
- Hevo-generated Metadata
- Data Loading
- Loading Data in a Database Destination
- Loading Data to a Data Warehouse
- Optimizing Data Loading for a Destination Warehouse
- Manually Triggering the Loading of Events
- Scheduling Data Load for a Destination
- Loading Events in Batches
- Data Loading Statuses
- Data Spike Alerts
- Name Sanitization
- Table and Column Name Compression
- Parsing Nested JSON Fields in Events
- Data Flow in a Pipeline
- Familiarizing with the Pipelines UI
Working with Pipelines
- Best Practices for Creating Database Pipelines
- Creating a Pipeline
- Connectivity Check for RDBMS Sources
- Scheduling a Pipeline
- Modifying a Pipeline
- Prioritizing a Pipeline
- Viewing Pipeline Progress
- Pausing and Deleting a Pipeline
- Log-based Pipelines
- Troubleshooting Data Replication Errors
- Managing Objects in Pipelines
Python Code-Based Transformations
- Supported Python Modules and Functions
Transformation Methods in the Event Class
- Create an Event
- Retrieve the Event Name
- Rename an Event
- Retrieve the Properties of an Event
- Modify the Properties for an Event
- Fetch the Primary Keys of an Event
- Modify the Primary Keys of an Event
- Fetch the Data Type of a Field
- Check if the Field is a String
- Check if the Field is a Number
- Check if the Field is Boolean
- Check if the Field is a Date
- Check if the Field is a Time Value
- Check if the Field is a Timestamp
- Convert Date String to Required Format
- Convert Date to Required Format
- Convert Datetime String to Required Format
- Convert Epoch Time to a Date
- Convert Epoch Time to a Datetime
- Convert Epoch to Required Format
- Convert Epoch to a Time
- Get Time Difference
- Parse Date String to Date
- Parse Date String to Datetime Format
- Parse Date String to Time
- Examples of Python Code-based Transformations
Drag and Drop Transformations
- Special Keywords
Transformation Blocks and Properties
- Add a Field
- Change Datetime Field Values
- Change Field Values
- Drop Events
- Drop Fields
- Find & Replace
- Flatten JSON
- Format Date to String
- Format Number to String
- Hash Fields
- Mask Fields
- Modify Text Casing
- Parse Date from String
- Parse JSON from String
- Parse Number from String
- Rename Events
- Rename Fields
- Round-off Decimal Fields
- Split Fields
- Examples of Drag and Drop Transformations
- Effect of Transformations on the Destination Table Structure
- Transformation Reference
- Transformation FAQs
- Python Code-Based Transformations
- Using Schema Mapper
- Mapping Statuses
- Auto Mapping Event Types
- Manually Mapping Event Types
- Modifying Schema Mapping for Event Types
- Schema Mapper Actions
- Fixing Unmapped Fields
- Resolving Incompatible Schema Mappings
- Resizing String Columns in the Destination
- Schema Mapper Compatibility Table
- Limits on the Number of Destination Columns
- File Log
- Troubleshooting Failed Events in a Pipeline
- Mismatch in Events Count in Source and Destination
- Activity Log
- Can multiple Sources connect to one Destination?
- What happens if I re-create a deleted Pipeline?
- Why is there a delay in my Pipeline?
- Can I change the Destination post-Pipeline creation?
- How does changing the query mode affect data ingestion?
- Why is my billable Events high with Delta Timestamp mode?
- Can I drop multiple Destination tables in a Pipeline at once?
- How does Run Now affect scheduled ingestion frequency?
- Will pausing some objects increase the ingestion speed?
- Can I see the historical load progress?
- Why is my Historical Load Progress still at 0%?
- Why is historical data not getting ingested?
- How do I set a field as a primary key?
- How do I ensure that records are loaded only once?
- Events Usage
- Free Sources
Databases and File Systems
- Data Warehouses
- Connecting to a Local Database
- Amazon DocumentDB
- Amazon DynamoDB
- Generic MongoDB
- MongoDB Atlas
- Support for Multiple Data Types for the _id Field
- Example - Merge Collections Feature
Errors During Pipeline Creation
- Error 1001 - Incorrect credentials
- Error 1005 - Connection timeout
- Error 1006 - Invalid database hostname
- Error 1007 - SSH connection failed
- Error 1008 - Database unreachable
- Error 1011 - Insufficient access
- Error 1028 - Primary/Master host needed for OpLog
- Error 1029 - Version not supported for Change Streams
- SSL 1009 - SSL Connection Failure
- Troubleshooting MongoDB Change Streams Connection
- Troubleshooting MongoDB OpLog Connection
- Errors During Pipeline Creation
- Amazon RDS SQL Server
- Azure SQL Server
- Google Cloud SQL Server
- Generic SQL Server
- Troubleshooting SQL Server
- SQL Server FAQs
- Amazon Aurora MySQL
- Amazon RDS MySQL
- Azure MySQL
- Google Cloud MySQL
- Generic MySQL
- MariaDB MySQL
Errors During Pipeline Creation
- Error 1003 - Connection to host failed
- Error 1006 - Connection to host failed
- Error 1007 - SSH connection failed
- Error 1011 - Access denied
- Error 1012 - Replication access denied
- Error 1017 - Connection to host failed
- Error 1026 - Failed to connect to database
- Error 1027 - Unsupported BinLog format
- Failed to determine binlog filename/position
- Schema 'xyz' is not tracked via bin logs
- Errors Post-Pipeline Creation
- Errors During Pipeline Creation
- MySQL FAQs
- Amazon Aurora PostgreSQL
- Amazon RDS PostgreSQL
- Azure PostgreSQL
- Google Cloud PostgreSQL
- Generic PostgreSQL
- Heroku PostgreSQL
Errors during Pipeline creation
- Error 1003 - Authentication failure
- Error 1006 - Connection settings errors
- Error 1011 - Access role issue for logical replication
- Error 1012 - Access role issue for logical replication
- Error 1014 - Database does not exist
- Error 1017 - Connection settings errors
- Error 1023 - No pg_hba.conf entry
- Error 1024 - Number of requested standby connections
- Errors Post-Pipeline Creation
- Errors during Pipeline creation
- PostgreSQL FAQs
- Troubleshooting Database Sources
- Amazon S3
- Azure Blob Storage
- FTP / SFTP
- Google Cloud Storage (GCS)
- Google Drive
- Google Sheets
- Android SDK
- Writing JSONPath Expressions
REST API FAQs
- Why does my REST API token keep changing?
- Can I use a bearer authorization token for authentication?
- Does Hevo’s REST API support API chaining?
- What is the maximum payload size returned by a REST API?
- How do I split an Event into multiple Event Types?
- How do I split multiple values in a key into separate Events?
- Jira Cloud
- QuickBooks Time
- Finance & Accounting Analytics
- Amazon Ads
- Apple Search Ads
- Facebook Ads
- Facebook Page Insights
- Firebase Analytics
- Google Ads
- Google Analytics
- Google Analytics 4
- Google Analytics 360
- Google Play Console
- Google Search Console
- Instagram Business
- LinkedIn Ads
- Microsoft Advertising
- Pinterest Ads
- SendGrid Webhook
- Salesforce Marketing Cloud
- Snapchat Ads
- TikTok Ads
- Twitter Ads
- YouTube Analytics
- Product Analytics
Sales & Support Analytics
- Help Scout
- Hub Planner
- Salesforce Bulk API V2
- Toggl Track
- From how far back can the Pipeline ingest data?
- Can I connect to a Source not listed in Hevo?
- Can I connect a local database as a Source?
- How can I push data to Hevo API?
- How do I connect a CSV file as a Source?
- Why are my selected Source objects not visible in the Schema Mapper?
- How does the Merge Table feature work?
- Familiarizing with the Destinations UI
- Amazon Aurora MySQL
- SQL Server
- Connecting to a Local Database
- Limitations of using MySQL as a Destination
- Structure of Data in the Amazon Redshift Data Warehouse
- Loading Data to an Amazon Redshift Data Warehouse
- Troubleshooting Amazon Redshift Destination
- Amazon Redshift FAQs
- Azure Synapse Analytics
- Clustering in BigQuery
- Partitioning in BigQuery
- Loading Data to a Google BigQuery Data Warehouse
- Near Real-time Data Loading using Streaming
- Troubleshooting Google BigQuery
- Google BigQuery FAQs
- Hevo Managed Google BigQuery
- Structure of Data in the Snowflake Data Warehouse
- Loading Data to a Snowflake Data Warehouse
- Troubleshooting Snowflake
- Snowflake FAQs
- Amazon Redshift
- Can I move data between SaaS applications using Hevo?
- Can I change the primary key in my Destination table?
- How do I change the data type of table columns?
- Can I change the Destination table name after creating the Pipeline?
- How can I change or delete the Destination table prefix?
- How do I resolve duplicate records in the Destination table?
- How do I enable or disable deduplication of records?
- Why does my Destination have deleted Source records?
- How do I filter deleted Events from the Destination?
- Does a data load regenerate deleted Hevo metadata columns?
- Can I load data to a specific Destination table?
- How do I filter out specific fields before loading data?
- How do I sort the data in the Destination?
- dbt™ Models
- Familiarizing with the Models UI
- Types of Models
- Key Features
- Working with SQL Models
- Previewing a Model
- Viewing the Query History
- Legacy Models
- Models FAQs
- Account Management
- Personal Settings
- Team Settings
- Pricing Plans
- Time-based Events Buffer
- Setting up Pricing Plans, Billing, and Payments
- On-Demand Purchases
- Billing Alerts
- Viewing Billing History
- Billing Notifications
- Can I get a plan apart from the Starter plan?
- Are free trial Events charged once I purchase a plan?
- For how long can I stay on the Free plan?
- How can I upgrade my plan?
- Is there a discount for non-profit organizations?
- Can I seek a refund of my payment?
- Do ingested Events count towards billing?
- Will Pipeline get paused if I exceed the Events quota?
- Will the initial load of data be free?
- Does the Hevo plan support multiple Destinations?
- Do rows loaded through Models count in my usage?
- Is Hevo subscription environment-specific?
- Can I pause billing if I have no active Pipelines?
- Can you explain the pricing plans in Hevo?
- Where do I get invoices for payments?
- Account Suspension and Restoration
- Account Management FAQs
- Activate Concepts
- Familiarizing with the Activate UI
- Working with Activate
- Activate Warehouses
- Activate Targets
- Release Notes
- Release Version 2.16.4
- Release Version 2.16.3
- Release Version 2.16.2
- Release Version 2.16.1
- Release Version 2.16
- Release Version 2.15
- Release Version 2.14
- Release Version 2.13
- Release Version 2.12
- Release Version 2.11
- Release Version 2.10
- Release Version 2.09
- Release Version 2.08
- Release Version 2.07
- Release Version 2.06
- Release Version 2.05
- Release Version 2.04
- Release Version 2.03
- Release Version 2.02
- Release Version 2.01
- Release Version 2.00
- Release Version 1.99
- Release Version 1.98
- Release Version 1.97
- Release Version 1.96
- Release Version 1.95
- Release Version 1.93 & 1.94
- Release Version 1.92
- Release Version 1.91
- Release Version 1.90
- Release Version 1.89
- Release Version 1.88
- Release Version 1.87
- Release Version 1.86
- Release Version 1.84 & 1.85
- Release Version 1.83
- Release Version 1.82
- Release Version 1.81
- Release Version 1.80 (Jan-24-2022)
- Release Version 1.79 (Jan-03-2022)
- Release Version 1.78 (Dec-20-2021)
- Release Version 1.77 (Dec-06-2021)
- Release Version 1.76 (Nov-22-2021)
- Release Version 1.75 (Nov-09-2021)
- Release Version 1.74 (Oct-25-2021)
- Release Version 1.73 (Oct-04-2021)
- Release Version 1.72 (Sep-20-2021)
- Release Version 1.71 (Sep-09-2021)
- Release Version 1.70 (Aug-23-2021)
- Release Version 1.69 (Aug-09-2021)
- Release Version 1.68 (Jul-26-2021)
- Release Version 1.67 (Jul-12-2021)
- Release Version 1.66 (Jun-28-2021)
- Release Version 1.65 (Jun-14-2021)
- Release Version 1.64 (Jun-01-2021)
- Release Version 1.63 (May-19-2021)
- Release Version 1.62 (May-05-2021)
- Release Version 1.61 (Apr-20-2021)
- Release Version 1.60 (Apr-06-2021)
- Release Version 1.59 (Mar-23-2021)
- Release Version 1.58 (Mar-09-2021)
- Release Version 1.57 (Feb-22-2021)
- Release Version 1.56 (Feb-09-2021)
- Release Version 1.55 (Jan-25-2021)
- Release Version 1.54 (Jan-12-2021)
- Release Version 1.53 (Dec-22-2020)
- Release Version 1.52 (Dec-03-2020)
- Release Version 1.51 (Nov-10-2020)
- Release Version 1.50 (Oct-19-2020)
- Release Version 1.49 (Sep-28-2020)
- Release Version 1.48 (Sep-01-2020)
- Release Version 1.47 (Aug-06-2020)
- Release Version 1.46 (Jul-21-2020)
- Release Version 1.45 (Jul-02-2020)
- Release Version 1.44 (Jun-11-2020)
- Release Version 1.43 (May-15-2020)
- Release Version 1.42 (Apr-30-2020)
- Release Version 1.41 (Apr-2020)
- Release Version 1.40 (Mar-2020)
- Release Version 1.39 (Feb-2020)
- Release Version 1.38 (Jan-2020)
- Upcoming Features
Swell is a customizable e-commerce platform that provides you with the tools to sell products on the Internet. Swell allows you to host your digital retail stores on its platform regardless of your business model; business-to-consumer (B2C) or business-to-business (B2B).
Swell authenticates API requests from Hevo to access your account data with HTTP Basic authentication where the username is your Store ID and password is your API Key.
An active Swell account from which data is to be ingested.
An API key is available to authenticate Hevo on your Swell account.
Obtaining the Store ID and API Key
Swell automatically creates a unique store ID for each store. Hevo uses the store ID to identify the store from which to ingest the data, and the API key is used for authenticating Hevo on your Swell account. The API keys you generate in Swell do not expire. Therefore, you can use an existing key or create a new one to authenticate Hevo on your Swell account. Swell recommends creating a separate API key for each application that will be making calls on your behalf. For example, you can use the store ID and one API key for Hevo, to be used across all your Pipelines. However, you can also use the store ID with a different API key for each Pipeline.
Note: You must be logged in as an Admin user to obtain the API key.
Perform the following steps to obtains the Store ID and API Key:
Log in to your Swell account.
In the left navigation pane, under the ADMIN section, click Developer, and then click API keys.
In the API access page, copy the Store ID and save it securely like any other password.
To obtain the API key, do one of the following:
Create the API key:
In the API access page, scroll down to the Secret Keys section, and click Add secret key to generate a new API key.
In the New secret key pop-up dialog that is displayed, provide the Key Description for the API key that helps you easily identify it later.
Click Create key.
Use an existing API key. Click the masked portion of the secret key to reveal it fully.
Copy the API key and save it securely like any other password.
Configuring Swell as a Source
Perform the following steps to configure Swell as the Source in your Pipeline:
Click PIPELINES in the Navigation Bar.
Click + CREATE in the Pipelines List View.
In the Select Source Type page, select Swell.
In the Configure your Swell Source page, specify the following:
Click TEST & CONTINUE.
Proceed to configuring the data ingestion and setting up the Destination.
|Default Pipeline Frequency||Minimum Pipeline Frequency||Maximum Pipeline Frequency||Custom Frequency Range (Hrs)|
|1 hr||1 hr||24 hrs||1-24|
Note: You must set the custom frequency in hours as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.
Hevo ingests all the objects in Full Load mode in each run of the Pipeline.
Schema and Primary Keys
Hevo uses the following schema to upload the records in the Destination database:
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:
|Accounts||Contains the details of all the customer accounts.|
|Account Addresses||Contains the details of the billing and shipping addresses of a customer.|
|Account Cards||Contains the details of the cards used for transactions and payments by customers.|
|Account Credits||Contains the details of the credits available to a customer. Credits are a form of currency added to customers’ account, which can be used to make purchases.|
|Attributes||Contains the details of the attributes of all the products. Product attributes are additional properties of a product.|
|Categories||Contains information of all the categories used for organizing products in the store.|
|Carts||Contains the details of the carts made by customers to purchase products from the store. Carts contain all the information needed to fulfill a purchase.|
|Coupons||Contains the details of the coupons available for your customers on the store website.|
|Coupon Codes||Contains the details of the customer-redeemable codes associated with the coupons for discounts on products.|
|Coupon Generation||Contains the details of all the instances when a coupon code is generated for a particular coupon.|
|Coupon Uses||Contains the details of the instance when coupon codes are redeemed to purchase a product.|
|Gift Cards||Contains the details of the gift cards offered by the store to the customers. A gift card is a specific prepaid card of a certain amount of money that can be used to purchase items from the store.|
|Gift Card Debits||Contains the details of all the transactions and payments made by using a gift card.|
|Invoices||Contains the details about the sale of products, such as the prices and billing dates.|
|Orders||Contains the details of the orders placed to the store.|
|Payments||Contains the details of the payments made to the store.|
|Products||Contains the details of the products available for purchase in the store. Products are items that can be sold to a customer as either one-off sales or as subscriptions.|
|Promotions||Contains the details of the promotions offered by the store to the customers.|
|Promotion Uses||Contains the details about instances where a promotion has been used by a customer to apply a discount.|
|Purchase Links||Contains the details of the links that direct customers to the checkout page for a list of selected products, to complete the purchase.|
|Refunds||Contains the details of all the refunds issued by the store to the customers.|
|Returns||Contains the details of all the returns made by the customers to the store.|
|Shipments||Contains the details about the shipment of an order. Shipments contain information about the orders being fulfilled, and the shipping details such as address and tracking number.|
|Stocks||Contains the details of the stock levels of products in the store. It helps you to keep track of the inventory changes.|
|Subscriptions||Contains the details of the subscriptions plans offered by the store.|
|Variants||Contains the details of all the variants of a product in the store.|
Pagination: Each API response for each Swell object fetches one page with up to 1000 items per page.
Rate limit: Swell does not impose a hard limit on the number of API calls that can be made in a specific time interval.
Hevo currently does not support deletes. Therefore, any data deleted in the Source may continue to exist in the Destination.
The data is loaded in Full Load mode in each Pipeline run. As a result, you cannot load the historical data alone at any time.
Refer to the following table for the list of key updates made to this page:
|Date||Release||Description of Change|
|Dec-14-2022||NA||Updated section, Configuring Swell as a Source to reflect the latest Hevo UI.|
|Dec-07-2022||2.03||- Updated sections, Schema and Primary Keys and Data Model to add information about all the Swell objects supported by Hevo.|