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

Retrieve aggregated top talkers statistics for specified appliances.

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

Retrieves aggregated top talkers (highest bandwidth consumers) statistics for specified appliances. The request body filters by appliance IDs (nePks). Results include source IP, zone, VRF, and flow count data. IPv6 addresses are automatically converted to IPv4 format where applicable.

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

Start of the time range in seconds since UNIX epoch. Must be >= 0 and less than endTime.

int64
required
≥ 0

End of the time range in seconds since UNIX epoch. Must be >= 0 and greater than startTime.

integer
≥ 1

Maximum number of top talker records to return per appliance. Optional; returns all if not specified.

boolean

When true, adds an extra grouping level in the response to split stats by appliance (nePk). Default is null (no splitting).

boolean

When true and no data found in the specified range, automatically queries one hour earlier (startTime-3600, endTime-3600).

Body Params

Array of appliance-tunnel filter objects. Each entry specifies an appliance and optionally a tunnel to retrieve statistics for.

Array of appliance-tunnel filter objects. Each entry specifies an appliance and optionally a tunnel to retrieve statistics for.

Identifies an appliance and optionally a specific tunnel for statistics retrieval.

string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE'.

string | null

Specific tunnel identifier to filter. If null or not provided, returns stats for all tunnels on the appliance (excluding 'all traffic' and 'optimized traffic').

string | null

Orchestrator tunnel ID. Required when isRemote is true to identify the remote tunnel.

boolean
Defaults to false

Indicates if querying for a remote tunnel. When true, orchTid must be provided. Stats are retrieved from peer appliances.

Responses

Updated about 11 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 11 hours ago

Did this page help you?