HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. aggregateStats

Retrieve aggregated port statistics filtered by appliances and query parameters

post
http://127.0.0.1:8080/stats2/aggregate/ports

Returns aggregated port traffic statistics (bytes, packets, flows) for specified appliances within a time range. Statistics are grouped by source/destination, known/unknown port status, protocol, and port number. Supports filtering by specific port criteria and optional appliance-level grouping.

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

Start of time range as Unix epoch seconds. Data is queried from the hourlytopport table.

int64
required

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

integer
enum

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

Allowed:
integer
enum

Filter by port assignment status. 0 = unassigned/unknown port, 1 = assigned to a known application. If omitted, returns both.

Allowed:
integer

Filter by protocol number (e.g., 6 = TCP, 17 = UDP). If omitted, returns all protocols.

integer
0 to 65535

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

integer
≥ 1

Limit results to top N entries by total LAN traffic (LANRX_BYTES + LANTX_BYTES descending).

boolean
Defaults to false

When true, results are grouped by appliance (nePk). When false/null, aggregates across all appliances.

boolean
Defaults to false

When true and no data found in specified time range, automatically retries with time range shifted back by one hour.

Body Params

Array of appliance identifiers (nePks) to filter statistics. Each nePk uniquely identifies an appliance.

Appliance primary key identifier

Responses

Updated about 12 hours ago

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

Updated about 12 hours ago

Did this page help you?