Help Center> Web Application Firewall> API Reference> API> Dashboard> Querying Website Bandwidth Usage Statistics
View PDF

Querying Website Bandwidth Usage Statistics

Function

This API is used to query the website bandwidth usage statistics.

Debugging

You can use API Explorer to debug this API.

URI

GET /v1/{project_id}/waf/overviews/bandwidth/timeline

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID
Table 2 Query parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID

from

Yes

Long

Start time, which is a 13-digit timestamp in millisecond

to

Yes

Long

End time, which is a 13-digit timestamp in millisecond

hosts

No

String

List of domain names to query, which can be obtained by calling the ListHost API

instances

No

String

List of instance to query (only for the instantiation mode).

group_by

No

String

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

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Tenant token

Content-Type

Yes

String

Content type

Default: application/json;charset=utf8

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

[items]

Array of StatisticsTimelineItem objects

Timeline of security statistics
Table 5 StatisticsTimelineItem

Parameter

Type

Description

key

String

Key value

timeline

Array of TimeLineItem objects

Timeline corresponding to the key value
Table 6 TimeLineItem

Parameter

Type

Description

time

Long

Time

num

Integer

Quantity

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

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.

Parent topic: Dashboard