HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. aggregateStats

Get DNS aggregate statistics for multiple appliances

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

Retrieves aggregated DNS traffic statistics for multiple SD-WAN appliances. Returns domain-level or country-level traffic metrics including bytes, packets, and flow counts. Supports automatic fallback to previous hour data when lastHour=true.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64
required
≥ 0

Query start time as Unix epoch seconds. Must be non-negative and less than endTime.

int64
required
≥ 0

Query end time as Unix epoch seconds. Must be greater than startTime.

integer
enum

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

Allowed:
integer
enum

Filter by protocol type. 0=HTTP, 1=HTTPS, 2=unassigned, 3=other protocols.

Allowed:
integer
≥ 1

Maximum number of DNS entries to return per appliance. Limits result set size.

boolean
Defaults to false

Fallback mode: when true and no data found, automatically queries one hour earlier (startTime-3600 to endTime-3600).

boolean

When true, results are grouped by appliance ID in separate response objects. When false/null, data is aggregated.

string
enum
Defaults to dns

Aggregation dimension. 'dns' groups by domain name, 'country' groups by geographic location.

Allowed:
integer
≥ 1
Defaults to 2

Domain depth for grouping. Value 2 yields 'example.com', value 3 yields 'sub.example.com'.

Body Params

JSON object containing list of appliance IDs to query. All appliances must exist in Orchestrator.

Request body containing the list of appliance identifiers.

nePks
array of objects
required

List of appliance identifiers (nePks).

nePks*
Responses

403

Forbidden - User lacks required permissions. Requires READ or READ_WRITE role.

Updated about 14 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 14 hours ago

Did this page help you?