Retrieve DSCP time series bandwidth statistics for multiple appliances

post

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

Retrieves DSCP (Differentiated Services Code Point) time series statistics for multiple specified appliances. Provide appliance IDs in the request body to query bandwidth metrics filtered by DSCP value and traffic type. Response includes column definitions and data arrays grouped by appliance identifier. Use 'latest' parameter for recent data or specify exact time range with startTime/endTime.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

startTime

int64

required

≥ 0

Unix timestamp (seconds since EPOCH) for query start. Automatically rounded down to nearest minute. Required unless 'latest' is provided.

endTime

int64

required

≥ 0

Unix timestamp (seconds since EPOCH) for query end. Automatically rounded up to nearest minute. Must be greater than startTime.

granularity

string

enum

required

Time interval for data aggregation. Case-insensitive (e.g., 'hour' or 'HOUR').

Allowed:

trafficType

string

enum

required

Traffic category filter. Case-insensitive. Maps to internal traffic type numbers (1-4).

Allowed:

dscp

integer

required

0 to 63

DSCP (Differentiated Services Code Point) value for QoS filtering. Valid range: 0-63.

limit

integer

1 to 10000

Defaults to 10000

Maximum data points per appliance. Values exceeding 10000 are capped to 10000.

format

string

enum

Output format. Set to 'CSV' for file download with Content-Disposition header.

Allowed:

boolean

Defaults to false

Use appliance IP address as response key instead of nePk identifier.

latest

integer

≥ 1

Retrieve stats for last N minutes from current time. When provided, overrides startTime/endTime.

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 must have 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

200DSCP time series statistics retrieved successfully.

400Bad Request - Invalid or missing parameters