HomeGuidesAPI Reference
API Reference

Get application time series statistics for multiple appliances

Retrieves time series traffic statistics for a specific application across multiple appliances. Returns bytes and packets for LAN (LRX/LTX) and WAN (WRX/WTX) sides at each timestamp. Use POST to query multiple appliances in a single request. Time range: provide startTime/endTime, or use 'latest' for recent data. Set total=true for aggregated stats across all appliances.

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

Application name to filter statistics. Required, cannot be empty. Examples: HTTP, DNS, SSL, SMTP.

int64
≥ 0

Start time in Unix epoch seconds. Required unless 'latest' is provided. Must be >= 0 and < endTime.

int64
≥ 0

End time in Unix epoch seconds. Required unless 'latest' is provided. Must be >= 0 and > startTime.

integer
≥ 1

Get stats for last N minutes. When provided, auto-calculates startTime=(now - N*60) and endTime=now, ignoring explicit time params.

boolean
Defaults to false

When true, aggregates stats across all appliances. When false (default), returns per-appliance breakdown.

string
enum

Response format. Set to 'CSV' for downloadable CSV file (application/vnd.ms-excel). Default: JSON.

Allowed:
integer
≥ 1

Maximum number of data points to return. Useful for limiting large result sets.

Body Params

JSON object containing array of appliance IDs to query. All IDs must exist in GMS.

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

401

Unauthorized - Valid authentication credentials required

403

Forbidden - Requires READ or READ_WRITE permission on the resource

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