Jump to Content
Taboola Backstage APIAPI ReferenceCommunity DiscussionAnnouncements
API ReferenceAnnouncementsCommunity Discussion
API ReferenceCommunity DiscussionAnnouncementsLog InTaboola Backstage API
API Reference
Log In

Overview

  • Welcome
  • A Note for Publishers
  • Video Campaigns
  • Java Client SDK

Authentication

  • Authentication Basics
  • Getting an Access Token
  • Client Credentials Flowpost

Request Basics

  • Making Requests
  • Errors
  • Dictionary

Your Account

  • Your Account ID
  • Get Account Detailsget
  • Network Accounts
  • Get Advertiser Accounts in Networkget
  • Get Allowed Accountsget

Campaigns

  • Campaigns Overview
  • Get All Campaignsget
  • Get a Campaignget
  • Get all campaigns across the networkget
  • Create a Campaignpost
  • Duplicating Campaigns
  • Duplicate a Campaignpost
  • Updating Campaigns
  • Update a Campaignpost
  • Bulk Update Campaignspost
  • Patching Collections
  • Patching Bid Modifiers
  • Patch a Collectionpatch
  • Pausing/unpausing Campaigns
  • Deleting Campaigns
  • Delete a Campaigndelete

Campaign Fields

  • Campaign Object
  • Campaign Fields
    • id
    • advertiser_id
    • name
    • branding_text
    • tracking_code
    • pricing_model
    • cpc
    • daily_cap
    • daily_ad_delivery_model
    • spending_limit
    • spending_limit_model
    • cpa_goal
    • country_targeting
    • sub_country_targeting
    • dma_country_targeting
    • region_country_targeting
    • city_targeting
    • postal_code_targeting
    • platform_targeting
    • publisher_targeting
    • os_targeting
    • connection_type_targeting
    • auto_publisher_targeting
    • publisher_bid_modifier
    • publisher_bid_strategy_modifiers
    • comments
    • spent
    • bid_strategy
    • bid_type
    • traffic_allocation_mode
    • traffic_allocation_ab_test_end_date
    • external_brand_safety
    • start_date
    • end_date
    • approval_state
    • is_active
    • status
    • audience_segments_multi_targeting
    • custom_audience_targeting
    • marking_label_multi_targeting
    • lookalike_audience_targeting
    • marketing_objective
    • verification_pixel
    • viewability_tag
    • activity_schedule
    • policy_review
    • browser_targeting
  • Bidding strategies
    • Maximize conversions
    • Target CPA
    • Enhanced CPC (aka SmartBid)
    • Fixed CPC
  • Targeting
  • Policy Review Object
  • External Brand Safety
  • External Brand Safety Object
    • External Brand Safety Restriction Object
  • Verification Pixel
  • Verification Pixel Object
    • Verification Pixel Item Object
  • Viewability Tags
  • Viewability Tag Object
    • Viewability Tag Item Object
  • Publisher Bid Modifier Object
    • 'Bid Modifier Per Publisher' Object
  • Publisher Bid Strategy Modifier Object
    • 'Bid Strategy Per Publisher' Object
  • Patch Object
    • patch_operation
    • publisher_bid_modifier
    • publisher_bid_strategy_modifiers
    • publisher_targeting
  • Activity Schedule Object
    • mode
    • rules
    • time_zone
  • Activity Schedule Item Object
    • type
    • day
    • from_hour
    • until_hour

