Skip to main content
GET
Get campaign information

Autorizaciones

Authorization
string
header
requerido

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 ruta

campaign-id
string<uuid>
requerido

The ID of the campaign to get.

Parámetros de consulta

vendor_id
string
requerido

The ID of the vendor to get the campaign for.

Respuesta

Successful Response

campaignId
string<uuid>
requerido

The unique identifier of the campaign

dsps
enum<string>[]
requerido

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

Minimum array length: 1
Opciones disponibles:
google_ads,
meta
Ejemplo:
name
string
requerido

The name of the campaign

status
enum<string>
requerido

The current status of the campaign

Opciones disponibles:
ENABLED,
PAUSED
startDate
string<date-time>
requerido

The start date of the campaign

endDate
string<date-time>
requerido

The end date of the campaign

budget
integer
requerido

The daily budget allocated for the campaign in cents

targetRoas
number
requerido

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.

Rango requerido: 1 <= x <= 20
Ejemplo:

3

audience
PublicOffsiteAudience · object | null
requerido

The audience targeted by the campaign