Get campaign by ID

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/campaign/{campaignId}.do

Returns a single campaign: name, on/off flag (active), advertiserId, priority, weight, exchange rate, optimization settings, action-tracking settings (autoTagLandingUrl, maxActionPriceOverride, campaignAliasForActionTracking), targeting flags, labels, autolink categories, banner IDs and count, creation time (the creation day, at midnight), status tokens and hasTraffic; every field update accepts is returned under its update name (autolinkCategories as autoLinkCategories). Pricing and the self-serve status are added only with selfServRequest=true. The caller must have UPDATE permission on the campaign's advertiser and MANAGE_PRICING permission (enabled or read-only). Each campaign's 'status' array holds UI status tokens computed from traffic statistics, which are not the on/off switch — that is the 'active' field: status-active = switched on AND served traffic in the last ~6 hours; status-not-active = switched off OR no traffic in the last ~6 hours, so active=true together with status-not-active is normal for an idle, not-yet-started or newly created campaign; status-finished (added alongside) = the campaign's delivery limits have ended it — end date passed, total limit reached or an action limit reached. 'hasTraffic' is the same ~6-hour traffic flag on its own. Traffic data is refreshed hourly. A deleted campaign has an empty array. The response also carries additionalFieldValues: every custom field the network defines for this entity type, keyed by field id, each with its name and this entity's value (null when unset) - the values of /rest-api/additional-fields/{entityType}/{entityId}.

Path Params

campaignId integer required

Unique identifier of the campaign to retrieve

2001

Query Params

selfServRequest boolean

When true, returns a simplified self-serve response format instead of the full campaign details

false

Responses

200

Campaign details

400

Campaign has been deleted

401

Authentication error

403

Not enough permissions

404

Campaign not found

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001.do?selfServRequest=false' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001.do?selfServRequest=false", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001.do?selfServRequest=false', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001.do?selfServRequest=false"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001.do?selfServRequest=false");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001.do?selfServRequest=false", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

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

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001.do?selfServRequest=false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001.do?selfServRequest=false")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body