HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get aggregate tunnel stats data filter by query parameters.

This operation is used to retrieve tunnel aggregate stats, you need to pass a request body containing appliance ids and tunnel ids (optional) 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

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.

Body Params

An array of appliance primary keys

string
string
Response

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