Get request log data

Retrieve request log data over account’s domains. The log records every request passing through WAAP towards the origin server.

GET /waap/v1/analytics/requests

Python

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
)
page = client.waap.analytics.get_requests(
    start="2024-04-13T00:00:00+01:00",
)
page = page.results[0]
print(page.id)

package main

import (
	"context"
	"fmt"

	"github.com/G-Core/gcore-go"
	"github.com/G-Core/gcore-go/option"
	"github.com/G-Core/gcore-go/waap"
)

func main() {
	client := gcore.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.Waap.Analytics.GetRequests(context.TODO(), waap.AnalyticsGetRequestsParams{
		Start: "2024-04-13T00:00:00+01:00",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

curl --request GET \
  --url https://api.gcore.com/waap/v1/analytics/requests \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/waap/v1/analytics/requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/waap/v1/analytics/requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/waap/v1/analytics/requests")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/waap/v1/analytics/requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "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,
      "traffic_types": "<string>",
      "decision": "blocked",
      "optional_action": "captcha",
      "session_id": "",
      "scheme": "https",
      "http_version": "1.1",
      "ja3": "e7d705a3286e19ea42f587b344ee6865"
    }
  ]
}

{
  "type": "http-bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "Invalid domain name: ''''"
}

{
  "detail": "Auth token is missing or invalid"
}

{
  "detail": "Permission denied"
}

{
  "type": "http-not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "The resource is not found"
}

{
  "type": "request-validation-failed",
  "title": "Request validation error.",
  "status": 422,
  "detail": "One or more fields have validation errors.",
  "errors": [
    {
      "loc": [
        "body",
        "name"
      ],
      "detail": "Input should be a valid string"
    },
    {
      "loc": [
        "body",
        "date"
      ],
      "detail": "Field required"
    },
    {
      "loc": [
        "query",
        "limit"
      ],
      "detail": "Field required"
    }
  ]
}

{
  "type": "internal-server-error",
  "title": "Internal server error.",
  "status": 500,
  "detail": "An unexpected condition was encountered which prevented the server from fulfilling the request."
}

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.

Pattern: ^\w{2}$

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.

Pattern: ^[a-f0-9]{32}$

request_ids · string[]

Filter data by request IDs.

Pattern: ^[a-f0-9]{32}-[0-9]{6}$

session_ids · string[]

Filter data by session IDs.

Pattern: ^[a-f0-9]{32}$

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:

["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"]

exclude_ips · string<ipvanyaddress>[]

Exclude traffic data by client IP.

Example:

["1.2.3.4", "2001:678:194::3c25:ddad"]

exclude_countries · string[]

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

Pattern: ^\w{2}$

Example:

["DE", "MY"]

exclude_session_ids · string[]

Exclude data by session IDs.

Pattern: ^[a-f0-9]{32}$

exclude_reference_ids · string[]

Exclude data by reference IDs.

Pattern: ^[a-f0-9]{32}$

exclude_security_rule_names · string[]

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

Maximum string length: 100

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

Example:

["SQL injection"]

exclude_domains · integer[]

Exclude data by domain ID.

ja3 · string | null

Filter by JA3 TLS client fingerprint. When present, the value must be exactly 32 hexadecimal characters (mixed case allowed) and is case-folded to lowercase when the backend filter is built. Omit the parameter entirely to apply no JA3 filter.

Pattern: ^[0-9a-fA-F]{32}$

Example:

"e7d705a3286e19ea42f587b344ee6865"

user_agent · string | null

Include entries whose user agent contains the supplied text, case-insensitive partial match. Omit the parameter to apply no user agent text filter.

Maximum string length: 300

Example:

"Mozilla/5.0"

user_agent_clients · string[]

Include entries whose parsed user agent client exactly equals any supplied value. Omit or provide an empty list to apply no user agent client filter.

Maximum array length: 10

Maximum string length: 50

Example:

["Chrome", "Firefox"]

user_agent_devices · string[]

Include entries whose parsed user agent device exactly equals any supplied value. Omit or provide an empty list to apply no user agent device filter.

Maximum array length: 10

Maximum string length: 50

Example:

["mac", "Nokia", "PlayStation"]

tags · string[]

Include entries whose tag exactly equals any supplied value. Omit or provide an empty list to apply no tag filter.

Maximum array length: 5

Maximum string length: 50

Example:

["evasiveclient", "injectionattack"]

organizations · string[]

Include entries whose organization exactly equals any supplied value. Omit or provide an empty list to apply no organization filter.

Maximum array length: 10

Maximum string length: 100

Example:

["Example Org", "Acme Corp"]

exclude_user_agent · string | null

Exclude entries whose user agent contains the supplied text, case-insensitive partial match. Omit the parameter to apply no user agent text exclusion.

Maximum string length: 300

Example:

"python-requests"

exclude_user_agent_clients · string[]

Exclude entries whose parsed user agent client exactly equals any supplied value. Omit or provide an empty list to apply no user agent client exclusion.

Maximum array length: 10

Maximum string length: 50

Example:

["OpenAI GPTBot", "Uptimerobot"]

exclude_user_agent_devices · string[]

Exclude entries whose parsed user agent device exactly equals any supplied value. Omit or provide an empty list to apply no user agent device exclusion.

Maximum array length: 10

Maximum string length: 50

Example:

["SMART TV"]

exclude_ja3 · string | null

Exclude entries whose JA3 TLS client fingerprint equals the supplied value. Must be exactly 32 hexadecimal characters (mixed case allowed) and is case-folded to lowercase when the backend filter is built. Omit the parameter to apply no JA3 exclusion.

Pattern: ^[0-9a-fA-F]{32}$

Example:

"e7d705a3286e19ea42f587b344ee6865"

exclude_tags · string[]

Exclude entries whose tag exactly equals any supplied value. Omit or provide an empty list to apply no tag exclusion.

Maximum array length: 5

Maximum string length: 50

Example:

["mousedevice"]

exclude_organizations · string[]

Exclude entries whose organization exactly equals any supplied value. Omit or provide an empty list to apply no organization exclusion.

Maximum array length: 10

Maximum string length: 100

Example:

["Acme corp"]

Response

200

application/json

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

Show child attributes