Passer au contenu principal
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",
  "name": "<string>",
  "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
    },
    "syncedDsps": []
  }
}

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 chemin

​
campaign-id
string<uuid>
requis

The ID of the campaign to get.

Paramètres de requête

​
vendor_id
string
requis

The ID of the vendor to get the campaign for.

Réponse

Successful Response

​
campaignId
string<uuid>
requis

The unique identifier of the campaign

​
dsp
enum<string>
requis

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

Options disponibles:
google_ads,
meta
​
name
string
requis

The name of the campaign

​
status
enum<string>
requis

The current status of the campaign

Options disponibles:
ENABLED,
PAUSED
​
startDate
string<date-time>
requis

The start date of the campaign

​
endDate
string<date-time>
requis

The end date of the campaign

​
budget
integer
requis

The budget allocated for the campaign in cents

​
audience
PublicOffsiteAudience · object
requis

The audience targeted by the campaign