Items (Ads)

  • Campaign Items Overview
  • Campaign Item Fields
    • id
    • campaign_id
    • type
    • url
    • thumbnail_url
    • title
    • description
    • approval_state
    • is_active
    • status
    • policy_review
    • cta
    • creative_focus
    • verification_pixel
    • viewability_tag
    • custom_data
  • CTA Object
  • Creative Focus Object
  • Coordinates Object
  • Item Status
  • Item Types
  • Get All Campaign Itemsget
  • Get a Campaign Itemget
  • Creating a Campaign Item
  • Create a Campaign Itempost
  • Updating Campaign Items
  • Update a Campaign Itempost
  • Deleting Campaign Items
  • Delete a Campaign Itemdelete
  • Creative Focus
  • Creative CTA
  • Pausing/unpausing Campaign Items
  • RSS Items
  • Get Children Itemsget
  • Get a Child Itemget
  • Update a Child Itempost
  • Bulk Operations
  • Mass create items for a given campaignpost
  • Bulk create items across campaignsput
  • Bulk update items across campaignspost
  • Bulk delete items across campaignsdelete
  • MANAGING IMAGES
  • Upload Image From Local Device
  • Get Taxonomiesget
  • Get Images From Image Libraryget
  • Upload Image From an Image Librarypost
  • End-To-End Flow

Motion Ads

  • Performance Video Items (Motion Ads)
  • Get All Performance Video Items (Motion Ads)get
  • Get a Performance Video Item (Motion Ad)get
  • Create a Performance Video Item (Motion Ad)post
  • Update a Performance Video Item (Motion Ad)put
  • Delete a Performance Video Item (Motion Ad)delete
  • Performance Video Items (Motion Ads) - Flow
  • Performance Video Items (Motion Ads) - Fields
    • id
    • campaign_id
    • url
    • title
    • description
    • approval_state
    • is_active
    • status
    • policy_review
    • video_url
    • video_file
    • fallback_url
    • fallback_file
    • gif_url
    • verification_pixel
    • viewability_tag

Taboola Pixel API

  • Taboola Pixel API Overview
  • CONVERSION RULE QUICK REFERENCE
  • Get All Conversion Rulesget
  • Get a Conversion Ruleget
  • Get All Conversion Rules Plus Dataget
  • Create a Conversion Rulepost
  • Update a Conversion Rulepost
  • Archiving/unarchiving a Conversion Rule
  • Sample Conversion Rule
  • Conversion Rule Fields
    • id
    • display_name
    • look_back_window
    • view_through_look_back_window
    • category
    • status
    • type
    • event_name
    • condition
    • effects
    • include_in_total_conversions
    • exclude_from_campaigns
    • description
    • advertiser_id
    • last_modified_by
    • last_modified_at
  • Effect Object
    • type
    • data
  • Condition Object
    • property
    • predicate
    • value
    • children
  • CUSTOM AUDIENCE QUICK REFERENCE
  • Get All Custom Audiencesget
  • Get a Custom Audience Ruleget
  • Create a Custom Audience Rulepost
  • Update a Custom Audience Rulepost
  • Sample Custom Audience Rule
  • Custom Audience Fields
    • id
    • display_name
    • look_back_window
    • category
    • status
    • type
    • event_name
    • condition
    • exclude_from_campaigns
    • description
    • advertiser_id
    • last_modified_by
    • last_modified_at
    • audience_size

Targeting

  • Targeting Overview
  • Targeting Object
    • Targeting Flow
  • Geo Targeting
  • Country And Sub-Country Targeting
    • Examples
    • Examples - INCORRECT Usage
  • City Targeting
    • Examples and flow
  • Postal Code Targeting
  • Get Postal Codes Targetingget
  • Update Postal Codes Targetingpost
    • Postal Code Targeting Flow
  • Postal Codes Targeting Restrictions Object
  • Platform Targeting
  • OS Targeting
  • Browser Targeting
  • Connection Type Targeting
  • Publisher Targeting (Blocking)
  • List Of Publishers
  • Get list of available Publishersget
  • Patching Targeted Publishers
  • Auto-Targeted Publishers
  • Publisher Targeting Patch Object
  • ACCOUNT LEVEL BLOCKING
  • Get Blocked Publishers At Account Levelget
  • Block Publishers At Account Levelpost

