Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Reporting

Retrieve WAF firewall events report.

For given site it checks cloudflare stats to get WAF firewall events data and returns it.

get/v1/reporting/sites/{id}/waf/firewall-events

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Query parameters

duration'30m' | '1h' | '6h' | '12h' | '24h' | '72h' | '7d' | '30d' required

Duration that the listed data is for (m = minutes, h = hours, d = days)

Example:7d

Response

OK

errorsstring[]
allowTotalinteger

Events where the rule allowed the visit

blockTotalinteger

Events where the rule blocked the visit

challengeTotalinteger

Events where the rule caused a challenge to be solved before the visit

skipTotalinteger

Events where the rule skipped the Web Application Firewall (WAF)

Example response

{
  "errors": [
    "bf095f43-72a7-45cc-b4c3-cfbace9695cb"
  ],
  "data": {
    "viewer": {
      "__typename": "viewer",
      "zones": [
        {
          "__typename": "zone",
          "series": [
            {
              "__typename": "ZoneFirewallEventsAdaptiveGroups",
              "avg": {
                "__typename": "ZoneFirewallEventsAdaptiveGroupsAvg",
                "sampleInterval": 3.8457300275482096
              },
              "count": 25661,
              "dimensions": {
                "typename": "ZoneFirewallEventsAdaptiveGroupsDimensions",
                "metric": "100016",
                "ts": "2024-08-19T20:05:00Z"
              }
            }
          ]
        }
      ]
    }
  },
  "allowTotal": 10,
  "blockTotal": 6130,
  "challengeTotal": 100,
  "skipTotal": 10
}