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

Retrieve DSCP time series statistics for multiple appliances (batch query)

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

Retrieves DSCP time series statistics for multiple appliances specified in request body. Use for batch queries across selected appliances. Returns JSON with column definitions and data arrays keyed by appliance. Supports CSV export and IP-based grouping. When 'latest' parameter is provided, it overrides startTime/endTime to query last N minutes.

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

Unix timestamp (seconds since EPOCH) for query start. Required unless 'latest' is provided. Must be >= 0 and < endTime.

int64
required
≥ 0

Unix timestamp (seconds since EPOCH) for query end. Required unless 'latest' is provided. Must be >= 0 and > startTime.

string
enum
required

Data aggregation interval for time series resolution. Maps to database table: minute, hourly, or daily.

Allowed:
string
enum
required

Traffic category filter. Values map to internal codes: optimized_traffic=1, pass_through_shaped=2, pass_through_unshaped=3, all_traffic=4.

Allowed:
integer
required
0 to 63

DSCP (Differentiated Services Code Point) value for QoS filtering. Range: 0-63. Common values: 0=Best Effort, 46=EF (Expedited Forwarding).

integer
1 to 10000
Defaults to 10000

Maximum records to return. Used for pagination or limiting response size.

string
enum

Response format. Set to 'CSV' for downloadable Excel-compatible file with filename 'DscpTimeSeriesStats.csv'.

Allowed:
boolean
Defaults to false

When true, groups results by appliance IP address instead of nePk identifier. Default: false.

integer
≥ 1

Retrieve data for last N minutes from current time. When provided, overrides startTime and endTime (endTime=now, startTime=now-latest*60).

Body Params

JSON object containing the list of appliance identifiers (nePks) to retrieve statistics for.

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 - User requires READ or READ_WRITE role permission

Updated about 11 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 11 hours ago

Did this page help you?