Get DSCP time series statistics filtered by query parameters

get

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

Retrieves DSCP time series statistics for a single appliance, a group of appliances, or all appliances. Returns data as JSON with column definitions and data arrays, where each data point corresponds to a timestamp. When nePk is empty, uses groupPk to filter appliances. Supports CSV export and IP-based grouping.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

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.

startTime

int64

required

≥ 0

Unix timestamp in seconds since EPOCH indicating the start of the data time range. Must be less than endTime.

endTime

int64

required

≥ 0

Unix timestamp in seconds since EPOCH indicating the end of the data time range. Must be greater than startTime.

granularity

string

enum

required

Data aggregation interval determining the resolution of time series data points.

Allowed:

groupPk

string

Internal group identifier to retrieve stats for all appliances within that group. Used when nePk is not provided.

trafficType

string

enum

required

Traffic category filter to specify which type of traffic statistics to retrieve.

Allowed:

dscp

integer

required

0 to 63

DSCP value to filter statistics. Valid range: 0-63. DSCP is used for QoS classification in IP packets.

limit

integer

≤ 10000

Defaults to 10000

Maximum number of stats records to retrieve. Default and maximum value is 10000.

format

string

enum

Output format for the response. When set to 'CSV', returns data as downloadable CSV file.

Allowed:

boolean

Defaults to false

When true, groups stats by IP address instead of internal appliance ID. Default is false.

latest

integer

≥ 1

Retrieve stats for the last N minutes from current time. Overrides startTime and endTime when provided.

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 permission

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 containing DSCP time series statistics with column definitions and data arrays per appliance.

400Bad Request - Invalid parameters provided