Taboola

App · 25 actions

Run your Taboola advertising: create, update, pause and copy campaigns, add and edit their ads, run performance reports, manage conversion rules, custom audience targeting and blocked sites, and start workflows when campaigns or ads change.

Actions

ActionWhat it does
Add adAdd an ad to a campaign for a landing page.
Block sitesStop showing the account's ads on these sites.
Create campaignCreate a campaign in an advertiser account.
Create conversion ruleCount a conversion when someone visits a page address, or when your Taboola pixel sends an event.
Delete adDelete an ad for good: Taboola stops it and it can't be found again.
Delete campaignDelete a campaign for good: Taboola stops it and it can't be found again.
Duplicate campaignCopy a campaign with its settings and targeting, in the same account or another account in your network.
Get adGet one ad with its title, image, link, button, review state and status.
Get API key's accountGet the account the API key belongs to: its name, account id, currency and type.
Get campaignGet one campaign with its budget, bid, targeting, dates, review state and status.
Get conversion ruleGet one conversion rule with its condition, value and status.
List accountsList every account the API key may work on: the network account and each advertiser account in it, or just your own.
List adsList a campaign's ads with their titles, images, links, review state and status.
List blocked sitesList the sites the account never shows its ads on.
List campaignsList an account's campaigns with their budgets, bids, targeting and status.
List conversion rulesList the account's conversion rules, including those made for the whole network.
List custom audiencesList the account's custom audiences: the people your Taboola pixel saw visit pages or send events.
Pause or resume campaignPause a campaign so it stops showing ads, or resume it.
Run campaign summary reportGet spend, clicks, impressions and conversions for a date range, by day, campaign, site, country, device or another breakdown.
Run top campaign content reportGet the top 1,000 ads by performance for a date range, for every campaign or one: impressions, clicks, spend and conversions per ad.
Set campaign's custom audiencesChoose which custom audiences a campaign shows to and which it leaves out.
Unblock sitesLet the account's ads show on these blocked sites again.
Update adChange an ad's title, image, landing page, description or button, or pause or resume it.
Update campaignChange a campaign's name, brand, bid, budget, dates, tracking code, devices or countries.
Update conversion ruleRename a conversion rule, change its value, category or windows, or disable, archive or restore it.

Add ad

Add an ad to a campaign for a landing page. Taboola reads the page for a title and image (status CRAWLING); once that ends, change them with 'Update ad'.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.
Landing pageurltextRequired
Where the ad takes people, starting with https://.

Outputs

itemobject
The ad as Taboola has it
Example output
{
  "item": {
    "approval_state": "PENDING",
    "campaign_id": "5750752",
    "cta": {
      "cta_type": "LEARN_MORE"
    },
    "description": "",
    "id": "123",
    "is_active": true,
    "policy_review": {
      "reject_reason": "",
      "status_reason": ""
    },
    "status": "CRAWLING",
    "thumbnail_url": "",
    "title": "",
    "type": "ITEM",
    "url": "https://www.example.com/article"
  }
}

Block sites

Stop showing the account's ads on these sites. Sites already blocked stay blocked.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
SitessiteslistRequired
The sites to block: ones that showed your ads in the last 30 days, or a site name from a report's site column.

Outputs

changed_siteslist
The sites this step was given
countnumber
How many sites are blocked
siteslist
Every site the account blocks now
Example output
{
  "changed_sites": [
    "other-publisher"
  ],
  "count": 2,
  "sites": [
    "demo-publisher",
    "other-publisher"
  ]
}

Create campaign

Create a campaign in an advertiser account. Taboola reviews it before it runs; add ads to it with 'Add ad'.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
NamenametextRequired
The campaign's name, up to 200 characters.
Brand namebranding_texttextRequired
The brand shown on every ad, up to 25 characters.
Goalmarketing_objectivetextRequired
What the campaign is for.One of: DRIVE_WEBSITE_TRAFFIC (Drive website traffic), LEADS_GENERATION (Get leads), ONLINE_PURCHASES (Online purchases), BRAND_AWARENESS (Brand awareness).
Biddingbid_strategytextRequired
How Taboola bids. Maximize conversions is Taboola's recommendation for a new campaign.One of: MAX_CONVERSIONS (Maximize conversions), TARGET_CPA (Target cost per action), SMART (Enhanced CPC), FIXED (Fixed CPC).
Cost per clickcpcnumber
The bid per click in the account's currency, such as 0.25. Needed for Fixed and Enhanced CPC bidding.At least 0.01.
Target cost per actioncpa_goalnumber
The cost per conversion to aim for. Needed for Target CPA.At least 0.01.
Budgetspending_limit_modeltextRequired
A budget that renews each month, one for the whole campaign, or no limit (some accounts only).One of: MONTHLY (Monthly budget), ENTIRE (Budget for the whole campaign), NONE (No spending limit).
Spending limitspending_limitnumber
The most the campaign may spend each month or in all, at least twice the daily cap. Leave empty with No spending limit.At least 1.
Daily capdaily_capnumber
The most to spend in a day. Needed with No spending limit.At least 0.
Start datestart_datedate
When the campaign starts, today or later. Defaults to now.
End dateend_datedate
When the campaign stops. Leave empty for no end.
Ad typecampaign_typetext
Native ads unless chosen. Display and video need Taboola to enable them for the account.One of: HAS_NO_ITEMS (Native (default)), HAS_NO_ITEMS_DISPLAY (Display), HAS_NO_ITEMS_PERFORMANCE_DISPLAY_VIDEO (Performance video).
Tracking codetracking_codetext
Added to each ad's link, such as utm_source=taboola&utm_medium=referral (Taboola's default).
Devicesplatformslist
Show the ads only on these devices. Leave empty for all of them.One or more of: DESK (Desktop), PHON (Smartphone), TBLT (Tablet).
Countriescountrieslist
Show the ads only in these countries. Leave empty for all of them.

