Skip to main content
POST
Listing 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

campaignFormat
string
erforderlich

Campaign format type. Must be 'listing'.

Allowed value: "listing"
campaignType
string
erforderlich

Campaign type. Must be 'autobidding'.

Allowed value: "autobidding"
products
PublicProductRequest · object[]
erforderlich

List of products in the campaign (required)

Minimum array length: 1
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
targetingFilters
PublicCampaignTargetingFilters · object | null

Optional audience targeting, in the same shape as campaign creation. When active, the forecast covers only users in these segments. Segment IDs are the marketplace's external segment IDs.

multiplierConfig
PublicCampaignMultiplierConfig · object | null

Optional audience bid multipliers, in the same shape as campaign creation. Segment IDs are the marketplace's external segment IDs.

exclusionFilters
PublicCampaignExclusionFilters · object | null

Optional audience exclusion, in the same shape as campaign creation. When active, the forecast leaves out users in these segments. Segment IDs are the marketplace's external segment IDs.

Antwort

Successful Response

forecasts
PublicCampaignForecastMetrics · object
erforderlich

Campaign performance forecasts