Passer au contenu principal
GET
Get campaign information

Autorisations

Authorization
string
header
requis

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.

Paramètres de chemin

campaign-id
string<uuid>
requis

The ID of the campaign to get.

Paramètres de requête

vendor_id
string
requis

The ID of the vendor to get the campaign for.

Réponse

Successful Response

campaignId
string<uuid>
requis

The unique identifier of the campaign

dsp
enum<string>
requis

The Demand-Side Platform (DSP) associated with the campaign

Options disponibles:
google_ads,
meta
name
string
requis

The name of the campaign

status
enum<string>
requis

The current status of the campaign

Options disponibles:
ENABLED,
PAUSED
startDate
string<date-time>
requis

The start date of the campaign

endDate
string<date-time>
requis

The end date of the campaign

budget
integer
requis

The budget allocated for the campaign in cents

audience
PublicOffsiteAudience · object | null
requis

The audience targeted by the campaign