Skip to main content
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

dsps
enum<string>[]
erforderlich

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

Minimum array length: 1
Verfügbare Optionen:
google_ads,
meta
Beispiel:
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 daily budget allocated for the campaign in cents

targetRoas
number
erforderlich

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.

Erforderlicher Bereich: 1 <= x <= 20
Beispiel:

3

audience
PublicOffsiteAudience · object | null
erforderlich

The audience targeted by the campaign