- Introduction
- Getting Started
- Creating an Account in Hevo
- Subscribing to Hevo via AWS Marketplace
-
Connection Options
- Connecting Through SSH
- Connecting Through Reverse SSH Tunnel
- Connecting Through VPN
- Connecting Through Mongo PrivateLink
- Connecting Through AWS Transit Gateway
- Connecting Through AWS VPC Endpoint
- Connecting Through AWS VPC Peering
- 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
- Data Loading
- Loading Data in a Database Destination
- Loading Data to a Data Warehouse
- Optimizing Data Loading for a Destination Warehouse
- Deduplicating Data in a Data Warehouse Destination
- 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
- Pipelines
- Data Flow in a Pipeline
- Familiarizing with the Pipelines UI
- Working with Pipelines
- Managing Objects in Pipelines
- Pipeline Jobs
-
Transformations
-
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
-
TimeUtils
- 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
- Utils
- 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
- If-Else
- 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
-
Schema Mapper
- 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
- Audit Tables
- Activity Log
-
Pipeline FAQs
- 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?
- 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
- Sources
- Free Sources
-
Databases and File Systems
- Data Warehouses
-
Databases
- Connecting to a Local Database
- Amazon DocumentDB
- Amazon DynamoDB
- Elasticsearch
-
MongoDB
- Generic MongoDB
- MongoDB Atlas
- Support for Multiple Data Types for the _id Field
- Example - Merge Collections Feature
-
Troubleshooting MongoDB
-
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
- SQL Server
-
MySQL
- Amazon Aurora MySQL
- Amazon RDS MySQL
- Azure MySQL
- Generic MySQL
- Google Cloud MySQL
- MariaDB MySQL
-
Troubleshooting 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
- Oracle
-
PostgreSQL
- Amazon Aurora PostgreSQL
- Amazon RDS PostgreSQL
- Azure PostgreSQL
- Generic PostgreSQL
- Google Cloud PostgreSQL
- Heroku PostgreSQL
-
Troubleshooting 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
- File Storage
- Engineering Analytics
- Finance & Accounting Analytics
-
Marketing Analytics
- ActiveCampaign
- AdRoll
- Amazon Ads
- Apple Search Ads
- AppsFlyer
- CleverTap
- Criteo
- Drip
- Facebook Ads
- Facebook Page Insights
- Firebase Analytics
- Freshsales
- Google Campaign Manager
- Google Ads
- Google Analytics
- Google Analytics 4
- Google Analytics 360
- Google Play Console
- Google Search Console
- HubSpot
- Instagram Business
- Klaviyo v2
- Lemlist
- LinkedIn Ads
- Mailchimp
- Mailshake
- Marketo
- Microsoft Ads
- Onfleet
- Outbrain
- Pardot
- Pinterest Ads
- Pipedrive
- Recharge
- Segment
- SendGrid Webhook
- SendGrid
- Salesforce Marketing Cloud
- Snapchat Ads
- SurveyMonkey
- Taboola
- TikTok Ads
- Twitter Ads
- Typeform
- YouTube Analytics
- Product Analytics
- Sales & Support Analytics
- Source FAQs
- Destinations
- Familiarizing with the Destinations UI
- Cloud Storage-Based
- Databases
-
Data Warehouses
- Amazon Redshift
- Amazon Redshift Serverless
- Azure Synapse Analytics
- Databricks
- Firebolt
- Google BigQuery
- Hevo Managed Google BigQuery
- Snowflake
-
Destination FAQs
- 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?
- 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?
- How do I filter out specific fields before loading data?
- Transform
- Alerts
- Account Management
- Activate
- Glossary
Releases- Release 2.28.1 (Sep 30-Oct 07, 2024)
- Release 2.28 (Sep 02-30, 2024)
- 2024 Releases
-
2023 Releases
- Release 2.19 (Dec 04, 2023-Jan 15, 2024)
- Release Version 2.18
- Release Version 2.17
- Release Version 2.16 (with breaking changes)
- Release Version 2.15 (with breaking changes)
- 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
-
2022 Releases
- 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)
-
2021 Releases
- 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)
-
2020 Releases
- 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)
- Early Access New
- Upcoming Features
Snapchat Ads
Snapchat Ads is Snapchat’s advertising platform that enables you to retrieve statistics about the ads, ad squads, and campaigns running on Snapchat.
Hevo uses the Snapchat Marketing APIs to replicate your Snapchat Ads data into the desired Destination database or data warehouses for scalable analysis. For this, you must authorize Hevo to access data from your Snapchat Ads account.
Prerequisites
-
An active Snapchat Ads account from which the data is to be ingested.
-
A Snapchat user with Admin privileges, to access the data from the Snapchat Ads account.
-
You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.
Configuring Snapchat Ads as a Source
Perform the following steps to configure Snapchat Ads as the Source in your Pipeline:
-
Click PIPELINES in the Navigation Bar.
-
Click + CREATE PIPELINE in the Pipelines List View.
-
In the Select Source Type page, select Snapchat Ads.
-
In the Configure your Snapchat Ads account page, do one of the following:
-
Select a previously configured account and click CONTINUE.
-
Click + ADD SNAPCHAT ADS ACCOUNT and perform the following steps to configure an account:
-
Sign in using your Snapchat Ads account.
-
Click Continue to authorize Hevo to access your Snapchat Ads data.
-
-
-
In the Configure your Snapchat Ads Source page, specify the following:
-
Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.
-
Select Organizations: The Snapchat organization whose data you would like to ingest. You can select multiple organizations.
-
Select Ad Accounts: The Snapchat Ads account whose data you would like to ingest. You can select multiple Ad Accounts.
-
Historical Sync Duration: The duration for which you want to ingest the existing data from the Source. Default duration: 1 Year.
-
Advanced Settings:
-
Attribution Windows: The number of days between a user’s responses on an ad. You can specify either one or both of the following:
-
View Attribution Window: The number of days between a person viewing your ad and taking an action such as visiting a page. Default value: 1_Day.
-
Swipe Attribution Window: The number of days between a person swiping up on an ad and taking an action such as tapping a story tile or sharing a lens with a friend. Default value: 28_Day.
-
-
-
-
Click TEST & CONTINUE.
-
Proceed to configuring the data ingestion and setting up the Destination.
Data Replication
For Teams Created | Default Ingestion Frequency | Minimum Ingestion Frequency | Maximum Ingestion Frequency | Custom Frequency Range (in Hrs) |
---|---|---|---|---|
Before Release 2.21 | 3 Hrs | 1 Hr | 24 Hrs | 1-24 |
After Release 2.21 | 6 Hrs | 30 Mins | 24 Hrs | 1-24 |
Note: The custom frequency must be set in hours as an integer value. For example, 1, 2, or 3 but not 1.5 or 1.75.
-
Historical Data: The first run of the Pipeline ingests historical data for the selected reports and objects on the basis of the historical sync duration specified at the time of creating the Pipeline and loads it to the Destination. Default duration: 1 Year.
-
Incremental Data: Once the historical load is complete, all new and updated records are ingested as per the ingestion frequency.
-
For objects, Hevo performs full load to capture any data changes.
-
For reports, Hevo incrementally fetches data up to the previous day (as per the Snapchat Ads account’s timezone).
-
-
Refresher Data: Daily Reports are refreshed once a day, and hourly reports are refreshed once every 6 hours. The refresher window depends on the attribution window you select. For example, if you select a 28 day window, Hevo refreshes the daily report data once a day, and the hourly report data once every 6 hours for the past 28 days.
Custom frequency for Full Load objects
Hevo allows you to set the ingestion frequency for Full Load objects separately from the Pipeline ingestion frequency. You can reduce your Events quota consumption by ingesting Full Load objects at a lower frequency without affecting other objects in the Pipeline. Read Query Modes and Events Quota Consumption to know how different query modes affect your Events quota consumption.
You can identify the Full Load objects in the Pipelines Detailed View by the FL tag corresponding to their name. Alternatively, you can view only Full Load objects in your Pipeline by selecting Full Load from the Filter ( ) menu.
Perform the following steps to set a custom ingestion frequency for Full Load objects:
-
In the Pipelines Detailed View, click the More ( ) icon to open the Pipeline’s Action menu and click Change Schedule.
-
In the Change the Pipeline Ingestion Schedule pop-up window, enable the Change Full Load Object Schedule option.
-
Select the ingestion frequency for the Full Load objects as per your requirements. You can select Custom and define the ingestion frequency by specifying an integer value in hours.
-
Click SCHEDULE.
The updated schedule is applied immediately.
Note: The following image displays the frequencies suggested by Hevo for teams created before Release 2.21:
Handling Deleted Objects
Snapchat Ads APIs allow performing a soft delete of records. For the deleted records, Hevo sets the deleted
column to True in the ingested data and the Destination.
Hevo tracks the deleted Events through the metadata column, deleted
and replicates that information for the following objects:
Object Name | Event Type Tracked |
---|---|
ADS | updated |
AD SQUADS | deleted |
CAMPAIGNS | deleted |
Note: As Hevo also replicates the deleted data, you might see more Events in your Destination than in the Source.
Schema and Primary Keys
Hevo uses the following schema to upload the records in the Destination:
Data Model
Hevo fetches both objects and reports from your specified ads account. Reports provide metrics around your users, their interaction related details, and the performance of your Ads.
Objects
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:
Object | Description |
---|---|
Account | Contains the details of the Snapchat Ads account. |
Ads | Contains information required to display an ad per ads squad. |
Ad Squads | Contains information of ad squads associated with an ad campaign. |
Audience Segments | Contains the list of created audience segments. |
Campaigns | Contains the details of the ad campaigns per ad account. |
Creatives | Contains the details of creatives owned by an ad account. |
Funding Sources | Contains information about the configured funding sources responsible to pay for the ad activity within an ad account of an organization. |
Media | Contains the list of created audience segments. |
Organizations | Contains the organization details of the user associated with the Snapchat Ads account. |
Snap Pixels | Contains the details of snap pixels associated with the Snapchat ads account. |
Reports
The following reports are replicated as tables in the Destination when you run the Pipeline:
Ad Reports
The Ad reports include the following reports:
-
AD_HOURLY_REPORT
-
AD_DAILY_REPORT
-
AD_GEO_COUNTRY_DAILY_REPORT
-
AD_GEO_REGION_DAILY_REPORT
-
AD_GEO_DMA_DAILY_REPORT
-
AD_INTEREST_DAILY_REPORT
-
AD_DEVICE_OS_DAILY_REPORT
-
AD_DEVICE_MAKE_DAILY_REPORT
-
AD_DEMOGRAPHIC_DAILY_REPORT
-
AD_UNIQUE_IMPRESSION_DAILY_REPORT
Ad Squad Reports
The Ad Squad reports include the following reports:
-
AD_SQUAD_HOURLY_REPORT
-
AD_SQUAD_DAILY_REPORT
-
AD_SQUAD_GEO_COUNTRY_DAILY_REPORT
-
AD_SQUAD_GEO_REGION_DAILY_REPORT
-
AD_SQUAD_GEO_DMA_DAILY_REPORT
-
AD_SQUAD_DEVICE_OS_DAILY_REPORT
-
AD_SQUAD_DEVICE_MAKE_DAILY_REPORT
-
AD_SQUAD_DEMOGRAPHIC_DAILY_REPORT
-
AD_SQUAD_UNIQUE_IMPRESSION_DAILY_REPORT
Campaign Reports
The Campaign reports include the following reports:
-
CAMPAIGN_DAILY_REPORT
-
CAMPAIGN_HOURLY_REPORT
-
CAMPAIGN_GEO_COUNTRY_DAILY_REPORT
-
CAMPAIGN_GEO_REGION_DAILY_REPORT
-
CAMPAIGN_GEO_DMA_DAILY_REPORT
-
CAMPAIGN_INTEREST_DAILY_REPORT
-
CAMPAIGN_DEVICE_OS_DAILY_REPORT
-
CAMPAIGN_DEVICE_MAKE_DAILY_REPORT
-
CAMPAIGN_DEMOGRAPHIC_DAILY_REPORT
-
CAMPAIGN_UNIQUE_IMPRESSION_DAILY_REPORT
Revision History
Refer to the following table for the list of key updates made to this page:
Date | Release | Description of Change |
---|---|---|
Mar-05-2024 | 2.21 | - Updated the ingestion frequency table in the Data Replication section. - Updated the Custom frequency for Full Load objects section with suggested frequencies for teams before and after Release 2.21. |
Dec-07-2022 | NA | Updated section, Data Replication to reorganize the content for better understanding and coherence. |
Sep-21-2022 | 1.98 | Added section, Custom frequency for Full Load objects to inform users about the option to change ingestion frequency for Full Load objects. |
May-10-2022 | 1.88 | New document. |