Get interface time series statistics for a single appliance

get

http://127.0.0.1:8080/stats/timeseries/interface

Retrieves interface-level time series statistics for a single appliance. Returns traffic metrics including bytes transmitted/received, packet counts, overhead bytes, and firewall drop statistics. Data is aggregated based on the specified granularity and filtered by traffic type. Results are ordered by timestamp descending.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

required

^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

startTime

int64

required

Start of the time range in Unix epoch seconds (signed 64-bit integer). Must be less than endTime.

endTime

int64

required

End of the time range in Unix epoch seconds (signed 64-bit integer). Must be greater than startTime.

granularity

string

enum

required

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

Allowed:

trafficType

string

enum

required

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

Allowed:

interfaceName

string

Filter results to a specific interface by name. If omitted, returns stats for all interfaces.

limit

integer

1 to 10000

Defaults to 10000

Maximum number of records to return. If not provided or exceeds 10000, defaults to 10000.

Responses

401

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User lacks READ or READ_WRITE permission

Language

Loading…

Response

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

application/json

200Successfully retrieved interface time series statistics. Returns an array of statistics objects sorted by timestamp in descending order.

400Bad Request - Invalid parameters provided

503Service Unavailable - Unable to connect to statistics database