Get an overview of metrics for the specified Shield Zone
curl --request GET \
--url https://api.bunny.net/shield/metrics/overview/{shieldZoneId}import requests
url = "https://api.bunny.net/shield/metrics/overview/{shieldZoneId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.bunny.net/shield/metrics/overview/{shieldZoneId}', 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.bunny.net/shield/metrics/overview/{shieldZoneId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.bunny.net/shield/metrics/overview/{shieldZoneId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.bunny.net/shield/metrics/overview/{shieldZoneId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bunny.net/shield/metrics/overview/{shieldZoneId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"overview": {
"dDoSMitigated": 123,
"wafTriggeredRules": 123,
"ratelimitBreaches": 123,
"botDetectionChallenged": 123,
"accessListActions": 123,
"uploadScanningBlocks": 123,
"apiGuardianBlocks": 123
},
"waf": {
"totalTriggeredRules": 123,
"blockedRequests": 123,
"loggedRequests": 123,
"challengedRequests": 123
},
"overviewPastTwentyEightDays": {},
"dDoS": {
"loggedRequests": 123,
"verifiedRequests": 123,
"blockedRequests": 123,
"challengedRequests": 123
},
"dDoSOverviewPastTwentyEightDays": {},
"ratelimit": {
"totalBreaches": 123,
"loggedBreaches": 123,
"challengedBreaches": 123,
"blockedBreaches": 123
},
"ratelimitOverviewPastTwentyEightDays": {},
"botDetection": {
"loggedRequests": 123,
"challengedRequests": 123
},
"botDetectionOverviewPastTwentyEightDays": {},
"accessList": {
"totalActions": 123,
"blockedRequests": 123,
"loggedRequests": 123,
"challengedRequests": 123
},
"accessListOverviewPastTwentyEightDays": {},
"uploadScanningOverviewPastTwentyEightDays": {},
"apiGuardian": {
"blockedRequests": 123,
"loggedRequests": 123,
"rateLimited": 123,
"requestsInspected": 123,
"failedRequestValidation": 123,
"failedAuthenticationEnforcement": 123
},
"apiGuardianOverviewPastTwentyEightDays": {},
"totalCleanRequestsLimit": 123,
"totalBillableRequests": 123,
"uploadScanning": {
"loggedRequests": 123,
"blockedRequests": 123,
"filesScanned": 123
}
},
"error": {
"success": true,
"message": "<string>",
"errorKey": "<string>"
}
}{
"statusCode": 123
}Metrics
Get an overview of metrics for the specified Shield Zone
GET
/
shield
/
metrics
/
overview
/
{shieldZoneId}
Get an overview of metrics for the specified Shield Zone
curl --request GET \
--url https://api.bunny.net/shield/metrics/overview/{shieldZoneId}import requests
url = "https://api.bunny.net/shield/metrics/overview/{shieldZoneId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.bunny.net/shield/metrics/overview/{shieldZoneId}', 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.bunny.net/shield/metrics/overview/{shieldZoneId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.bunny.net/shield/metrics/overview/{shieldZoneId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.bunny.net/shield/metrics/overview/{shieldZoneId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bunny.net/shield/metrics/overview/{shieldZoneId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"overview": {
"dDoSMitigated": 123,
"wafTriggeredRules": 123,
"ratelimitBreaches": 123,
"botDetectionChallenged": 123,
"accessListActions": 123,
"uploadScanningBlocks": 123,
"apiGuardianBlocks": 123
},
"waf": {
"totalTriggeredRules": 123,
"blockedRequests": 123,
"loggedRequests": 123,
"challengedRequests": 123
},
"overviewPastTwentyEightDays": {},
"dDoS": {
"loggedRequests": 123,
"verifiedRequests": 123,
"blockedRequests": 123,
"challengedRequests": 123
},
"dDoSOverviewPastTwentyEightDays": {},
"ratelimit": {
"totalBreaches": 123,
"loggedBreaches": 123,
"challengedBreaches": 123,
"blockedBreaches": 123
},
"ratelimitOverviewPastTwentyEightDays": {},
"botDetection": {
"loggedRequests": 123,
"challengedRequests": 123
},
"botDetectionOverviewPastTwentyEightDays": {},
"accessList": {
"totalActions": 123,
"blockedRequests": 123,
"loggedRequests": 123,
"challengedRequests": 123
},
"accessListOverviewPastTwentyEightDays": {},
"uploadScanningOverviewPastTwentyEightDays": {},
"apiGuardian": {
"blockedRequests": 123,
"loggedRequests": 123,
"rateLimited": 123,
"requestsInspected": 123,
"failedRequestValidation": 123,
"failedAuthenticationEnforcement": 123
},
"apiGuardianOverviewPastTwentyEightDays": {},
"totalCleanRequestsLimit": 123,
"totalBillableRequests": 123,
"uploadScanning": {
"loggedRequests": 123,
"blockedRequests": 123,
"filesScanned": 123
}
},
"error": {
"success": true,
"message": "<string>",
"errorKey": "<string>"
}
}{
"statusCode": 123
}Last modified on June 26, 2026
Was this page helpful?
Get the overage breakdown for the specified Shield Zone for a given month, segmented by billing plan changesGet a detailed metrics overview for the specified Shield Zone within the selected time range and resolution
⌘I