HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get Shaper time series stats data filter by certain query parameters and certain appliance IDs.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

nePk is the device key assigned by Orchestrator, usually look like '0.NE'.

string

Internal group ID of a group for which you want to retrieve stats

integer
required

Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range

integer
required

Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range

string
enum
required

Data granularity filtering whether data is minutely data, hourly data or daily data.

Allowed:
integer
enum
required

Filter for data which belongs to trafficClass by integer value {trafficClass} 1 - 10

integer
enum
required

0 - Outbound/1 - Inbound

Allowed:
boolean

Using IP as key for grouping stats instead of using internal appliance id as key. Default value if false

string
enum

The only format other than JSON we support currently is CSV, so format=csv.

Allowed:
integer

Limit the number of stats entity retrieved. Default and maximum limits are both 10000.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*