Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Analytics

Get Simple Event Statistics

Retrieves event statistics per given dimension of a request characteristics. A WAAP Event represents a request observed by the system. The report contains the total, blocked, suppressed, and allowed event counts for top ten points in the selected dimension.

get/waap/v1/analytics/stats/{dimension}

Path parameters

dimension'country' | 'rule' | 'org' | 'ip' | 'useragent' | 'target' required

A request characteristics dimension

A request characteristics dimension

Query parameters

domainsinteger[]

List of domain IDs. Empty list means all domains belonging to the current account.

List of domain IDs. Empty list means all domains belonging to the current account.

[
  1,
  2,
  3
]
startstring required

Filter data items starting from a specified date in ISO 8601 format

Example:2024-04-13T00:00:00+01:00

Filter data items starting from a specified date in ISO 8601 format

endstring nullable

Filter data items up to a specified end date in ISO 8601 format. If not provided, defaults to the current date and time.

Example:2024-04-14T12:00:00Z

Filter data items up to a specified end date in ISO 8601 format. If not provided, defaults to the current date and time.

ipsstring[]

Filter statistics by client IP addresses (max 10).

Filter statistics by client IP addresses (max 10).

[
  "1.2.3.4",
  "2001:678:194::3c25:ddad"
]
security_rule_namesstring[]

Filter data by name of a security rule matched the request.

Filter data by name of a security rule matched the request.

[
  "SQL injection"
]

Response

Successful Response

referenceobject nullable required

Additional information, depending on the selected dimension. Keys refer to the items in the result (first value of a tuple).

Example response

{
  "total": [
    [
      "1.2.3.4",
      100000
    ],
    [
      "5.6.7.8",
      80000
    ]
  ],
  "blocked": [
    [
      "1.2.3.4",
      2000
    ],
    [
      "5.6.7.8",
      1000
    ]
  ],
  "suppressed": [
    [
      "1.2.3.4",
      1500
    ],
    [
      "5.6.7.8",
      1100
    ]
  ],
  "allowed": [
    [
      "1.2.3.4",
      1000
    ],
    [
      "5.6.7.8",
      900
    ]
  ],
  "reference": {
    "1.2.3.4": {
      "country": "SG",
      "org": "Singapore Networks"
    }
  }
}