Get HTTP Status Code Number
Retrieves the data sample of the number of HTTP status codes , aggregated in 5-minute intervals.
Request
Request-Line
POST /waap/v1.0/analytics/httpCodes 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. Interval between start time and end time cannot be longer than 24 hours. |
Response
Response Body
Property name | Type | Required | Description |
---|---|---|---|
Array | Mandatory | Array of Domain HTTP Codes. |
Object: Domain HTTP Codes
Parameter | Type | Required | Description |
---|---|---|---|
domain | String | Mandatory | Name of domain. |
httpCodes | Object | Mandatory | List of HTTP codes and their number of requests values. Array of HTTP Code. |
Object: HTTP Code
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. |
httpCodeValues | Map | Mandatory | Map of HTTP status codes and their corresponding request counts within a 5-minute interval. |
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 24 hours. |
400 | TimeRange.EndBeforeStart | End time must be later than start time. |
400 | GetHttpCodes.OperationFailed | Get Http Codes failed. |
404 | Domain.NotFound | Domain is not found. |
Examples
Get HTTP Status Code Number
Request
POST /waap/v1.0/analytics/httpCodes HTTP/1.1
{
"domains": [
"www.example1.com",
"www.example2.com"
],
"startTime": "2025-09-09T17:35:00Z",
"endTime": "2025-09-09T17:45:00Z"
}
Successful Response Body
[
{
"domain": "www.example1.com",
"httpCodes": [
{
"timestamp": "2025-09-09T17:35:00Z",
"httpCodeValues": {
"200": 3,
"206": 10
}
}
]
},
{
"domain": "www.example2.com",
"httpCodes": [
{
"timestamp": "2025-09-09T17:35:00Z",
"httpCodeValues": {
"200": 2,
"304": 1
}
}
]
}
]