Get aggregated port statistics with optional filtering

get

http://127.0.0.1:8080/stats/aggregate/ports

Retrieves aggregated port statistics for network traffic analysis. Data is grouped by port direction, application classification, protocol, and port number. Results are sorted by total LAN throughput (LANRX_BYTES + LANTX_BYTES) in descending order. Use splitByNe=true to see per-appliance breakdown.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE'). When omitted, results are returned for all appliances.

startTime

int64

required

Start of the time range in seconds since EPOCH (Unix timestamp). Must be less than endTime.

endTime

int64

required

End of the time range in seconds since EPOCH (Unix timestamp). Must be greater than startTime.

isSource

integer

enum

Filter by port direction. 1 = source port, 0 = destination port. When omitted, returns both.

Allowed:

isKnown

integer

enum

Filter by application classification. 1 = port assigned to known application, 0 = unclassified port. When omitted, returns both.

Allowed:

protocol

integer

0 to 255

Filter by IP protocol number (e.g., 6 for TCP, 17 for UDP). When omitted, returns all protocols.

port

integer

0 to 65535

Filter by specific port number. When omitted, returns all ports.

top

integer

≥ 1

Maximum number of records to return, sorted by total LAN bytes (lanrx + lantx) descending.

splitByNe

boolean

When true, groups results by appliance (nePk). Each stats object includes appliance identifier. Default is null (aggregated across appliances).

lastHour

boolean

When true, if no data found in the specified time range, queries data from one hour prior. Useful for near-real-time dashboards.

format

string

enum

Response format. Use 'csv' to download as CSV file. Default returns JSON.

Allowed:

Responses

401

Unauthorized. Authentication required or invalid credentials.

403

Forbidden. User lacks READ or READ_WRITE permission.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved port aggregate statistics.

400Bad request. Invalid parameters such as missing required fields, invalid time range, or invalid nePk format.

503Stats database unavailable.