curl --request GET \
--url 'https://api.edgeful.com/v1/settings/report-customizations?report=<report>' \
--header 'Authorization: Bearer <api-key>'import requests
url = "https://api.edgeful.com/v1/settings/report-customizations?report=<report>"
headers = {"Authorization": "Bearer <api-key>"}
response = requests.get(url, headers=headers)
print(response.json())const url = "https://api.edgeful.com/v1/settings/report-customizations?report=<report>";
const options = {
method: "GET",
headers: { Authorization: "Bearer <api-key>" },
};
const response = await fetch(url, options);
const data = await response.json();
console.log(data);<?php
$ch = curl_init("https://api.edgeful.com/v1/settings/report-customizations?report=<report>");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <api-key>"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.edgeful.com/v1/settings/report-customizations?report=<report>", nil)
req.Header.Set("Authorization", "Bearer <api-key>")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.edgeful.com/v1/settings/report-customizations?report=<report>"))
.header("Authorization", "Bearer <api-key>")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());require "net/http"
require "uri"
uri = URI("https://api.edgeful.com/v1/settings/report-customizations?report=<report>")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <api-key>"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts response.body{
"slots": [
{}
],
"setting_key": "<string>",
"status": "<string>",
"pages": [
{}
],
"report": "<string>",
"sub_report": "<string>",
"name": "<string>",
"markets": [
"<string>"
],
"url": "<string>",
"note": "<string>"
}{
"detail": "NQX is not a futures ticker Edgeful knows."
}{
"detail": {
"detail": "No active subscription with API access found.",
"code": "missing_entitlement"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}describe report customizations
describe a report page’s customizations (what its customization modal edits) by report and sub_report, or by setting_key: each slot’s stored key, label, domain, default, current value and the slot or page control that activates it, plus every page the setting key drives with the query that makes a report endpoint apply the saved values. works with writes off.
curl --request GET \
--url 'https://api.edgeful.com/v1/settings/report-customizations?report=<report>' \
--header 'Authorization: Bearer <api-key>'import requests
url = "https://api.edgeful.com/v1/settings/report-customizations?report=<report>"
headers = {"Authorization": "Bearer <api-key>"}
response = requests.get(url, headers=headers)
print(response.json())const url = "https://api.edgeful.com/v1/settings/report-customizations?report=<report>";
const options = {
method: "GET",
headers: { Authorization: "Bearer <api-key>" },
};
const response = await fetch(url, options);
const data = await response.json();
console.log(data);<?php
$ch = curl_init("https://api.edgeful.com/v1/settings/report-customizations?report=<report>");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <api-key>"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.edgeful.com/v1/settings/report-customizations?report=<report>", nil)
req.Header.Set("Authorization", "Bearer <api-key>")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.edgeful.com/v1/settings/report-customizations?report=<report>"))
.header("Authorization", "Bearer <api-key>")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());require "net/http"
require "uri"
uri = URI("https://api.edgeful.com/v1/settings/report-customizations?report=<report>")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <api-key>"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts response.body{
"slots": [
{}
],
"setting_key": "<string>",
"status": "<string>",
"pages": [
{}
],
"report": "<string>",
"sub_report": "<string>",
"name": "<string>",
"markets": [
"<string>"
],
"url": "<string>",
"note": "<string>"
}{
"detail": "NQX is not a futures ticker Edgeful knows."
}{
"detail": {
"detail": "No active subscription with API access found.",
"code": "missing_entitlement"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Send your Edgeful API key in the Authorization header as Bearer <api-key> (for example, Bearer ef_live_<random>).
Query Parameters
report page slug from the report catalog; give this or setting_key.
1 - 80sub-report slug of that page; standard when omitted.
1 - 80a setting key; give this or report.
1 - 80Response
Successful Response
each stored slot with its label, domain, default, current value and dependency.
Show child attributes
Show child attributes
the setting key the page stores, or null when the page has no customizations.
customized or defaults.
every report page the key drives, with the query that applies the saved values.
Show child attributes
Show child attributes
pages without customizations: the report page slug.
pages without customizations: the sub-report slug.
pages without customizations: the display name.
pages without customizations: the markets.
pages without customizations: the page in Edgeful.
pages without customizations: why there is nothing to describe.
Was this page helpful?