HomeGuidesAPI Reference
API Reference

Retrieve DDoS Total timeseries statistics filtered by zone, metric, protocol, and classification.

Retrieves DDoS Total timeseries statistics for the specified appliances. The request body must contain the appliance IDs (nePk) to filter on. Returns time-series data with column definitions and data rows containing nePk, zoneId, classification, metric, protocol, statsId, count, and timeStamp fields.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64
required
≥ 0

EPOCH timestamp (milliseconds) marking the start of the data range. Must be non-negative and less than endTime.

int64
required
≥ 0

EPOCH timestamp (milliseconds) marking the end of the data range. Must be greater than startTime.

string
enum
required

Time interval for data aggregation. Determines whether data is grouped by minute, hour, or day.

Allowed:
int32
required

DDoS zone identifier to filter statistics. Required parameter for zone-specific filtering.

int32
enum
required

DDoS metric type to retrieve. 0=Concurrent flows, 1=Embryonic flows, 2=Flows per second, 3=Embryonic Two-Way flows.

Allowed:
int32
enum
required

Network protocol filter. 0=All protocols, 1=TCP, 2=UDP, 4=Others.

Allowed:
string
required

Comma-separated stat identifiers for filtering. Valid values: 3, 4, 5, 6, 7.

int32
enum
required

Classification filter for data grouping. 1=Zone-based classification, 2=Source-based classification.

Allowed:
int32
≥ 1

Maximum number of data rows to return. Optional parameter for pagination. When omitted, returns all matching records.

Body Params

Request body containing the appliance primary key (nePk) to filter statistics.

Request body containing appliance identifier for filtering statistics.

string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE'.

Responses

401

Unauthorized - Authentication required or invalid credentials.

403

Forbidden - User lacks READ or READ_WRITE permission.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json