Passer au contenu principal
GET
Get vendor offsite campaigns

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 requête

vendor_id
string
requis

The ID of the vendor to get the campaign for.

dsps
enum<string>[]

The DSPs to filter campaigns by. If empty, all DSPs are included.

The DSP to scope the requested operation or to filter the response by.

Options disponibles:
google_ads,
meta
include_inactive
boolean | null
défaut:false

Whether to include inactive campaigns.

limit
integer
défaut:100

The maximum number of campaigns to return.

Plage requise: x <= 100
next_page
string | null

The next page token.

Réponse

Successful Response

hasMore
boolean
requis

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

campaigns
OfsiteCampaign · object[]
requis

The campaigns for the vendor

nextPage
string | null

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum string length: 1
Exemple:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="