HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get aggregate ports stats data filter by query parameters.

This operation is used to retrieve ports 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 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

integer
enum

Integer value representing whether dns is from source or destination

Allowed:
integer
enum

Integer value representing whether port is assigned to a application(1) or not(0)

Allowed:
integer

Integer value representing whether protocol used by port

integer

Integer value representing whether port number

integer

No. of rows to return

boolean

Boolean value indicating whether you want to split aggregate stats by appliance, if true is provided, there will be an extra level of key inside each stats object indicating what appliance the inner stats object belongs to. Default value is null.

boolean

Boolean value representing whether to fetch data one hour behind from last hour if data is not found in last hour time range

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