Help Center/ Web Application Firewall/ API Reference/ APIs/ Dashboard/ Querying Response Code Statistics
Updated on 2025-08-19 GMT+08:00

Querying Response Code Statistics

Function

This API is used to query response code statistics.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/waf/overviews/response-code/timeline

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

from

Yes

Integer

Definition

Start time.

Constraints

N/A

Range

N/A

Default Value

N/A

to

Yes

Integer

Definition

End time.

Constraints

N/A

Range

N/A

Default Value

N/A

hosts

No

String

Definition

List of the domain names for the query.

Constraints

N/A

Range

N/A

Default Value

N/A

instances

No

String

Definition

List of instances for the query.

Constraints

N/A

Range

N/A

Default Value

N/A

response_source

No

String

Definition

Response source.

Constraints

N/A

Range

WAF and UPSTREAM.

Default Value

N/A

group_by

No

String

Definition

Display dimension. For example, the value is DAY if data is displayed by the day.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

N/A

Default Value

application/json;charset=utf8

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

[items]

Array of StatisticsTimelineItem objects

Definition

Timeline of security statistics. Statistics is displayed in time sequence.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 5 StatisticsTimelineItem

Parameter

Type

Description

key

String

Definition

Key value

Range

  • Total number of requests (ACCESS)

  • Bot attack defense (CRAWLER)

  • Total Attacks (ATTACK)

  • Basic web protection (WEB_ATTACK)

  • Precise Protection (PRECISE)

  • CC attack defense (CC)

timeline

Array of TimeLineItem objects

Statistics data over time for the corresponding key value

Table 6 TimeLineItem

Parameter

Type

Description

time

Long

Definition

Time.

Range

N/A

num

Integer

Definition

time: indicates the statistical value in the interval between the time point and the previous time point.

Range

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 8 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 10 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 12 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

ok

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.