Show search and navigation.

 

Get Top Event Log Entries

WAF Insights does not support automation via our REST API web service. If you are currently using WAF Insights, upgrade your WAF solution to take advantage of our REST API.

Provides the top events over a given time period.

This endpoint only supports JSON.

Request

A request to retrieve the top occurring event log entries is described below.

HTTP Method Request URI

GET

https://api.transactcdn.com/v2/mcc/customers/AccountNumber/defend/rate_limiting/eventlogs/top?field=Field& start_time=StartDateTime&end_time=EndDateTime&page_size=ItemsPerPage

Define the following terms when submitting the above request:

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).

Description

AccountNumber

Required

Replace this variable with a customer account number. This account number may be found in the upper left-hand corner of the TCC.

Field

Required

Replace this variable with the name of the desired field. Use the Get Available Event Log Fields (Rate Limiting) endpoint to retrieve a list of the available fields (i.e., friendly_name).

ClosedFields & 500 Internal Server Error

Invalid syntax may generate a 500 Internal Server Error. Avoid the following syntax issues:

  • The syntax for this parameter is "?field=field." Enclosing the desired field name in quotes (e.g., ?field="Host") may generate an error.
  • A field name is invalid if it is misspelled or if it uses the wrong case (e.g., HOST). Use the Get Available Event Log Fields (Rate Limiting) endpoint to retrieve a list of valid field names.

  • Replace spaces with %20.

    Example:

    field=Rate%20Limiting%20Enforcement%20Rule%20ID

StartDateTime

Required

Replace this variable with the start date/time for the report. Only the top events that took place after the specified date/time will be included in the report.

Format:YYYY-MM-DDThh:mm:ss

Key information:

  • Time (i.e., Thh:mm:ss) is optional when defining a start and end date/time. If time is not specified, then a default time (i.e., 00:00:00) will be used.

For more information on date/time format, please refer to Report Date/Time Format.

EndDateTime

Required

Replace this variable with the end date/time for the report. Only the top events that took place before the end of the specified date/time will be included in the report.

Format:YYYY-MM-DDThh:mm:ss

For more information on date/time format, please refer to Report Date/Time Format.

ItemsPerPage

Replace this variable with the number of log events that may be included on each page.

Key information:

  • Omitting the page_size query string parameter in the request will return a maximum of 10 log events per page.
  • The maximum value for this variable is 100.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Request Body

Request body parameters are not required by this endpoint.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request contains the following response parameters:

Name Data Type Description
time_to

Number

floating-point

Indicates the report's end date/time, in seconds, using Unix time.

Sample value:

1414022400.0
total Integer Indicates the total number of requests that occurred during the requested date range that satisfied at least one of the specified filters.

time_from

Number

floating-point

Indicates the report's start date/time, in seconds, using Unix time.

Sample value:

1414022400.0

results

Array

Contains the results for the requested report.

count

Integer

results array

Indicates the total number of requests that occurred during the requested date range that satisfy both of the following:

  • The criteria defined in the filters query string parameter.
  • The value defined in the term response parameter.

term

String

results array

Indicates a unique value for the field defined in the request (i.e., ?field=Field)

Errors

The response body for an unsuccessful request will contain an error response that provides additional information.

View common error messages.

Sample Request and Response

A sample JSON request is shown below.

GET https://api.transactcdn.com/v2/mcc/customers/0001/defend/rate_limiting/eventlogs/top?field=Referer&start_time=2015-10-28&end_time=2015-11-05 HTTP/1.1

Authorization: TOK:12345678-1234-1234-1234-1234567890ab

Accept: application/json

Content-Type: application/json

Host:api.transactcdn.com

A sample JSON response is shown below.

HTTP/1.1 200 OK

Cache-Control: private

Content-Type: application/json; charset=utf-8

Date: Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 262

{
	"time_to" : 1446681600.0,
	"total" : 13100,
	"time_from" : 1445990400.0,
	"results" : [{
			"count" : 8700,
			"term" : "www.exampledomain1.com"
		}, {
			"count" : 4400,
			"term" : "www.exampledomain2.com"
		}
	]
}