Skip to main content
GET
Get plan suggestion set

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

planSuggestionSetId
string
required

Plan suggestion set id. Digits only, up to 18 characters — the underlying bigint id.

Pattern: ^[1-9][0-9]{0,17}$

Response

Get plan suggestion set

planSuggestionSetId
string
required
optimizerRunId
string
required
planId
string
required
planName
string | null
required
campaignId
string
required
campaignName
string | null
required
planRunSequence
string
required

Monotonic per-plan run counter. A pending set is replaced only by a complete set with a strictly greater sequence.

planMediaBuyCount
number
required
budgetCurrency
string
required
applyMode
enum<string>
required
Available options:
AUTO,
MANUAL
status
string
required
statusReason
string | null
required
netAllocationDelta
string | null
required

Sum of every member media buy's net movement, in minor units. Exactly "0" for any set that is eligible to apply.

applyAttemptCount
number
required
compensationAttemptCount
number
required
notifiedAt
string | null
required

When the buyer was notified this set is waiting on them. Null means the set is actionable but no notification has landed yet.

decidedAt
string | null
required
appliedAt
string | null
required
firstMessageAt
string
required
lastMessageAt
string
required
mediaBuys
object[]
required