Skip to main content
POST
Sponsored Brand Campaign Performance Forecasts

Authorizations

Authorization
string
header
required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Body

application/json
dailyBudget
number
required

Daily budget for the campaign

dateRange
PublicDateRange · object
required

Campaign date range

targetRoas
number
required

Target Return on Ad Spend

campaignType
enum<string>
required

Campaign type (required)

Available options:
autobidding,
manual
chargeType
enum<string>
required

Billing rail for the campaign: 'cpm' or 'cpc'.

Available options:
cpm,
cpc
placements
PublicPlacementRequest · object[]
required

Placements the sponsored brand campaign targets (required). Each id is the external placement slug.

Required array length: 1 - 100 elements
triggers
PublicTriggerRequest · object[]

List of campaign triggers (optional, defaults to empty list)

targets
enum<string>[] | null

Optional list of target variables to forecast. If not provided, all targets will be forecasted.

Available options:
ad_spend,
clicks,
impressions,
purchases,
sales

Response

Successful Response

forecasts
PublicCampaignForecastMetrics · object
required

Campaign performance forecasts