Outputs

campaignobject
The campaign as Taboola has it
Example output
{
  "campaign": {
    "advertiser_id": "taboola-demo-advertiser",
    "advertiser_name": "taboola-demo-advertiser",
    "approval_state": "APPROVED",
    "bid_strategy": "FIXED",
    "branding_text": "Pizza",
    "campaign_item_type": "HAS_NO_ITEMS",
    "comments": "",
    "country_targeting": {
      "href": "",
      "type": "INCLUDE",
      "value": [
        "AU",
        "GB"
      ]
    },
    "cpa_goal": 0.0,
    "cpc": 0.25,
    "daily_ad_delivery_model": "STRICT",
    "daily_cap": 100.0,
    "end_date": "9999-12-31",
    "id": "5750752",
    "is_active": true,
    "marketing_objective": "DRIVE_WEBSITE_TRAFFIC",
    "name": "Demo Campaign",
    "os_targeting": {
      "href": "",
      "type": "ALL",
      "value": []
    },
    "platform_targeting": {
      "href": "",
      "type": "INCLUDE",
      "value": [
        "TBLT",
        "PHON"
      ]
    },
    "policy_review": {
      "reject_reason": ""
    },
    "pricing_model": "CPC",
    "spending_limit": 1000.0,
    "spending_limit_model": "MONTHLY",
    "spent": 0.0,
    "start_date": "2026-11-20",
    "status": "PENDING_APPROVAL",
    "tracking_code": "utm_source=taboola&utm_medium=referral",
    "traffic_allocation_mode": "EVEN"
  }
}

Create conversion rule

Count a conversion when someone visits a page address, or when your Taboola pixel sends an event. The name must be new in the account.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Namedisplay_nametextRequired
The rule's name, different from every other rule's.
CategorycategorytextRequired
The kind of conversion this is.One of: MAKE_PURCHASE (Purchase), LEAD, COMPLETE_REGISTRATION (Complete registration), ADD_TO_CART (Add to cart), START_CHECKOUT (Start checkout), ADD_PAYMENT_INFO (Add payment info), ADD_TO_WISHLIST (Add to wishlist), VIEW_CONTENT (View content), SEARCH, APP_INSTALL (App install), OTHER.
Countsrule_typetext
A page visit unless chosen.One of: BASIC (A visit to a page address), EVENT_BASED (An event your pixel sends).
Matchurl_matchtext
How the page address is matched. Contains unless chosen.Only when Counts is A visit to a page address. One of: CONTAINS (Address contains), EQUALS (Address is exactly).
Page addressurl_valuetext
The address, or part of it, such as /thank-you.Only when Counts is A visit to a page address.
Event nameevent_nametext
The event your pixel sends, up to 50 characters, such as lead.Only when Counts is An event your pixel sends.
Value per conversionconversion_valuenumber
What each conversion is worth, such as 19.95, for return on ad spend.At least 0.
Count in total conversionsinclude_in_total_conversionstrue/false
Whether these conversions count toward the campaign's total.
Days after a clicklook_back_windownumber
How many days after a click a conversion still counts, 1 to 365. Taboola's default is 30.From 1 to 365.
Hours after a viewview_through_look_back_windownumber
How many hours after an ad is seen a conversion still counts, 1 to 720. Taboola's default is 24.From 1 to 720.
Descriptiondescriptiontext
A note about the rule, for your team.

Outputs

conversion_ruleobject
The conversion rule
Example output
{
  "conversion_rule": {
    "advertiser_id": "taboola-demo-advertiser",
    "category": "ADD_TO_CART",
    "condition": {
      "children": [],
      "predicate": "CONTAINS",
      "property": "URL",
      "value": "example.com/cart"
    },
    "description": "",
    "display_name": "Add to cart",
    "effects": [
      {
        "data": "15",
        "type": "REVENUE"
      }
    ],
    "event_name": "page_view",
    "exclude_from_campaigns": false,
    "id": 78,
    "include_in_total_conversions": true,
    "last_modified_at": "2026-11-17",
    "last_modified_by": "jo@example.com",
    "look_back_window": 30,
    "status": "ACTIVE",
    "type": "BASIC",
    "view_through_look_back_window": 24
  }
}

