This integration is powered by Singer's Taboola tap. For support, visit the GitHub repo or join the Singer Slack.
Taboola integration summary
Stitch’s Taboola integration replicates data using the Taboola Backstage API. Refer to the Schema section for a list of objects available for replication.
Taboola feature snapshot
A high-level look at Stitch's Taboola (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Released on April 25, 2017 |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Unsupported |
Column selection |
Unsupported |
Select all |
Unsupported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Taboola
Taboola setup requirements
To set up Taboola in Stitch, you need:
-
Access to the Taboola API.
-
The following API credentials:
- Taboola Account ID
- Client ID
- Client Secret
Reach out to your Taboola Account Manager for assistance. Once you receive this information, you can continue with the setup.
Step 1: Add Taboola as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Taboola icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Taboola” would create a schema called
stitch_taboola
in the destination. Note: Schema names cannot be changed after you save the integration. - In the Username field, enter your Taboola username. This user must have access to the Taboola API.
- In the Password field, enter your Taboola password.
- In the Account ID field, enter your Taboola account ID.
- In the Client ID field, enter your Taboola client ID.
- In the Client Secret field, enter your Taboola client secret.
Step 2: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Taboola integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond Taboola’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 3: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Taboola integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Initial and historical replication jobs
After you finish setting up Taboola, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Taboola table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Taboola integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
campaign
The campaign
table contains info about the campaigns in your Taboola account.
Replication
During every replication job, all campaigns in your Taboola account will be extracted, or “fully replicated.” If you look in the Extraction Logs in the Stitch app, you’ll see lines like this:
2017-10-25 13:46:52,254Z tap - INFO Synced 100 campaigns.
2017-10-25 13:46:52,255Z tap - INFO Done syncing campaigns.
Roughly the same amount of campaigns should be extracted during every job, unless brand new campaigns are added between jobs.
When Stitch loads the extracted records into your destination, however, only new and updated campaigns will be loaded. This means that only new and updated campaign records will count towards your row count.
Deleted campaigns
Currently, the Singer tap powering this integration has no way to account for campaigns that are hard-deleted in Taboola. This means that if a campaign is deleted at the source, the record for that campaign will remain in the destination.
NULL dates
On occasion, Taboola’s API will push NULL
for start_date
and 999-12-31
for end_date
. The Singer tap behind this integration will convert NULL
dates to 999-12-31
for consistency.
Full Table |
|
Primary Key |
id |
Useful links |
Join campaign with | on |
---|---|
campaign_performance |
campaign.id = campaign_performance.campaign_id |
advertiser_id STRING |
|||
approval_state STRING |
|||
country_targeting OBJECT
|
|||
cpc NUMBER |
|||
daily_cap NUMBER |
|||
end_date DATE |
|||
id INTEGER |
|||
is_active BOOLEAN |
|||
name STRING |
|||
platform_targeting OBJECT
|
|||
publisher_targeting OBJECT
|
|||
spending_limit NUMBER |
|||
spending_limit_model STRING |
|||
spent NUMBER |
|||
start_date DATE |
|||
status STRING |
|||
tracking_code STRING |
campaign_performance
The campaign_performance
table contains performance data for the campaigns in your Taboola account, broken down by day.
Key-based Incremental |
|
Primary Keys |
campaign_id date |
Replication Key |
date |
Useful links |
Join campaign_performance with | on |
---|---|
campaign |
campaign_performance.campaign_id = campaign.id |
campaign_id INTEGER |
clicks INTEGER |
cpa NUMBER |
cpa_actions_num INTEGER |
cpa_conversion_rate NUMBER |
cpc NUMBER |
cpm NUMBER |
ctr NUMBER |
currency STRING |
date DATE |
impressions INTEGER |
spent NUMBER |
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.