Skip to main content
GET
/
shield
/
metrics
/
overview
/
{shieldZoneId}
/
detailed
Get a detailed metrics overview for the specified Shield Zone within the selected time range and resolution
curl --request GET \
  --url https://api.bunny.net/shield/metrics/overview/{shieldZoneId}/detailed
import requests

url = "https://api.bunny.net/shield/metrics/overview/{shieldZoneId}/detailed"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.bunny.net/shield/metrics/overview/{shieldZoneId}/detailed', 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}/detailed",
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}/detailed"

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}/detailed")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.bunny.net/shield/metrics/overview/{shieldZoneId}/detailed")

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": {
    "waf": {
      "metrics": {},
      "totals": {}
    },
    "ddos": {
      "metrics": {},
      "totals": {}
    },
    "rateLimit": {
      "metrics": {},
      "totals": {}
    },
    "accessLists": {
      "metrics": {},
      "totals": {}
    },
    "botDetection": {
      "metrics": {},
      "totals": {}
    },
    "uploadScanning": {
      "metrics": {},
      "totals": {}
    },
    "apiGuardian": {
      "metrics": {},
      "totals": {}
    },
    "totalCleanRequestsLimit": 123,
    "totalBillableRequestsThisMonth": 123
  },
  "error": {
    "success": true,
    "message": "<string>",
    "errorKey": "<string>"
  }
}
{
"statusCode": 123
}

Path Parameters

shieldZoneId
integer<int32>
required

The ID of the Shield Zone.

Query Parameters

StartDate
string<date-time>
EndDate
string<date-time>
Resolution
enum<integer>

0 = Auto 1 = TwoMinutes 2 = TenMinutes 3 = Hourly 4 = Daily 5 = Weekly 6 = Monthly

Available options:
0,
1,
2,
3,
4,
5,
6

Response

OK

data
object
error
object

Generic response object containing status information for API operations.

Last modified on June 26, 2026