Get appliance time series statistics

get

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

Retrieves time-series statistics for one or more appliances filtered by time range, granularity, and traffic type. Returns bandwidth, compression, latency, packet loss, and flow metrics organized by timestamp. When nePk is omitted, stats are retrieved for all appliances in the specified group (groupPk).

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 timestamp (seconds since epoch) for the start of the time range. Required unless 'latest' parameter is provided.

endTime

int64

required

≥ 0

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

granularity

string

enum

required

Time interval granularity for aggregating stats data. Determines the resolution of returned data points.

Allowed:

groupPk

string

Internal group identifier. When specified without nePk, retrieves stats for all appliances in the group.

trafficType

string

enum

required

Traffic category to filter statistics. Determines which type of traffic data is returned.

Allowed:

limit

integer

1 to 10000

Defaults to 10000

Maximum number of stat records to return. Default and maximum value is 10000.

format

string

enum

Output format. When set to 'CSV', returns data as downloadable CSV file instead of JSON.

Allowed:

boolean

Defaults to false

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

latest

integer

≥ 1

Retrieves stats for the most recent N minutes. When provided, overrides startTime and endTime (endTime becomes current time, startTime becomes current time minus N minutes).

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized - Authentication required

403

Forbidden - Insufficient permissions. Requires READ or READ_WRITE role.

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

200Successful retrieval of appliance time series statistics.

400Bad Request - Invalid parameters provided