Skip to main content
GET
/
public
/
v1
/
offsite-ads
/
campaigns
/
{campaign-id}
Get campaign information
curl --request GET \
  --url https://api.topsort.com/public/v1/offsite-ads/campaigns/{campaign-id} \
  --header 'Authorization: Bearer <token>'
{
  "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.

Path Parameters

​
campaign-id
string<uuid>
required

The ID of the campaign to get.

Query Parameters

​
vendor_id
string
required

The ID of the vendor to get the campaign for.

Response

Successful Response

​
campaignId
string<uuid>
required

The unique identifier of the campaign

​
dsp
enum<string>
required

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

Available options:
google_ads,
meta
​
name
string
required

The name of the campaign

​
status
enum<string>
required

The current status of the campaign

Available options:
ENABLED,
PAUSED
​
startDate
string<date-time>
required

The start date of the campaign

​
endDate
string<date-time>
required

The end date of the campaign

​
budget
integer
required

The budget allocated for the campaign in cents

​
audience
PublicOffsiteAudience · object
required

The audience targeted by the campaign