Get traffic class time series statistics for single appliance or group

get

http://127.0.0.1:8080/stats/timeseries/trafficClass

Retrieves traffic class time series statistics for a single appliance or group. Returns a JSON object with column_def (field names) and data (arrays of values). Use nePk for single appliance or groupPk for all appliances in a group. The 'latest' parameter overrides startTime/endTime for convenience.

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' is specified.

endTime

int64

required

≥ 0

Unix timestamp (seconds since EPOCH) for the end of the time range. Must be greater than startTime.

granularity

string

enum

required

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

Allowed:

groupPk

string

Internal group identifier to retrieve stats for all appliances in a group. Use when nePk is not provided.

trafficType

string

enum

required

Traffic type filter to select specific traffic category for statistics.

Allowed:

trafficClass

integer

enum

required

1 to 10

Traffic class identifier (QoS priority level). Values 1-10 represent different priority levels.

limit

integer

1 to 10000

Defaults to 10000

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

format

string

enum

Response format. When set to 'CSV', returns downloadable CSV file instead of JSON.

Allowed:

boolean

Defaults to false

When true, groups stats by appliance IP address instead of internal nePk identifier. Default is false.

latest

integer

≥ 1

Retrieve stats for the latest N minutes. Overrides startTime and endTime when provided.

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

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 response containing column definitions and time series stats data

400Bad Request - Invalid parameters

503Service Unavailable - Server is busy processing other requests