Delete ad

Delete an ad for good: Taboola stops it and it can't be found again.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.
Aditem_idtextRequired
The ad. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
itemobject
The ad, now with status STOPPED
item_idtext
The ad deleted
Example output
{
  "deleted": true,
  "item": {
    "approval_state": "APPROVED",
    "campaign_id": "5750752",
    "cta": {
      "cta_type": "LEARN_MORE"
    },
    "description": "",
    "id": "123",
    "is_active": true,
    "policy_review": {
      "reject_reason": "",
      "status_reason": ""
    },
    "status": "STOPPED",
    "thumbnail_url": "https://cdn.example.com/demo_image.jpg",
    "title": "Demo Article",
    "type": "ITEM",
    "url": "https://www.example.com/article"
  },
  "item_id": "123"
}

Delete campaign

Delete a campaign for good: Taboola stops it and it can't be found again.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.

Outputs

campaignobject
The campaign, now with status TERMINATED
campaign_idtext
The campaign deleted
deletedtrue/false
Always true once deleted
Example output
{
  "campaign": {
    "advertiser_id": "taboola-demo-advertiser",
    "advertiser_name": "taboola-demo-advertiser",
    "approval_state": "APPROVED",
    "bid_strategy": "FIXED",
    "branding_text": "Pizza",
    "campaign_item_type": "HAS_NO_ITEMS",
    "comments": "",
    "country_targeting": {
      "href": "",
      "type": "INCLUDE",
      "value": [
        "AU",
        "GB"
      ]
    },
    "cpa_goal": 0.0,
    "cpc": 0.25,
    "daily_ad_delivery_model": "STRICT",
    "daily_cap": 100.0,
    "end_date": "9999-12-31",
    "id": "5750752",
    "is_active": true,
    "marketing_objective": "DRIVE_WEBSITE_TRAFFIC",
    "name": "Demo Campaign",
    "os_targeting": {
      "href": "",
      "type": "ALL",
      "value": []
    },
    "platform_targeting": {
      "href": "",
      "type": "INCLUDE",
      "value": [
        "TBLT",
        "PHON"
      ]
    },
    "policy_review": {
      "reject_reason": ""
    },
    "pricing_model": "CPC",
    "spending_limit": 1000.0,
    "spending_limit_model": "MONTHLY",
    "spent": 0.0,
    "start_date": "2026-11-20",
    "status": "TERMINATED",
    "tracking_code": "utm_source=taboola&utm_medium=referral",
    "traffic_allocation_mode": "EVEN"
  },
  "campaign_id": "5750752",
  "deleted": true
}

Duplicate campaign

Copy a campaign with its settings and targeting, in the same account or another account in your network. Returns the copy.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.
New namenametext
A name for the copy. Leave empty to keep the original's.
Copy to accountdestination_account_idtext
Another account in your network. Leave empty for the same one.

Outputs

campaignobject
The campaign as Taboola has it
Example output
{
  "campaign": {
    "advertiser_id": "taboola-demo-advertiser",
    "advertiser_name": "taboola-demo-advertiser",
    "approval_state": "APPROVED",
    "bid_strategy": "FIXED",
    "branding_text": "Pizza",
    "campaign_item_type": "HAS_NO_ITEMS",
    "comments": "",
    "country_targeting": {
      "href": "",
      "type": "INCLUDE",
      "value": [
        "AU",
        "GB"
      ]
    },
    "cpa_goal": 0.0,
    "cpc": 0.25,
    "daily_ad_delivery_model": "STRICT",
    "daily_cap": 100.0,
    "end_date": "9999-12-31",
    "id": "5750753",
    "is_active": false,
    "marketing_objective": "DRIVE_WEBSITE_TRAFFIC",
    "name": "Demo Campaign",
    "os_targeting": {
      "href": "",
      "type": "ALL",
      "value": []
    },
    "platform_targeting": {
      "href": "",
      "type": "INCLUDE",
      "value": [
        "TBLT",
        "PHON"
      ]
    },
    "policy_review": {
      "reject_reason": ""
    },
    "pricing_model": "CPC",
    "spending_limit": 1000.0,
    "spending_limit_model": "MONTHLY",
    "spent": 0.0,
    "start_date": "2026-11-20",
    "status": "RUNNING",
    "tracking_code": "utm_source=taboola&utm_medium=referral",
    "traffic_allocation_mode": "EVEN"
  }
}

Get ad

Get one ad with its title, image, link, button, review state and status.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.
Aditem_idtextRequired
The ad. Pick one, or give its id from an earlier step.

Outputs

