Get appliance time series statistics

get

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

Retrieves appliance time series statistics for bandwidth and throughput metrics. Returns column definitions and data arrays grouped by appliance identifier. When nePk is provided, returns stats for that single appliance. When nePk is omitted but groupPk is provided, returns stats for all appliances in that group. When both are omitted, returns stats for all appliances. The 'latest' parameter provides a shortcut to get recent data without calculating epoch timestamps.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

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.

startTime

int64

required

≥ 0

Unix epoch timestamp (seconds) for the start of the data range. Must be >= 0 and less than endTime.

endTime

int64

required

≥ 0

Unix epoch timestamp (seconds) for the end of the data range. Must be > startTime.

granularity

string

enum

required

Data aggregation interval. Determines the time resolution of returned statistics.

Allowed:

groupPk

string

Internal group ID to filter appliances. When nePk is omitted, retrieves stats for all appliances in this group; if both omitted, returns stats for all appliances.

trafficType

string

enum

required

Type of traffic to filter statistics. Each type represents different WAN optimization categories.

Allowed:

limit

integer

1 to 10000

Defaults to 10000

Maximum number of stats records to retrieve. Default and maximum value is 10000.

format

string

enum

Output format. Set to 'CSV' to download results as a CSV file instead of JSON.

Allowed:

boolean

Defaults to false

When true, uses appliance IP address as the key in the response data object instead of nePk. Default is false.

latest

integer

≥ 1

Shortcut to retrieve the latest N minutes of data. Overrides startTime and endTime when provided. Unit is minutes.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User lacks READ or READ_WRITE permission

500

Internal Server Error - Unexpected error during stats retrieval

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/vnd.ms-excel

200Successfully retrieved appliance time series statistics.

400Bad Request - Invalid parameters