HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. timeseriesStats

Retrieve user time series statistics for multiple appliances

post
http://127.0.0.1:8080/stats/timeseries/user2

Returns time series statistics for a specific user across multiple appliances. The response contains traffic metrics including LAN/WAN bytes and packets, along with flow statistics. Supports filtering by time range and optional CSV export.

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

Start of the time range in Unix epoch seconds. Must be non-negative and less than endTime.

int64
required
≥ 0

End of the time range in Unix epoch seconds. Must be greater than startTime.

string
required
length ≥ 1

Username to filter statistics. Required parameter that cannot be empty.

integer
≥ 1

Number of minutes from current time to retrieve stats. When provided, overrides startTime and endTime with calculated values (endTime=now, startTime=now-latest*60).

boolean
Defaults to false

When true, includes aggregate 'total' records along with user-specific data. Default is false.

string
enum

Response format. Use 'csv' for CSV file download, omit for JSON response.

Allowed:
integer
≥ 1

Maximum number of records to return. Capped at server-configured LIMIT_OF_ROW. Default applies server maximum if not specified.

Body Params

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

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

Updated about 14 hours ago

Did this page help you?
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

Updated about 14 hours ago

Did this page help you?