Offsite Ads API

Get vendor offsite campaigns

Get vendor offsite campaigns.

get/public/v1/offsite-ads/campaigns

Request

  • Base URL: https://api.topsort.com
  • URL: https://api.topsort.com/public/v1/offsite-ads/campaigns
  • Auth: HTTP bearer

Query parameters

vendor_idstring required

The ID of the vendor to get the campaign for.

dspsAdvancedAPIsPublicDsp[]

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

[
  "google_ads",
  "meta"
]
include_inactiveboolean nullable

Whether to include inactive campaigns.

limitinteger

The maximum number of campaigns to return.

next_pagestring nullable

The next page token.

Response

Successful Response

hasMoreboolean 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.

nextPagestring nullable

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

Example response

{
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo=",
  "campaigns": [
    {
      "dsps": [
        "google_ads",
        "meta"
      ],
      "targetRoas": 3
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.