Get report type schema

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

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v6/report-types/{id}/schema', 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/{id}/schema",
  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/{id}/schema"

	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/{id}/schema")

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

{
  "columns": [
    {
      "name": "<string>",
      "note": "<string>",
      "sample_value": "<string>"
    }
  ],
  "context_parameters": {},
  "report_type_id": "<string>"
}

Report Types

Get report type schema

Returns the schema a report type produces - the ordered columns that appear in its output. For report types with fixed columns, these are the report type’s preview columns. For configurable report types, they are the client-named columns defined by the report type’s column mapping parameters. Report types whose columns depend on the client’s own configuration resolve them against the report type’s declared parameter defaults, which the response echoes as context_parameters. To resolve the columns against your own parameter values instead, post them to this same path. Use this to discover a report type’s output shape without running the report.

GET

report-types

{id}

schema

Get report type schema

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

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v6/report-types/{id}/schema', 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/{id}/schema",
  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/{id}/schema"

	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/{id}/schema")

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

{
  "columns": [
    {
      "name": "<string>",
      "note": "<string>",
      "sample_value": "<string>"
    }
  ],
  "context_parameters": {},
  "report_type_id": "<string>"
}

Authorizations

Authorization

string

header

required

Path Parameters

string

required

The Extole unique report type identifier.

Response

Schema the report type produces, as an ordered, non-empty list of output columns, alongside the parameter values it was resolved against.

columns

object[]

required

Columns the report type produces, in output order.

Show child attributes

context_parameters

object

required

read-only

Report parameters this schema was resolved against, keyed by parameter name. Each one changes the columns; supply report parameter values in the POST request body to resolve the schema against a different context. A value is what the caller supplied, otherwise the report type's declared default; parameters with neither are absent, and leaving one out resolves the schema against the report type's own default behavior rather than making the answer partial. Run the report with these same parameter values to get these same columns. Empty for report types whose columns do not depend on context.

Show child attributes

report_type_id

string

required

read-only

Id of the report type this schema belongs to. Pass it to GET /v6/report-types/{id}/schema to fetch this schema on its own.

⌘I

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Get report type schema

Authorizations

Path Parameters

Response