HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. timeseriesStats

Retrieve shaper time series statistics for multiple appliances

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

Retrieves QoS shaper statistics over time for a batch of appliances specified in the request body. Use this endpoint when querying multiple appliances simultaneously. Returns metrics including shaped bytes, packets, QoS drops, and wait times aggregated at the specified granularity.

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

Start of time range in Unix epoch seconds. Must be >= 0 and less than endTime.

int64
required
≥ 0

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

string
enum
required

Time interval for data aggregation. Valid values: minute, hour, day, month. The value is case-insensitive.

Allowed:
integer
1 to 10

Filter by QoS traffic class (1-10). Class 1 is highest priority. When omitted, returns data for all traffic classes.

integer
enum

Filter by traffic direction. 0 = outbound (WAN-bound), 1 = inbound (LAN-bound). When omitted, returns data for both directions.

Allowed:
boolean
Defaults to false

When true, keys response data by appliance IP address instead of nePk. Default is false (uses nePk).

string
enum

Response format. Set to 'csv' for CSV file download. Omit or use any other value for JSON response.

Allowed:
integer
≥ 1
Defaults to 10000

Maximum number of data points to return per appliance. Default is 10000 if not specified.

Body Params

JSON object containing the list of appliance primary keys to retrieve statistics for.

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

Updated about 14 hours ago

Did this page help you?
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

Updated about 14 hours ago

Did this page help you?