Taboola Backstage API

API Reference
Community Discussion
Announcements

{{user.name}}Log In

Welcome to Taboola's Backstage API

Welcome to Taboola's Backstage API hub. You'll find comprehensive guides and documentation to help you start working with the Backstage API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Taboola Backstage API

Taboola Mobile SDK Documentation Website
Taboola Backstage API

HomeGuidesAPI ReferenceReferenceAnnouncementsCommunity DiscussionPage Not FoundSearch{{ state.current().meta.title }}API LogsTutorials

Only admins can see thisEnable it for everyone

Welcome

Taboola Backstage API
A Note for Publishers
Minimum CPC
Java Client SDK

Authentication

Authentication Basics
- The Access Token
- The Refresh Token
Access Token - 4 Flows
post
Client Credentials Flow
post
Password Credentials Flow
Implicit Flow
Authorization Code Flow

Making Requests

Your Account ID
get
Get Account Details
Request Basics
Errors
Dictionary

Campaigns

Campaigns Overview
Fetching Campaigns
get
Get All Campaigns
get
Get a Campaign
Creating Campaigns
post
Create a Campaign
Duplicating Campaigns
post
Duplicate a Campaign
Updating Campaigns
post
Update a Campaign
Patching Collections
Patching Bid Modifiers
patch
Patch a Collection
Pausing/unpausing Campaigns
Deleting Campaigns
delete
Delete a Campaign

Campaign Fields

Campaign Object
Campaign Fields
Policy Review Object
External Brand Safety
External Brand Safety Object
- External Brand Safety Restriction Object
Verification Pixel
- Verification Pixel Object
Viewability Tags
Viewability Tag Object
- Viewability Tag Item Object
Campaign Spending Models
Publisher Bid Modifier Object
- 'Bid Modifier Per Publisher' Object
Publisher Bid Strategy Modifier Object
- 'Bid Strategy Per Publisher' Object
Patch Object
Activity Schedule Object
Activity Schedule Item Object
Targeting

Campaign Items

Campaign Items Overview
Campaign Item Fields
CTA Object
Creative Focus Object
Coordinates Object
Item Status
Item Types
get
Get All Campaign Items
get
Get a Campaign Item
Creating a Campaign Item
post
Create a Campaign Item
Updating Campaign Items
put
Update a Campaign Item
Deleting Campaign Items
delete
Delete a Campaign Item
Creative Focus
Creative CTA
Pausing/unpausing Campaign Items
RSS Items
get
Get Children Items
get
Get a Child Item
put
Update a Child Item
Creating a Batch of Campaign Items
post
Create a Batch of Campaign Items
MANAGING IMAGES
Upload Image From Local Device
get
Get Taxonomies
get
Get Images From Image Library
post
Upload Image From an Image Library
End-To-End Flow

Taboola Pixel

Taboola Pixel Overview
Taboola Pixel Fields
Conversion Rule Quick Reference
Custom Audience Quick Reference
get
Get All Conversion Rules
get
Get a Conversion Rule
get
Get All Conversion Rules Plus Data
post
Create a Conversion Rule
put
Update a Conversion Rule
Archiving/unarchiving a Conversion Rule
get
Get All Custom Audiences
get
Get a Custom Audience Rule
post
Create a Custom Audience Rule
put
Update a Custom Audience Rule
Conversion Rule Object
Custom Audience Rule Object
Condition Object
Effect Object
- type
- data

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
Get Postal Codes Targeting
post
Update Postal Codes Targeting
- Postal Code Targeting Flow
Postal Codes Targeting Restrictions Object
Platform Targeting
OS Targeting
Browser Targeting
Connection Type Targeting
Publisher Targeting
List Of Publishers
get
Get list of available Publishers
Patching Targeted Publishers
Auto-Targeted Publishers
Publisher Targeting Patch Object
ACCOUNT LEVEL BLOCKING
get
Get Blocked Publishers At Account Level
post
Block Publishers At Account Level

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
Get Marketplace Audience Targeting
get
Get Custom Audience Targeting
get
Get Lookalike Audience Targeting
post
Update Marketplace Audience Targeting
post
Update Custom Audience Targeting
post
Update Lookalike Audience Targeting

Reporting

A Note for Publishers
Reporting Overview
Dimensions, Filters and Columns
CAMPAIGN SUMMARY REPORT
get
Campaign Summary Report
Dimensions Overview
Dimensions Cheat Sheet
Filters
Standard Columns
Dimension Columns
Custom Conversion Columns
Metadata Object Schema
Row Object Schema
- id
- value
TOP CAMPAIGN CONTENT
get
Top Campaign Content Report
- Dimension Cheat Sheet
Supported Filters
Standard Columns
Dimension Columns
Custom Conversion Columns

Dictionary

DICTIONARY OVERVIEW
Common Use Cases
Request URL
Response
Traversing the Tree
ENUMS
get
Get list of Dictionaries
get
Get list of Campaign Enums
get
Get list of Item Enums
GENERAL LISTS
get
Get Days of Week
get
Get list of Languages
get
Get list of Minimum CPC values
POSSIBLE VALUES
get
Get possible values for Campaign Category
get
Get possible values for Item Status
get
Get possible values for Item CTA
get
Get supported languages for Image Library
TARGETING
get
Get list of Platforms
get
Get list of Operating Systems
get
Get list of iOS Versions
get
Get list of Android Versions
get
Get list of Browsers
GEO TARGETING
get
Get list of Countries
get
Get Regions in a Country
get
Get DMAs in the US
- getGet Cities in a Country
get
Get Postal Codes for a Country
AUDIENCE TARGETING
get
Get Marketplace Audiences
get
Get Marketplace Audiences for a specific Country
get
Get Lookalike Audiences
get
Get Lookalike Audiences for a specific Country