- 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.29.1 (Oct 21-28, 2024)
- Release 2.29 (Sep 30-Oct 22, 2024)
-
2024 Releases
- Release 2.28 (Sep 02-30, 2024)
- Release 2.27 (Aug 05-Sep 02, 2024)
- Release 2.26 (Jul 08-Aug 05, 2024)
- Release 2.25 (Jun 10-Jul 08, 2024)
- Release 2.24 (May 06-Jun 10, 2024)
- Release 2.23 (Apr 08-May 06, 2024)
- Release 2.22 (Mar 11-Apr 08, 2024)
- Release 2.21 (Feb 12-Mar 11, 2024)
- Release 2.20 (Jan 15-Feb 12, 2024)
-
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
AppsFlyer
AppsFlyer is a mobile-app tracking and attribution analytics platform that helps app developers and marketers to manage, measure, and optimize their mobile user acquisition process.
Hevo uses AppsFlyer’s PULL API to replicate the raw and aggregated app performance reports from your AppsFlyer account to the Destination system. The user needs to provide the AppsFlyer API Token to connect Hevo to the AppsFlyer account.
Note: For Pipelines created from Release 2.13 onwards, Hevo supports version 2 of AppsFlyer’s API token to replicate your data. Refer to the section, Migrating from AppsFlyer API V1 Token to V2 to update the API token in your existing Pipelines.
Prerequisites
-
An active AppsFlyer account with access to at least one app exists.
-
The App ID and API token are available to authenticate Hevo on your AppsFlyer account. You must be logged in as an Admin user in AppsFlyer to obtain these credentials. Else, you can obtain them from your account administrator.
-
You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.
Obtaining the App ID and API Token
You require an app ID and an API token to authenticate Hevo on your AppsFlyer account. The app ID is the unique ID of the app listed in the AppsFlyer dashboard whose data you want to replicate to the Destination. You need to create an API token for the listed app.
Note: You must log in as an Admin user to perform these steps.
Step 1. Obtain the App ID
-
Log in to your AppsFlyer account. On the homepage, you can find the apps added to your account.
-
Copy the app ID of the app from which you want to fetch data. Use this ID while configuring your Hevo Pipeline.
Note: The app ID for iOS apps starts with
id
.
Step 2. Obtain the API Token
-
In the top right of the AppsFlyer homepage, click the drop-down next to your username, and click Security center.
-
In the Manage your account security page, scroll down and click Manage your AppsFlyer API tokens.
-
In the API tokens page, copy the API token V2.0 and save it securely like any other password. The API token allows Hevo to pull raw and aggregated data reports from AppsFlyer. Use this token while configuring your Hevo Pipeline.
Configuring AppsFlyer as a Source
Perform the following steps to configure AppsFlyer 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 AppsFlyer.
-
In the Configure your AppsFlyer Source page, specify the following:
-
Pipeline Name - A unique name for your Pipeline, not exceeding 255 characters.
-
App ID - The unique ID of your AppsFlyer app that you obtained from your AppsFlyer account.
-
API Token - The API token that you obtained from your AppsFlyer account.
-
Pull API Timezone - The timezone in which you want to receive the data.
-
-
Click TEST & CONTINUE.
-
Proceed to configuring the data ingestion and setting up the Destination.
Migrating from AppsFlyer API V1 Token to V2
Effective September 18, 2023, AppsFlyer has discontinued support for the API V1 token to fetch raw and aggregated data reports from your AppsFlyer app. Therefore, you must replace the V1 token with the V2 token in your existing Pipelines to prevent data ingestion failures.
Note:
-
Replacing the API token does not affect the data replication process.
-
Once you update the API token in your existing Pipeline, you cannot revert to using the V1 token for fetching data from your AppsFlyer app.
Perform the following steps to replace the API token in an existing Pipeline:
-
Click PIPELINES in the Navigation Bar.
-
Search for your AppsFlyer Source Pipeline and click anywhere in its Pipeline Summary row.
-
Click the Settings ( ) icon next to the Source name.
-
In the hover window that appears, click the Edit ( ) icon.
-
In the Edit AppsFlyer Pipeline connection settings page, specify the API Token V2 that you retrieved in the Obtain the API Token step above.
-
Click TEST & SAVE.
Data Replication
For Teams Created | Default Ingestion Frequency | Minimum Ingestion Frequency | Maximum Ingestion Frequency | Custom Frequency Range (in Hrs) |
---|---|---|---|---|
Before Release 2.21 | 30 Mins | 5 Mins | 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: In the first run of the Pipeline, Hevo ingests the data of the past 90 days for the selected objects in your AppsFlyer account. You can use the Change Position option for an object to load data older or recent than 90 days.
Refer to the following table to know about the maximum number of days for which AppsFlyer provides historical data for each object:
Object API Limit for Historical Data (Days) daily_report 60 geo_by_date_acquisition_report 60 geo_by_date_retargeting_report 60 in-app_events_report 31 in-app_events_retargeting_report 31 installs_report 60 organic_installations_report 60 organic_in_app_events_report 31 partners_by_date_report 60 partners_report 100 uninstalls_report 60 Note: You are not charged for the Events that are loaded or reloaded after the change of position.
-
Incremental Data: Once the historical data ingestion is complete, every subsequent run of the Pipeline fetches new and updated data for the reports.
Schema and Primary Keys
Hevo uses the following schema to upload the records in the Destination:
Data Model
Hevo uses the following data model to ingest data from your AppsFlyer account:
Object | Report Type | Description |
---|---|---|
daily_report | Aggregated | Contains details of clicks and impressions grouped by Date. |
geo_by_date_acquisition_report | Aggregated | Contains an acquisition report grouped by date, country, agency, media source, and campaign. To view examples, see this. |
geo_by_date_retargeting_report. | Aggregated | Contains retargeting report grouped by date, country, agency, media source, and campaign. To view examples, see this. |
in-app_events_report | Raw | Contains report of in-app events as per the user’s action. |
in-app_events_retargeting_report | Raw | Contains the data of the media sources attributed to the conversion. |
installs_report | Raw | Contains report of the event generated when the app is opened for the first time. |
organic_installations_report | Raw | Contains installation reports of the app, such as, the time of installation, type of device, operating system, region, city, and country. |
organic_in_app_events_report | Raw | Contains details of actions performed by users. |
partners_by_date_report | Aggregated | Contains partner data grouped by date, agency, media source, and campaign. View examples here. |
partners_report | Aggregated | Contains partner data grouped by date, agency, media source, and campaign. View examples here. |
uninstalls_report | Raw | Contains uninstallation reports of the app, such as, time of uninstallation, type of device, operating system, region, city, and country. |
Note: __hevo_id
, which represents a unique ID for the Source data, is derived by hashing the Source data’s primary key columns.
Additional Information
Read the detailed Hevo documentation for the following related topics:
Limitations
- Hevo does not support raw reports of
Ad revenue
andRetargeting
fetched from AppsFlyer.
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. |
Jun-05-2023 | 2.13 | Updated the content to add information about API V2 token. |
Jan-10-2023 | 2.05 | Updated section, Data Replication to mention about custom ingestion frequency. |
Dec-07-2022 | NA | Updated section, Data Replication to reorganize the content for better understanding and coherence. |
Mar-17-2022 | NA | Removed the Pipeline frequency table from the Data Replication section as you cannot configure the Pipeline frequency from the UI. |
Mar-07-2022 | NA | - Updated the steps under the Obtaining the App ID and the API Token section, to reflect the latest AppsFlyer UI. - Updated the Pipeline Frequency table and added information about historical data in the Data Replication section. |
Oct-25-2021 | NA | Added the Pipeline frequency information in the Data Replication section. |