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

Retrieve traffic class time series statistics for multiple appliances

post
http://127.0.0.1:8080/stats/timeseries/trafficClass

Retrieves traffic class (QoS priority) time series statistics for multiple appliances. Validation order: granularity → trafficType → trafficClass → nePks → time range. The 'latest' parameter provides a convenient alternative to explicit startTime/endTime. Response includes column_def array defining field order and data object mapping appliance identifiers to arrays of metric values. Use for bandwidth monitoring, latency analysis, and traffic class performance comparison across appliances.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

Data aggregation interval. Determines time-bucket resolution for stats. Case-insensitive.

Allowed:
string
enum
required

Traffic category filter. 'optimized_traffic' (1) = WAN-optimized flows, 'pass_through_shaped' (2) = shaped but not optimized, 'pass_through_unshaped' (3) = passthrough traffic, 'all_traffic' (4) = combined total.

Allowed:
integer
enum
required
1 to 10

QoS traffic class priority level (1-10). Class 1 is highest priority, class 10 is lowest. Must be between 1 and 10 inclusive.

int64
≥ 0

Unix timestamp (seconds since EPOCH) for range start. Required unless 'latest' is provided. Must be >= 0 and less than endTime.

int64
≥ 0

Unix timestamp (seconds since EPOCH) for range end. Required unless 'latest' is provided. Must be > startTime.

integer
≥ 1

Retrieve stats for the latest N minutes from current time. When provided, auto-calculates startTime=(now - latest*60) and endTime=now, overriding any explicit time parameters.

integer
1 to 10000
Defaults to 10000

Maximum records per appliance to return. Limits result set size for performance.

boolean
Defaults to false

When true, response data keys are appliance IP addresses instead of nePk identifiers. Useful for human-readable output.

string
enum

Output format. Set to 'CSV' for downloadable spreadsheet file (application/vnd.ms-excel). Default returns JSON.

Allowed:
Body Params

JSON object containing the list of appliance identifiers (nePks) to retrieve statistics for.

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

401

Unauthorized - Authentication credentials missing or invalid. Provide valid Basic Auth credentials.

403

Forbidden - Authenticated user lacks required permissions. Requires READ or READ_WRITE role on the appliances.

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?