Zum Hauptinhalt springen
GET
/
public
/
v1
/
offsite-ads
/
jobs
/
{job-id}
Get Job Status
curl --request GET \
  --url https://api.topsort.com/public/v1/offsite-ads/jobs/{job-id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.topsort.com/public/v1/offsite-ads/jobs/{job-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/jobs/{job-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/jobs/{job-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/jobs/{job-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/jobs/{job-id}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/offsite-ads/jobs/{job-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
{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dsp": [],
  "result": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Autorisierungen

​
Authorization
string
header
erforderlich

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.

Pfadparameter

​
job-id
string<uuid>
erforderlich

The ID of the job to retrieve the status for.

Abfrageparameter

​
vendor_id
string | null

The ID of the vendor to retrieve the job status for.

Antwort

Successful Response

​
jobId
string<uuid>
erforderlich

The unique identifier for the queued job.

​
requestType
enum<string>
erforderlich

The type of operation the job represents.

Verfügbare Optionen:
advertiser_creation,
campaign_creation,
campaign_update,
user_list_audience_creation
​
status
enum<string>
erforderlich

The current status of the job.

Verfügbare Optionen:
not_started,
in_progress,
completed,
failed,
retrying
​
dsp
enum<string>[]
erforderlich

The DSP(s) associated with the job.

DSPs an offsite audience is synced to.

Verfügbare Optionen:
google_ads,
meta,
tiktok_ads,
snapchat_ads
​
result
string | null

Optional result data in json format (e.g., {error: 'error message'}).