Get campaign information

Get campaign.

GET /public/v1/offsite-ads/campaigns/{campaign-id}

Get campaign information

cURL

curl --request GET \
  --url https://api.topsort.com/public/v1/offsite-ads/campaigns/{campaign-id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.topsort.com/public/v1/offsite-ads/campaigns/{campaign-id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.topsort.com/public/v1/offsite-ads/campaigns/{campaign-id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.topsort.com/public/v1/offsite-ads/campaigns/{campaign-id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.topsort.com/public/v1/offsite-ads/campaigns/{campaign-id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.topsort.com/public/v1/offsite-ads/campaigns/{campaign-id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/offsite-ads/campaigns/{campaign-id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "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": []
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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.

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

200

application/json

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 | null · required

The audience targeted by the campaign

Show child attributes