List report types with their associated clients

curl --request GET \
  --url https://api.extole.io/v6/report-types/clients \
  --header 'Authorization: <api-key>'

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))

}

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": [],
      "categories": [
        "<string>"
      ],
      "component_ids": [
        "<string>"
      ],
      "component_references": [
        {
          "component_id": "<string>",
          "socket_names": [
            "<string>"
          ]
        }
      ],
      "data_sources": [],
      "data_start": "2025-10-24T02:00:00-07:00",
      "description": "<string>",
      "display_name": "<string>",
      "formats": [],
      "name": "<string>",
      "parameters": [
        {
          "category": "<string>",
          "default_value": "<string>",
          "description": "<string>",
          "display_name": "<string>",
          "is_required": true,
          "name": "<string>",
          "order": 123,
          "type": {
            "values": [
              "<string>"
            ]
          }
        }
      ],
      "preview_columns": [
        {
          "name": "<string>",
          "note": "<string>",
          "sample_value": "<string>"
        }
      ],
      "scopes": [],
      "tags": [
        {
          "name": "<string>"
        }
      ],
      "type": "CONFIGURED",
      "created_date": "2025-10-24T02:00:00-07:00",
      "updated_date": "2025-10-24T02:00:00-07:00"
    }
  }
]

GET

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>'

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))

}

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": [],
      "categories": [
        "<string>"
      ],
      "component_ids": [
        "<string>"
      ],
      "component_references": [
        {
          "component_id": "<string>",
          "socket_names": [
            "<string>"
          ]
        }
      ],
      "data_sources": [],
      "data_start": "2025-10-24T02:00:00-07:00",
      "description": "<string>",
      "display_name": "<string>",
      "formats": [],
      "name": "<string>",
      "parameters": [
        {
          "category": "<string>",
          "default_value": "<string>",
          "description": "<string>",
          "display_name": "<string>",
          "is_required": true,
          "name": "<string>",
          "order": 123,
          "type": {
            "values": [
              "<string>"
            ]
          }
        }
      ],
      "preview_columns": [
        {
          "name": "<string>",
          "note": "<string>",
          "sample_value": "<string>"
        }
      ],
      "scopes": [],
      "tags": [
        {
          "name": "<string>"
        }
      ],
      "type": "CONFIGURED",
      "created_date": "2025-10-24T02:00:00-07:00",
      "updated_date": "2025-10-24T02:00:00-07:00"
    }
  }
]

Authorizations

Authorization

string

header

required

Query Parameters

report_type_id

string

display_name

string

description

string

visibility

enum<string>

Available options:

EXTOLE_ONLY,

PRIVATE,

PUBLIC

Response

Successful response

client_ids

string[]

required

Stable Extole identifiers for clients that have access to this report type.

report_type

CONFIGURED · object

required

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.

CONFIGURED
DASHBOARD
SPARK
SQL

Show child attributes

List report types List recommended report types

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

List report types with their associated clients

Authorizations

Query Parameters

Response