Skip to main content
GET
Get campaign information

Autorizações

Authorization
string
header
obrigatório

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.

Parâmetros de caminho

campaign-id
string<uuid>
obrigatório

The ID of the campaign to get.

Parâmetros de consulta

vendor_id
string
obrigatório

The ID of the vendor to get the campaign for.

Resposta

Successful Response

campaignId
string<uuid>
obrigatório

The unique identifier of the campaign

dsps
enum<string>[]
obrigatório

The Demand-Side Platforms (DSPs) associated with the campaign

Minimum array length: 1
Opções disponíveis:
google_ads,
meta
Exemplo:
name
string
obrigatório

The name of the campaign

status
enum<string>
obrigatório

The current status of the campaign

Opções disponíveis:
ENABLED,
PAUSED
startDate
string<date-time>
obrigatório

The start date of the campaign

endDate
string<date-time>
obrigatório

The end date of the campaign

budget
integer
obrigatório

The daily budget allocated for the campaign in cents

targetRoas
number
obrigatório

Target ROAS of the campaign. Acceptable values are between 1.0 and 20.0. Topsort maps this value to the closest equivalent bidding configuration supported by each DSP.

Intervalo necessário: 1 <= x <= 20
Exemplo:

3

audience
PublicOffsiteAudience · object | null
obrigatório

The audience targeted by the campaign