Skip to main content
GET
/
waap
/
v1
/
analytics
/
requests
Get request log data
curl --request GET \
  --url https://api.gcore.com/waap/v1/analytics/requests \
  --header 'Authorization: <api-key>'
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "results": [
    {
      "id": "<string>",
      "path": "<string>",
      "client_ip": "<string>",
      "method": "<string>",
      "rule_name": "<string>",
      "country": "<string>",
      "action": "<string>",
      "rule_id": "<string>",
      "domain": "<string>",
      "domain_id": 123,
      "user_agent": "<string>",
      "user_agent_client": "<string>",
      "organization": "<string>",
      "request_time": 123,
      "reference_id": "<string>",
      "status_code": 123,
      "result": "passed",
      "traffic_types": "<string>",
      "decision": "passed",
      "optional_action": "captcha",
      "session_id": ""
    }
  ]
}

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]
​
ordering
string

Sort data by given field.

Examples:

"userAgent"

"-requestTime"

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

​
limit
integer
default:100

Number of items to return

Required range: 0 <= x <= 100
​
offset
integer
default:0

Number of items to skip

Required range: 0 <= x <= 100000
​
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

​
limit
integer
required

Number of items requested in the response

​
offset
integer
required

Items response offset used

​
count
integer
required

Number of items contain in the response

​
results
RequestSummary · object[]
required

List of items returned in the response following given criteria