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

Get aggregated top talkers bandwidth statistics

get
http://127.0.0.1:8080/stats/aggregate/topTalkers

Retrieves aggregated top talkers (highest bandwidth consumers) statistics for appliances. Returns source/destination IP pairs with LAN/WAN traffic metrics, grouped by appliance. Results are sorted by total LAN bandwidth (LANRX_BYTES + LANTX_BYTES) in descending order.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
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.

int64
required
≥ 0

Start of time range as Unix epoch timestamp in seconds. Required. Must be >= 0 and < endTime.

int64
required
≥ 0

End of time range as Unix epoch timestamp in seconds. Required. Must be >= 0 and > startTime.

integer
≥ 1

Maximum number of top talker records to return per appliance. Limits results to the top N bandwidth consumers sorted by total LAN bytes.

boolean
Defaults to false

When true, groups results by appliance. When nePk is provided, this is forced to false.

boolean
Defaults to false

When true and no data exists for the time range, automatically queries data from one hour prior (startTime-3600, endTime-3600).

Responses

401

Unauthorized - Authentication required or invalid credentials.

403

Forbidden - User lacks READ or READ_WRITE permissions for this resource.

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?