Usage

Daily traffic counters of a zone at the edge, requests, blocked requests, bytes and DNS queries.

Daily usage counters of a zone, as counted by the edge.

OperationEndpoint
Get zone usageGET /v1/orgs/{org}/zones/{zone}/usage

Get zone usage

GET /v1/orgs/{org}/zones/{zone}/usage

Returns the daily usage counters of the zone, requests, blocked requests, bytes and DNS queries, for the last 30 days by default.

Required role: readonly or higher.

Parameters

NameInTypeRequiredDescription
orgpathstring (uuid)YesOrganization id. Every route checks that it is the token's organization (otherwise 404).
zonepathstring (uuid)YesZone id (see List zones).
fromquerystring (date)NoFirst day (UTC). Default: 30 days ago.
toquerystring (date)NoLast day (UTC). Default: today.

Response

  • 200: Returns items, an array of Usage.
FieldTypeDescription
items[].zone_idstring (uuid)Zone id.
items[].daystring (date)Day (UTC).
items[].requestsintegerRequests.
items[].bytes_inintegerBytes received from visitors.
items[].bytes_outintegerBytes sent to visitors.
items[].blocked_requestsintegerBlocked requests.
items[].dns_queriesintegerDNS queries answered.

Example

curl "https://dash.openwaf.dev/v1/orgs/$OPENWAF_ORG/zones/6f1d2c3b-8a4e-4b7d-9c21-5e3f7a8b9c0d/usage?from=2026-10-01&to=2026-10-27" \
  -H "Authorization: Bearer $OPENWAF_TOKEN"
200
{
  "items": [
    {
      "zone_id": "6f1d2c3b-8a4e-4b7d-9c21-5e3f7a8b9c0d",
      "day": "2026-10-26",
      "requests": 182340,
      "bytes_in": 41230512,
      "bytes_out": 2318823104,
      "blocked_requests": 1204,
      "dns_queries": 95210
    }
  ]
}

Last updated:

↑↓ to navigate↵ to openesc to close