itemobject
The ad as Taboola has it
Example output
{
  "item": {
    "approval_state": "APPROVED",
    "campaign_id": "5750752",
    "cta": {
      "cta_type": "LEARN_MORE"
    },
    "description": "",
    "id": "123",
    "is_active": true,
    "policy_review": {
      "reject_reason": "",
      "status_reason": ""
    },
    "status": "RUNNING",
    "thumbnail_url": "https://cdn.example.com/demo_image.jpg",
    "title": "Demo Article",
    "type": "ITEM",
    "url": "https://www.example.com/article"
  }
}

Get API key's account

Get the account the API key belongs to: its name, account id, currency and type. For a network, this is the network account.

Inputs

None.

Outputs

accountobject
The API key's account
Example output
{
  "account": {
    "account_id": "taboola-demo-advertiser",
    "campaign_types": [
      "PAID"
    ],
    "currency": "USD",
    "id": 1234,
    "name": "Taboola Demo - Advertiser",
    "partner_types": [
      "ADVERTISER"
    ],
    "time_zone_name": "US/Eastern",
    "type": "PARTNER"
  }
}

Get campaign

Get one campaign with its budget, bid, targeting, dates, review state and status.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.

Outputs

campaignobject
The campaign as Taboola has it
Example output
{
  "campaign": {
    "advertiser_id": "taboola-demo-advertiser",
    "advertiser_name": "taboola-demo-advertiser",
    "approval_state": "APPROVED",
    "bid_strategy": "FIXED",
    "branding_text": "Pizza",
    "campaign_item_type": "HAS_NO_ITEMS",
    "comments": "",
    "country_targeting": {
      "href": "",
      "type": "INCLUDE",
      "value": [
        "AU",
        "GB"
      ]
    },
    "cpa_goal": 0.0,
    "cpc": 0.25,
    "daily_ad_delivery_model": "STRICT",
    "daily_cap": 100.0,
    "end_date": "9999-12-31",
    "id": "5750752",
    "is_active": true,
    "marketing_objective": "DRIVE_WEBSITE_TRAFFIC",
    "name": "Demo Campaign",
    "os_targeting": {
      "href": "",
      "type": "ALL",
      "value": []
    },
    "platform_targeting": {
      "href": "",
      "type": "INCLUDE",
      "value": [
        "TBLT",
        "PHON"
      ]
    },
    "policy_review": {
      "reject_reason": ""
    },
    "pricing_model": "CPC",
    "spending_limit": 1000.0,
    "spending_limit_model": "MONTHLY",
    "spent": 0.0,
    "start_date": "2026-11-20",
    "status": "RUNNING",
    "tracking_code": "utm_source=taboola&utm_medium=referral",
    "traffic_allocation_mode": "EVEN"
  }
}

Get conversion rule

Get one conversion rule with its condition, value and status.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Conversion rulerule_idtextRequired
The conversion rule. Pick one, or give its id from an earlier step.

Outputs

conversion_ruleobject
The conversion rule
Example output
{
  "conversion_rule": {
    "advertiser_id": "taboola-demo-advertiser",
    "category": "ADD_TO_CART",
    "condition": {
      "children": [],
      "predicate": "CONTAINS",
      "property": "URL",
      "value": "example.com/cart"
    },
    "description": "",
    "display_name": "Add to cart",
    "effects": [
      {
        "data": "15",
        "type": "REVENUE"
      }
    ],
    "event_name": "page_view",
    "exclude_from_campaigns": false,
    "id": 78,
    "include_in_total_conversions": true,
    "last_modified_at": "2026-11-17",
    "last_modified_by": "jo@example.com",
    "look_back_window": 30,
    "status": "ACTIVE",
    "type": "BASIC",
    "view_through_look_back_window": 24
  }
}

List accounts

List every account the API key may work on: the network account and each advertiser account in it, or just your own.

Inputs

None.

Outputs

accountslist
The accounts
countnumber
How many were returned
totalnumber
How many there are in all, when Taboola says
Example output
{
  "accounts": [
    {
      "account_id": "taboola-demo-advertiser",
      "campaign_types": [
        "PAID"
      ],
      "currency": "USD",
      "id": 1234,
      "name": "Taboola Demo - Advertiser",
      "partner_types": [
        "ADVERTISER"
      ],
      "time_zone_name": "US/Eastern",
      "type": "PARTNER"
    }
  ],
  "count": 1,
  "total": 1
}

List ads

List a campaign's ads with their titles, images, links, review state and status.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.

Outputs

countnumber
How many were returned
itemslist
The ads
totalnumber
How many there are in all, when Taboola says
Example output
{
  "count": 1,
  "items": [
    {
      "approval_state": "APPROVED",
      "campaign_id": "5750752",
      "cta": {
        "cta_type": "LEARN_MORE"
      },
      "description": "",
      "id": "123",
      "is_active": true,
      "policy_review": {
        "reject_reason": "",
        "status_reason": ""
      },
      "status": "RUNNING",
      "thumbnail_url": "https://cdn.example.com/demo_image.jpg",
      "title": "Demo Article",
      "type": "ITEM",
      "url": "https://www.example.com/article"
    }
  ],
  "total": 1
}

