cURL
curl --request POST \
--url 'https://api.edgeful.com/v1/settings/report-customizations' \
--header 'Authorization: Bearer <api-key>' \
--header 'Content-Type: application/json' \
--data '{"changes": [{"setting_key": "ADR", "values": {"value": 10}}]}'import requests
url = "https://api.edgeful.com/v1/settings/report-customizations"
headers = {"Authorization": "Bearer <api-key>"}
payload = {'changes': [{'setting_key': 'ADR', 'values': {'value': 10}}]}
response = requests.post(url, headers=headers, json=payload)
print(response.json())const url = "https://api.edgeful.com/v1/settings/report-customizations";
const options = {
method: "POST",
headers: { Authorization: "Bearer <api-key>", "Content-Type": "application/json" },
body: JSON.stringify({"changes": [{"setting_key": "ADR", "values": {"value": 10}}]}),
};
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");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <api-key>", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"changes": [{"setting_key": "ADR", "values": {"value": 10}}]}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://api.edgeful.com/v1/settings/report-customizations", strings.NewReader(`{"changes": [{"setting_key": "ADR", "values": {"value": 10}}]}`))
req.Header.Set("Authorization", "Bearer <api-key>")
req.Header.Set("Content-Type", "application/json")
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"))
.header("Authorization", "Bearer <api-key>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"changes\": [{\"setting_key\": \"ADR\", \"values\": {\"value\": 10}}]}"))
.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")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <api-key>"
request["Content-Type"] = "application/json"
request.body = '{"changes": [{"setting_key": "ADR", "values": {"value": 10}}]}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts response.body{
"status": "<string>",
"settings": [
{
"setting_key": "<string>",
"status": "<string>",
"previous": {},
"values": {},
"pages": [
{}
],
"activation": {}
}
],
"changed": {
"updated": [
"<string>"
],
"reset": [
"<string>"
]
}
}settings
update report customizations
set or reset report-page customizations: each change names a setting_key with values by stored slot (value, value2, …) or reset true. values are checked the way the customization modal checks them, unspecified slots keep their current values, and one invalid change refuses the whole batch. each record returns the key’s previous and resulting values; send previous back to undo. this changes your account, and Edgeful shows the change after a reload. requires the key’s write permission.
POST
/
v1
/
settings
/
report-customizations
cURL
curl --request POST \
--url 'https://api.edgeful.com/v1/settings/report-customizations' \
--header 'Authorization: Bearer <api-key>' \
--header 'Content-Type: application/json' \
--data '{"changes": [{"setting_key": "ADR", "values": {"value": 10}}]}'import requests
url = "https://api.edgeful.com/v1/settings/report-customizations"
headers = {"Authorization": "Bearer <api-key>"}
payload = {'changes': [{'setting_key': 'ADR', 'values': {'value': 10}}]}
response = requests.post(url, headers=headers, json=payload)
print(response.json())const url = "https://api.edgeful.com/v1/settings/report-customizations";
const options = {
method: "POST",
headers: { Authorization: "Bearer <api-key>", "Content-Type": "application/json" },
body: JSON.stringify({"changes": [{"setting_key": "ADR", "values": {"value": 10}}]}),
};
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");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <api-key>", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"changes": [{"setting_key": "ADR", "values": {"value": 10}}]}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://api.edgeful.com/v1/settings/report-customizations", strings.NewReader(`{"changes": [{"setting_key": "ADR", "values": {"value": 10}}]}`))
req.Header.Set("Authorization", "Bearer <api-key>")
req.Header.Set("Content-Type", "application/json")
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"))
.header("Authorization", "Bearer <api-key>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"changes\": [{\"setting_key\": \"ADR\", \"values\": {\"value\": 10}}]}"))
.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")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <api-key>"
request["Content-Type"] = "application/json"
request.body = '{"changes": [{"setting_key": "ADR", "values": {"value": 10}}]}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts response.body{
"status": "<string>",
"settings": [
{
"setting_key": "<string>",
"status": "<string>",
"previous": {},
"values": {},
"pages": [
{}
],
"activation": {}
}
],
"changed": {
"updated": [
"<string>"
],
"reset": [
"<string>"
]
}
}Authorizations
Send your Edgeful API key in the Authorization header as Bearer <api-key> (for example, Bearer ef_live_<random>).
Body
application/json
one entry per setting key, each setting slot values or reset; one invalid entry refuses the whole batch.
Required array length:
1 - 100 elementsShow child attributes
Show child attributes
Was this page helpful?