List the report metric columns you may use

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/analytics/columns.do

Lists the metric columns the console's column picker offers the caller for a report type: each column's id (the value reportsLayoutSettings takes in /rest-api/analytics/{format}.do, saved reports and dashboard widgets, and a widget's choosenMetric), its display name in the caller's language and the picker group it sits in (BASIC, PUBLISHER or ADVERTISER with the group's display name). Columns hidden from the caller's role are left out, as in the console.

Query Params

statisticType string

Report type; omitted means the General report. E.g. HADOOP for the Advanced report

HADOOP

Responses

200

{statisticType, columns:[{id, name, group, groupName}]}

400

Bad request — invalid or missing parameters

401

Authentication error

403

The caller's role cannot run this report type; the message names the permission

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/analytics/columns.do?statisticType=HADOOP' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/analytics/columns.do?statisticType=HADOOP", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/analytics/columns.do?statisticType=HADOOP', {
  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/analytics/columns.do?statisticType=HADOOP"))
    .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/analytics/columns.do?statisticType=HADOOP");
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/analytics/columns.do?statisticType=HADOOP", 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/analytics/columns.do?statisticType=HADOOP");
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/analytics/columns.do?statisticType=HADOOP")
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