Release Status Released Supported By Singer community
Availability Free Status Page Taboola Status Page
Default Historical Sync 1 year Default Replication Frequency 30 minutes
Whitelisting Unsupported Destination Incompatibilities None

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

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Taboola icon.

  4. 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.

  5. In the Username field, enter your Taboola username. This user must have access to the Taboola API.
  6. In the Password field, enter your Taboola password.
  7. In the Account ID field, enter your Taboola account ID.
  8. In the Client ID field, enter your Taboola client ID.
  9. In the Client Secret field, enter your Taboola client secret.

Step 2: Define the Historical Sync

The Sync Historical Data setting will define 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.

Stitch offers two methods of creating a replication schedule:

  • Replication Frequency: This method requires selecting the interval you want replication to run for the integration. Start times of replication jobs are based on the start time and duration of the previous job. Refer to the Replication Frequency documentation for more information and examples.
  • Anchor scheduling: Based on the Replication Frequency, or interval, you select, this method “anchors” the start times of this integration’s replication jobs to a time you select to create a predictable schedule. Anchor scheduling is a combination of the Anchor Time and Replication Frequency settings, which must both be defined to use this method. Additionally, note that:

    • A Replication Frequency of at least one hour is required to use anchor scheduling.
    • An initial replication job may not begin immediately after saving the integration, depending on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

To help prevent overages, 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.

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 schemas

Replication Method: Key-based Incremental Replication Key : n/a
Primary Key : id API Endpoint: listCampaignsAssociatedWithAnAccount

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 data warehouse, 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 data warehouse.

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.

id
INTEGER

The campaign ID.

start_date
DATE

The start date for the campaign.

end_date
DATE

The end date for the campaign.

advertiser_id
STRING

The advertiser ID. Ex: taboola-demo-advertiser

name
STRING

The name of the campaign.

tracking_code
STRING

The tracking code of the campaign. Ex: taboola-track

cpc
NUMBER

The cost per click for the campaign.

daily_cap
NUMBER

The daily cap for the campaign.

spending_limit
NUMBER

The spending limit for the campaign.

spending_limit_model
STRING

Indicates if the campaign has a monthly recurring budget or an overall budget. Possible values are MONTHLY and ENTIRE.

country_targeting__type
STRING

The type of targeting for the associated country. Possible values are INCLUDE or EXCLUDE.

country_targeting__value

The list of countries the campaign will target or exclude.

If your destination doesn't natively support nested data, this data may be denested into a subtable named campaign__country_targeting__value. Refer to the Singer schema for details on possible attributes.

platform_targeting__type
STRING

The type of targeting for the associated platform. Possible values are INCLUDE or EXCLUDE.

platform_targeting__value

Details about the platforms the campaign will target or exclude.

If your destination doesn't natively support nested data, this data may be denested into a subtable named campaign__platform_targeting__value. Refer to the Singer schema for details on possible attributes.

publisher_targeting__type
STRING

The type of targeting for the associated publisher. This will always be EXCLUDE.

publisher_targeting__value

Details about the publishers that blacklisted from publishing the campaign.

If your destination doesn't natively support nested data, this data may be denested into a subtable named campaign__publisher_targeting__value. Refer to the Singer schema for details on possible attributes.

approval_state
STRING

The approval state for the campaign, which indicates if the campaign is approved to be served. Possible values:

  • APPROVED
  • REJECTED
  • PENDING
is_active
BOOLEAN

Indicates if the campaign is active.

spent
NUMBER

The estimated amount of money the campaign has consumed.

status
STRING

The status of the campaign. Ex: RUNNING


campaign_performance

Replication Method: Key-based Incremental Replication Key : date
Primary Key : campaign_id : date Documentation: Official Docs

The campaign_performance table contains performance data for the campaigns in your Taboola account, broken down by day.

campaign_id
INTEGER

The campaign ID.

date
DATE

The start date of the campaign.

impressions
INTEGER

The total number of impressions for the campaign for this date..

ctr
NUMBER

for this date, calculated as (clicks/impressions)

clicks
INTEGER

The total number of clicks for the campaign for this date.

cpc
NUMBER

The cost per click for the campaign for this date, calculated as (spend/clicks)

cpm
NUMBER

The cost per 1000 impressions for the campaign for this date, calculated as (spend/impressions)

cpa_conversion_rate
NUMBER

The conversion rate for the campaign for this date, calculated as (actions/clicks)

cpa_actions_num
INTEGER

The total actions (conversions) for the campaign for this date.

cpa
NUMBER

The for the campaign for this date, calculated as (spend/actions

spent
NUMBER

The total amount spent for the campaign for this date.

currency
STRING

The ISO4217 currency code for columns containing monetary data.



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.