HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get aggregate tunnel drc stats data filter by query parameters.

This operation is used to retrieve tunnel aggregate stats and it's identical to the GET operation on this URL except that you need to pass a request body containing appliance ids that you want to filter on to it. 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
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

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

Allowed:
integer

Indicate top x items

string

when it is 'all',return all bonded tunnels;when it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.

string
enum

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

Allowed:
boolean

Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra column inside each tunnel stats record in CSV format indicating what appliance the inner stats object belongs to. Default value is true.

Body Params

JSON array containing appliance IDs you want to filter on.

string
string
Response

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