HomeGuidesAPI Reference
API Reference

Get aggregate application stats by appliance, group, or all

Retrieves aggregated application bandwidth statistics for appliances. Supports three query modes: single appliance (nePk), group (groupPk), or all appliances. Returns LAN/WAN byte and packet counts per application.

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

EPOCH timestamp (milliseconds) for the start of the data time range. Must be >= 0 and less than endTime.

int64
required
≥ 0

EPOCH timestamp (milliseconds) for the end of the data time range. Must be >= 0 and greater than startTime.

string

Filter results by application name. Case-sensitive match.

integer
≥ 1

Limit results to top N applications sorted by throughput.

string

Internal group ID for filtering stats by appliance group. Used when nePk is not provided.

string
enum

Output format. Use 'csv' for CSV export. Omit for JSON response.

Allowed:
boolean
Defaults to true

Group results by appliance (nePk). Default is true. When true, response includes appliance identifiers in nested structure.

boolean
Defaults to false

When true, fetches data from one hour prior if no data exists in the specified time range. Useful for recent data queries.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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