Skip to main content
GET
/
waap
/
v1
/
analytics
/
traffic-filtered
Get filtered traffic data
curl --request GET \
  --url https://api.gcore.com/waap/v1/analytics/traffic-filtered \
  --header 'Authorization: <api-key>'
[
  {
    "timestamp": 123,
    "passed": 0,
    "blocked": 0,
    "monitored": 0,
    "allowed": 0
  }
]

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

Query Parameters

​
domains
integer[]

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

Domain ID

Example:
[1, 2, 3]
​
resolution
enum<string>
required

Specifies the granularity of the result data.

Available options:
daily,
hourly,
minutely
​
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 traffic data by client IP.

Example:
["1.2.3.4", " 2001:678:194::3c25:ddad"]
​
path
string | null

Filter by URL path with a glob-like pattern.

Example:

"/home"

​
countries
string[]

Filter data by a country code of the originating IP address in ISO 3166-1 alpha-2 format.

Example:
["DE", "MY"]
​
status_codes
integer[]

Filter data by HTTP response status code.

Required range: 100 <= x <= 599
Example:
["403", "499"]
​
http_methods
enum<string>[]

Filter by HTTP methods

An HTTP method of a request.

Available options:
DELETE,
GET,
HEAD,
OPTIONS,
PATCH,
POST,
PUT,
TRACE
Example:
["GET", "HEAD"]
​
reference_ids
string[]

Filter data by reference IDs.

​
request_ids
string[]

Filter data by request IDs.

​
session_ids
string[]

Filter data by session IDs.

​
security_rule_names
string[]

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

Maximum string length: 100
Example:
["SQL injection"]
​
decision
enum<string>[]

Filter data by decision.

Filter data by the event decision.

Available options:
blocked,
monitored,
allowed,
passed
Example:
["allowed", "blocked"]
​
optional_action
enum<string>[]

Filter data by optional action.

Filter data by the optional action.

Available options:
captcha,
challenge
Example:
["captcha", "challenge"]

Response

Successful Response

​
timestamp
integer
required

UNIX timestamp indicating when the traffic data was recorded

​
passed
integer
default:0

Traffic (number of requests) that was passed to the origin and didn't trigger any rules

​
blocked
integer
default:0

Traffic blocked by a security policy, custom rule, or DDoS protection

​
monitored
integer
default:0

Traffic that was identified as malicious by security policies (for monitored domains)

​
allowed
integer
default:0

Traffic passed due to a permissive security rule