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

Get appliance time series statistics for multiple appliances (batch query)

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

Retrieves bandwidth and throughput time series statistics for multiple appliances specified in request body. Validation order: granularity → trafficType → nePks list → time range. All appliance IDs are validated before querying. Use 'latest' parameter for quick access to recent data without calculating epoch timestamps.

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

Unix epoch timestamp (seconds) for data range start. Ignored when 'latest' is provided. Value is rounded down to the nearest minute boundary.

int64
≥ 0

Unix epoch timestamp (seconds) for data range end. Must be greater than startTime. Ignored when 'latest' is provided. Value is rounded up to the next minute boundary.

string
enum
required

Data aggregation interval determining time resolution. Use 'minute' for real-time monitoring, 'hour' for daily trends, 'day' for long-term analysis.

Allowed:
string
enum
required

Traffic category filter. optimized_traffic (1): WAN optimized traffic. pass_through_shaped (2): Shaped but not optimized. pass_through_unshaped (3): Unshaped passthrough. all_traffic (4): Combined total.

Allowed:
integer
1 to 10000
Defaults to 10000

Maximum records to return per appliance. If omitted or exceeds 10000, defaults to 10000.

string
enum

Response format. When 'CSV', returns downloadable CSV file with filename 'ApplianceTimeSeriesStats.csv'.

Allowed:
boolean
Defaults to false

Use appliance IP address instead of nePk as key in response data object. Defaults to false if not provided.

integer
≥ 1

Retrieve last N minutes of data. When provided, calculates endTime as current time and startTime as (current - latest*60). Overrides startTime/endTime parameters.

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

403

Forbidden - User must have READ or READ_WRITE permission (RolesAllowed annotation)

500

Internal Server Error - Database or processing error during statistics retrieval

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?