Help Center/ Edge Security/ API Reference/ API/ HTTP Statistics/ Querying the Timeline Data of HTTP Attack Statistics
Updated on 2024-11-18 GMT+08:00

Querying the Timeline Data of HTTP Attack Statistics

Function

This API is used to query the timeline data of HTTP attack statistics.

URI

GET /v1/edgesec/stat/http-attack-timelines

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). The default value is 0.

domain_name

No

String

Domain name.

stat_type

Yes

String

Metric type. Currently, only req_num is supported.

group_by

Yes

String

Group type. Currently, only action and attack_category are supported.

group_by_value

No

String

Value corresponding to the group type. (If this parameter is not passed, the total value is used by default.) For example, the action metric type can be log, block, captcha, or js_challenge, and the attack_category metric type can be cc, access_control, bot, or web_app_attack.

interval

Yes

Integer

Time granularity (unit: second). Different time ranges have different time granularities. For the time rage of [0,1H], the available time granularities are 1M and 5M. For the time range of (1H,1D], the available time granularities are 1M, 5M, and 1H. For the time range of (1D,3D], the available time granularities are 1M, 5M, 1H, and 1D. For the time range of (3D,7D], the available time granularities are 5M, 1H, and 1D. For the time range of (7D,30D], the available time granularities are 1H and 1D. M indicates minute, H indicates hour, and D indicates day.

start_time

Yes

Long

Start time

end_time

Yes

Long

End time

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Tenant token

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

stat_type

String

Metric type

group_by

String

Group type

group_by_value

String

Value corresponding to the group type

interval

Integer

Time granularity (s)

values

Array of TimeStatItem objects

Value array

Table 4 TimeStatItem

Parameter

Type

Description

key

Long

Timestamp, which is left aligned with the time granularity. For example, if the time granularity is 5 minutes and the time range is [19:10,19:15), the timestamp is 19:10.

value

Long

Number of attack requests

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.