Get DNS aggregate statistics for a single appliance

get

http://127.0.0.1:8080/stats/aggregate/dns

Retrieves aggregated DNS statistics for a single appliance. Returns domain/country-level traffic metrics including bytes, packets, and flow counts. Response format varies based on groupBy and splitByNe parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

required

^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

startTime

int64

required

≥ 0

Start time boundary as epoch seconds (signed 64-bit). Must be >= 0 and less than endTime.

endTime

int64

required

≥ 0

End time boundary as epoch seconds (signed 64-bit). Must be >= 0 and greater than startTime.

isSource

integer

enum

Filter by traffic direction: 0 = destination DNS, 1 = source DNS.

Allowed:

splitType

integer

enum

Filter by protocol type: 0 = HTTP, 1 = HTTPS, 2 = unassigned, 3 = others.

Allowed:

top

integer

≥ 1

Maximum number of results to return. Limits the result set size.

splitByNe

boolean

Split results by appliance. When true, response includes nested objects keyed by appliance ID. Default: null.

groupBy

string

enum

Group results by field. Use 'dns' for domain grouping or 'country' for geographic grouping. Default: 'dns'.

Allowed:

groupBySubDomains

integer

≥ 1

Defaults to 2

Number of sub-domains to include in domain grouping (e.g., 2 = example.com, 3 = sub.example.com). Default: 2.

Responses

403

Forbidden - Insufficient permissions. Requires READ or READ_WRITE role.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved DNS aggregate statistics. Returns array with appliance-keyed data and header metadata.

400Bad Request - Invalid parameters