List blocked sites

List the sites the account never shows its ads on.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.

Outputs

countnumber
How many sites are blocked
siteslist
The blocked sites
Example output
{
  "count": 1,
  "sites": [
    "demo-publisher"
  ]
}

List campaigns

List an account's campaigns with their budgets, bids, targeting and status. A network account lists every advertiser's. Deleted campaigns aren't listed.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Which campaignsfetch_leveltext
All of them, or only recent ones: made in the last 30 days or approved.One of: ALL (All campaigns (default)), R (Recent, not paused), RAP (Recent, paused or not).
Sort bysort_bytext
The field to sort by. Leave empty for Taboola's order.One of: name, status, spent, cpc (Cost per click), daily_cap (Daily cap), spending_limit (Spending limit), start_date (Start date).
Sort directionsort_directiontext
Ascending unless chosen.One of: asc (Ascending), desc (Descending).
Pagepagenumber
Which page to get, from 1. Leave empty for every campaign.At least 1.
Page sizepage_sizenumber
How many on a page, 1 to 500. Defaults to 100 with a page.From 1 to 500.

Outputs

campaignslist
The campaigns
countnumber
How many were returned
totalnumber
How many there are in all, when Taboola says
Example output
{
  "campaigns": [
    {
      "advertiser_id": "taboola-demo-advertiser",
      "advertiser_name": "taboola-demo-advertiser",
      "approval_state": "APPROVED",
      "bid_strategy": "FIXED",
      "branding_text": "Pizza",
      "campaign_item_type": "HAS_NO_ITEMS",
      "comments": "",
      "country_targeting": {
        "href": "",
        "type": "INCLUDE",
        "value": [
          "AU",
          "GB"
        ]
      },
      "cpa_goal": 0.0,
      "cpc": 0.25,
      "daily_ad_delivery_model": "STRICT",
      "daily_cap": 100.0,
      "end_date": "9999-12-31",
      "id": "5750752",
      "is_active": true,
      "marketing_objective": "DRIVE_WEBSITE_TRAFFIC",
      "name": "Demo Campaign",
      "os_targeting": {
        "href": "",
        "type": "ALL",
        "value": []
      },
      "platform_targeting": {
        "href": "",
        "type": "INCLUDE",
        "value": [
          "TBLT",
          "PHON"
        ]
      },
      "policy_review": {
        "reject_reason": ""
      },
      "pricing_model": "CPC",
      "spending_limit": 1000.0,
      "spending_limit_model": "MONTHLY",
      "spent": 0.0,
      "start_date": "2026-11-20",
      "status": "RUNNING",
      "tracking_code": "utm_source=taboola&utm_medium=referral",
      "traffic_allocation_mode": "EVEN"
    }
  ],
  "count": 1,
  "total": 1
}

List conversion rules

List the account's conversion rules, including those made for the whole network.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.

Outputs

conversion_ruleslist
The conversion rules
countnumber
How many were returned
totalnumber
How many there are in all, when Taboola says
Example output
{
  "conversion_rules": [
    {
      "advertiser_id": "taboola-demo-advertiser",
      "category": "ADD_TO_CART",
      "condition": {
        "children": [],
        "predicate": "CONTAINS",
        "property": "URL",
        "value": "example.com/cart"
      },
      "description": "",
      "display_name": "Add to cart",
      "effects": [
        {
          "data": "15",
          "type": "REVENUE"
        }
      ],
      "event_name": "page_view",
      "exclude_from_campaigns": false,
      "id": 78,
      "include_in_total_conversions": true,
      "last_modified_at": "2026-11-17",
      "last_modified_by": "jo@example.com",
      "look_back_window": 30,
      "status": "ACTIVE",
      "type": "BASIC",
      "view_through_look_back_window": 24
    }
  ],
  "count": 1,
  "total": 1
}

List custom audiences

List the account's custom audiences: the people your Taboola pixel saw visit pages or send events.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.

Outputs

audienceslist
The custom audiences
countnumber
How many were returned
totalnumber
How many there are in all, when Taboola says
Example output
{
  "audiences": [
    {
      "advertiser_id": "taboola-demo-advertiser",
      "category": "OTHER",
      "condition": {
        "children": [],
        "predicate": "CONTAINS",
        "property": "URL",
        "value": "example.com/cart"
      },
      "description": "",
      "display_name": "Cart visitors",
      "effects": [],
      "event_name": "page_view",
      "exclude_from_campaigns": false,
      "id": 201,
      "include_in_total_conversions": true,
      "last_modified_at": "2026-11-17",
      "last_modified_by": "jo@example.com",
      "look_back_window": 30,
      "status": "ACTIVE",
      "type": "BASIC",
      "view_through_look_back_window": 24
    }
  ],
  "count": 1,
  "total": 1
}

