HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. aggregateStats

Retrieve aggregated appliance statistics by throughput or packet metrics.

post
http://127.0.0.1:8080/stats3/aggregate/appliance

Retrieves aggregated appliance statistics for specified appliances over a time range. Returns either throughput (bytes) or packet count metrics based on the metric parameter. Results can be filtered by traffic type and limited to top N appliances.

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

Start time boundary in EPOCH milliseconds. Must be >= 0 and less than endTime.

int64
required
≥ 0

End time boundary in EPOCH milliseconds. Must be >= 0 and greater than startTime.

string
enum
required

Data aggregation interval. Determines how stats are grouped over time.

Allowed:
string
enum

Filter stats by traffic type. When omitted, returns all traffic types.

Allowed:
string
enum
required

Metric type determining which stats to aggregate and sort by. Required parameter.

Allowed:
integer
≥ 1

Limit results to top N appliances by the specified metric. Requires metric parameter.

boolean
Defaults to false

Include IP address information in the response.

string
enum
Defaults to json

Response format. Use 'csv' to download as Excel-compatible file.

Allowed:
Body Params

List of appliance identifiers (nePks) to retrieve statistics for.

Request body containing list of appliance identifiers.

nePks
array of objects
required

List of appliance identifiers (nePks).

nePks*
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized - Authentication credentials missing or invalid.

403

Forbidden - User lacks READ or READ_WRITE permission.

Updated about 12 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/vnd.ms-excel

Updated about 12 hours ago

Did this page help you?