Retrieve aggregated interface statistics

post

http://127.0.0.1:8080/stats/aggregate/interface

Retrieves aggregate interface statistics for specified appliances. Returns traffic metrics including bytes, packets, overhead, and forward drops aggregated over the specified time range and granularity.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

startTime

int64

required

≥ 0

Start of the time range as Unix epoch timestamp in seconds. Must be non-negative and less than endTime.

endTime

int64

required

≥ 0

End of the time range as Unix epoch timestamp in seconds. Must be greater than startTime.

granularity

string

enum

required

Time granularity for data aggregation. Determines the time bucket size for statistics.

Allowed:

trafficType

string

enum

Filter statistics by traffic type. If not specified, returns data for all traffic types. Defaults to 'all_traffic' when format=csv.

Allowed:

format

string

enum

Response format. If set to 'csv', returns data as a downloadable CSV file. Otherwise returns JSON.

Allowed:

Body Params

List of appliance IDs (nePks) to retrieve statistics for. At least one 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. Authentication required.

403

Forbidden. User lacks required READ or READ_WRITE permissions.

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 interface aggregate statistics.

400Bad request due to validation errors.