cURL
curl --request DELETE \
--url 'https://api.edgeful.com/v1/custom-reports/<definition_id>' \
--header 'Authorization: Bearer <api-key>'import requests
url = "https://api.edgeful.com/v1/custom-reports/<definition_id>"
headers = {"Authorization": "Bearer <api-key>"}
response = requests.delete(url, headers=headers)
print(response.json())const url = "https://api.edgeful.com/v1/custom-reports/<definition_id>";
const options = {
method: "DELETE",
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/custom-reports/<definition_id>");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
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("DELETE", "https://api.edgeful.com/v1/custom-reports/<definition_id>", 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/custom-reports/<definition_id>"))
.header("Authorization", "Bearer <api-key>")
.method("DELETE", 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/custom-reports/<definition_id>")
request = Net::HTTP::Delete.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{
"status": "<string>",
"definition_id": "<string>"
}custom reports
delete custom report
delete one of your saved custom reports and its stored runs; a default or attached conversation reference to it is cleared, and the builder conversation remains. a report that is not yours, or was already deleted, is a 404. this changes your account; requires the key’s write permission.
DELETE
/
v1
/
custom-reports
/
{definition_id}
cURL
curl --request DELETE \
--url 'https://api.edgeful.com/v1/custom-reports/<definition_id>' \
--header 'Authorization: Bearer <api-key>'import requests
url = "https://api.edgeful.com/v1/custom-reports/<definition_id>"
headers = {"Authorization": "Bearer <api-key>"}
response = requests.delete(url, headers=headers)
print(response.json())const url = "https://api.edgeful.com/v1/custom-reports/<definition_id>";
const options = {
method: "DELETE",
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/custom-reports/<definition_id>");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
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("DELETE", "https://api.edgeful.com/v1/custom-reports/<definition_id>", 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/custom-reports/<definition_id>"))
.header("Authorization", "Bearer <api-key>")
.method("DELETE", 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/custom-reports/<definition_id>")
request = Net::HTTP::Delete.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{
"status": "<string>",
"definition_id": "<string>"
}Authorizations
Send your Edgeful API key in the Authorization header as Bearer <api-key> (for example, Bearer ef_live_<random>).
Path Parameters
the saved custom report's id, from the list.
Was this page helpful?