- 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
Facebook Page Insights
From Release 2.25, Hevo has upgraded to v19.0 of the Marketing API. You may need to reauthorize Hevo for existing Pipelines. Refer to section, Configuring Facebook Pages as a Source for the authorization steps.
The new API version has removed the following Page Insights metrics:
Page Insights Category | Page Insights Metrics |
---|---|
Page Video Views | - page_video_views_10s - page_video_views_10s_paid - page_video_views_10s_organic - page_video_views_10s_autoplayed - page_video_views_10s_click_to_play - page_video_views_10s_unique - page_video_views_10s_repeat |
Page Video Posts | - post_video_views_10s - post_video_views_10s_unique - post_video_views_10s_autoplayed - post_video_views_10s_clicked_to_play - post_video_views_10s_organic - post_video_views_10s_paid - post_video_views_10s_sound_on |
Note: Hevo does not ingest any new data for the metrics listed in the table above, so the corresponding Destination tables are also not updated.
Facebook Pages uses Facebook’s Marketing API to fetch insights data for a Facebook page as a whole (such as followers and impressions), and for page posts (such as likes, shares, comments, and video plays). You can replicate the data of one or multiple Facebook pages, including details such as posting and activity history, page insights including page views, post impressions, and insights on posted stories or Ads to a Destination database or data warehouse using Hevo Pipelines.
The Facebook Pages admin user must authorize Hevo to access the Facebook Pages APIs for reading the page and posts-related insights data for the selected pages.
Note: The data is ingested only for posts made by the page owner.
Prerequisites
-
An active Facebook (FB) account with privileges to manage one or more FB pages exists.
-
You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.
Configuring Facebook Pages as a Source
Perform the following steps to configure Facebook Pages 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 Facebook Pages.
-
In the Configure your Facebook Pages account page, do one of the following:
-
Select a previously configured account and click CONTINUE.
-
Click Add Facebook Pages account and perform the following steps to configure an account:
-
Log in to your Facebook Pages account, and click Continue as <Company Name> in the pop-up dialog.
-
Select one of the following options:
-
Opt in to all current and future business (Default): Hevo gets access to all the existing businesses in your Business Manager account(s) and the ones you create in the future.
-
Opt in to current businesses only: Hevo gets access only to the businesses in the Business Manager account(s) you select. You can select the accounts individually or click the Select all option to grant access to all the accounts.
Note: As part of the Facebook Marketing API update to v18.0, Hevo requires business management permission to replicate data from your Facebook Pages account(s).
-
-
Click Continue.
-
Select one of the following to choose the pages you want to replicate:
-
Opt in to all current and future Pages: Hevo gets access to all the existing pages in the account and the ones you create in the future.
-
Opt in to current Pages only (Default): Hevo gets access only to the pages you select. You can select the pages individually or click the Select all option to grant access to all the pages.
-
-
Click Continue.
-
Review the permissions requested by Hevo and click Save to authorize Hevo to access the data.
-
Click Got it in the confirmation dialog.
-
-
-
In the Configure your Facebook Pages Source page, specify the following:
-
Pipeline Name: A unique name for your Pipeline, not exceeding 255 characters.
-
Pages: The pages whose data you want to replicate. Select one or more pages from the drop-down. Default selection: All.
-
Historical Sync Duration: The duration for which you want to ingest the existing data from the Source. Default duration: 1 Month.
Note: You can fetch data for
daily_page
orunique_page
metrics for a period more than three months by changing the position of these objects to any past date up till two years from the current date, in the Pipeline Overview page. Any data ingested from the Source using the Change Position action is billable.
-
-
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 | 24 Hrs | 12 Hrs | 24 Hrs | 12-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 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 Month.
Note: You can fetch data for Daily Page or Unique Page metrics for a period more than three months by changing the position of these objects to any past date up till two years from the current date, in the Pipeline Overview page.
-
Incremental Data: Once the historical load is complete, data is ingested as per the ingestion frequency in Full Load or Incremental mode, as applicable.
-
Data Refresh: Data for the last 90 days is refreshed on a rolling basis for all data objects.
Schema and Primary Keys
Hevo uses the following schema to upload the records in the Destination database:
Data Model
Hevo ingests the following data from your Facebook account:
Object | Description & Update Frequency |
---|---|
Daily Page Metrics | Daily page metrics, grouped on the basis of the following categories: - Action Type - Age Gender - City - Consumption Type - Country - Frequency Distribution - Like Source - Paid Non-paid - Locale - Story Type - Time - Type - Unlike Source - Total - Profile Tab |
Lifetime Post Metrics | All time post-level metrics grouped on the basis of the following categories: - Action Type - Age Gender - Country - Locale - Type - Total |
Page | All page details such as bio, about, likes, creation date, page type, hours, products. Metrics such as likes and shares are subject to change daily. Other details such as bio and working hours are subject to a page owner’s preference. |
Post | All posts-related activity and metrics such as likes, views, and shares, from the feed, fetched and updated for the past 14 days. |
Post Attachments | Attachment details for posts, such as, description, type, and URLs. |
Post Tagged Object | Details related to an entity tagged on any post, such as name, type, and related post details. |
Post Video Property | All properties related to a video included in a post such as description, length, and source. |
Unique Page Metrics | Individual page-level metrics grouped on the basis of the following categories: - Action Type - Age Gender - City - Consumption Type - Country - Frequency Distribution - Like Source - Paid Non-paid - Locale - Story Type - Time - Type - Unlike Source - Total - Profile Tab |
Unique Lifetime Post Metrics | Individual post-level metrics grouped on the basis of the following categories: - Action Type - Age Gender - Country - Locale - Type - Total |
Additional Information
Read the detailed Hevo documentation for the following related topics:
Limitations
-
All page data is limited to the past two years due to Facebook Pages API limitations.
Note: To fetch data for
daily_page
orunique_page
metrics for a period more than three months, change the position of the object to any past date up till two years from the current date, in the Pipeline Overview page.
Revision History
Refer to the following table for the list of key updates made to this page:
Date | Release | Description of Change |
---|---|---|
Aug-29-2024 | NA | Updated section, Limitations to remove the limitation on ingesting post data and metrics only from the last 90 days. |
Jul-01-2024 | 2.25 | Updated the page overview to: - Add a warning container to inform about the upgrade to Marketing API v19.0, - Remove the note about the upgrade to Marketing API v18.0. |
Mar-05-2024 | 2.21 | Updated the ingestion frequency table in the Data Replication section. |
Jan-29-2024 | 2.19.3 | Added a note in the page overview about the Marketing API v18.0 update. |
Oct-03-2023 | NA | Updated the se |
Oct-03-2023 | NA | Updated the section, Configuring Facebook Pages as a Source as per the latest Facebook UI. |
Feb-20-2023 | NA | Updated section, Configuring Facebook Pages as a Source to update the information about historical sync duration. |
Sep-05-2022 | NA | Updated section, Data Replication to reorganize the content for better understanding and coherence. |
Dec-06-2021 | 1.77 | Updated the Data Model section to correct the definitions of Lifetime Post Metrics and Unique Page Metrics. |
Oct-25-2021 | NA | Added the Pipeline frequency information in the Data Replication section. |
Jul-26-2021 | NA | Added a note in the Overview section about Hevo providing a fully-managed Google BigQuery Destination for Pipelines created with this Source. |