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

Retrieve aggregated shaper QoS statistics for appliances

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

Retrieves aggregated QoS shaper statistics for specified appliances within a time range. Returns traffic metrics grouped by traffic class (1-10) and direction. Results are ordered by totalBytes descending and include a header with field names.

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

Start time boundary as Unix epoch seconds. Must be >= 0 and less than endTime.

int64
required
≥ 0

End time boundary as Unix epoch seconds. Must be >= 0 and greater than startTime.

string
enum
required

Data aggregation granularity determining which stats table to query (minute, hour, day, or month).

Allowed:
integer
enum

Traffic direction filter. 0=Outbound (LAN to WAN), 1=Inbound (WAN to LAN). If omitted, returns both directions.

Allowed:
integer
≥ 1

Maximum number of rows to return, ordered by totalBytes descending. If omitted, returns all results.

Body Params

Array of appliance identifiers to retrieve shaper stats for. At minimum, nePk is required.

List of appliance tunnel objects to filter statistics.

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

401

Unauthorized - Authentication required or invalid credentials.

403

Forbidden - User lacks READ or READ_WRITE role permissions.

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?