Skip to main content
GET
Get planning brief

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

briefId
integer
required
Required range: 1 <= x <= 9007199254740991

Response

Get planning brief

A demand signal plus its per-publisher target rows.

id
string
required
customerId
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
advertiserId
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
brandDomain
string | null
required
buyerName
string
required
advertiserName
string
required
campaignName
string | null
required
audience
string
required
geo
string
required
channels
enum<string>[]
required

Channel the buyer wants to reach. Maps to ADCP MediaType. Lower-case to match the AdCP wire format; only Postgres-enum types use UPPERCASE.

Available options:
display,
native,
video,
audio,
ctv,
dooh,
newsletter,
podcast
exclusions
object[]
required
startDate
string
required
endDate
string
required
flexibility
object | null
required
statedBudget
number
required
currency
string
required
primaryKpi
object | null
required
priceExpect
number | null
required
creativeReady
boolean | null
required
rawPrompt
string | null
required
status
enum<string>
required

Lifecycle of a demand signal. SEARCHING on create; QUOTED when at least one seller responds; BOOKED when at least one target converts to a deal; ABANDONED after idle; DECLINED if every target declined.

Available options:
SEARCHING,
QUOTED,
BOOKED,
ABANDONED,
DECLINED
targetingMode
enum<string>
required

DIRECT = buyer named the seller(s). FILTERED = matched ≤5 candidates. BROAD = >5.

Available options:
DIRECT,
FILTERED,
BROAD
qualifiedBudget
number | null
required
createdAt
string
required
updatedAt
string
required
targets
object[]
required
targetCount
integer
Required range: 0 <= x <= 9007199254740991
responseSummary
object