Retrieve aggregated user statistics for specified appliances

post deprecated

http://127.0.0.1:8080/stats/aggregate/user2

Fetches aggregated user statistics for the specified appliances within a time range. Supports filtering by user name, top N users by throughput, and optional CSV export. The endpoint can retry with a 1-hour offset if no data is found and lastHour is enabled.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

startTime

int64

required

≥ 0

Start of the time range as Unix epoch timestamp in seconds. Must be >= 0 and less than endTime.

endTime

int64

required

≥ 0

End of the time range as Unix epoch timestamp in seconds. Must be >= 0 and greater than startTime.

user

string

Filter results by specific user name. If omitted, returns stats for all users.

groupByNE

boolean

Defaults to true

Groups statistics by appliance (Network Element). When true, response includes an extra level with appliance identifiers as keys. Default is true.

top

integer

≥ 1

Limits results to top N users ranked by throughput. If not specified, returns all users.

lastHour

boolean

Defaults to false

If true and no data found in the specified time range, retries query with timestamps shifted back by 1 hour.

format

string

enum

Response format. Use 'csv' for CSV file download, otherwise returns JSON.

Allowed:

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*

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 permissions.

500

Internal server error during statistics retrieval.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/vnd.ms-excel

200Successful response with aggregated user statistics.

400Bad request due to invalid parameters.