HomeGuidesAPI Reference
API Reference

Get DSCP aggregate statistics for single appliance or group

Retrieves aggregated DSCP statistics for a single appliance (via nePk) or appliance group (via groupPk). Returns traffic statistics grouped by DSCP value and traffic type. Response structure varies based on groupByNE parameter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE'). When omitted, results are returned for all appliances.

string

Group primary key for filtering stats by appliance group. Used when nePk is not provided.

int64
required
≥ 0

EPOCH timestamp (signed 64-bit) for data range start. Must be >= 0 and less than endTime.

int64
required
≥ 0

EPOCH timestamp (signed 64-bit) for data range end. Must be >= 0 and greater than startTime.

string
enum
required

Traffic type classification filter. Determines which traffic category to include in stats.

Allowed:
string
enum
required

Data aggregation interval. Controls the time granularity of returned statistics.

Allowed:
integer
0 to 63

DSCP value filter. Valid range: 0-63. When omitted, returns stats for all DSCP values.

boolean
Defaults to false

Use IP address as grouping key instead of internal appliance ID (nePk).

string
enum

Sort results by specified metric. Required when using 'top' parameter.

integer
≥ 1

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

string
enum

Response format. Set to 'csv' for CSV file download.

Allowed:
boolean
Defaults to true

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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