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

Get time series statistics for multiple appliances (batch)

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

Retrieves time-series statistics for multiple appliances specified in the request body. Returns bandwidth, throughput, compression, latency, and flow metrics grouped by timestamp. Use this endpoint when querying stats for specific appliances by their IDs.

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

Unix timestamp (seconds since epoch) for the start of the time range. Required unless 'latest' is provided. Must be >= 0 and < endTime.

int64
≥ 0

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

string
enum
required

Time granularity for data aggregation. Determines resolution of returned data points: minute (1-min intervals), hour (hourly), day (daily).

Allowed:
string
enum
required

Traffic category filter. OPTIMIZED_TRAFFIC(1)=WAN optimized, PASS_THROUGH_SHAPED(2)=shaped but not optimized, PASS_THROUGH_UNSHAPED(3)=neither, ALL_TRAFFIC(4)=combined.

Allowed:
integer
≥ 1

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

string
enum

Output format. Set to 'CSV' for downloadable CSV file (Content-Type: application/vnd.ms-excel). Omit or use any other value for JSON.

Allowed:
boolean
Defaults to false

When true, response keys use appliance IP address instead of nePk. Default is false (uses nePk).

integer
≥ 1

Retrieve stats for most recent N minutes. When provided, overrides startTime/endTime: endTime=now, startTime=now-(latest*60).

Body Params

JSON object containing list of appliance IDs (nePks) to retrieve statistics for. At least one valid appliance ID is required.

Request body containing 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 - Valid authentication credentials required

403

Forbidden - Requires READ or READ_WRITE role permission

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?