HomeGuidesAPI Reference
API Reference

Get application bandwidth trends and statistics

Retrieves bandwidth statistics for top applications across specified appliances over a time range. Returns data grouped by appliance, with each appliance containing stats for its top applications. The stat granularity (MINUTE, HOURLY, DAILY) is automatically determined based on the time range: <=1 hour returns minute-level stats, <=60 hours returns hourly stats, <=60 days returns daily stats.

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

Start timestamp in milliseconds (epoch time). Used with endDate to determine the stat granularity: <=60min returns MINUTE stats, <=60hrs returns HOURLY stats, <=60 days returns DAILY stats.

int64
required

End timestamp in milliseconds (epoch time). The time range (endDate - startDate) must not exceed 60 days. Stats granularity is auto-determined based on range.

string
enum
required

Filter by traffic type. Determines which category of network traffic to include in bandwidth statistics.

Allowed:
string
enum
required

Traffic direction filter. Select inbound for received traffic or outbound for transmitted traffic.

Allowed:
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

boolean
Defaults to false

When true, applies custom time range rounding logic for drill-down queries. Affects how start/end times are rounded based on previousStatType.

string
enum

Previous stat granularity used before drill-down. When customRangeUsed is true, this determines time rounding behavior for zooming into data.

Allowed:
Responses

401

Unauthorized - Authentication required. User must have READ or READ_WRITE role.

403

Forbidden - User lacks required permissions (READ or READ_WRITE role).

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json