Get aggregate appliance stats data filter by query parameters.

post

http://127.0.0.1:8080/stats/aggregate/appliance

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

startTime

integer

required

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

endTime

integer

required

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

granularity

string

enum

required

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

Allowed:

trafficType

string

enum

Filter for data for given traffic type

Allowed:

boolean

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

metric

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.

top

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.

format

string

enum

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

Allowed:

groupByNE

boolean

Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object 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.

placeholderProperty1

string

placeholderProperty2

string

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200No response was specified