HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get aggregate dscp stats data for a single appliance filter by query parameters

This operation is used to retrieve dscp aggregate stats for a single appliance. Depend on what query parameters are provided. The response format may look different.

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

Appliance internal id to filter from.

integer
required

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

integer
required

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

string
enum
required

Filter for data for given traffic type

Allowed:
string
enum
required

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

Allowed:
integer
enum

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

integer

Filter for data which belongs to a certain flow type. Valid DSCP: 0 - 63

boolean

Using IP as key for grouping stats instead of using internal appliance id as key.

string
enum

If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.

integer

This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.

string
enum

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

Allowed:
Response

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