List report types with their associated clients
curl --request GET \
--url https://api.extole.io/v6/report-types/clients \
--header 'Authorization: <api-key>'import requests
url = "https://api.extole.io/v6/report-types/clients"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.extole.io/v6/report-types/clients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.extole.io/v6/report-types/clients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.extole.io/v6/report-types/clients"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.extole.io/v6/report-types/clients")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v6/report-types/clients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"client_ids": [
"<string>"
],
"report_type": {
"allowed_scopes": [
"CLIENT_ADMIN"
],
"categories": [
"<string>"
],
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"data_sources": [
"AUDIT_EMAIL"
],
"data_start": "2025-10-24T02:00:00-07:00",
"description": "<string>",
"display_name": "<string>",
"executor_type": "DASHBOARD",
"formats": [
"CSV"
],
"name": "<string>",
"parameters": [
{
"category": "<string>",
"default_value": "<string>",
"description": "<string>",
"display_name": "<string>",
"is_required": true,
"name": "<string>",
"order": 123,
"type": {
"name": "AUDIENCE_ID",
"value_type": "DYNAMIC",
"values": [
"<string>"
]
}
}
],
"preview_columns": [
{
"name": "<string>",
"note": "<string>",
"sample_value": "<string>"
}
],
"scopes": [
"CLIENT_ADMIN"
],
"tags": [
{
"name": "<string>",
"type": "GLOBAL"
}
],
"type": "CONFIGURED",
"visibility": "EXTOLE_ONLY",
"created_date": "2025-10-24T02:00:00-07:00",
"updated_date": "2025-10-24T02:00:00-07:00"
}
}
]Report Types
List report types with their associated clients
Returns every report type alongside the ids of clients that have access to it. Equivalent to running GET /v6/report-types and GET /v6/report-types/{id}/clients for every result, but in a single call. Requires the client_superuser scope - use this only when auditing cross-client access at the platform level.
GET
https://api.extole.io
/
v6
/
report-types
/
clients
List report types with their associated clients
curl --request GET \
--url https://api.extole.io/v6/report-types/clients \
--header 'Authorization: <api-key>'import requests
url = "https://api.extole.io/v6/report-types/clients"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.extole.io/v6/report-types/clients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.extole.io/v6/report-types/clients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.extole.io/v6/report-types/clients"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.extole.io/v6/report-types/clients")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v6/report-types/clients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"client_ids": [
"<string>"
],
"report_type": {
"allowed_scopes": [
"CLIENT_ADMIN"
],
"categories": [
"<string>"
],
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"data_sources": [
"AUDIT_EMAIL"
],
"data_start": "2025-10-24T02:00:00-07:00",
"description": "<string>",
"display_name": "<string>",
"executor_type": "DASHBOARD",
"formats": [
"CSV"
],
"name": "<string>",
"parameters": [
{
"category": "<string>",
"default_value": "<string>",
"description": "<string>",
"display_name": "<string>",
"is_required": true,
"name": "<string>",
"order": 123,
"type": {
"name": "AUDIENCE_ID",
"value_type": "DYNAMIC",
"values": [
"<string>"
]
}
}
],
"preview_columns": [
{
"name": "<string>",
"note": "<string>",
"sample_value": "<string>"
}
],
"scopes": [
"CLIENT_ADMIN"
],
"tags": [
{
"name": "<string>",
"type": "GLOBAL"
}
],
"type": "CONFIGURED",
"visibility": "EXTOLE_ONLY",
"created_date": "2025-10-24T02:00:00-07:00",
"updated_date": "2025-10-24T02:00:00-07:00"
}
}
]Authorizations
HEADERQUERYCOOKIE
Query Parameters
Available options:
EXTOLE_ONLY, PRIVATE, PUBLIC Available options:
DISPLAY_NAME, ID, TYPE, VISIBILITY Available options:
ASC, ASCENDING, DESC, DESCENDING Response
Successful response
Stable Extole identifiers for clients that have access to this report type.
Stable Extole identifiers for clients that have access to this report type.
Report type definition. Polymorphic on type: SQL, SPARK, DASHBOARD, and CONFIGURED share the common metadata below (display name, description, scopes, parameters, formats, tags, data sources) and add their own type-specific fields.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Was this page helpful?