Get Volume

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

Request

Request-Line

POST /waap/v1.0/analytics/volume 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 parameter that specifies whether to return zero for empty data points. Accepted values are true or false. The default is false.
interval	String	Optional	Defines the granularity of data points. Supported values are "minute" and "day". For "minute", each data point represents a 5-minute interval; for "day", each data point represents one day. The default is "minute".

Response

Response Body

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

Object: Domain Volume

Parameter	Type	Required	Description
domain	String	Mandatory	Name of domain.
volumes	Object	Mandatory	Array of Volume metrics recorded at 5-minute intervals.

Object: Volume

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	Data volume within a 5-minute interval, expressed as an integer (e.g., 32342331).

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	GetVolume.OperationFailed	Get Volume failed.
404	Domain.NotFound	Domain is not found.

Examples

Get Volume

Request

POST /waap/v1.0/analytics/volume 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",
        "volumes": [
            {
                "timestamp": "2025-09-09T17:35:00Z",
                "value": 32342331
            }
        ]
    },
    {
        "domain": "www.example2.com",
        "volumes": [
            {
                "timestamp": "2025-09-09T17:35:00Z",
                "value": 32342331
            }
        ]
    }
]