Skip to main content
GET
Get Simple Event Statistics

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

dimension
enum<string>
required

A request characteristics dimension

Available options:
country,
rule,
org,
ip,
useragent,
target

Query Parameters

domains
integer[]

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

Domain ID

Example:
order_by
enum<string>
default:total.desc

Ordering applied to the ranked points within the dimension. total.desc ranks by total event count descending; threats.desc ranks by threat (blocked and monitored) event count descending.

Available options:
total.desc,
threats.desc
start
string
required

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

Example:

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

end
string | null

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"

ips
string<ipvanyaddress>[]

Filter statistics by client IP addresses (max 10).

Maximum array length: 10
Example:
security_rule_names
string[]

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

Maximum string length: 100
Pattern: ^[a-zA-Z0-9_ ~!@#$%^&*()+\[\]{}|.,;:<>?/-]*$
Example:

Response

Successful Response

A collection of event counts per dimension values over a time span.

total
tuple[]
required

Total number of observed requests. First element of the tuple is a key, the second one is its counter value. The key refers to a point in the requested dimension (e.g., an IP address). Results are ordered by the counter value in descending order.

Example:
blocked
tuple[]
required

Number of blocked request events, with the same keys and formatted the same as in the total field.

Example:
suppressed
tuple[]
required

Number of requests observed in monitoring mode that would have been blocked otherwise.

Example:
allowed
tuple[]
required

Number of requests passed due to a permissive security rule.

Example:
reference
Reference · object | null
required

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

Example: