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
{
  "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>"
  }
}

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.