Zum Hauptinhalt springen
GET
Get campaign information

Autorisierungen

Authorization
string
header
erforderlich

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.

Pfadparameter

campaign-id
string<uuid>
erforderlich

The ID of the campaign to get.

Abfrageparameter

vendor_id
string
erforderlich

The ID of the vendor to get the campaign for.

Antwort

Successful Response

campaignId
string<uuid>
erforderlich

The unique identifier of the campaign

dsp
enum<string>
erforderlich

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

Verfügbare Optionen:
google_ads,
meta
name
string
erforderlich

The name of the campaign

status
enum<string>
erforderlich

The current status of the campaign

Verfügbare Optionen:
ENABLED,
PAUSED
startDate
string<date-time>
erforderlich

The start date of the campaign

endDate
string<date-time>
erforderlich

The end date of the campaign

budget
integer
erforderlich

The budget allocated for the campaign in cents

audience
PublicOffsiteAudience · object | null
erforderlich

The audience targeted by the campaign