Skip to main content
GET
/
waap
/
v1
/
domains
/
{domain_id}
/
stats
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
waap_event_statistics = client.waap.domains.statistics.get_events_aggregated(
    domain_id=1,
    start="2024-04-13T00:00:00+01:00",
)
print(waap_event_statistics.blocked)
{
  "count": {
    "action": [
      [
        "<string>"
      ]
    ],
    "country": [
      [
        "<string>"
      ]
    ],
    "org": [
      [
        "<string>"
      ]
    ],
    "rule_name": [
      [
        "<string>"
      ]
    ]
  },
  "blocked": {
    "action": [
      [
        "<string>"
      ]
    ],
    "country": [
      [
        "<string>"
      ]
    ],
    "org": [
      [
        "<string>"
      ]
    ],
    "rule_name": [
      [
        "<string>"
      ]
    ]
  }
}

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

​
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.

​
reference_id
string[] | null

A list of reference IDs to filter event statistics.

​
action
enum<string>[] | null

A list of action names to filter on.

Available options:
block,
captcha,
handshake,
monitor
​
result
enum<string>[] | null

A list of results to filter event statistics.

Available options:
passed,
blocked,
monitored,
allowed

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