Skip to main content
POST
Sponsored Brand Campaign Performance Forecasts

Autorisierungen

Authorization
string
header
erforderlich

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
erforderlich

Daily budget for the campaign

dateRange
PublicDateRange · object
erforderlich

Campaign date range

targetRoas
number
erforderlich

Target Return on Ad Spend

campaignType
enum<string>
erforderlich

Campaign type (required)

Verfügbare Optionen:
autobidding,
manual
chargeType
enum<string>
erforderlich

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

Verfügbare Optionen:
cpm,
cpc
placements
PublicPlacementRequest · object[]
erforderlich

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.

Verfügbare Optionen:
ad_spend,
clicks,
impressions,
purchases,
sales

Antwort

Successful Response

forecasts
PublicCampaignForecastMetrics · object
erforderlich

Campaign performance forecasts