HomeGuidesAPI Reference
API Reference

Get aggregated interface statistics for appliances

Retrieves aggregated interface statistics for specified appliances within a time range. Returns bandwidth, packet counts, overhead, and forward drop metrics per interface. Use the granularity parameter to control time bucket size (minute/hour/day) and trafficType to filter by traffic category.

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

Unix timestamp in seconds (EPOCH) marking the start of the time range. Must be >= 0 and less than endTime.

int64
required
≥ 0

Unix timestamp in seconds (EPOCH) marking the end of the time range. Must be >= 0 and greater than startTime.

string
enum
required

Time interval for data aggregation. Determines whether statistics are grouped by minute, hour, or day.

Allowed:
string
enum
required

Filter statistics by traffic category. Required parameter to specify which traffic type to include in results.

Allowed:
string
enum

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

Allowed:
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 - Authentication required or invalid credentials.

403

Forbidden - User lacks READ or READ_WRITE permissions.

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