Audience Targeting

  • Audience Targeting Overview
  • Audience Targeting Flow
  • Multi-Targeting Object
  • Audience Targeting Quick Reference
  • Audience Targeting Object
    • Audience Targeting Restrictions Object
    • Lookalike Audience Object
  • Get Marketplace Audience Targetingget
  • Update Marketplace Audience Targetingpost
  • Get Custom Audience Targetingget
  • Update Custom Audience Targetingpost
  • Get Lookalike Audience Targetingget
  • Update Lookalike Audience Targetingpost
  • Contextual Targeting
  • Get Contextual Targetingget
  • Update Contextual Targetingpost

COMBINED AUDIENCES

  • Overview
  • List available audiencesget
    • Available audience object schema
  • Get all combined audiencesget
  • Get a combined audienceget
  • Create a combined audiencepost
  • Update a combined audiencepost

Audience Onboarding

  • First Party Audience Onboarding
  • Create a First Party Audiencepost
  • Fields
  • Add/remove userspost
  • Fields
    • User Object
    • User ID Object
  • Get My Audienceget
  • Get My Audience Targetingget
  • Update My Audience Targetingpost

Reporting

  • Reporting Overview
  • Dimensions, Filters and Columns
  • CAMPAIGN SUMMARY REPORT
  • Campaign Summary Reportget
  • Dimensions Overview
  • Dimensions Cheat Sheet
  • Filters
    • start_date
    • end_date
    • campaign
    • platform
    • country
    • site
    • partner_name
  • Standard Columns
  • Dimension Columns
  • Network-wide reports
  • Custom Conversion Columns
    • 2 new properties (dynamic_fields)
    • The Metadata Section
    • An Example
  • Metadata Object Schema
    • caption
    • id
    • format
    • data_type
  • Row Object Schema
    • id
    • value
  • TOP CAMPAIGN CONTENT
  • Top Campaign Content Reportget
    • Dimension Cheat Sheet
  • Supported Filters
    • start_date
    • end_date
    • campaign
  • Standard Columns
  • Dimension Columns
  • Custom Conversion Columns

Real-time Reports

  • Realtime Campaign Reportget
    • The response object
    • Some examples
    • Dimensions Cheat Sheet
    • Filters
    • Dimension columns
    • Campaign columns
    • Standard columns
  • Realtime Ads Reportget
    • The response object
    • Some examples
    • Dimensions Cheat Sheet
    • Filters
    • Dimension columns
    • Item columns
    • Standard columns

Dictionary

  • DICTIONARY OVERVIEW
  • Common Use Cases
  • Request URL
  • Response
  • Traversing the Tree
  • ENUMS
  • Get list of Dictionariesget
  • Get list of Campaign Enumsget
  • Get list of Item Enumsget
  • GENERAL LISTS
  • Get Days of Weekget
  • Get list of Languagesget
  • Get list of Minimum CPC valuesget
  • POSSIBLE VALUES
  • Get possible values for Campaign Categoryget
  • Get possible values for Item Statusget
  • Get possible values for Item CTAget
  • Get supported languages for Image Libraryget
  • TARGETING
  • Get list of Platformsget
  • Get list of Operating Systemsget
  • Get list of iOS Versionsget
  • Get list of Android Versionsget
  • Get list of Browsersget
  • GEO TARGETING
  • Get list of Countriesget
  • Get Regions in a Countryget
  • Get DMAs in the USget
    • Get Cities in a Countryget
  • Get Postal Codes for a Countryget
  • AUDIENCE TARGETING
  • Get Marketplace Audiencesget
  • Get Marketplace Audiences for a specific Countryget
  • Get Lookalike Audiencesget
  • Get Lookalike Audiences for a specific Countryget
  • Get Contextual Segmentsget

Publisher reports

📘

For the most part, the Dev Center focuses on API endpoints for advertising.

For publisher reports, see the following PDF Guides:

  • Backstage API Reports
  • Bidder Revenue Summary Report