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

Get DSCP aggregate statistics for multiple appliances

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

Retrieves aggregated DSCP statistics for multiple appliances specified in request body. Use this for batch queries across several appliances. Required: nePks in body, granularity, trafficType, startTime, endTime. Validates all appliance IDs exist before processing.

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

Data aggregation interval. Maps to database table: minute, hourly, daily, or monthly.

Allowed:
string
enum
required

Traffic type classification. Maps to: 1=Optimized, 2=Pass-through Shaped, 3=Pass-through Unshaped, 4=All Traffic.

Allowed:
int64
required
≥ 0

EPOCH timestamp for data range start. Must be >= 0 and less than endTime.

int64
required
≥ 0

EPOCH timestamp for data range end. Must be >= 0 and greater than startTime.

integer
0 to 63

DSCP value filter (0-63). Omit to return stats for all DSCP values.

boolean
Defaults to false

Use IP address as grouping key instead of nePk. Default: false.

string
enum

Metric for sorting/filtering results. Required when 'top' is specified.

integer
≥ 1

Limit results to top N items sorted by metric. Requires 'metric' parameter.

string
enum

Set to 'csv' to download results as CSV file.

Allowed:
boolean
Defaults to true

Group results by appliance. Default: true. When false, aggregates across all appliances.

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

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?