Skip to main content
GET
/
waap
/
v1
/
analytics
/
stats
/
{dimension}
Get Simple Event Statistics
curl --request GET \
  --url https://api.gcore.com/waap/v1/analytics/stats/{dimension} \
  --header 'Authorization: <api-key>'
{
  "total": [
    [
      "<string>",
      123
    ]
  ],
  "blocked": [
    [
      "<string>",
      123
    ]
  ],
  "suppressed": [
    [
      "<string>",
      123
    ]
  ],
  "allowed": [
    [
      "<string>",
      123
    ]
  ],
  "reference": {
    "1.2.3.4": {
      "country": "SG",
      "org": "Singapore Networks"
    }
  }
}

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

​
dimension
enum<string>
required

A request characterisics dimension

Available options:
country,
rule,
org,
action,
ip,
useragent,
target

Query Parameters

​
domains
integer[]

Set of domains

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

Response

Successful Response

A collection of event counts per dimension values over a time span.

​
total
tuple[]
required

Total number of observed requests. First element of the tuple is a key, the second one is its counter value. The key refers to a point in the requested dimension (e.g., an IP address). Results are ordered by the counter value in descending order.

Example:
[["1.2.3.4", 100000], ["5.6.7.8", 80000]]
​
blocked
tuple[]
required

Number of blocked request events, with the same keys and formatted the same as in the total field.

Example:
[["1.2.3.4", 2000], ["5.6.7.8", 1000]]
​
suppressed
tuple[]
required

Number of requests observed in monitoring mode that would have been blocked otherwise.

Example:
[["1.2.3.4", 1500], ["5.6.7.8", 1100]]
​
allowed
tuple[]
required

Number of requests passed due to a permissive security rule.

Example:
[["1.2.3.4", 1000], ["5.6.7.8", 900]]
​
reference
Reference · object
required

Additional information, depending on the selected dimension. Keys refer to the items in the result (first value of a tuple).

Example:
{
  "1.2.3.4": {
    "country": "SG",
    "org": "Singapore Networks"
  }
}