Read an entity's custom field values

Returns every custom (additional) field the network defines for the entity type, with the entity's value.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/additional-fields/{entityType}/{entityId}.do

Returns every custom (additional) field the network defines for the entity type, with the entity's value. A field the entity has no value for comes back with value null. These are the fields of the console's Basic Info card; their definitions are managed under /rest-api/additional-entity-fields-configuration. Needs view rights on the entity: the advertiser's share for an advertiser, campaign or banner, the site's share for a site, zone or placement.

Path Params

entityType string required

Entity type the fields belong to

CAMPAIGN

entityId integer required

Id of the advertiser, campaign, banner, site, zone or placement

2001

Responses

200

'fields' lists {id, name, title, value} for each field of the entity type

400

Unknown entity type

401

Authentication error

403

No view rights on the entity

404

The entity does not exist or is deleted

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/additional-fields/CAMPAIGN/2001.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

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

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/additional-fields/CAMPAIGN/2001.do', {
  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/additional-fields/CAMPAIGN/2001.do"))
    .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/additional-fields/CAMPAIGN/2001.do");
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/additional-fields/CAMPAIGN/2001.do", 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/additional-fields/CAMPAIGN/2001.do");
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/additional-fields/CAMPAIGN/2001.do")
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