Release Status Released Availability Free
Status Page Taboola Status Page Default Historical Sync 1 year
Whitelist Tables/Columns Unsupported/Unsupported Default Replication Frequency 30 minutes
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. On the Stitch Dashboard page, click the Add Integration button.
  2. Click the Taboola icon.

  3. Enter a name for the integration. This is the name that will display on the for the integration; it’ll also be used to create the schema in your data warehouse.

    For example, the name “Stitch Taboola” would create a schema called stitch_taboola in the data warehouse. Note that the schema name cannot be changed after you save the integration.

  4. In the Username field, enter your Taboola username. This user must have access to the Taboola API.
  5. In the Password field, enter your Taboola password.
  6. In the Account ID field, enter your Taboola account ID.
  7. In the Client ID field, enter your Taboola client ID.
  8. 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 sync data beyond Taboola’s default setting of 1 year. For a detailed look at historical syncs, check out the Syncing Historical SaaS Data guide.

Step 3: Define Replication Frequency

The Replication Frequency controls how often Stitch will attempt to extract data from your Taboola integration.

Note: This setting only affects the frequency of data extraction from Taboola, not the interval at which data is loaded into your data warehouse. For example: a one (1) minute Replication Frequency means Stitch will attempt to extract data every minute, but loading the extracted data may take longer than this.

Use the Default Frequency

To use the default Replication Frequency (30 minutes), leave the Use integration default box checked and click Check and Save to create the integration.

Customize the Frequency

To adjust the Replication Frequency:

  1. Uncheck the Use integration default checkbox. A slider with various frequencies will display.
  2. Click the desired frequency on the slider.
  3. Click Check and Save to create the integration.

To help prevent overages, consider setting the integration to replicate less frequently. See the Understanding & Reducing Your Row Usage guide for tips on reducing your usage.

Taboola’s Intial Replication Job

After you finish setting up Taboola, you might see its Sync Status 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.


Taboola Table Schemas

Replication Method: 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.

This data may be de-nested into a subtable if your data warehouse doesn't natively support nested data.

Refer to the Singer schema for detail 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.

This data may be de-nested into a subtable if your data warehouse doesn't natively support nested data.

Refer to the Singer schema for detail 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.

This data may be de-nested into a subtable if your data warehouse doesn't natively support nested data.

Refer to the Singer schema for detail 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: 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, please reach out to us.