Pause or resume campaign

Pause a campaign so it stops showing ads, or resume it. Nothing changes if it is already that way.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.
StatestatetextRequired
Running shows the campaign's ads; Paused stops them.One of: active (Running), paused.

Outputs

campaignobject
The campaign as Taboola has it
Example output
{
  "campaign": {
    "advertiser_id": "taboola-demo-advertiser",
    "advertiser_name": "taboola-demo-advertiser",
    "approval_state": "APPROVED",
    "bid_strategy": "FIXED",
    "branding_text": "Pizza",
    "campaign_item_type": "HAS_NO_ITEMS",
    "comments": "",
    "country_targeting": {
      "href": "",
      "type": "INCLUDE",
      "value": [
        "AU",
        "GB"
      ]
    },
    "cpa_goal": 0.0,
    "cpc": 0.25,
    "daily_ad_delivery_model": "STRICT",
    "daily_cap": 100.0,
    "end_date": "9999-12-31",
    "id": "5750752",
    "is_active": false,
    "marketing_objective": "DRIVE_WEBSITE_TRAFFIC",
    "name": "Demo Campaign",
    "os_targeting": {
      "href": "",
      "type": "ALL",
      "value": []
    },
    "platform_targeting": {
      "href": "",
      "type": "INCLUDE",
      "value": [
        "TBLT",
        "PHON"
      ]
    },
    "policy_review": {
      "reject_reason": ""
    },
    "pricing_model": "CPC",
    "spending_limit": 1000.0,
    "spending_limit_model": "MONTHLY",
    "spent": 0.0,
    "start_date": "2026-11-20",
    "status": "PAUSED",
    "tracking_code": "utm_source=taboola&utm_medium=referral",
    "traffic_allocation_mode": "EVEN"
  }
}

Run campaign summary report

Get spend, clicks, impressions and conversions for a date range, by day, campaign, site, country, device or another breakdown. Taboola's figures lag a few hours and can change for days.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Break downdimensiontextRequired
How to group the figures: one row per what.One of: day (By day), week (By week), month (By month), campaign_breakdown (By campaign), campaign_day_breakdown (By campaign and day), campaign_site_day_breakdown (By campaign, site and day (90 days at most)), site_breakdown (By site (publisher)), country_breakdown (By country), region_breakdown (By region), dma_breakdown (By US DMA), and 8 more.
Fromstart_datedateRequired
The first day of the report.
Toend_datedateRequired
The last day of the report, included.
Campaigncampaign_idtext
Only this campaign. Leave empty for every campaign.
Only this deviceplatformtext
Only one device. Can't be combined with a country or site, and works with time, campaign and advertiser breakdowns.One of: DESK (Desktop), PHON (Smartphone), TBLT (Tablet).
Only this countrycountrytext
Only one country. Can't be combined with a device or site.
Only this sitesitetext
Only one site. Can't be combined with a device or country; a day, week or month report also needs a campaign.
Leave out campaigns with no impressionsexclude_empty_campaignstrue/false
For the campaign breakdowns only.
Add a column per conversion ruleinclude_multi_conversionstrue/false
Also report each conversion rule's own conversions.

Outputs

countnumber
How many were returned
dimensiontext
The breakdown used
last_updatedtext
When Taboola last updated the report's data
rowslist
The report's rows
timezonetext
The time zone the report's dates are in, such as EST
totalnumber
How many there are in all, when Taboola says
Example output
{
  "count": 1,
  "dimension": "campaign_day_breakdown",
  "last_updated": "2026-11-17 09:00:00.0",
  "rows": [
    {
      "campaign": "5750752",
      "campaign_name": "Demo Campaign",
      "clicks": 40,
      "conversions_value": 0,
      "country": "US",
      "cpa": 0.2,
      "cpa_actions_num": 40,
      "cpa_conversion_rate": 100,
      "cpc": 0.199,
      "cpm": 0.13,
      "ctr": 0.06,
      "currency": "USD",
      "date": "2026-11-16 00:00:00.0",
      "date_end_period": "2026-11-16 00:00:00.0",
      "impressions": 61609,
      "platform": "PHON",
      "roas": 0,
      "site": "demo-publisher",
      "site_name": "Demo Publisher",
      "spent": 7.95,
      "vcpm": 0.87,
      "vctr": 0.44,
      "visible_impressions": 9148
    }
  ],
  "timezone": "EST",
  "total": 1
}

Run top campaign content report

Get the top 1,000 ads by performance for a date range, for every campaign or one: impressions, clicks, spend and conversions per ad.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Fromstart_datedateRequired
The first day of the report.
Toend_datedateRequired
The last day of the report, included.
Campaigncampaign_idtext
Only this campaign. Leave empty for every campaign.
Add a column per conversion ruleinclude_multi_conversionstrue/false
Also report each conversion rule's own conversions.

Outputs

