DSP API Documentation

The DSP API gives full access to DSP functionality, allowing you to build and optimize advertising campaigns through a RESTful API.

Getting Started - An API client must be authenticated to access any part of the DSP API. See Authentication to learn how to request and use tokens to make API calls.

API Hierarchy

To manage many of your assets in Basis DSP, you use some or all of the following endpoint path:

Copy

Core URI Path

/advertisers/{Id}/brands/{Id}/campaignGroups/{Id}/campaigns/{Id}/targeting

All steps along this path have additional requests for managing your account and campaigns. To begin bidding on impressions, you must set up at least one brand, group, and campaign. You can also set up programmatic guaranteed and digital out-of-home campaigns.

Advertisers

Each client is assigned a unique advertiser ID. Data that applies for the entire client organization is stored here.

Resources used by multiple brands are managed at this level, such as datapoints, domain lists, PMP deals, and add-ons.

Brands

Brands offer a way to separate your advertising at a level above campaign groups. You can have one or many brands.

Resources used by multiple campaigns are managed at this level, such as audiences, conversion pixels, creatives, and universal pixels.

Campaign Groups

Groups help you manage the status, budget, pacing, and delivery dates of multiple campaigns at once.

Groups also allow you to control advertiser spend settings, apply pacing controls, group budget optimization, and add-ons.

Campaigns

Campaigns contain most of the specific tactics for achieving a marketing objective.

Specify the budget, duration, schedules, creatives, exchanges, domains, optimization strategies, viewability tracking, and more at the campaign level.

Campaign Targeting

To further refine the reach of your campaigns, you can use campaign targeting requests to specify audiences, contexts, devices, domains, locations, traffic types, and more.

Reporting and Statistic APIs

Use offline reports and statistics endpoints to help you track your campaign metrics.

Reports

Request a specific set of data collected for previous days. Submit a timeframe, how you want the data aggregated, and the report type to retrieve a URL that contains the requested data.

Statistics

Request real-time data at the campaign, group, advertiser, brand, audience, or conversion pixel level. See the Stats Response Details page for descriptions of the response fields.

Resource APIs

Use the resource APIs to retrieve available data that you can use in other requests, such as the devices you can target or geo location codes.

Geo

View the available location segments to use for geo targeting.

Taxonomy

Retrieve data-sets for devices and app stores, digital out-off-home, geopolitical locations, and viewability tracking services.

Vertical Attributes

List advertising categories available for brands and campaign groups.

What's New?

April 2024
Deal Enhancements Added two new requests, Add a Deal to Deal Groups and Add PMP Deals to a Campaign.
March 2024
Report Type Updates Some legacy report types are being deprecated on April 15, 2024. Identity Targeting Update You no longer need to set identity targeting campaigns using CRM audiences.
February 2024
Group Budget Optimization: Campaign Ranking Campaign ranking allows you to manually set ranks for campaigns and control spend based on specific business preferences.
January 2024
Deal Groups You can now target groups of deals with your campaigns. Basis provides some curated deal groups, or you can create your own deal groups. Political Metadata Add political metadata fields to your brands.
December 2023
New Report Types Basis added new report types to allow you to retrieve average frequencies instead of number of frequencies.
November 2023
Bid Shading Enabled By Default Bid shading is enabled for all campaigns by default.
October 2023
Adaptive Bidding For private marketplace deals, you can now use a deal floor price multiplier for your campaign to bid appropriately on deals. Campaign Max Bid You can now set the `maxBid` value at the campaign level instead of applying it on the optimization and multiplier requests.
September 2023
CTV Reports You can now create CTV publisher reports to unify various app IDs and bundles that represent a publisher in a single row.
July 2023
Digital Out-of-Home You can now create digital out-of-home (DOOH) campaigns. Viewability Tracking You can now choose between multiple viewability tracking providers and standards.