List recently deleted entities

Advertisers, campaigns, banners, sites, zones and placements deleted in the last 90 days and not restored yet, newest first - only those under an advertiser or site the caller may view.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/deleted-entities/list.do

Advertisers, campaigns, banners, sites, zones and placements deleted in the last 90 days and not restored yet, newest first - only those under an advertiser or site the caller may view. Each item is the entity a user deleted: what its delete took down with it (the campaigns and banners of a deleted advertiser, the zones and placements of a deleted site) is counted in cascaded and comes back with it. Each item carries deletionId, type, id, name, deletedAt (ISO-8601 instant), deletedBy {id, username}, its ancestors (advertiserId/advertiserName, campaignId/campaignName, siteId/siteName, zoneId/zoneName), cascaded {TYPE: count}, links (banner-placement links the delete removed), linksLost (those of them whose placement or banner is deleted now, so a restore cannot make them again), canRestore (the caller may delete it, which restoring takes) and blockedBy {type, id, name}: a deleted ancestor that has to be restored first. Deletions made before deletions were recorded are not listed and cannot be restored here.

Query Params

types array<string>

Only these entity types: ADVERTISER, CAMPAIGN, BANNER, SITE, ZONE, PLACEMENT. Default: all

BANNER

ancestorType string

With ancestorId: only entities under this ADVERTISER, CAMPAIGN, SITE or ZONE

ADVERTISER

ancestorId integer

With ancestorType: the id of that advertiser, campaign, site or zone

1001

start integer

Skip this many items. Default 0

0

limit integer

How many items to return, 1-200. Default 50

50

Responses

200

{success, items:[...], total, start, returned, truncated, retentionDays}

400

Unknown type, ancestorType without ancestorId, limit outside 1-200 or start below 0

401

Authentication error

403

Forbidden — insufficient permissions

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/deleted-entities/list.do?types=BANNER&ancestorType=ADVERTISER&ancestorId=1001' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/deleted-entities/list.do?types=BANNER&ancestorType=ADVERTISER&ancestorId=1001", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/deleted-entities/list.do?types=BANNER&ancestorType=ADVERTISER&ancestorId=1001', {
  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/deleted-entities/list.do?types=BANNER&ancestorType=ADVERTISER&ancestorId=1001"))
    .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/deleted-entities/list.do?types=BANNER&ancestorType=ADVERTISER&ancestorId=1001");
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/deleted-entities/list.do?types=BANNER&ancestorType=ADVERTISER&ancestorId=1001", 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/deleted-entities/list.do?types=BANNER&ancestorType=ADVERTISER&ancestorId=1001");
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/deleted-entities/list.do?types=BANNER&ancestorType=ADVERTISER&ancestorId=1001")
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