HomeGuidesAPI Reference
API Reference

Get application time series statistics filtered by appliance or group

Retrieves time series statistics for a specific application filtered by appliance or group. Returns traffic data including bytes and packets for both LAN and WAN sides. When nePk is provided, returns stats for that specific appliance. When nePk is omitted and groupPk is provided, returns aggregated stats for all appliances in that group. The 'latest' parameter provides a convenient shortcut to get recent data without calculating epoch times.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
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.

int64
≥ 0

Start of the time range in Unix epoch seconds (signed 64-bit). 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 in Unix epoch seconds (signed 64-bit). Required unless 'latest' parameter is provided. Must be greater than startTime and greater than or equal to 0.

string
required

Name of the application to filter statistics for. This parameter is required and cannot be empty.

string

Internal unique identifier of an appliance group. Used to retrieve aggregated stats for all appliances in the group when nePk is not provided.

string
enum

Output format for the response. When set to 'CSV', returns data as a downloadable CSV file instead of JSON.

Allowed:
boolean
Defaults to false

When true, returns aggregated total values for the application across all matching appliances. Default behavior returns per-appliance breakdown.

integer
≥ 1

Retrieve stats for the last N minutes from current time. When provided, overrides startTime and endTime parameters. Value represents minutes.

integer
≥ 1

Maximum number of data points to return in the response. Used for pagination or limiting large result sets.

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 lacks READ or READ_WRITE permission

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