Retrieve shaper time series statistics

get

http://127.0.0.1:8080/stats/timeseries/shaper

Retrieves QoS shaper statistics over time for specified appliances or groups. Returns metrics including shaped bytes, packets, QoS drops, and wait times. When nePk is provided, returns stats for a single appliance; otherwise uses groupPk to filter by group.

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.

groupPk

string

Internal group ID for filtering stats. Used when nePk is not provided to retrieve stats for all appliances in the group.

startTime

int64

required

≥ 0

Start of time range in Unix epoch seconds (must be >= 0 and < endTime).

endTime

int64

required

≥ 0

End of time range in Unix epoch seconds (must be > startTime).

granularity

string

enum

required

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

Allowed:

trafficClass

integer

enum

1 to 10

QoS traffic class to filter (1-10). Class 1 is highest priority, class 10 is lowest.

direction

integer

enum

Traffic direction filter: 0 for outbound (WAN-bound), 1 for inbound (LAN-bound).

Allowed:

boolean

Defaults to false

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

format

string

enum

Response format. Use 'csv' to download as CSV file. Omit for JSON response.

Allowed:

limit

integer

≤ 10000

Defaults to 10000

Maximum number of data points to return. Default and maximum is 10000.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

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 with shaper statistics

400Bad Request - Invalid parameters

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions (requires READ or READ_WRITE role)