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

Get aggregate application stats for multiple appliances

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

Retrieves aggregated application bandwidth statistics for a list of appliances specified in the request body. Returns LAN and WAN byte/packet counts per application for each appliance. Use this endpoint when querying stats for multiple specific appliances rather than by group.

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

EPOCH timestamp (milliseconds) marking the start of the query time range. Must be non-negative and less than endTime.

int64
required
≥ 0

EPOCH timestamp (milliseconds) marking the end of the query time range. Must be non-negative and greater than startTime.

string

Filter results to a specific application name. Case-sensitive exact match. If omitted, returns stats for all applications.

integer
≥ 1

Return only the top N applications by total throughput. Useful for identifying highest bandwidth consumers.

string
enum

Output format for the response. Set to 'csv' for CSV file download. Omit or use any other value for JSON response.

Allowed:
boolean
Defaults to true

Group results by appliance identifier. When true (default), each result includes the nePk field. When false, results are aggregated across all specified appliances.

boolean
Defaults to false

Enable automatic retry with shifted time range. When true and no data found, the query retries with startTime and endTime shifted back by 3600000ms (1 hour).

Body Params

JSON object containing the list of appliance IDs to query. The nePks array must contain at least one valid appliance ID.

Request body containing the 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

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

Did this page help you?