Data analytics fields

Updated at:

The ESA data analytics API returns fields covering traffic, requests, and cache status. Use these fields for in-depth analysis and business insights into your system performance.

Data Analytics

Metrics

Data analytics provides metrics such as response traffic, request count, request traffic, and page views. Use these metrics to assess traffic distribution, user behavior patterns, and system performance, and to identify potential issues.

Field name

Description

Traffic

The size of the response that the ESA node returns to the client. Unit: byte.

Requests

The number of requests.

RequestTraffic

The size of the client request. Unit: byte.

PageView

The number of page views.

Dimensions

Data analytics supports multiple dimensions for metrics, such as geographic distribution, user behavior, request details, cache status, and system performance. Use these dimensions to pinpoint issues, optimize operations, and improve user experience.

Field name

Description

ALL

Full data from the user dimension.

ClientASN

The autonomous system number (ASN) information parsed from the client IP address.

ClientBrowser

The type of the browser on the client.

ClientCountryCode

The ISO-3166 Alpha-2 Code parsed from the client IP address.

ClientDevice

The type of the client device.

ClientIP

The IP address of the client that establishes a connection with the ESA node.

ClientIPVersion

The IP version of the client that establishes a connection with the ESA node.

ClientISP

The Internet Service Provider (ISP) information parsed from the client IP address.

ClientOS

The operating system of the client.

ClientProvinceCode

The province information in the Chinese mainland parsed from the client IP address.

ClientRequestHost

The Host information in the client request.

ClientRequestMethod

The HTTP Method information of the client request.

ClientRequestPath

The path information of the client request.

ClientRequestProtocol

The protocol information of the client request.

ClientRequestQuery

The Query information in the client request.

ClientRequestReferer

The Referer information in the client request.

ClientRequestUserAgent

The User-Agent information in the client request.

ClientSSLProtocol

The SSL protocol version of the client. A hyphen (-) indicates that SSL is not used.

ClientXRequestedWith

The X-Requested-With request header from the client.

EdgeCacheStatus

The cache status of the client request.

EdgeResponseContentType

The Content-Type information in the response from the ESA node.

EdgeResponseStatusCode

The status code that the ESA node returns to the client.

OriginResponseStatusCode

The response status code from the origin server.

SiteId

The ID of the current site.

Version

The version number from version management.

Event Analytics

Metrics

Field name

Description

Requests

The number of requests.

Dimensions

Field name

Description

Action

The action taken by WAF (such as block or allow).

ALL

Full user dimension data.

ClientASN

The Autonomous System Number (ASN) information resolved from the client IP address.

ClientCountryCode

The ISO-3166 Alpha-2 Code resolved from the client IP address.

ClientIP

The IP address of the client that establishes a connection with the ESA node.

ClientISP

The Internet Service Provider (ISP) information resolved from the client IP address.

ClientRequestID

The ID of the client request.

ClientRequestHost

The Host information in the client request.

ClientRequestMethod

The HTTP Method information of the client request.

ClientRequestPath

The path information of the client request.

ClientRequestProtocol

The protocol information of the client request.

ClientRequestQuery

The Query information in the client request.

ClientRequestReferer

The Referer information of the client request.

ClientRequestUserAgent

The User-Agent information of the client request.

EdgeResponseStatusCode

The status code that the ESA node returns to the client.

JA3

The JA3 fingerprint of the TLS client.

JA4

The JA4 fingerprint of the TLS client.

RuleID

The ID of the WAF rule that was triggered.

SiteId

The ID of the current site.

Source

The WAF rule source or plugin type.

SourceType

The WAF rule source type.