countnumber
How many were returned
last_updatedtext
When Taboola last updated the report's data
rowslist
The report's rows
timezonetext
The time zone the report's dates are in, such as EST
totalnumber
How many there are in all, when Taboola says
Example output
{
  "count": 1,
  "last_updated": "2026-11-17 09:00:00.0",
  "rows": [
    {
      "actions": 40,
      "campaign": "2345",
      "campaign_name": "Sample Campaign 1",
      "clicks": 40,
      "content_provider": "123456",
      "content_provider_name": "Content Provider 1",
      "conversions_value": 0,
      "cpa": 0.2,
      "cpc": 0.199,
      "cpm": 0.13,
      "ctr": 0.06,
      "currency": "USD",
      "cvr": 100,
      "impressions": 61609,
      "item": "12345678",
      "item_name": "Sample Campaign Item 1",
      "learning_display_status": "Learning CTR",
      "roas": 0,
      "spent": 7.95,
      "thumbnail_url": "https://cdn.example.com/thumbnails/thumb-1.jpg",
      "url": "https://www.example.com/wedding-rings",
      "vcpm": 0.87,
      "vctr": 0.44,
      "visible_impressions": 9148
    }
  ],
  "timezone": "EST",
  "total": 1
}

Set campaign's custom audiences

Choose which custom audiences a campaign shows to and which it leaves out. This replaces the campaign's custom audience targeting; leave both empty to show to everyone.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.
Show toinclude_audience_idslist
Show the campaign only to these audiences.
Leave outexclude_audience_idslist
Never show the campaign to these audiences.

Outputs

campaign_idtext
The campaign
excluded_audience_idslist
Audiences the campaign leaves out
included_audience_idslist
Audiences the campaign shows to
targets_everyonetrue/false
True when no custom audience is targeted
Example output
{
  "campaign_id": "5750752",
  "excluded_audience_ids": [],
  "included_audience_ids": [
    201
  ],
  "targets_everyone": false
}

Unblock sites

Let the account's ads show on these blocked sites again.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
SitessiteslistRequired
The blocked sites to unblock.

Outputs

changed_siteslist
The sites this step was given
countnumber
How many sites are blocked
siteslist
Every site the account blocks now
Example output
{
  "changed_sites": [
    "other-publisher"
  ],
  "count": 1,
  "sites": [
    "demo-publisher"
  ]
}

Update ad

Change an ad's title, image, landing page, description or button, or pause or resume it. Only the fields given change. An ad can't change while its status is CRAWLING.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.
Aditem_idtextRequired
The ad. Pick one, or give its id from an earlier step.
Titletitletext
A new headline. Leave empty to keep it.
Image linkthumbnail_urltext
A link to a new image. Leave empty to keep it.
Landing pageurltext
A new landing page. Leave empty to keep it.
Descriptiondescriptiontext
A new description, up to 250 characters.
Buttoncta_typetext
The call to action button. Leave empty to keep it.One of: APPLY_NOW (Apply now), BET_NOW (Bet now), BOOK_NOW (Book now), BROWSE_NOW (Browse now), BUILD_YOURS (Build yours), BUY_NOW (Buy now), CALL_NOW (Call now), CAMERA_3D (Camera 3D), CAR_CONFIGURATION (Car configuration), CLICK_HERE (Click here), and 65 more.
Statestatetext
Pause or resume the ad. Leave empty to keep it.One of: active (Running), paused.

Outputs

itemobject
The ad as Taboola has it
Example output
{
  "item": {
    "approval_state": "APPROVED",
    "campaign_id": "5750752",
    "cta": {
      "cta_type": "LEARN_MORE"
    },
    "description": "",
    "id": "123",
    "is_active": true,
    "policy_review": {
      "reject_reason": "",
      "status_reason": ""
    },
    "status": "RUNNING",
    "thumbnail_url": "https://cdn.example.com/demo_image.jpg",
    "title": "Updated Title",
    "type": "ITEM",
    "url": "https://www.example.com/article"
  }
}

Update campaign

Change a campaign's name, brand, bid, budget, dates, tracking code, devices or countries. Only the fields given change.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.
Namenametext
A new name. Leave empty to keep it.
Brand namebranding_texttext
A new brand name, up to 25 characters. Leave empty to keep it.
Biddingbid_strategytext
How Taboola bids. Maximize conversions is Taboola's recommendation for a new campaign. Leave empty to keep it.One of: MAX_CONVERSIONS (Maximize conversions), TARGET_CPA (Target cost per action), SMART (Enhanced CPC), FIXED (Fixed CPC).
Cost per clickcpcnumber
The bid per click in the account's currency, such as 0.25. Needed for Fixed and Enhanced CPC bidding.At least 0.01.
Target cost per actioncpa_goalnumber
The cost per conversion to aim for. Needed for Target CPA.At least 0.01.
Budgetspending_limit_modeltext
A budget that renews each month, one for the whole campaign, or no limit (some accounts only). Leave empty to keep it.One of: MONTHLY (Monthly budget), ENTIRE (Budget for the whole campaign), NONE (No spending limit).
Spending limitspending_limitnumber
The most the campaign may spend each month or in all, at least twice the daily cap. Leave empty with No spending limit.At least 1.
Daily capdaily_capnumber
The most to spend in a day. Needed with No spending limit.At least 0.
Start datestart_datedate
A new start date, only while the campaign hasn't started.
End dateend_datedate
A new end date. Leave empty to keep it.
Tracking codetracking_codetext
Added to each ad's link, such as utm_source=taboola&utm_medium=referral (Taboola's default).
Devicesplatformslist
Show the ads only on these devices from now on. Leave empty to keep the devices as they are.One or more of: DESK (Desktop), PHON (Smartphone), TBLT (Tablet).
Countriescountrieslist
Show the ads only in these countries from now on. Leave empty to keep the countries as they are.

