Get Bandwidth

Retrieves the data sample of bandwidth, aggregated in 5-minute or 1-day intervals.

Request

Request-Line

POST /waap/v1.0/analytics/bandwidth HTTP/1.1

Request Parameters

Body Parameters

Parameter	Type	Required	Description
domains	String[]	Mandatory	Array of domain names, the max array size is 50.
startTime	String	Mandatory	Start time. Specify in UTC using the format yyyy-MM-ddTHH:mm:ssZ.
endTime	String	Mandatory	End time. Specify in UTC using the format yyyy-MM-ddTHH:mm:ssZ. If interval = minute, the time range between start and end cannot exceed 24 hours. If interval = day, the time range cannot exceed 90 days.
fillFixedTime	Boolean	Optional	Boolean value if need to fill in zero value for empty data. Values: true or false. Default value: false.
interval	String	Optional	Interval of data spot, could be "minute", "day". For "minute", data spot is for 5 minutes, and for "day", data spot is one day. Default is "minute".

Response

Response Body

Property name	Type	Required	Description
	Array	Mandatory	Array of Domain Bandwidth.

Object: Domain Bandwidth

Parameter	Type	Required	Description
domain	String	Mandatory	Name of domain.
bandwidths	Object	Mandatory	List of bandwidth data with 5 minutes interval. Array of Bandwidth.

Object: Bandwidth

Parameter	Type	Required	Description
timestamp	String	Mandatory	Specify in UTC using the format yyyy-MM-ddTHH:mm:ssZ. E.g., 2025-09-09T17:35:00Z will return data from 2025-09-09T17:35:00Z to 2025-09-09T17:39:59Z.
value	Float	Mandatory	Displays the bandwidth value in bps. Example format: 94.33.

Status Codes, Error Codes and Error Messages

Status Code	Error Code	Error Message
400	Request.BadRequest	Bad request.
400	Domains.Invalid	Domains is empty or invalid.
400	StartTime.Invalid	StartTime is empty or invalid.
400	EndTime.Invalid	EndTime is empty or invalid.
400	TimeRange.Exceeded	The difference between EndTime and StartTime cannot exceed 90 days.
400	TimeRange.Exceeded	The difference between EndTime and StartTime cannot exceed 24 hours.
400	TimeRange.EndBeforeStart	End time must be later than start time.
400	GetBandwidth.OperationFailed	Get Bandwidth failed.
404	Domain.NotFound	Domain is not found.

Examples

Get Bandwidth

Request

POST /waap/v1.0/analytics/bandwidth HTTP/1.1

{
    "domains": [
        "www.example1.com",
        "www.example2.com"
    ],
    "startTime": "2025-09-09T17:35:00Z",
    "endTime": "2025-09-09T17:45:00Z",
    "fillFixedTime": "false",
    "interval": "minute"
}

Successful Response Body

[  
    {   
        "domain": "www.example1.com",  
        "bandwidths": [  
            {  
                "timestamp": "2025-09-09T17:35:00Z",  
                "value": 1.01  
            },  
            {  
                "timestamp": "2025-09-09T17:40:00Z",  
                "value": 3.01  
            }  
        ]  
    },  
    {  
        "domain": "www.example2.com",  
        "bandwidths": [  
            {  
                "timestamp": "2025-09-09T17:35:00Z",  
                "value": 4.04  
            },  
            {  
                "timestamp": "2025-09-09T17:40:00Z",  
                "value": 7.04  
            }  
        ]  
    }  
]