HomeGuidesAPI Reference
API Reference

Get aggregated user bandwidth statistics

Retrieves aggregated user statistics for specified appliances. Returns bandwidth data grouped by appliance with header metadata. If no data is found in the specified time range and lastHour is true, data from one hour prior is returned.

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

Unix epoch timestamp (seconds) for the start of the time range. Required for data retrieval.

int64
required

Unix epoch timestamp (seconds) for the end of the time range. Must be greater than startTime.

string

Username to filter statistics. When omitted, returns aggregated stats for all users.

integer
≥ 1

Limits results to top N users by throughput. When omitted, returns all users.

boolean
Defaults to false

When true and no data is found in the specified time range, automatically fetches data from one hour prior. Default is false.

Body Params

List of appliance network element primary keys (nePks) to query statistics for.

Request body containing list of appliance identifiers.

nePks
array of objects
required

List of appliance identifiers (nePks).

nePks*
Responses

401

Unauthorized - Authentication required or invalid credentials.

403

Forbidden - User lacks required 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