Decode click IDs and encrypted tracking links

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/tracking-decode.do

Finds every click ID (SUB_ID, ACTION_DATA / CLICK_ID, version 1 or 2) and every URL in the text — one per line, a whole VAST, a postback or landing URL — and decodes each: an encrypted tracking URL is decrypted with this network's keys, its parameters are named (banner, placement, campaign, country, transaction, time, event, custom parameters...), the click IDs it carries are decoded, the landing URL of a click included, and the kind is named: impression, click, VAST tag, VAST event, conversion postback or pixel. An item is decoded only when it names an advertiser, campaign or banner your account can view, or a placement on a site it can view; any other is refused without naming whose it is. A query added after an encrypted URL was not sealed by the network: its parameters and click IDs are listed apart under appended, and only the sealed part decides whether the item is decoded and which entities are named. The publisher's details (page, app, channel, traffic source, custom parameters) are shown only when your account can view the placement's site, the advertiser's (DSP, win price, landing URL, action) only when it can view the campaign or banner; otherwise only that side's ids are shown, and hidden names the side held back. Entity names are given only for what your account can view, the rest read "not visible to your account". The visitor's IP, LES IP, user agent, cookie and device ids and consent string are never shown, custom parameters of those names included: they read "present (hidden)". An altered or foreign item is answered with an error of its own, never by failing the request. At most 65536 characters and the first 50 items per call; a repeated parameter counts by its first value. POST only, so the pasted text never lands in a query string or an access log. Requires the ACTION_TRACKING_S2S permission.

Form Params

input string required

The text to decode: click IDs and URLs, one per line, or a whole VAST

https://ads.example.com/at?subId=AQ8...&action=k-1-813

Responses

200

{success, items:[{input, kind, fields, clickIds:[{parameter, version, fields, hidden}], entities, hidden:{demand, supply}, appended:{fields, clickIds, hidden}, error}], truncated}

400

No input, or more than the input limit

401

Authentication error

403

The role lacks the ACTION_TRACKING_S2S permission

405

Called by GET: the text goes in a POST body

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/tracking-decode.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'input=https://ads.example.com/at?subId=AQ8...&action=k-1-813'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/tracking-decode.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"input": "https://ads.example.com/at?subId=AQ8...&action=k-1-813"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/tracking-decode.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"input":"https://ads.example.com/at?subId=AQ8...&action=k-1-813"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/tracking-decode.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("input=https%3A%2F%2Fads.example.com%2Fat%3FsubId%3DAQ8...%26action%3Dk-1-813"))
    .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("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/tracking-decode.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["input"] = "https://ads.example.com/at?subId=AQ8...&action=k-1-813" });

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

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/tracking-decode.do", strings.NewReader(`input=https%3A%2F%2Fads.example.com%2Fat%3FsubId%3DAQ8...%26action%3Dk-1-813`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	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/tracking-decode.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'input=https%3A%2F%2Fads.example.com%2Fat%3FsubId%3DAQ8...%26action%3Dk-1-813');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/tracking-decode.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('input' => "https://ads.example.com/at?subId=AQ8...&action=k-1-813")

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