HomeGuidesAPI Reference
API Reference

Get DDoS peak and peak drop rate timeseries statistics filtered by appliance, zone, metric, protocol, and time range.

Retrieves DDoS peak and peak drop rate timeseries statistics for a specific appliance and zone. Returns flow counts, thresholds, and drop counts aggregated by the specified time granularity. Requires READ or READ_WRITE role permissions.

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

Start time boundary for data range as UNIX epoch timestamp in milliseconds (signed 64-bit). Must be less than endTime.

int64
required

End time boundary for data range as UNIX epoch timestamp in milliseconds (signed 64-bit). Must be greater than startTime.

string
enum
required

Time granularity for data aggregation. Determines whether data points are aggregated per minute, hour, or day.

Allowed:
int32
required

DDoS protection zone identifier. Filters statistics for the specified zone.

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

Statistics identifier(s) for filtering. Comma-separated values (e.g., '1' or '1,2'). 1=Peak, 2=Peak drop rate.

int32
enum
required

Classification filter for stats grouping. 1=Zone-based statistics, 2=Source-based statistics.

Allowed:
int32
Defaults to 100

Maximum number of records to return per statId. Limits the result set size for each statistics category.

Body Params

Request body containing the appliance identifier to filter statistics.

Request body containing the appliance identifier.

string
required
^\d+\.NE$

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

Responses

401

Unauthorized. Authentication credentials are missing or invalid.

403

Forbidden. User lacks READ or READ_WRITE role permissions.

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