Get traffic behavioral stats by query parameters

get

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

Retrieves aggregate traffic behavioral statistics. Traffic is classified into behavioral categories (Business, Recreational, Streaming, General). When nePk is provided, returns stats for a single appliance. When nePk is omitted, returns stats for all appliances or filtered by groupPk. The isAggregated parameter controls whether to return category-level summaries or detailed per-application breakdowns.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE'). When omitted, results are returned for all appliances.

startTime

int64

required

≥ 0

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

endTime

int64

required

≥ 0

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

behavioralCate

string

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

application

string

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

top

integer

≥ 1

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

groupByNE

boolean

Defaults to true

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

groupPk

string

^\d+\.Network$

Appliance group ID to filter stats. Used when nePk is not provided to query by group.

isAggregated

boolean

Defaults to false

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

lastHour

boolean

Defaults to false

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

format

string

enum

Output format. Use 'csv' for downloadable CSV file.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Loading…

Response

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

application/json

application/vnd.ms-excel

200Traffic behavioral statistics retrieved successfully.

400Invalid or missing required parameters.

401Authentication required. Provide valid credentials.

403Insufficient permissions. Requires READ or READ_WRITE role.