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

Get aggregated top talkers statistics for multiple appliances

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

Retrieves aggregated top talkers statistics for multiple appliances specified in the request body. Returns a list of maps where each map contains an appliance ID as key and its stats array as value. Results are sorted by total LAN bandwidth (LANRX_BYTES + LANTX_BYTES) descending. Supports CSV export via format parameter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
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 sorted by total LAN bytes (LANRX + LANTX).

boolean
Defaults to false

When true, groups results by appliance with nePk field indicating which appliance the stats belong to.

string
enum

Response format. Use 'csv' for CSV file download (TopTalkersAggregateStats.csv). Default returns JSON.

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

Body Params

JSON object containing array of appliance IDs to query. The nePks array is required and must contain at least one valid appliance ID.

Request body containing list of appliance identifiers.

nePks
array of objects
required

List of appliance identifiers (nePks).

nePks*
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
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
application/vnd.ms-excel

Updated about 12 hours ago

Did this page help you?