HomeGuidesAPI Reference
API Reference

Get Traffic Behavioral Timeseries Statistics

Returns time-series traffic behavioral statistics for a specified application. Provides LAN/WAN traffic metrics, flow counts, and behavioral categorization. Supports filtering by single appliance (nePk) or appliance group (groupPk).

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

Application name to filter statistics. Must be a valid application name configured in the system.

int64
≥ 0

Start of the time range as Unix epoch timestamp in seconds. Required unless 'latest' parameter is provided. Must be less than endTime and greater than or equal to 0.

int64
≥ 0

End of the time range as Unix epoch timestamp in seconds. Required unless 'latest' parameter is provided. Must be greater than startTime and greater than or equal to 0.

integer
≥ 1

Retrieve stats for the latest N minutes. When provided, overrides startTime and endTime parameters. Calculates time range as (current_time - latest*60) to current_time.

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.

string

Internal group ID to filter statistics by appliance group. Used when nePk is not provided. Returns aggregated stats for all appliances in the specified group.

string

Behavioral category filter to retrieve stats for a specific traffic behavior classification.

boolean
Defaults to false

When true, returns aggregated totals across the time range instead of individual time-series data points.

integer
1 to 10000
Defaults to 10000

Maximum number of statistics records to return. Default and maximum value is 10000.

string
enum

Output format for the response. Use 'csv' to export data as a CSV file download instead of JSON.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized - Authentication required or invalid credentials.

403

Forbidden - User does not have READ or READ_WRITE permissions.

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