Skip to main content
GET
/
public
/
v1
/
offsite-ads
/
campaigns
Get vendor offsite campaigns
curl --request GET \
  --url https://api.topsort.com/public/v1/offsite-ads/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo=",
  "campaigns": [
    {
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dsp": "google_ads",
      "name": "<string>",
      "status": "ENABLED",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "budget": 123,
      "audience": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "estimatedSize": 123,
        "estimatedSizeRange": {
          "lowerBound": 123,
          "upperBound": 123
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Query Parameters

​
vendor_id
string
required

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.

​
include_inactive
boolean | null
default:false

Whether to include inactive campaigns.

​
limit
integer
default:100

The maximum number of campaigns to return.

Required range: 0 < x <= 100
​
next_page
string | null

The next page token.

Response

Successful Response

​
hasMore
boolean
required

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[]
required

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 length: 1
Examples:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="