Skip to main content
GET
Get 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

domain_id
integer
required

The domain ID

Query Parameters

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"

ip
string<ipvanyaddress>[] | null

A list of IPs to filter event statistics.

Example:

"1.2.3.4"

reference_id
string[] | null

A list of reference IDs to filter event statistics.

Example:

"13a38422e6ddd05ff7ecee010286909b"

action
enum<string>[] | null

A list of action names to filter on.

An action applied to a request according to the security configuration.

Available options:
allow,
block,
captcha,
handshake
Example:

"block"

result
enum<string>[] | null

A list of results to filter event statistics.

Available options:
passed,
blocked,
monitored,
allowed
Example:

"passed"

Response

Successful Response

A collection of event metrics over a time span

count
Count · object
required

A collection of total numbers of events per criteria

blocked
Blocked · object
required

A collection of total numbers of events with blocked results per criteria