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

Get traffic behavioral stats for multiple appliances

post
http://127.0.0.1:8080/stats/aggregate/trafficBehavior

Retrieves aggregate traffic behavioral statistics for multiple appliances specified in the request body. Use this endpoint to query stats for a specific list of appliances. The isAggregated parameter controls whether to return category-level summaries or detailed per-application breakdowns. Note: groupByNE parameter is not used in POST method.

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

Start time in Unix epoch seconds. Must be non-negative and less than endTime.

int64
required
≥ 0

End time in Unix epoch seconds. Must be non-negative and greater than startTime.

string

Filter by behavioral category name. Common values: Business, Recreational, Streaming, General.

string

Filter by application name to retrieve stats for a specific application within the category.

string
enum

Output format. Use 'CSV' for downloadable CSV file (case-insensitive).

Allowed:
integer
≥ 1

Limit results to top N entries ranked by traffic volume. Useful for dashboard displays.

boolean
Defaults to false

If no data in last hour, fetch from one hour earlier. Useful for recent data queries. Default: false.

boolean
Defaults to false

When true, returns aggregated summary stats by category. When false, returns detailed per-application stats. Default: false.

boolean
Defaults to true

Include appliance-level breakdown in response. Only used when nePk is provided. Default: true.

Body Params

JSON object containing the list of appliance identifiers (nePks) to retrieve statistics for.

Request body containing the 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

Updated about 11 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 11 hours ago

Did this page help you?