HomeGuidesAPI Reference
API Reference

Get flow time series statistics for all flow types from a single appliance.

Retrieves flow time series statistics for all flow types from a specified appliance within a time range. Returns flow creation/deletion metrics, existing flow counts, peak values with timestamps, and throughput statistics (bytes and packets) for both LAN and WAN sides. Unlike /flow endpoint, this returns statistics for all flow types combined without requiring a flowType parameter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

string
enum
required

Data aggregation interval. Determines time bucket size for stats.

Allowed:
int64
required

Start of time range as Unix timestamp (seconds since epoch). Must be less than endTime.

int64
required

End of time range as Unix timestamp (seconds since epoch). Must be greater than startTime.

integer
≥ 1

Maximum number of records to return. Optional parameter to limit response size.

string
enum
required

Traffic classification type to filter. Maps to internal traffic type number (1=Optimized, 2=Pass-through Shaped, 3=Pass-through Unshaped, 4=All Traffic).

Allowed:
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