Get DSCP time series statistics for traffic analysis

get

http://127.0.0.1:8080/stats3/timeseries/dscp

Retrieves DSCP time series statistics for bandwidth and packet metrics. Returns column definitions and data arrays where each data point corresponds to a timestamp. When nePk is provided, returns stats for that specific appliance. When nePk is omitted, returns stats for all appliances in the specified group (groupPk). The 'latest' parameter can override startTime/endTime to get recent data.

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 (seconds since EPOCH) for the start of the time range. Required unless 'latest' is provided.

endTime

int64

required

≥ 0

Unix timestamp (seconds since EPOCH) for the end of the time range. Must be greater than startTime. Required unless 'latest' is provided.

granularity

string

enum

required

Time interval for data aggregation. Determines whether stats are aggregated by minute, hour, day, or month.

Allowed:

groupPk

string

Internal group ID to filter appliances. Used when nePk is not provided to retrieve stats for all appliances in the group.

trafficType

string

enum

required

Traffic category filter. Specifies which type of traffic to include in the statistics.

Allowed:

dscp

integer

required

0 to 63

DSCP value to filter statistics. Valid range is 0-63 representing QoS priority levels.

limit

integer

≤ 10000

Defaults to 10000

Maximum number of data points to return. Default and maximum value is 10000.

format

string

enum

Output format. Set to 'CSV' for downloadable CSV file, otherwise returns JSON.

Allowed:

boolean

Defaults to false

Use IP address as the grouping key instead of internal appliance ID (nePk). Default is false.

latest

integer

≥ 1

Retrieve stats for the last N minutes. Overrides startTime and endTime when provided. Unit is minutes.

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

200Successfully retrieved DSCP time series statistics

400Bad Request - Invalid parameters