Outputs

campaignobject
The campaign as Taboola has it
Example output
{
  "campaign": {
    "advertiser_id": "taboola-demo-advertiser",
    "advertiser_name": "taboola-demo-advertiser",
    "approval_state": "APPROVED",
    "bid_strategy": "FIXED",
    "branding_text": "Pizza",
    "campaign_item_type": "HAS_NO_ITEMS",
    "comments": "",
    "country_targeting": {
      "href": "",
      "type": "INCLUDE",
      "value": [
        "AU",
        "GB"
      ]
    },
    "cpa_goal": 0.0,
    "cpc": 0.25,
    "daily_ad_delivery_model": "STRICT",
    "daily_cap": 100.0,
    "end_date": "9999-12-31",
    "id": "5750752",
    "is_active": true,
    "marketing_objective": "DRIVE_WEBSITE_TRAFFIC",
    "name": "Spring sale",
    "os_targeting": {
      "href": "",
      "type": "ALL",
      "value": []
    },
    "platform_targeting": {
      "href": "",
      "type": "INCLUDE",
      "value": [
        "TBLT",
        "PHON"
      ]
    },
    "policy_review": {
      "reject_reason": ""
    },
    "pricing_model": "CPC",
    "spending_limit": 1000.0,
    "spending_limit_model": "MONTHLY",
    "spent": 0.0,
    "start_date": "2026-11-20",
    "status": "RUNNING",
    "tracking_code": "utm_source=taboola&utm_medium=referral",
    "traffic_allocation_mode": "EVEN"
  }
}

Update conversion rule

Rename a conversion rule, change its value, category or windows, or disable, archive or restore it. Taboola can't delete a rule.

Inputs

Accountaccount_idtextRequired
The Taboola advertiser account. Pick one, or give its account id (such as demo-advertiser) from an earlier step.
Conversion rulerule_idtextRequired
The conversion rule. Pick one, or give its id from an earlier step.
Namedisplay_nametext
A new name. Leave empty to keep it.
Statusstatustext
Archived hides the rule; Active brings it back.One of: ACTIVE, DISABLED, ARCHIVED.
Categorycategorytext
A new category. Leave empty to keep it.One of: MAKE_PURCHASE (Purchase), LEAD, COMPLETE_REGISTRATION (Complete registration), ADD_TO_CART (Add to cart), START_CHECKOUT (Start checkout), ADD_PAYMENT_INFO (Add payment info), ADD_TO_WISHLIST (Add to wishlist), VIEW_CONTENT (View content), SEARCH, APP_INSTALL (App install), OTHER.
Value per conversionconversion_valuenumber
What each conversion is worth, such as 19.95, for return on ad spend.At least 0.
Count in total conversionsinclude_in_total_conversionstrue/false
Whether these conversions count toward the campaign's total.
Days after a clicklook_back_windownumber
How many days after a click a conversion still counts, 1 to 365. Taboola's default is 30.From 1 to 365.
Hours after a viewview_through_look_back_windownumber
How many hours after an ad is seen a conversion still counts, 1 to 720. Taboola's default is 24.From 1 to 720.
Descriptiondescriptiontext
A note about the rule, for your team.

Outputs

conversion_ruleobject
The conversion rule
Example output
{
  "conversion_rule": {
    "advertiser_id": "taboola-demo-advertiser",
    "category": "ADD_TO_CART",
    "condition": {
      "children": [],
      "predicate": "CONTAINS",
      "property": "URL",
      "value": "example.com/cart"
    },
    "description": "",
    "display_name": "Add to cart",
    "effects": [
      {
        "data": "15",
        "type": "REVENUE"
      }
    ],
    "event_name": "page_view",
    "exclude_from_campaigns": false,
    "id": 78,
    "include_in_total_conversions": true,
    "last_modified_at": "2026-11-17",
    "last_modified_by": "jo@example.com",
    "look_back_window": 30,
    "status": "ARCHIVED",
    "type": "BASIC",
    "view_through_look_back_window": 24
  }
}

On this page