Skip to main content
GET
Get campaign suggestion set

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

campaignSuggestionSetId
string
required

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

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

Response

Get campaign suggestion set

campaignSuggestionSetId
string
required
optimizerRunId
string
required
campaignId
string
required

The campaign's business identifier, as GET /campaigns returns it and GET /campaigns/{campaignId} takes it.

Example:

"cmp_987654321"

campaignDbId
string
required

The campaign's internal row id. Matches campaignDbId on the optimization-suggestion notifications.

Example:

"4471"

campaignName
string | null
required
campaignRunSequence
string
required

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

campaignMediaBuyCount
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